Spec docs for IDNA2008 support
[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 2017
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 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP and web sites" "SECID2"
449 .cindex "web site"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is currently the University of
452 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
453 distribution'& below. In addition, there is a web site and an FTP site at
454 &%exim.org%&. These are now also hosted at the University of Cambridge. The
455 &%exim.org%& site was previously hosted for a number of years by Energis
456 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
457
458 .cindex "wiki"
459 .cindex "FAQ"
460 As well as Exim distribution tar files, the Exim web site contains a number of
461 differently formatted versions of the documentation. A recent addition to the
462 online information is the Exim wiki (&url(http://wiki.exim.org)),
463 which contains what used to be a separate FAQ, as well as various other
464 examples, tips, and know-how that have been contributed by Exim users.
465
466 .cindex Bugzilla
467 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
468 this to report bugs, and also to add items to the wish list. Please search
469 first to check that you are not duplicating a previous entry.
470
471
472
473 .section "Mailing lists" "SECID3"
474 .cindex "mailing lists" "for Exim users"
475 The following Exim mailing lists exist:
476
477 .table2 140pt
478 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
479 .row &'exim-users@exim.org'&      "General discussion list"
480 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
481 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
482 .endtable
483
484 You can subscribe to these lists, change your existing subscriptions, and view
485 or search the archives via the mailing lists link on the Exim home page.
486 .cindex "Debian" "mailing list for"
487 If you are using a Debian distribution of Exim, you may wish to subscribe to
488 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
489 via this web page:
490 .display
491 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
492 .endd
493 Please ask Debian-specific questions on this list and not on the general Exim
494 lists.
495
496 .section "Exim training" "SECID4"
497 .cindex "training courses"
498 Training courses in Cambridge (UK) used to be run annually by the author of
499 Exim, before he retired. At the time of writing, there are no plans to run
500 further Exim courses in Cambridge. However, if that changes, relevant
501 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
502
503 .section "Bug reports" "SECID5"
504 .cindex "bug reports"
505 .cindex "reporting bugs"
506 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
507 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
508 whether some behaviour is a bug or not, the best thing to do is to post a
509 message to the &'exim-dev'& mailing list and have it discussed.
510
511
512
513 .section "Where to find the Exim distribution" "SECTavail"
514 .cindex "FTP site"
515 .cindex "distribution" "ftp site"
516 The master ftp site for the Exim distribution is
517 .display
518 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
519 .endd
520 This is mirrored by
521 .display
522 &*ftp://ftp.exim.org/pub/exim*&
523 .endd
524 The file references that follow are relative to the &_exim_& directories at
525 these sites. There are now quite a number of independent mirror sites around
526 the world. Those that I know about are listed in the file called &_Mirrors_&.
527
528 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
529 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
530 distributions), and &_Testing_& for testing versions. In the &_exim4_&
531 subdirectory, the current release can always be found in files called
532 .display
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The two
537 files contain identical data; the only difference is the type of compression.
538 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
539
540 .cindex "distribution" "signing details"
541 .cindex "distribution" "public key"
542 .cindex "public key for signed distribution"
543 The distributions will be PGP signed by an individual key of the Release
544 Coordinator.  This key will have a uid containing an email address in the
545 &'exim.org'& domain and will have signatures from other people, including
546 other Exim maintainers.  We expect that the key will be in the "strong set" of
547 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
548 PGP key, a version of which can be found in the release directory in the file
549 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
550 such as &'pool.sks-keyservers.net'&.
551
552 At time of last update, releases were being made by Phil Pennock and signed with
553 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
554 A trust path from Nigel's key to Phil's can be observed at
555 &url(https://www.security.spodhuis.org/exim-trustpath).
556
557 Releases have also been authorized to be performed by Todd Lyons who signs with
558 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
559 Pennock and Todd Lyons through a common associate.
560
561 The signatures for the tar bundles are in:
562 .display
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made separately available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Run time configuration" "SECID7"
625 Exim's run time configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages on the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message, and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery,
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages on its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific licence requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk, and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct file names, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is so-called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender address
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1078 (either over TCP/IP, or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients, or the entire message, can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example, when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to any frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator, and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or the program crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Run time options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the run time configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specially by the local host. These
1237 are typically addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program, unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport, or generates one or more &"child"& addresses. Processing the
1295 original address ceases,
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports, and discards any duplicates that it finds. During this
1353 check, local parts are treated as case-sensitive. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1368 the local parts handled by the router may or must have certain prefixes and/or
1369 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1370 skipped. These conditions are tested first. When an affix is present, it is
1371 removed from the local part before further processing, including the evaluation
1372 of any other conditions.
1373 .next
1374 Routers can be designated for use only when not verifying an address, that is,
1375 only when routing it for delivery (or testing its delivery routing). If the
1376 &%verify%& option is set false, the router is skipped when Exim is verifying an
1377 address.
1378 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1379 &%verify_recipient%&, which independently control the use of the router for
1380 sender and recipient verification. You can set these options directly if
1381 you want a router to be used for only one type of verification.
1382 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1383 .next
1384 If the &%address_test%& option is set false, the router is skipped when Exim is
1385 run with the &%-bt%& option to test an address routing. This can be helpful
1386 when the first router sends all new messages to a scanner of some sort; it
1387 makes it possible to use &%-bt%& to test subsequent delivery routing without
1388 having to simulate the effect of the scanner.
1389 .next
1390 Routers can be designated for use only when verifying an address, as
1391 opposed to routing it for delivery. The &%verify_only%& option controls this.
1392 Again, cutthrough delivery counts as a verification.
1393 .next
1394 Individual routers can be explicitly skipped when running the routers to
1395 check an address given in the SMTP EXPN command (see the &%expn%& option).
1396 .next
1397 If the &%domains%& option is set, the domain of the address must be in the set
1398 of domains that it defines.
1399 .next
1400 .vindex "&$local_part_prefix$&"
1401 .vindex "&$local_part$&"
1402 .vindex "&$local_part_suffix$&"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals, or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain on your queue for ever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left on the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory, and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681
1682
1683 .section "PCRE library" "SECTpcre"
1684 .cindex "PCRE library"
1685 Exim no longer has an embedded PCRE library as the vast majority of
1686 modern systems include PCRE as a system library, although you may need
1687 to install the PCRE or PCRE development package for your operating
1688 system. If your system has a normal PCRE installation the Exim build
1689 process will need no further configuration. If the library or the
1690 headers are in an unusual location you will need to either set the PCRE_LIBS
1691 and INCLUDE directives appropriately,
1692 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1693 If your operating system has no
1694 PCRE support then you will need to obtain and build the current PCRE
1695 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1696 More information on PCRE is available at &url(http://www.pcre.org/).
1697
1698 .section "DBM libraries" "SECTdb"
1699 .cindex "DBM libraries" "discussion of"
1700 .cindex "hints database" "DBM files used for"
1701 Even if you do not use any DBM files in your configuration, Exim still needs a
1702 DBM library in order to operate, because it uses indexed files for its hints
1703 databases. Unfortunately, there are a number of DBM libraries in existence, and
1704 different operating systems often have different ones installed.
1705
1706 .cindex "Solaris" "DBM library for"
1707 .cindex "IRIX, DBM library for"
1708 .cindex "BSD, DBM library for"
1709 .cindex "Linux, DBM library for"
1710 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1711 Linux distribution, the DBM configuration should happen automatically, and you
1712 may be able to ignore this section. Otherwise, you may have to learn more than
1713 you would like about DBM libraries from what follows.
1714
1715 .cindex "&'ndbm'& DBM library"
1716 Licensed versions of Unix normally contain a library of DBM functions operating
1717 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1718 versions of Unix seem to vary in what they contain as standard. In particular,
1719 some early versions of Linux have no default DBM library, and different
1720 distributors have chosen to bundle different libraries with their packaged
1721 versions. However, the more recent releases seem to have standardized on the
1722 Berkeley DB library.
1723
1724 Different DBM libraries have different conventions for naming the files they
1725 use. When a program opens a file called &_dbmfile_&, there are several
1726 possibilities:
1727
1728 .olist
1729 A traditional &'ndbm'& implementation, such as that supplied as part of
1730 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1731 .next
1732 .cindex "&'gdbm'& DBM library"
1733 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1734 compatibility interface it makes two different hard links to it with names
1735 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1736 file name is used unmodified.
1737 .next
1738 .cindex "Berkeley DB library"
1739 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1740 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1741 programmer exactly the same as the traditional &'ndbm'& implementation.
1742 .next
1743 If the Berkeley package is used in its native mode, it operates on a single
1744 file called &_dbmfile_&; the programmer's interface is somewhat different to
1745 the traditional &'ndbm'& interface.
1746 .next
1747 To complicate things further, there are several very different versions of the
1748 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1749 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1750 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1751 versions of Berkeley DB can be obtained from
1752 &url(http://www.sleepycat.com/).
1753 .next
1754 .cindex "&'tdb'& DBM library"
1755 Yet another DBM library, called &'tdb'&, is available from
1756 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1757 operates on a single file.
1758 .endlist
1759
1760 .cindex "USE_DB"
1761 .cindex "DBM libraries" "configuration for building"
1762 Exim and its utilities can be compiled to use any of these interfaces. In order
1763 to use any version of the Berkeley DB package in native mode, you must set
1764 USE_DB in an appropriate configuration file (typically
1765 &_Local/Makefile_&). For example:
1766 .code
1767 USE_DB=yes
1768 .endd
1769 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1770 error is diagnosed if you set more than one of these.
1771
1772 At the lowest level, the build-time configuration sets none of these options,
1773 thereby assuming an interface of type (1). However, some operating system
1774 configuration files (for example, those for the BSD operating systems and
1775 Linux) assume type (4) by setting USE_DB as their default, and the
1776 configuration files for Cygwin set USE_GDBM. Anything you set in
1777 &_Local/Makefile_&, however, overrides these system defaults.
1778
1779 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1780 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1781 in one of these lines:
1782 .code
1783 DBMLIB = -ldb
1784 DBMLIB = -ltdb
1785 .endd
1786 Settings like that will work if the DBM library is installed in the standard
1787 place. Sometimes it is not, and the library's header file may also not be in
1788 the default path. You may need to set INCLUDE to specify where the header
1789 file is, and to specify the path to the library more fully in DBMLIB, as in
1790 this example:
1791 .code
1792 INCLUDE=-I/usr/local/include/db-4.1
1793 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1794 .endd
1795 There is further detailed discussion about the various DBM libraries in the
1796 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1797
1798
1799
1800 .section "Pre-building configuration" "SECID25"
1801 .cindex "building Exim" "pre-building configuration"
1802 .cindex "configuration for building Exim"
1803 .cindex "&_Local/Makefile_&"
1804 .cindex "&_src/EDITME_&"
1805 Before building Exim, a local configuration file that specifies options
1806 independent of any operating system has to be created with the name
1807 &_Local/Makefile_&. A template for this file is supplied as the file
1808 &_src/EDITME_&, and it contains full descriptions of all the option settings
1809 therein. These descriptions are therefore not repeated here. If you are
1810 building Exim for the first time, the simplest thing to do is to copy
1811 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1812
1813 There are three settings that you must supply, because Exim will not build
1814 without them. They are the location of the run time configuration file
1815 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1816 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1817 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1818 a colon-separated list of file names; Exim uses the first of them that exists.
1819
1820 There are a few other parameters that can be specified either at build time or
1821 at run time, to enable the same binary to be used on a number of different
1822 machines. However, if the locations of Exim's spool directory and log file
1823 directory (if not within the spool directory) are fixed, it is recommended that
1824 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1825 detected early in Exim's execution (such as a malformed configuration file) can
1826 be logged.
1827
1828 .cindex "content scanning" "specifying at build time"
1829 Exim's interfaces for calling virus and spam scanning software directly from
1830 access control lists are not compiled by default. If you want to include these
1831 facilities, you need to set
1832 .code
1833 WITH_CONTENT_SCAN=yes
1834 .endd
1835 in your &_Local/Makefile_&. For details of the facilities themselves, see
1836 chapter &<<CHAPexiscan>>&.
1837
1838
1839 .cindex "&_Local/eximon.conf_&"
1840 .cindex "&_exim_monitor/EDITME_&"
1841 If you are going to build the Exim monitor, a similar configuration process is
1842 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1843 your installation and saved under the name &_Local/eximon.conf_&. If you are
1844 happy with the default settings described in &_exim_monitor/EDITME_&,
1845 &_Local/eximon.conf_& can be empty, but it must exist.
1846
1847 This is all the configuration that is needed in straightforward cases for known
1848 operating systems. However, the building process is set up so that it is easy
1849 to override options that are set by default or by operating-system-specific
1850 configuration files, for example to change the name of the C compiler, which
1851 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1852 do this.
1853
1854
1855
1856 .section "Support for iconv()" "SECID26"
1857 .cindex "&[iconv()]& support"
1858 .cindex "RFC 2047"
1859 The contents of header lines in messages may be encoded according to the rules
1860 described RFC 2047. This makes it possible to transmit characters that are not
1861 in the ASCII character set, and to label them as being in a particular
1862 character set. When Exim is inspecting header lines by means of the &%$h_%&
1863 mechanism, it decodes them, and translates them into a specified character set
1864 (default is set at build time). The translation is possible only if the operating system
1865 supports the &[iconv()]& function.
1866
1867 However, some of the operating systems that supply &[iconv()]& do not support
1868 very many conversions. The GNU &%libiconv%& library (available from
1869 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1870 systems to remedy this deficiency, as well as on systems that do not supply
1871 &[iconv()]& at all. After installing &%libiconv%&, you should add
1872 .code
1873 HAVE_ICONV=yes
1874 .endd
1875 to your &_Local/Makefile_& and rebuild Exim.
1876
1877
1878
1879 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1880 .cindex "TLS" "including support for TLS"
1881 .cindex "encryption" "including support for"
1882 .cindex "SUPPORT_TLS"
1883 .cindex "OpenSSL" "building Exim with"
1884 .cindex "GnuTLS" "building Exim with"
1885 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1886 command as per RFC 2487. It can also support legacy clients that expect to
1887 start a TLS session immediately on connection to a non-standard port (see the
1888 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1889 line option).
1890
1891 If you want to build Exim with TLS support, you must first install either the
1892 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1893 implementing SSL.
1894
1895 If OpenSSL is installed, you should set
1896 .code
1897 SUPPORT_TLS=yes
1898 TLS_LIBS=-lssl -lcrypto
1899 .endd
1900 in &_Local/Makefile_&. You may also need to specify the locations of the
1901 OpenSSL library and include files. For example:
1902 .code
1903 SUPPORT_TLS=yes
1904 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1905 TLS_INCLUDE=-I/usr/local/openssl/include/
1906 .endd
1907 .cindex "pkg-config" "OpenSSL"
1908 If you have &'pkg-config'& available, then instead you can just use:
1909 .code
1910 SUPPORT_TLS=yes
1911 USE_OPENSSL_PC=openssl
1912 .endd
1913 .cindex "USE_GNUTLS"
1914 If GnuTLS is installed, you should set
1915 .code
1916 SUPPORT_TLS=yes
1917 USE_GNUTLS=yes
1918 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1919 .endd
1920 in &_Local/Makefile_&, and again you may need to specify the locations of the
1921 library and include files. For example:
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1926 TLS_INCLUDE=-I/usr/gnu/include
1927 .endd
1928 .cindex "pkg-config" "GnuTLS"
1929 If you have &'pkg-config'& available, then instead you can just use:
1930 .code
1931 SUPPORT_TLS=yes
1932 USE_GNUTLS=yes
1933 USE_GNUTLS_PC=gnutls
1934 .endd
1935
1936 You do not need to set TLS_INCLUDE if the relevant directory is already
1937 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1938 given in chapter &<<CHAPTLS>>&.
1939
1940
1941
1942
1943 .section "Use of tcpwrappers" "SECID27"
1944
1945 .cindex "tcpwrappers, building Exim to support"
1946 .cindex "USE_TCP_WRAPPERS"
1947 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1948 .cindex "tcp_wrappers_daemon_name"
1949 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1950 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1951 alternative to Exim's own checking facilities for installations that are
1952 already making use of &'tcpwrappers'& for other purposes. To do this, you
1953 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1954 &_tcpd.h_& to be available at compile time, and also ensure that the library
1955 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1956 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1957 you might have
1958 .code
1959 USE_TCP_WRAPPERS=yes
1960 CFLAGS=-O -I/usr/local/include
1961 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1962 .endd
1963 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1964 files is &"exim"&. For example, the line
1965 .code
1966 exim : LOCAL  192.168.1.  .friendly.domain.example
1967 .endd
1968 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1969 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1970 All other connections are denied. The daemon name used by &'tcpwrappers'&
1971 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1972 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1973 configure file. Consult the &'tcpwrappers'& documentation for
1974 further details.
1975
1976
1977 .section "Including support for IPv6" "SECID28"
1978 .cindex "IPv6" "including support for"
1979 Exim contains code for use on systems that have IPv6 support. Setting
1980 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1981 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1982 where the IPv6 support is not fully integrated into the normal include and
1983 library files.
1984
1985 Two different types of DNS record for handling IPv6 addresses have been
1986 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1987 currently seen as the mainstream. Another record type called A6 was proposed
1988 as better than AAAA because it had more flexibility. However, it was felt to be
1989 over-complex, and its status was reduced to &"experimental"&.
1990 Exim used to
1991 have a compile option for including A6 record support but this has now been
1992 withdrawn.
1993
1994
1995
1996 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1997 .cindex "lookup modules"
1998 .cindex "dynamic modules"
1999 .cindex ".so building"
2000 On some platforms, Exim supports not compiling all lookup types directly into
2001 the main binary, instead putting some into external modules which can be loaded
2002 on demand.
2003 This permits packagers to build Exim with support for lookups with extensive
2004 library dependencies without requiring all users to install all of those
2005 dependencies.
2006 Most, but not all, lookup types can be built this way.
2007
2008 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2009 installed; Exim will only load modules from that directory, as a security
2010 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2011 for your OS; see &_OS/Makefile-Linux_& for an example.
2012 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2013 see &_src/EDITME_& for details.
2014
2015 Then, for each module to be loaded dynamically, define the relevant
2016 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2017 For example, this will build in lsearch but load sqlite and mysql support
2018 on demand:
2019 .code
2020 LOOKUP_LSEARCH=yes
2021 LOOKUP_SQLITE=2
2022 LOOKUP_MYSQL=2
2023 .endd
2024
2025
2026 .section "The building process" "SECID29"
2027 .cindex "build directory"
2028 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2029 created, run &'make'& at the top level. It determines the architecture and
2030 operating system types, and creates a build directory if one does not exist.
2031 For example, on a Sun system running Solaris 8, the directory
2032 &_build-SunOS5-5.8-sparc_& is created.
2033 .cindex "symbolic link" "to source files"
2034 Symbolic links to relevant source files are installed in the build directory.
2035
2036 If this is the first time &'make'& has been run, it calls a script that builds
2037 a make file inside the build directory, using the configuration files from the
2038 &_Local_& directory. The new make file is then passed to another instance of
2039 &'make'&. This does the real work, building a number of utility scripts, and
2040 then compiling and linking the binaries for the Exim monitor (if configured), a
2041 number of utility programs, and finally Exim itself. The command &`make
2042 makefile`& can be used to force a rebuild of the make file in the build
2043 directory, should this ever be necessary.
2044
2045 If you have problems building Exim, check for any comments there may be in the
2046 &_README_& file concerning your operating system, and also take a look at the
2047 FAQ, where some common problems are covered.
2048
2049
2050
2051 .section 'Output from &"make"&' "SECID283"
2052 The output produced by the &'make'& process for compile lines is often very
2053 unreadable, because these lines can be very long. For this reason, the normal
2054 output is suppressed by default, and instead output similar to that which
2055 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2056 each module that is being compiled or linked. However, it is still possible to
2057 get the full output, by calling &'make'& like this:
2058 .code
2059 FULLECHO='' make -e
2060 .endd
2061 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2062 command reflection in &'make'&. When you ask for the full output, it is
2063 given in addition to the short output.
2064
2065
2066
2067 .section "Overriding build-time options for Exim" "SECToverride"
2068 .cindex "build-time options, overriding"
2069 The main make file that is created at the beginning of the building process
2070 consists of the concatenation of a number of files which set configuration
2071 values, followed by a fixed set of &'make'& instructions. If a value is set
2072 more than once, the last setting overrides any previous ones. This provides a
2073 convenient way of overriding defaults. The files that are concatenated are, in
2074 order:
2075 .display
2076 &_OS/Makefile-Default_&
2077 &_OS/Makefile-_&<&'ostype'&>
2078 &_Local/Makefile_&
2079 &_Local/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile-_&<&'archtype'&>
2081 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2082 &_OS/Makefile-Base_&
2083 .endd
2084 .cindex "&_Local/Makefile_&"
2085 .cindex "building Exim" "operating system type"
2086 .cindex "building Exim" "architecture type"
2087 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2088 architecture type. &_Local/Makefile_& is required to exist, and the building
2089 process fails if it is absent. The other three &_Local_& files are optional,
2090 and are often not needed.
2091
2092 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2093 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2094 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2095 values are used, thereby providing a means of forcing particular settings.
2096 Otherwise, the scripts try to get values from the &%uname%& command. If this
2097 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2098 of &'ad hoc'& transformations are then applied, to produce the standard names
2099 that Exim expects. You can run these scripts directly from the shell in order
2100 to find out what values are being used on your system.
2101
2102
2103 &_OS/Makefile-Default_& contains comments about the variables that are set
2104 therein. Some (but not all) are mentioned below. If there is something that
2105 needs changing, review the contents of this file and the contents of the make
2106 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2107 default values are.
2108
2109
2110 .cindex "building Exim" "overriding default settings"
2111 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2112 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2113 need to change the original files. Instead, you should make the changes by
2114 putting the new values in an appropriate &_Local_& file. For example,
2115 .cindex "Tru64-Unix build-time settings"
2116 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2117 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2118 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2119 called with the option &%-std1%&, to make it recognize some of the features of
2120 Standard C that Exim uses. (Most other compilers recognize Standard C by
2121 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2122 containing the lines
2123 .code
2124 CC=cc
2125 CFLAGS=-std1
2126 .endd
2127 If you are compiling for just one operating system, it may be easier to put
2128 these lines directly into &_Local/Makefile_&.
2129
2130 Keeping all your local configuration settings separate from the distributed
2131 files makes it easy to transfer them to new versions of Exim simply by copying
2132 the contents of the &_Local_& directory.
2133
2134
2135 .cindex "NIS lookup type" "including support for"
2136 .cindex "NIS+ lookup type" "including support for"
2137 .cindex "LDAP" "including support for"
2138 .cindex "lookup" "inclusion in binary"
2139 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2140 lookup, but not all systems have these components installed, so the default is
2141 not to include the relevant code in the binary. All the different kinds of file
2142 and database lookup that Exim supports are implemented as separate code modules
2143 which are included only if the relevant compile-time options are set. In the
2144 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2145 .code
2146 LOOKUP_LDAP=yes
2147 LOOKUP_NIS=yes
2148 LOOKUP_NISPLUS=yes
2149 .endd
2150 and similar settings apply to the other lookup types. They are all listed in
2151 &_src/EDITME_&. In many cases the relevant include files and interface
2152 libraries need to be installed before compiling Exim.
2153 .cindex "cdb" "including support for"
2154 However, there are some optional lookup types (such as cdb) for which
2155 the code is entirely contained within Exim, and no external include
2156 files or libraries are required. When a lookup type is not included in the
2157 binary, attempts to configure Exim to use it cause run time configuration
2158 errors.
2159
2160 .cindex "pkg-config" "lookups"
2161 .cindex "pkg-config" "authenticators"
2162 Many systems now use a tool called &'pkg-config'& to encapsulate information
2163 about how to compile against a library; Exim has some initial support for
2164 being able to use pkg-config for lookups and authenticators.  For any given
2165 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2166 variable with the &`_PC`& suffix in the name and assign as the value the
2167 name of the package to be queried.  The results of querying via the
2168 &'pkg-config'& command will be added to the appropriate Makefile variables
2169 with &`+=`& directives, so your version of &'make'& will need to support that
2170 syntax.  For instance:
2171 .code
2172 LOOKUP_SQLITE=yes
2173 LOOKUP_SQLITE_PC=sqlite3
2174 AUTH_GSASL=yes
2175 AUTH_GSASL_PC=libgsasl
2176 AUTH_HEIMDAL_GSSAPI=yes
2177 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2178 .endd
2179
2180 .cindex "Perl" "including support for"
2181 Exim can be linked with an embedded Perl interpreter, allowing Perl
2182 subroutines to be called during string expansion. To enable this facility,
2183 .code
2184 EXIM_PERL=perl.o
2185 .endd
2186 must be defined in &_Local/Makefile_&. Details of this facility are given in
2187 chapter &<<CHAPperl>>&.
2188
2189 .cindex "X11 libraries, location of"
2190 The location of the X11 libraries is something that varies a lot between
2191 operating systems, and there may be different versions of X11 to cope
2192 with. Exim itself makes no use of X11, but if you are compiling the Exim
2193 monitor, the X11 libraries must be available.
2194 The following three variables are set in &_OS/Makefile-Default_&:
2195 .code
2196 X11=/usr/X11R6
2197 XINCLUDE=-I$(X11)/include
2198 XLFLAGS=-L$(X11)/lib
2199 .endd
2200 These are overridden in some of the operating-system configuration files. For
2201 example, in &_OS/Makefile-SunOS5_& there is
2202 .code
2203 X11=/usr/openwin
2204 XINCLUDE=-I$(X11)/include
2205 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2206 .endd
2207 If you need to override the default setting for your operating system, place a
2208 definition of all three of these variables into your
2209 &_Local/Makefile-<ostype>_& file.
2210
2211 .cindex "EXTRALIBS"
2212 If you need to add any extra libraries to the link steps, these can be put in a
2213 variable called EXTRALIBS, which appears in all the link commands, but by
2214 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2215 command for linking the main Exim binary, and not for any associated utilities.
2216
2217 .cindex "DBM libraries" "configuration for building"
2218 There is also DBMLIB, which appears in the link commands for binaries that
2219 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2220 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2221 binary, and which can be used, for example, to include additional X11
2222 libraries.
2223
2224 .cindex "configuration file" "editing"
2225 The make file copes with rebuilding Exim correctly if any of the configuration
2226 files are edited. However, if an optional configuration file is deleted, it is
2227 necessary to touch the associated non-optional file (that is,
2228 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2229
2230
2231 .section "OS-specific header files" "SECID30"
2232 .cindex "&_os.h_&"
2233 .cindex "building Exim" "OS-specific C header files"
2234 The &_OS_& directory contains a number of files with names of the form
2235 &_os.h-<ostype>_&. These are system-specific C header files that should not
2236 normally need to be changed. There is a list of macro settings that are
2237 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2238 are porting Exim to a new operating system.
2239
2240
2241
2242 .section "Overriding build-time options for the monitor" "SECID31"
2243 .cindex "building Eximon"
2244 A similar process is used for overriding things when building the Exim monitor,
2245 where the files that are involved are
2246 .display
2247 &_OS/eximon.conf-Default_&
2248 &_OS/eximon.conf-_&<&'ostype'&>
2249 &_Local/eximon.conf_&
2250 &_Local/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf-_&<&'archtype'&>
2252 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2253 .endd
2254 .cindex "&_Local/eximon.conf_&"
2255 As with Exim itself, the final three files need not exist, and in this case the
2256 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2257 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2258 variables of the same name, preceded by EXIMON_. For example, setting
2259 EXIMON_LOG_DEPTH in the environment overrides the value of
2260 LOG_DEPTH at run time.
2261 .ecindex IIDbuex
2262
2263
2264 .section "Installing Exim binaries and scripts" "SECID32"
2265 .cindex "installing Exim"
2266 .cindex "BIN_DIRECTORY"
2267 The command &`make install`& runs the &(exim_install)& script with no
2268 arguments. The script copies binaries and utility scripts into the directory
2269 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2270 .cindex "setuid" "installing Exim with"
2271 The install script copies files only if they are newer than the files they are
2272 going to replace. The Exim binary is required to be owned by root and have the
2273 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2274 install`& as root so that it can set up the Exim binary in this way. However, in
2275 some special situations (for example, if a host is doing no local deliveries)
2276 it may be possible to run Exim without making the binary setuid root (see
2277 chapter &<<CHAPsecurity>>& for details).
2278
2279 .cindex "CONFIGURE_FILE"
2280 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2281 in &_Local/Makefile_&. If this names a single file, and the file does not
2282 exist, the default configuration file &_src/configure.default_& is copied there
2283 by the installation script. If a run time configuration file already exists, it
2284 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2285 alternative files, no default is installed.
2286
2287 .cindex "system aliases file"
2288 .cindex "&_/etc/aliases_&"
2289 One change is made to the default configuration file when it is installed: the
2290 default configuration contains a router that references a system aliases file.
2291 The path to this file is set to the value specified by
2292 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2293 If the system aliases file does not exist, the installation script creates it,
2294 and outputs a comment to the user.
2295
2296 The created file contains no aliases, but it does contain comments about the
2297 aliases a site should normally have. Mail aliases have traditionally been
2298 kept in &_/etc/aliases_&. However, some operating systems are now using
2299 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2300 Exim's configuration if necessary.
2301
2302 The default configuration uses the local host's name as the only local domain,
2303 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2304 running as the local user. System aliases and &_.forward_& files in users' home
2305 directories are supported, but no NIS or NIS+ support is configured. Domains
2306 other than the name of the local host are routed using the DNS, with delivery
2307 over SMTP.
2308
2309 It is possible to install Exim for special purposes (such as building a binary
2310 distribution) in a private part of the file system. You can do this by a
2311 command such as
2312 .code
2313 make DESTDIR=/some/directory/ install
2314 .endd
2315 This has the effect of pre-pending the specified directory to all the file
2316 paths, except the name of the system aliases file that appears in the default
2317 configuration. (If a default alias file is created, its name &'is'& modified.)
2318 For backwards compatibility, ROOT is used if DESTDIR is not set,
2319 but this usage is deprecated.
2320
2321 .cindex "installing Exim" "what is not installed"
2322 Running &'make install'& does not copy the Exim 4 conversion script
2323 &'convert4r4'&. You will probably run this only once if you are
2324 upgrading from Exim 3. None of the documentation files in the &_doc_&
2325 directory are copied, except for the info files when you have set
2326 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2327
2328 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2329 to their names. The Exim binary itself, however, is handled differently. It is
2330 installed under a name that includes the version number and the compile number,
2331 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2332 called &_exim_& to point to the binary. If you are updating a previous version
2333 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2334 from the directory (as seen by other processes).
2335
2336 .cindex "installing Exim" "testing the script"
2337 If you want to see what the &'make install'& will do before running it for
2338 real, you can pass the &%-n%& option to the installation script by this
2339 command:
2340 .code
2341 make INSTALL_ARG=-n install
2342 .endd
2343 The contents of the variable INSTALL_ARG are passed to the installation
2344 script. You do not need to be root to run this test. Alternatively, you can run
2345 the installation script directly, but this must be from within the build
2346 directory. For example, from the top-level Exim directory you could use this
2347 command:
2348 .code
2349 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2350 .endd
2351 .cindex "installing Exim" "install script options"
2352 There are two other options that can be supplied to the installation script.
2353
2354 .ilist
2355 &%-no_chown%& bypasses the call to change the owner of the installed binary
2356 to root, and the call to make it a setuid binary.
2357 .next
2358 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2359 installed binary.
2360 .endlist
2361
2362 INSTALL_ARG can be used to pass these options to the script. For example:
2363 .code
2364 make INSTALL_ARG=-no_symlink install
2365 .endd
2366 The installation script can also be given arguments specifying which files are
2367 to be copied. For example, to install just the Exim binary, and nothing else,
2368 without creating the symbolic link, you could use:
2369 .code
2370 make INSTALL_ARG='-no_symlink exim' install
2371 .endd
2372
2373
2374
2375 .section "Installing info documentation" "SECTinsinfdoc"
2376 .cindex "installing Exim" "&'info'& documentation"
2377 Not all systems use the GNU &'info'& system for documentation, and for this
2378 reason, the Texinfo source of Exim's documentation is not included in the main
2379 distribution. Instead it is available separately from the ftp site (see section
2380 &<<SECTavail>>&).
2381
2382 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2383 source of the documentation is found in the source tree, running &`make
2384 install`& automatically builds the info files and installs them.
2385
2386
2387
2388 .section "Setting up the spool directory" "SECID33"
2389 .cindex "spool directory" "creating"
2390 When it starts up, Exim tries to create its spool directory if it does not
2391 exist. The Exim uid and gid are used for the owner and group of the spool
2392 directory. Sub-directories are automatically created in the spool directory as
2393 necessary.
2394
2395
2396
2397
2398 .section "Testing" "SECID34"
2399 .cindex "testing" "installation"
2400 Having installed Exim, you can check that the run time configuration file is
2401 syntactically valid by running the following command, which assumes that the
2402 Exim binary directory is within your PATH environment variable:
2403 .code
2404 exim -bV
2405 .endd
2406 If there are any errors in the configuration file, Exim outputs error messages.
2407 Otherwise it outputs the version number and build date,
2408 the DBM library that is being used, and information about which drivers and
2409 other optional code modules are included in the binary.
2410 Some simple routing tests can be done by using the address testing option. For
2411 example,
2412 .display
2413 &`exim -bt`& <&'local username'&>
2414 .endd
2415 should verify that it recognizes a local mailbox, and
2416 .display
2417 &`exim -bt`& <&'remote address'&>
2418 .endd
2419 a remote one. Then try getting it to deliver mail, both locally and remotely.
2420 This can be done by passing messages directly to Exim, without going through a
2421 user agent. For example:
2422 .code
2423 exim -v postmaster@your.domain.example
2424 From: user@your.domain.example
2425 To: postmaster@your.domain.example
2426 Subject: Testing Exim
2427
2428 This is a test message.
2429 ^D
2430 .endd
2431 The &%-v%& option causes Exim to output some verification of what it is doing.
2432 In this case you should see copies of three log lines, one for the message's
2433 arrival, one for its delivery, and one containing &"Completed"&.
2434
2435 .cindex "delivery" "problems with"
2436 If you encounter problems, look at Exim's log files (&'mainlog'& and
2437 &'paniclog'&) to see if there is any relevant information there. Another source
2438 of information is running Exim with debugging turned on, by specifying the
2439 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2440 with debugging turned on by a command of the form
2441 .display
2442 &`exim -d -M`& <&'exim-message-id'&>
2443 .endd
2444 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2445 produces rather a lot of output, but you can cut this down to specific areas.
2446 For example, if you use &%-d-all+route%& only the debugging information
2447 relevant to routing is included. (See the &%-d%& option in chapter
2448 &<<CHAPcommandline>>& for more details.)
2449
2450 .cindex '&"sticky"& bit'
2451 .cindex "lock files"
2452 One specific problem that has shown up on some sites is the inability to do
2453 local deliveries into a shared mailbox directory, because it does not have the
2454 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2455 writing to a mailbox file, and if it cannot create the lock file, the delivery
2456 is deferred. You can get round this either by setting the &"sticky bit"& on the
2457 directory, or by setting a specific group for local deliveries and allowing
2458 that group to create files in the directory (see the comments above the
2459 &(local_delivery)& transport in the default configuration file). Another
2460 approach is to configure Exim not to use lock files, but just to rely on
2461 &[fcntl()]& locking instead. However, you should do this only if all user
2462 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2463 see chapter &<<CHAPappendfile>>&.
2464
2465 One thing that cannot be tested on a system that is already running an MTA is
2466 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2467 &%-oX%& option can be used to run an Exim daemon that listens on some other
2468 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2469 &'exim_checkaccess'& utility can be used to check out policy controls on
2470 incoming SMTP mail.
2471
2472 Testing a new version on a system that is already running Exim can most easily
2473 be done by building a binary with a different CONFIGURE_FILE setting. From
2474 within the run time configuration, all other file and directory names
2475 that Exim uses can be altered, in order to keep it entirely clear of the
2476 production version.
2477
2478
2479 .section "Replacing another MTA with Exim" "SECID35"
2480 .cindex "replacing another MTA"
2481 Building and installing Exim for the first time does not of itself put it in
2482 general use. The name by which the system's MTA is called by mail user agents
2483 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2484 operating system), and it is necessary to make this name point to the &'exim'&
2485 binary in order to get the user agents to pass messages to Exim. This is
2486 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2487 or &_/usr/lib/sendmail_&
2488 .cindex "symbolic link" "to &'exim'& binary"
2489 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2490 privilege and executable status from the old MTA. It is then necessary to stop
2491 and restart the mailer daemon, if one is running.
2492
2493 .cindex "FreeBSD, MTA indirection"
2494 .cindex "&_/etc/mail/mailer.conf_&"
2495 Some operating systems have introduced alternative ways of switching MTAs. For
2496 example, if you are running FreeBSD, you need to edit the file
2497 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2498 described. A typical example of the contents of this file for running Exim is
2499 as follows:
2500 .code
2501 sendmail            /usr/exim/bin/exim
2502 send-mail           /usr/exim/bin/exim
2503 mailq               /usr/exim/bin/exim -bp
2504 newaliases          /usr/bin/true
2505 .endd
2506 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2507 your Exim installation is &"live"&. Check it by sending a message from your
2508 favourite user agent.
2509
2510 You should consider what to tell your users about the change of MTA. Exim may
2511 have different capabilities to what was previously running, and there are
2512 various operational differences such as the text of messages produced by
2513 command line options and in bounce messages. If you allow your users to make
2514 use of Exim's filtering capabilities, you should make the document entitled
2515 &'Exim's interface to mail filtering'& available to them.
2516
2517
2518
2519 .section "Upgrading Exim" "SECID36"
2520 .cindex "upgrading Exim"
2521 If you are already running Exim on your host, building and installing a new
2522 version automatically makes it available to MUAs, or any other programs that
2523 call the MTA directly. However, if you are running an Exim daemon, you do need
2524 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2525 new binary. You do not need to stop processing mail in order to install a new
2526 version of Exim. The install script does not modify an existing runtime
2527 configuration file.
2528
2529
2530
2531
2532 .section "Stopping the Exim daemon on Solaris" "SECID37"
2533 .cindex "Solaris" "stopping Exim on"
2534 The standard command for stopping the mailer daemon on Solaris is
2535 .code
2536 /etc/init.d/sendmail stop
2537 .endd
2538 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2539 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2540 for the text &"sendmail"&; this is not present because the actual program name
2541 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2542 solution is to replace the line that finds the process id with something like
2543 .code
2544 pid=`cat /var/spool/exim/exim-daemon.pid`
2545 .endd
2546 to obtain the daemon's pid directly from the file that Exim saves it in.
2547
2548 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2549 still be received from local processes, and if automatic delivery is configured
2550 (the normal case), deliveries will still occur.
2551
2552
2553
2554
2555 . ////////////////////////////////////////////////////////////////////////////
2556 . ////////////////////////////////////////////////////////////////////////////
2557
2558 .chapter "The Exim command line" "CHAPcommandline"
2559 .scindex IIDclo1 "command line" "options"
2560 .scindex IIDclo2 "options" "command line"
2561 Exim's command line takes the standard Unix form of a sequence of options,
2562 each starting with a hyphen character, followed by a number of arguments. The
2563 options are compatible with the main options of Sendmail, and there are also
2564 some additional options, some of which are compatible with Smail 3. Certain
2565 combinations of options do not make sense, and provoke an error if used.
2566 The form of the arguments depends on which options are set.
2567
2568
2569 .section "Setting options by program name" "SECID38"
2570 .cindex "&'mailq'&"
2571 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2572 were present before any other options.
2573 The &%-bp%& option requests a listing of the contents of the mail queue on the
2574 standard output.
2575 This feature is for compatibility with some systems that contain a command of
2576 that name in one of the standard libraries, symbolically linked to
2577 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2578
2579 .cindex "&'rsmtp'&"
2580 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2581 were present before any other options, for compatibility with Smail. The
2582 &%-bS%& option is used for reading in a number of messages in batched SMTP
2583 format.
2584
2585 .cindex "&'rmail'&"
2586 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2587 &%-oee%& options were present before any other options, for compatibility with
2588 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2589
2590 .cindex "&'runq'&"
2591 .cindex "queue runner"
2592 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2593 were present before any other options, for compatibility with Smail. The &%-q%&
2594 option causes a single queue runner process to be started.
2595
2596 .cindex "&'newaliases'&"
2597 .cindex "alias file" "building"
2598 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2599 If Exim is called under the name &'newaliases'& it behaves as if the option
2600 &%-bi%& were present before any other options, for compatibility with Sendmail.
2601 This option is used for rebuilding Sendmail's alias file. Exim does not have
2602 the concept of a single alias file, but can be configured to run a given
2603 command if called with the &%-bi%& option.
2604
2605
2606 .section "Trusted and admin users" "SECTtrustedadmin"
2607 Some Exim options are available only to &'trusted users'& and others are
2608 available only to &'admin users'&. In the description below, the phrases &"Exim
2609 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2610 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2611 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2612
2613 .ilist
2614 .cindex "trusted users" "definition of"
2615 .cindex "user" "trusted definition of"
2616 The trusted users are root, the Exim user, any user listed in the
2617 &%trusted_users%& configuration option, and any user whose current group or any
2618 supplementary group is one of those listed in the &%trusted_groups%&
2619 configuration option. Note that the Exim group is not automatically trusted.
2620
2621 .cindex '&"From"& line'
2622 .cindex "envelope sender"
2623 Trusted users are always permitted to use the &%-f%& option or a leading
2624 &"From&~"& line to specify the envelope sender of a message that is passed to
2625 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2626 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2627 users to set envelope senders.
2628
2629 .cindex "&'From:'& header line"
2630 .cindex "&'Sender:'& header line"
2631 .cindex "header lines" "From:"
2632 .cindex "header lines" "Sender:"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$message_exim_id$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file or directory
3056 (depending on the used scanner interface),
3057 using the malware scanning framework.  The option of &%av_scanner%& influences
3058 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3059 the expansion should have defaults which apply to this invocation.  ACLs are
3060 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3061 will never be populated and &%-bmalware%& will fail.
3062
3063 Exim will have changed working directory before resolving the filename, so
3064 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3065 user when it tries to open the file, rather than as the invoking user.
3066 This option requires admin privileges.
3067
3068 The &%-bmalware%& option will not be extended to be more generally useful,
3069 there are better tools for file-scanning.  This option exists to help
3070 administrators verify their Exim and AV scanner configuration.
3071
3072 .vitem &%-bnq%&
3073 .oindex "&%-bnq%&"
3074 .cindex "address qualification, suppressing"
3075 By default, Exim automatically qualifies unqualified addresses (those
3076 without domains) that appear in messages that are submitted locally (that
3077 is, not over TCP/IP). This qualification applies both to addresses in
3078 envelopes, and addresses in header lines. Sender addresses are qualified using
3079 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3080 defaults to the value of &%qualify_domain%&).
3081
3082 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3083 being used to re-submit messages that originally came from remote hosts after
3084 content scanning, you probably do not want to qualify unqualified addresses in
3085 header lines. (Such lines will be present only if you have not enabled a header
3086 syntax check in the appropriate ACL.)
3087
3088 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3089 messages that originate on the local host. When this is used, unqualified
3090 addresses in the envelope provoke errors (causing message rejection) and
3091 unqualified addresses in header lines are left alone.
3092
3093
3094 .vitem &%-bP%&
3095 .oindex "&%-bP%&"
3096 .cindex "configuration options" "extracting"
3097 .cindex "options" "configuration &-- extracting"
3098 If this option is given with no arguments, it causes the values of all Exim's
3099 main configuration options to be written to the standard output. The values
3100 of one or more specific options can be requested by giving their names as
3101 arguments, for example:
3102 .code
3103 exim -bP qualify_domain hold_domains
3104 .endd
3105 .cindex "hiding configuration option values"
3106 .cindex "configuration options" "hiding value of"
3107 .cindex "options" "hiding value of"
3108 However, any option setting that is preceded by the word &"hide"& in the
3109 configuration file is not shown in full, except to an admin user. For other
3110 users, the output is as in this example:
3111 .code
3112 mysql_servers = <value not displayable>
3113 .endd
3114 If &%config%& is given as an argument, the config is
3115 output, as it was parsed, any include file resolved, any comment removed.
3116
3117 If &%config_file%& is given as an argument, the name of the run time
3118 configuration file is output. (&%configure_file%& works too, for
3119 backward compatibility.)
3120 If a list of configuration files was supplied, the value that is output here
3121 is the name of the file that was actually used.
3122
3123 .cindex "options" "hiding name of"
3124 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3125 name will not be output.
3126
3127 .cindex "daemon" "process id (pid)"
3128 .cindex "pid (process id)" "of daemon"
3129 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3130 directories where log files and daemon pid files are written are output,
3131 respectively. If these values are unset, log files are written in a
3132 sub-directory of the spool directory called &%log%&, and the pid file is
3133 written directly into the spool directory.
3134
3135 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3136 .code
3137 exim -bP +local_domains
3138 .endd
3139 it searches for a matching named list of any type (domain, host, address, or
3140 local part) and outputs what it finds.
3141
3142 .cindex "options" "router &-- extracting"
3143 .cindex "options" "transport &-- extracting"
3144 .cindex "options" "authenticator &-- extracting"
3145 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3146 followed by the name of an appropriate driver instance, the option settings for
3147 that driver are output. For example:
3148 .code
3149 exim -bP transport local_delivery
3150 .endd
3151 The generic driver options are output first, followed by the driver's private
3152 options. A list of the names of drivers of a particular type can be obtained by
3153 using one of the words &%router_list%&, &%transport_list%&, or
3154 &%authenticator_list%&, and a complete list of all drivers with their option
3155 settings can be obtained by using &%routers%&, &%transports%&, or
3156 &%authenticators%&.
3157
3158 .cindex "environment"
3159 If &%environment%& is given as an argument, the set of environment
3160 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3161 variables.
3162
3163 .cindex "options" "macro &-- extracting"
3164 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3165 are available, similarly to the drivers.  Because macros are sometimes used
3166 for storing passwords, this option is restricted.
3167 The output format is one item per line.
3168
3169 .vitem &%-bp%&
3170 .oindex "&%-bp%&"
3171 .cindex "queue" "listing messages on"
3172 .cindex "listing" "messages on the queue"
3173 This option requests a listing of the contents of the mail queue on the
3174 standard output. If the &%-bp%& option is followed by a list of message ids,
3175 just those messages are listed. By default, this option can be used only by an
3176 admin user. However, the &%queue_list_requires_admin%& option can be set false
3177 to allow any user to see the queue.
3178
3179 Each message on the queue is displayed as in the following example:
3180 .code
3181 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3182           red.king@looking-glass.fict.example
3183           <other addresses>
3184 .endd
3185 .cindex "message" "size in queue listing"
3186 .cindex "size" "of message"
3187 The first line contains the length of time the message has been on the queue
3188 (in this case 25 minutes), the size of the message (2.9K), the unique local
3189 identifier for the message, and the message sender, as contained in the
3190 envelope. For bounce messages, the sender address is empty, and appears as
3191 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3192 the default sender address, the user's login name is shown in parentheses
3193 before the sender address.
3194
3195 .cindex "frozen messages" "in queue listing"
3196 If the message is frozen (attempts to deliver it are suspended) then the text
3197 &"*** frozen ***"& is displayed at the end of this line.
3198
3199 The recipients of the message (taken from the envelope, not the headers) are
3200 displayed on subsequent lines. Those addresses to which the message has already
3201 been delivered are marked with the letter D. If an original address gets
3202 expanded into several addresses via an alias or forward file, the original is
3203 displayed with a D only when deliveries for all of its child addresses are
3204 complete.
3205
3206
3207 .vitem &%-bpa%&
3208 .oindex "&%-bpa%&"
3209 This option operates like &%-bp%&, but in addition it shows delivered addresses
3210 that were generated from the original top level address(es) in each message by
3211 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3212 of just &"D"&.
3213
3214
3215 .vitem &%-bpc%&
3216 .oindex "&%-bpc%&"
3217 .cindex "queue" "count of messages on"
3218 This option counts the number of messages on the queue, and writes the total
3219 to the standard output. It is restricted to admin users, unless
3220 &%queue_list_requires_admin%& is set false.
3221
3222
3223 .vitem &%-bpr%&
3224 .oindex "&%-bpr%&"
3225 This option operates like &%-bp%&, but the output is not sorted into
3226 chronological order of message arrival. This can speed it up when there are
3227 lots of messages on the queue, and is particularly useful if the output is
3228 going to be post-processed in a way that doesn't need the sorting.
3229
3230 .vitem &%-bpra%&
3231 .oindex "&%-bpra%&"
3232 This option is a combination of &%-bpr%& and &%-bpa%&.
3233
3234 .vitem &%-bpru%&
3235 .oindex "&%-bpru%&"
3236 This option is a combination of &%-bpr%& and &%-bpu%&.
3237
3238
3239 .vitem &%-bpu%&
3240 .oindex "&%-bpu%&"
3241 This option operates like &%-bp%& but shows only undelivered top-level
3242 addresses for each message displayed. Addresses generated by aliasing or
3243 forwarding are not shown, unless the message was deferred after processing by a
3244 router with the &%one_time%& option set.
3245
3246
3247 .vitem &%-brt%&
3248 .oindex "&%-brt%&"
3249 .cindex "testing" "retry configuration"
3250 .cindex "retry" "configuration testing"
3251 This option is for testing retry rules, and it must be followed by up to three
3252 arguments. It causes Exim to look for a retry rule that matches the values
3253 and to write it to the standard output. For example:
3254 .code
3255 exim -brt bach.comp.mus.example
3256 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3257 .endd
3258 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3259 argument, which is required, can be a complete address in the form
3260 &'local_part@domain'&, or it can be just a domain name. If the second argument
3261 contains a dot, it is interpreted as an optional second domain name; if no
3262 retry rule is found for the first argument, the second is tried. This ties in
3263 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3264 rule is found that matches the host, one that matches the mail domain is
3265 sought. Finally, an argument that is the name of a specific delivery error, as
3266 used in setting up retry rules, can be given. For example:
3267 .code
3268 exim -brt haydn.comp.mus.example quota_3d
3269 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3270 .endd
3271
3272 .vitem &%-brw%&
3273 .oindex "&%-brw%&"
3274 .cindex "testing" "rewriting"
3275 .cindex "rewriting" "testing"
3276 This option is for testing address rewriting rules, and it must be followed by
3277 a single argument, consisting of either a local part without a domain, or a
3278 complete address with a fully qualified domain. Exim outputs how this address
3279 would be rewritten for each possible place it might appear. See chapter
3280 &<<CHAPrewrite>>& for further details.
3281
3282 .vitem &%-bS%&
3283 .oindex "&%-bS%&"
3284 .cindex "SMTP" "batched incoming"
3285 .cindex "batched SMTP input"
3286 This option is used for batched SMTP input, which is an alternative interface
3287 for non-interactive local message submission. A number of messages can be
3288 submitted in a single run. However, despite its name, this is not really SMTP
3289 input. Exim reads each message's envelope from SMTP commands on the standard
3290 input, but generates no responses. If the caller is trusted, or
3291 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3292 believed; otherwise the sender is always the caller of Exim.
3293
3294 The message itself is read from the standard input, in SMTP format (leading
3295 dots doubled), terminated by a line containing just a single dot. An error is
3296 provoked if the terminating dot is missing. A further message may then follow.
3297
3298 As for other local message submissions, the contents of incoming batch SMTP
3299 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3300 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3301 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3302
3303 Some other SMTP commands are recognized in the input. HELO and EHLO act
3304 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3305 QUIT quits, ignoring the rest of the standard input.
3306
3307 .cindex "return code" "for &%-bS%&"
3308 If any error is encountered, reports are written to the standard output and
3309 error streams, and Exim gives up immediately. The return code is 0 if no error
3310 was detected; it is 1 if one or more messages were accepted before the error
3311 was detected; otherwise it is 2.
3312
3313 More details of input using batched SMTP are given in section
3314 &<<SECTincomingbatchedSMTP>>&.
3315
3316 .vitem &%-bs%&
3317 .oindex "&%-bs%&"
3318 .cindex "SMTP" "local input"
3319 .cindex "local SMTP input"
3320 This option causes Exim to accept one or more messages by reading SMTP commands
3321 on the standard input, and producing SMTP replies on the standard output. SMTP
3322 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3323 Some user agents use this interface as a way of passing locally-generated
3324 messages to the MTA.
3325
3326 In
3327 .cindex "sender" "source of"
3328 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3329 set, the senders of messages are taken from the SMTP MAIL commands.
3330 Otherwise the content of these commands is ignored and the sender is set up as
3331 the calling user. Unqualified addresses are automatically qualified using
3332 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3333 &%-bnq%& option is used.
3334
3335 .cindex "inetd"
3336 The
3337 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3338 using a listening daemon. Exim can distinguish the two cases by checking
3339 whether the standard input is a TCP/IP socket. When Exim is called from
3340 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3341 above concerning senders and qualification do not apply. In this situation,
3342 Exim behaves in exactly the same way as it does when receiving a message via
3343 the listening daemon.
3344
3345 .vitem &%-bt%&
3346 .oindex "&%-bt%&"
3347 .cindex "testing" "addresses"
3348 .cindex "address" "testing"
3349 This option runs Exim in address testing mode, in which each argument is taken
3350 as a recipient address to be tested for deliverability. The results are
3351 written to the standard output. If a test fails, and the caller is not an admin
3352 user, no details of the failure are output, because these might contain
3353 sensitive information such as usernames and passwords for database lookups.
3354
3355 If no arguments are given, Exim runs in an interactive manner, prompting with a
3356 right angle bracket for addresses to be tested.
3357
3358 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3359 &[readline()]& function, because it is running as &'root'& and there are
3360 security issues.
3361
3362 Each address is handled as if it were the recipient address of a message
3363 (compare the &%-bv%& option). It is passed to the routers and the result is
3364 written to the standard output. However, any router that has
3365 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3366 genuine routing tests if your first router passes everything to a scanner
3367 program.
3368
3369 .cindex "return code" "for &%-bt%&"
3370 The return code is 2 if any address failed outright; it is 1 if no address
3371 failed outright but at least one could not be resolved for some reason. Return
3372 code 0 is given only when all addresses succeed.
3373
3374 .cindex "duplicate addresses"
3375 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3376 addresses after routing is complete, so that only one delivery takes place.
3377 This does not happen when testing with &%-bt%&; the full results of routing are
3378 always shown.
3379
3380 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3381 routers in the configuration makes any tests on the sender address of a
3382 message,
3383 .oindex "&%-f%&" "for address testing"
3384 you can use the &%-f%& option to set an appropriate sender when running
3385 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3386 default qualifying domain. However, if you have set up (for example) routers
3387 whose behaviour depends on the contents of an incoming message, you cannot test
3388 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3389 doing such tests.
3390
3391 .vitem &%-bV%&
3392 .oindex "&%-bV%&"
3393 .cindex "version number of Exim"
3394 This option causes Exim to write the current version number, compilation
3395 number, and compilation date of the &'exim'& binary to the standard output.
3396 It also lists the DBM library that is being used, the optional modules (such as
3397 specific lookup types), the drivers that are included in the binary, and the
3398 name of the run time configuration file that is in use.
3399
3400 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3401 configuration file. However, this is a static check only. It cannot check
3402 values that are to be expanded. For example, although a misspelt ACL verb is
3403 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3404 alone to discover (for example) all the typos in the configuration; some
3405 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3406 dynamic testing facilities.
3407
3408 .vitem &%-bv%&
3409 .oindex "&%-bv%&"
3410 .cindex "verifying address" "using &%-bv%&"
3411 .cindex "address" "verification"
3412 This option runs Exim in address verification mode, in which each argument is
3413 taken as a recipient address to be verified by the routers. (This does
3414 not involve any verification callouts). During normal operation, verification
3415 happens mostly as a consequence processing a &%verify%& condition in an ACL
3416 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3417 including callouts, see the &%-bh%& and &%-bhc%& options.
3418
3419 If verification fails, and the caller is not an admin user, no details of the
3420 failure are output, because these might contain sensitive information such as
3421 usernames and passwords for database lookups.
3422
3423 If no arguments are given, Exim runs in an interactive manner, prompting with a
3424 right angle bracket for addresses to be verified.
3425
3426 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3427 &[readline()]& function, because it is running as &'exim'& and there are
3428 security issues.
3429
3430 Verification differs from address testing (the &%-bt%& option) in that routers
3431 that have &%no_verify%& set are skipped, and if the address is accepted by a
3432 router that has &%fail_verify%& set, verification fails. The address is
3433 verified as a recipient if &%-bv%& is used; to test verification for a sender
3434 address, &%-bvs%& should be used.
3435
3436 If the &%-v%& option is not set, the output consists of a single line for each
3437 address, stating whether it was verified or not, and giving a reason in the
3438 latter case. Without &%-v%&, generating more than one address by redirection
3439 causes verification to end successfully, without considering the generated
3440 addresses. However, if just one address is generated, processing continues,
3441 and the generated address must verify successfully for the overall verification
3442 to succeed.
3443
3444 When &%-v%& is set, more details are given of how the address has been handled,
3445 and in the case of address redirection, all the generated addresses are also
3446 considered. Verification may succeed for some and fail for others.
3447
3448 The
3449 .cindex "return code" "for &%-bv%&"
3450 return code is 2 if any address failed outright; it is 1 if no address
3451 failed outright but at least one could not be resolved for some reason. Return
3452 code 0 is given only when all addresses succeed.
3453
3454 If any of the routers in the configuration makes any tests on the sender
3455 address of a message, you should use the &%-f%& option to set an appropriate
3456 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3457 calling user at the default qualifying domain.
3458
3459 .vitem &%-bvs%&
3460 .oindex "&%-bvs%&"
3461 This option acts like &%-bv%&, but verifies the address as a sender rather
3462 than a recipient address. This affects any rewriting and qualification that
3463 might happen.
3464
3465 .vitem &%-bw%&
3466 .oindex "&%-bw%&"
3467 .cindex "daemon"
3468 .cindex "inetd"
3469 .cindex "inetd" "wait mode"
3470 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3471 similarly to the &%-bd%& option.  All port specifications on the command-line
3472 and in the configuration file are ignored.  Queue-running may not be specified.
3473
3474 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3475 listening for connections.  This permits the system to start up and have
3476 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3477 each port only when the first connection is received.
3478
3479 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3480 which the daemon will exit, which should cause inetd to listen once more.
3481
3482 .vitem &%-C%&&~<&'filelist'&>
3483 .oindex "&%-C%&"
3484 .cindex "configuration file" "alternate"
3485 .cindex "CONFIGURE_FILE"
3486 .cindex "alternate configuration file"
3487 This option causes Exim to find the run time configuration file from the given
3488 list instead of from the list specified by the CONFIGURE_FILE
3489 compile-time setting. Usually, the list will consist of just a single file
3490 name, but it can be a colon-separated list of names. In this case, the first
3491 file that exists is used. Failure to open an existing file stops Exim from
3492 proceeding any further along the list, and an error is generated.
3493
3494 When this option is used by a caller other than root, and the list is different
3495 from the compiled-in list, Exim gives up its root privilege immediately, and
3496 runs with the real and effective uid and gid set to those of the caller.
3497 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3498 file contains a list of full pathnames, one per line, for configuration files
3499 which are trusted. Root privilege is retained for any configuration file so
3500 listed, as long as the caller is the Exim user (or the user specified in the
3501 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3502 not writeable by inappropriate users or groups.
3503
3504 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3505 configuration using &%-C%& right through message reception and delivery,
3506 even if the caller is root. The reception works, but by that time, Exim is
3507 running as the Exim user, so when it re-executes to regain privilege for the
3508 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3509 test reception and delivery using two separate commands (one to put a message
3510 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3511
3512 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3513 prefix string with which any file named in a &%-C%& command line option
3514 must start. In addition, the file name must not contain the sequence &`/../`&.
3515 However, if the value of the &%-C%& option is identical to the value of
3516 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3517 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3518 unset, any file name can be used with &%-C%&.
3519
3520 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3521 to a directory to which only root has access. This prevents someone who has
3522 broken into the Exim account from running a privileged Exim with an arbitrary
3523 configuration file.
3524
3525 The &%-C%& facility is useful for ensuring that configuration files are
3526 syntactically correct, but cannot be used for test deliveries, unless the
3527 caller is privileged, or unless it is an exotic configuration that does not
3528 require privilege. No check is made on the owner or group of the files
3529 specified by this option.
3530
3531
3532 .vitem &%-D%&<&'macro'&>=<&'value'&>
3533 .oindex "&%-D%&"
3534 .cindex "macro" "setting on command line"
3535 This option can be used to override macro definitions in the configuration file
3536 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3537 unprivileged caller, it causes Exim to give up its root privilege.
3538 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3539 completely disabled, and its use causes an immediate error exit.
3540
3541 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3542 colon-separated list of macros which are considered safe and, if &%-D%& only
3543 supplies macros from this list, and the values are acceptable, then Exim will
3544 not give up root privilege if the caller is root, the Exim run-time user, or
3545 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3546 to be removed in the future.  Acceptable values for the macros satisfy the
3547 regexp: &`^[A-Za-z0-9_/.-]*$`&
3548
3549 The entire option (including equals sign if present) must all be within one
3550 command line item. &%-D%& can be used to set the value of a macro to the empty
3551 string, in which case the equals sign is optional. These two commands are
3552 synonymous:
3553 .code
3554 exim -DABC  ...
3555 exim -DABC= ...
3556 .endd
3557 To include spaces in a macro definition item, quotes must be used. If you use
3558 quotes, spaces are permitted around the macro name and the equals sign. For
3559 example:
3560 .code
3561 exim '-D ABC = something' ...
3562 .endd
3563 &%-D%& may be repeated up to 10 times on a command line.
3564 Only macro names up to 22 letters long can be set.
3565
3566
3567 .vitem &%-d%&<&'debug&~options'&>
3568 .oindex "&%-d%&"
3569 .cindex "debugging" "list of selectors"
3570 .cindex "debugging" "&%-d%& option"
3571 This option causes debugging information to be written to the standard
3572 error stream. It is restricted to admin users because debugging output may show
3573 database queries that contain password information. Also, the details of users'
3574 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3575 writes an error message to the standard error stream and exits with a non-zero
3576 return code.
3577
3578 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3579 standard debugging data is output. This can be reduced, or increased to include
3580 some more rarely needed information, by directly following &%-d%& with a string
3581 made up of names preceded by plus or minus characters. These add or remove sets
3582 of debugging data, respectively. For example, &%-d+filter%& adds filter
3583 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3584 no spaces are allowed in the debug setting. The available debugging categories
3585 are:
3586 .display
3587 &`acl            `& ACL interpretation
3588 &`auth           `& authenticators
3589 &`deliver        `& general delivery logic
3590 &`dns            `& DNS lookups (see also resolver)
3591 &`dnsbl          `& DNS black list (aka RBL) code
3592 &`exec           `& arguments for &[execv()]& calls
3593 &`expand         `& detailed debugging for string expansions
3594 &`filter         `& filter handling
3595 &`hints_lookup   `& hints data lookups
3596 &`host_lookup    `& all types of name-to-IP address handling
3597 &`ident          `& ident lookup
3598 &`interface      `& lists of local interfaces
3599 &`lists          `& matching things in lists
3600 &`load           `& system load checks
3601 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3602                     &<<CHAPlocalscan>>&)
3603 &`lookup         `& general lookup code and all lookups
3604 &`memory         `& memory handling
3605 &`pid            `& add pid to debug output lines
3606 &`process_info   `& setting info for the process log
3607 &`queue_run      `& queue runs
3608 &`receive        `& general message reception logic
3609 &`resolver       `& turn on the DNS resolver's debugging output
3610 &`retry          `& retry handling
3611 &`rewrite        `& address rewriting
3612 &`route          `& address routing
3613 &`timestamp      `& add timestamp to debug output lines
3614 &`tls            `& TLS logic
3615 &`transport      `& transports
3616 &`uid            `& changes of uid/gid and looking up uid/gid
3617 &`verify         `& address verification logic
3618 &`all            `& almost all of the above (see below), and also &%-v%&
3619 .endd
3620 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3621 for &`-all`&. The reason for this is that &`+all`& is something that people
3622 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3623 is included, an awful lot of output that is very rarely of interest is
3624 generated, so it now has to be explicitly requested. However, &`-all`& does
3625 turn everything off.
3626
3627 .cindex "resolver, debugging output"
3628 .cindex "DNS resolver, debugging output"
3629 The &`resolver`& option produces output only if the DNS resolver was compiled
3630 with DEBUG enabled. This is not the case in some operating systems. Also,
3631 unfortunately, debugging output from the DNS resolver is written to stdout
3632 rather than stderr.
3633
3634 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3635 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3636 However, the &`pid`& selector is forced when debugging is turned on for a
3637 daemon, which then passes it on to any re-executed Exims. Exim also
3638 automatically adds the pid to debug lines when several remote deliveries are
3639 run in parallel.
3640
3641 The &`timestamp`& selector causes the current time to be inserted at the start
3642 of all debug output lines. This can be useful when trying to track down delays
3643 in processing.
3644
3645 If the &%debug_print%& option is set in any driver, it produces output whenever
3646 any debugging is selected, or if &%-v%& is used.
3647
3648 .vitem &%-dd%&<&'debug&~options'&>
3649 .oindex "&%-dd%&"
3650 This option behaves exactly like &%-d%& except when used on a command that
3651 starts a daemon process. In that case, debugging is turned off for the
3652 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3653 behaviour of the daemon without creating as much output as full debugging does.
3654
3655 .vitem &%-dropcr%&
3656 .oindex "&%-dropcr%&"
3657 This is an obsolete option that is now a no-op. It used to affect the way Exim
3658 handled CR and LF characters in incoming messages. What happens now is
3659 described in section &<<SECTlineendings>>&.
3660
3661 .vitem &%-E%&
3662 .oindex "&%-E%&"
3663 .cindex "bounce message" "generating"
3664 This option specifies that an incoming message is a locally-generated delivery
3665 failure report. It is used internally by Exim when handling delivery failures
3666 and is not intended for external use. Its only effect is to stop Exim
3667 generating certain messages to the postmaster, as otherwise message cascades
3668 could occur in some situations. As part of the same option, a message id may
3669 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3670 new message contains the id, following &"R="&, as a cross-reference.
3671
3672 .vitem &%-e%&&'x'&
3673 .oindex "&%-e%&&'x'&"
3674 There are a number of Sendmail options starting with &%-oe%& which seem to be
3675 called by various programs without the leading &%o%& in the option. For
3676 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3677 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3678
3679 .vitem &%-F%&&~<&'string'&>
3680 .oindex "&%-F%&"
3681 .cindex "sender" "name"
3682 .cindex "name" "of sender"
3683 This option sets the sender's full name for use when a locally-generated
3684 message is being accepted. In the absence of this option, the user's &'gecos'&
3685 entry from the password data is used. As users are generally permitted to alter
3686 their &'gecos'& entries, no security considerations are involved. White space
3687 between &%-F%& and the <&'string'&> is optional.
3688
3689 .vitem &%-f%&&~<&'address'&>
3690 .oindex "&%-f%&"
3691 .cindex "sender" "address"
3692 .cindex "address" "sender"
3693 .cindex "trusted users"
3694 .cindex "envelope sender"
3695 .cindex "user" "trusted"
3696 This option sets the address of the envelope sender of a locally-generated
3697 message (also known as the return path). The option can normally be used only
3698 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3699 users to use it.
3700
3701 Processes running as root or the Exim user are always trusted. Other
3702 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3703 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3704 of a local message is set to the caller's login name at the default qualify
3705 domain.
3706
3707 There is one exception to the restriction on the use of &%-f%&: an empty sender
3708 can be specified by any user, trusted or not, to create a message that can
3709 never provoke a bounce. An empty sender can be specified either as an empty
3710 string, or as a pair of angle brackets with nothing between them, as in these
3711 examples of shell commands:
3712 .code
3713 exim -f '<>' user@domain
3714 exim -f "" user@domain
3715 .endd
3716 In addition, the use of &%-f%& is not restricted when testing a filter file
3717 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3718 &%-bv%& options.
3719
3720 Allowing untrusted users to change the sender address does not of itself make
3721 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3722 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3723 though this can be overridden by setting &%no_local_from_check%&.
3724
3725 White
3726 .cindex "&""From""& line"
3727 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3728 given as two arguments or one combined argument). The sender of a
3729 locally-generated message can also be set (when permitted) by an initial
3730 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3731 if &%-f%& is also present, it overrides &"From&~"&.
3732
3733 .vitem &%-G%&
3734 .oindex "&%-G%&"
3735 .cindex "submission fixups, suppressing (command-line)"
3736 This option is equivalent to an ACL applying:
3737 .code
3738 control = suppress_local_fixups
3739 .endd
3740 for every message received.  Note that Sendmail will complain about such
3741 bad formatting, where Exim silently just does not fix it up.  This may change
3742 in future.
3743
3744 As this affects audit information, the caller must be a trusted user to use
3745 this option.
3746
3747 .vitem &%-h%&&~<&'number'&>
3748 .oindex "&%-h%&"
3749 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3750 This option is accepted for compatibility with Sendmail, but has no effect. (In
3751 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3752 headers.)
3753
3754 .vitem &%-i%&
3755 .oindex "&%-i%&"
3756 .cindex "Solaris" "&'mail'& command"
3757 .cindex "dot" "in incoming non-SMTP message"
3758 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3759 line by itself should not terminate an incoming, non-SMTP message. I can find
3760 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3761 command in Solaris 2.4 uses it. See also &%-ti%&.
3762
3763 .vitem &%-L%&&~<&'tag'&>
3764 .oindex "&%-L%&"
3765 .cindex "syslog" "process name; set with flag"
3766 This option is equivalent to setting &%syslog_processname%& in the config
3767 file and setting &%log_file_path%& to &`syslog`&.
3768 Its use is restricted to administrators.  The configuration file has to be
3769 read and parsed, to determine access rights, before this is set and takes
3770 effect, so early configuration file errors will not honour this flag.
3771
3772 The tag should not be longer than 32 characters.
3773
3774 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3775 .oindex "&%-M%&"
3776 .cindex "forcing delivery"
3777 .cindex "delivery" "forcing attempt"
3778 .cindex "frozen messages" "forcing delivery"
3779 This option requests Exim to run a delivery attempt on each message in turn. If
3780 any of the messages are frozen, they are automatically thawed before the
3781 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3782 and &%hold_domains%& are ignored.
3783
3784 Retry
3785 .cindex "hints database" "overriding retry hints"
3786 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3787 the normal retry time has not yet been reached. This option requires the caller
3788 to be an admin user. However, there is an option called &%prod_requires_admin%&
3789 which can be set false to relax this restriction (and also the same requirement
3790 for the &%-q%&, &%-R%&, and &%-S%& options).
3791
3792 The deliveries happen synchronously, that is, the original Exim process does
3793 not terminate until all the delivery attempts have finished. No output is
3794 produced unless there is a serious error. If you want to see what is happening,
3795 use the &%-v%& option as well, or inspect Exim's main log.
3796
3797 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3798 .oindex "&%-Mar%&"
3799 .cindex "message" "adding recipients"
3800 .cindex "recipient" "adding"
3801 This option requests Exim to add the addresses to the list of recipients of the
3802 message (&"ar"& for &"add recipients"&). The first argument must be a message
3803 id, and the remaining ones must be email addresses. However, if the message is
3804 active (in the middle of a delivery attempt), it is not altered. This option
3805 can be used only by an admin user.
3806
3807 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3808         &~<&'message&~id'&>"
3809 .oindex "&%-MC%&"
3810 .cindex "SMTP" "passed connection"
3811 .cindex "SMTP" "multiple deliveries"
3812 .cindex "multiple SMTP deliveries"
3813 This option is not intended for use by external callers. It is used internally
3814 by Exim to invoke another instance of itself to deliver a waiting message using
3815 an existing SMTP connection, which is passed as the standard input. Details are
3816 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3817 must be root or the Exim user in order to use it.
3818
3819 .vitem &%-MCA%&
3820 .oindex "&%-MCA%&"
3821 This option is not intended for use by external callers. It is used internally
3822 by Exim in conjunction with the &%-MC%& option. It signifies that the
3823 connection to the remote host has been authenticated.
3824
3825 .vitem &%-MCD%&
3826 .oindex "&%-MCD%&"
3827 This option is not intended for use by external callers. It is used internally
3828 by Exim in conjunction with the &%-MC%& option. It signifies that the
3829 remote host supports the ESMTP &_DSN_& extension.
3830
3831 .new
3832 .vitem &%-MCG%&
3833 .oindex "&%-MCG%&"
3834 This option is not intended for use by external callers. It is used internally
3835 by Exim in conjunction with the &%-MC%& option. It signifies that an
3836 alternate queue is used, named by the following option.
3837 .wen
3838
3839 .vitem &%-MCP%&
3840 .oindex "&%-MCP%&"
3841 This option is not intended for use by external callers. It is used internally
3842 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3843 which Exim is connected supports pipelining.
3844
3845 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3846 .oindex "&%-MCQ%&"
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim in conjunction with the &%-MC%& option when the original delivery was
3849 started by a queue runner. It passes on the process id of the queue runner,
3850 together with the file descriptor number of an open pipe. Closure of the pipe
3851 signals the final completion of the sequence of processes that are passing
3852 messages through the same SMTP connection.
3853
3854 .vitem &%-MCS%&
3855 .oindex "&%-MCS%&"
3856 This option is not intended for use by external callers. It is used internally
3857 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3858 SMTP SIZE option should be used on messages delivered down the existing
3859 connection.
3860
3861 .vitem &%-MCT%&
3862 .oindex "&%-MCT%&"
3863 This option is not intended for use by external callers. It is used internally
3864 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3865 host to which Exim is connected supports TLS encryption.
3866
3867 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3868 .oindex "&%-Mc%&"
3869 .cindex "hints database" "not overridden by &%-Mc%&"
3870 .cindex "delivery" "manually started &-- not forced"
3871 This option requests Exim to run a delivery attempt on each message in turn,
3872 but unlike the &%-M%& option, it does check for retry hints, and respects any
3873 that are found. This option is not very useful to external callers. It is
3874 provided mainly for internal use by Exim when it needs to re-invoke itself in
3875 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3876 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3877 respects retry times and other options such as &%hold_domains%& that are
3878 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3879 If you want to run a specific delivery as if in a queue run, you should use
3880 &%-q%& with a message id argument. A distinction between queue run deliveries
3881 and other deliveries is made in one or two places.
3882
3883 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3884 .oindex "&%-Mes%&"
3885 .cindex "message" "changing sender"
3886 .cindex "sender" "changing"
3887 This option requests Exim to change the sender address in the message to the
3888 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3889 &"edit sender"&). There must be exactly two arguments. The first argument must
3890 be a message id, and the second one an email address. However, if the message
3891 is active (in the middle of a delivery attempt), its status is not altered.
3892 This option can be used only by an admin user.
3893
3894 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3895 .oindex "&%-Mf%&"
3896 .cindex "freezing messages"
3897 .cindex "message" "manually freezing"
3898 This option requests Exim to mark each listed message as &"frozen"&. This
3899 prevents any delivery attempts taking place until the message is &"thawed"&,
3900 either manually or as a result of the &%auto_thaw%& configuration option.
3901 However, if any of the messages are active (in the middle of a delivery
3902 attempt), their status is not altered. This option can be used only by an admin
3903 user.
3904
3905 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3906 .oindex "&%-Mg%&"
3907 .cindex "giving up on messages"
3908 .cindex "message" "abandoning delivery attempts"
3909 .cindex "delivery" "abandoning further attempts"
3910 This option requests Exim to give up trying to deliver the listed messages,
3911 including any that are frozen. However, if any of the messages are active,
3912 their status is not altered. For non-bounce messages, a delivery error message
3913 is sent to the sender, containing the text &"cancelled by administrator"&.
3914 Bounce messages are just discarded. This option can be used only by an admin
3915 user.
3916
3917 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3918 .oindex "&%-Mmad%&"
3919 .cindex "delivery" "cancelling all"
3920 This option requests Exim to mark all the recipient addresses in the messages
3921 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3922 message is active (in the middle of a delivery attempt), its status is not
3923 altered. This option can be used only by an admin user.
3924
3925 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3926 .oindex "&%-Mmd%&"
3927 .cindex "delivery" "cancelling by address"
3928 .cindex "recipient" "removing"
3929 .cindex "removing recipients"
3930 This option requests Exim to mark the given addresses as already delivered
3931 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3932 the remaining ones must be email addresses. These are matched to recipient
3933 addresses in the message in a case-sensitive manner. If the message is active
3934 (in the middle of a delivery attempt), its status is not altered. This option
3935 can be used only by an admin user.
3936
3937 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3938 .oindex "&%-Mrm%&"
3939 .cindex "removing messages"
3940 .cindex "abandoning mail"
3941 .cindex "message" "manually discarding"
3942 This option requests Exim to remove the given messages from the queue. No
3943 bounce messages are sent; each message is simply forgotten. However, if any of
3944 the messages are active, their status is not altered. This option can be used
3945 only by an admin user or by the user who originally caused the message to be
3946 placed on the queue.
3947
3948 .vitem &%-Mset%&&~<&'message&~id'&>
3949 .oindex "&%-Mset%&
3950 .cindex "testing" "string expansion"
3951 .cindex "expansion" "testing"
3952 This option is useful only in conjunction with &%-be%& (that is, when testing
3953 string expansions). Exim loads the given message from its spool before doing
3954 the test expansions, thus setting message-specific variables such as
3955 &$message_size$& and the header variables. The &$recipients$& variable is made
3956 available. This feature is provided to make it easier to test expansions that
3957 make use of these variables. However, this option can be used only by an admin
3958 user. See also &%-bem%&.
3959
3960 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3961 .oindex "&%-Mt%&"
3962 .cindex "thawing messages"
3963 .cindex "unfreezing messages"
3964 .cindex "frozen messages" "thawing"
3965 .cindex "message" "thawing frozen"
3966 This option requests Exim to &"thaw"& any of the listed messages that are
3967 &"frozen"&, so that delivery attempts can resume. However, if any of the
3968 messages are active, their status is not altered. This option can be used only
3969 by an admin user.
3970
3971 .vitem &%-Mvb%&&~<&'message&~id'&>
3972 .oindex "&%-Mvb%&"
3973 .cindex "listing" "message body"
3974 .cindex "message" "listing body of"
3975 This option causes the contents of the message body (-D) spool file to be
3976 written to the standard output. This option can be used only by an admin user.
3977
3978 .vitem &%-Mvc%&&~<&'message&~id'&>
3979 .oindex "&%-Mvc%&"
3980 .cindex "message" "listing in RFC 2822 format"
3981 .cindex "listing" "message in RFC 2822 format"
3982 This option causes a copy of the complete message (header lines plus body) to
3983 be written to the standard output in RFC 2822 format. This option can be used
3984 only by an admin user.
3985
3986 .vitem &%-Mvh%&&~<&'message&~id'&>
3987 .oindex "&%-Mvh%&"
3988 .cindex "listing" "message headers"
3989 .cindex "header lines" "listing"
3990 .cindex "message" "listing header lines"
3991 This option causes the contents of the message headers (-H) spool file to be
3992 written to the standard output. This option can be used only by an admin user.
3993
3994 .vitem &%-Mvl%&&~<&'message&~id'&>
3995 .oindex "&%-Mvl%&"
3996 .cindex "listing" "message log"
3997 .cindex "message" "listing message log"
3998 This option causes the contents of the message log spool file to be written to
3999 the standard output. This option can be used only by an admin user.
4000
4001 .vitem &%-m%&
4002 .oindex "&%-m%&"
4003 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4004 treats it that way too.
4005
4006 .vitem &%-N%&
4007 .oindex "&%-N%&"
4008 .cindex "debugging" "&%-N%& option"
4009 .cindex "debugging" "suppressing delivery"
4010 This is a debugging option that inhibits delivery of a message at the transport
4011 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4012 it just doesn't actually transport the message, but instead behaves as if it
4013 had successfully done so. However, it does not make any updates to the retry
4014 database, and the log entries for deliveries are flagged with &"*>"& rather
4015 than &"=>"&.
4016
4017 Because &%-N%& discards any message to which it applies, only root or the Exim
4018 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4019 words, an ordinary user can use it only when supplying an incoming message to
4020 which it will apply. Although transportation never fails when &%-N%& is set, an
4021 address may be deferred because of a configuration problem on a transport, or a
4022 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4023 the message, and applies to any subsequent delivery attempts that may happen
4024 for that message.
4025
4026 .vitem &%-n%&
4027 .oindex "&%-n%&"
4028 This option is interpreted by Sendmail to mean &"no aliasing"&.
4029 For normal modes of operation, it is ignored by Exim.
4030 When combined with &%-bP%& it makes the output more terse (suppresses
4031 option names, environment values and config pretty printing).
4032
4033 .vitem &%-O%&&~<&'data'&>
4034 .oindex "&%-O%&"
4035 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4036 Exim.
4037
4038 .vitem &%-oA%&&~<&'file&~name'&>
4039 .oindex "&%-oA%&"
4040 .cindex "Sendmail compatibility" "&%-oA%& option"
4041 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4042 alternative alias file name. Exim handles &%-bi%& differently; see the
4043 description above.
4044
4045 .vitem &%-oB%&&~<&'n'&>
4046 .oindex "&%-oB%&"
4047 .cindex "SMTP" "passed connection"
4048 .cindex "SMTP" "multiple deliveries"
4049 .cindex "multiple SMTP deliveries"
4050 This is a debugging option which limits the maximum number of messages that can
4051 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4052 transport. If <&'n'&> is omitted, the limit is set to 1.
4053
4054 .vitem &%-odb%&
4055 .oindex "&%-odb%&"
4056 .cindex "background delivery"
4057 .cindex "delivery" "in the background"
4058 This option applies to all modes in which Exim accepts incoming messages,
4059 including the listening daemon. It requests &"background"& delivery of such
4060 messages, which means that the accepting process automatically starts a
4061 delivery process for each message received, but does not wait for the delivery
4062 processes to finish.
4063
4064 When all the messages have been received, the reception process exits,
4065 leaving the delivery processes to finish in their own time. The standard output
4066 and error streams are closed at the start of each delivery process.
4067 This is the default action if none of the &%-od%& options are present.
4068
4069 If one of the queueing options in the configuration file
4070 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4071 overrides it if &%queue_only_override%& is set true, which is the default
4072 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4073
4074 .vitem &%-odf%&
4075 .oindex "&%-odf%&"
4076 .cindex "foreground delivery"
4077 .cindex "delivery" "in the foreground"
4078 This option requests &"foreground"& (synchronous) delivery when Exim has
4079 accepted a locally-generated message. (For the daemon it is exactly the same as
4080 &%-odb%&.) A delivery process is automatically started to deliver the message,
4081 and Exim waits for it to complete before proceeding.
4082
4083 The original Exim reception process does not finish until the delivery
4084 process for the final message has ended. The standard error stream is left open
4085 during deliveries.
4086
4087 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4088 false and one of the queueing options in the configuration file is in effect.
4089
4090 If there is a temporary delivery error during foreground delivery, the
4091 message is left on the queue for later delivery, and the original reception
4092 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4093 restricted configuration that never queues messages.
4094
4095
4096 .vitem &%-odi%&
4097 .oindex "&%-odi%&"
4098 This option is synonymous with &%-odf%&. It is provided for compatibility with
4099 Sendmail.
4100
4101 .vitem &%-odq%&
4102 .oindex "&%-odq%&"
4103 .cindex "non-immediate delivery"
4104 .cindex "delivery" "suppressing immediate"
4105 .cindex "queueing incoming messages"
4106 This option applies to all modes in which Exim accepts incoming messages,
4107 including the listening daemon. It specifies that the accepting process should
4108 not automatically start a delivery process for each message received. Messages
4109 are placed on the queue, and remain there until a subsequent queue runner
4110 process encounters them. There are several configuration options (such as
4111 &%queue_only%&) that can be used to queue incoming messages under certain
4112 conditions. This option overrides all of them and also &%-odqs%&. It always
4113 forces queueing.
4114
4115 .vitem &%-odqs%&
4116 .oindex "&%-odqs%&"
4117 .cindex "SMTP" "delaying delivery"
4118 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4119 However, like &%-odb%& and &%-odi%&, this option has no effect if
4120 &%queue_only_override%& is false and one of the queueing options in the
4121 configuration file is in effect.
4122
4123 When &%-odqs%& does operate, a delivery process is started for each incoming
4124 message, in the background by default, but in the foreground if &%-odi%& is
4125 also present. The recipient addresses are routed, and local deliveries are done
4126 in the normal way. However, if any SMTP deliveries are required, they are not
4127 done at this time, so the message remains on the queue until a subsequent queue
4128 runner process encounters it. Because routing was done, Exim knows which
4129 messages are waiting for which hosts, and so a number of messages for the same
4130 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4131 configuration option has the same effect for specific domains. See also the
4132 &%-qq%& option.
4133
4134 .vitem &%-oee%&
4135 .oindex "&%-oee%&"
4136 .cindex "error" "reporting"
4137 If an error is detected while a non-SMTP message is being received (for
4138 example, a malformed address), the error is reported to the sender in a mail
4139 message.
4140
4141 .cindex "return code" "for &%-oee%&"
4142 Provided
4143 this error message is successfully sent, the Exim receiving process
4144 exits with a return code of zero. If not, the return code is 2 if the problem
4145 is that the original message has no recipients, or 1 for any other error.
4146 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4147
4148 .vitem &%-oem%&
4149 .oindex "&%-oem%&"
4150 .cindex "error" "reporting"
4151 .cindex "return code" "for &%-oem%&"
4152 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4153 return code, whether or not the error message was successfully sent.
4154 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4155
4156 .vitem &%-oep%&
4157 .oindex "&%-oep%&"
4158 .cindex "error" "reporting"
4159 If an error is detected while a non-SMTP message is being received, the
4160 error is reported by writing a message to the standard error file (stderr).
4161 .cindex "return code" "for &%-oep%&"
4162 The return code is 1 for all errors.
4163
4164 .vitem &%-oeq%&
4165 .oindex "&%-oeq%&"
4166 .cindex "error" "reporting"
4167 This option is supported for compatibility with Sendmail, but has the same
4168 effect as &%-oep%&.
4169
4170 .vitem &%-oew%&
4171 .oindex "&%-oew%&"
4172 .cindex "error" "reporting"
4173 This option is supported for compatibility with Sendmail, but has the same
4174 effect as &%-oem%&.
4175
4176 .vitem &%-oi%&
4177 .oindex "&%-oi%&"
4178 .cindex "dot" "in incoming non-SMTP message"
4179 This option, which has the same effect as &%-i%&, specifies that a dot on a
4180 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4181 single dot does terminate, though Exim does no special processing for other
4182 lines that start with a dot. This option is set by default if Exim is called as
4183 &'rmail'&. See also &%-ti%&.
4184
4185 .vitem &%-oitrue%&
4186 .oindex "&%-oitrue%&"
4187 This option is treated as synonymous with &%-oi%&.
4188
4189 .vitem &%-oMa%&&~<&'host&~address'&>
4190 .oindex "&%-oMa%&"
4191 .cindex "sender" "host address, specifying for local message"
4192 A number of options starting with &%-oM%& can be used to set values associated
4193 with remote hosts on locally-submitted messages (that is, messages not received
4194 over TCP/IP). These options can be used by any caller in conjunction with the
4195 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4196 other circumstances, they are ignored unless the caller is trusted.
4197
4198 The &%-oMa%& option sets the sender host address. This may include a port
4199 number at the end, after a full stop (period). For example:
4200 .code
4201 exim -bs -oMa 10.9.8.7.1234
4202 .endd
4203 An alternative syntax is to enclose the IP address in square brackets,
4204 followed by a colon and the port number:
4205 .code
4206 exim -bs -oMa [10.9.8.7]:1234
4207 .endd
4208 The IP address is placed in the &$sender_host_address$& variable, and the
4209 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4210 are present on the command line, the sender host IP address is taken from
4211 whichever one is last.
4212
4213 .vitem &%-oMaa%&&~<&'name'&>
4214 .oindex "&%-oMaa%&"
4215 .cindex "authentication" "name, specifying for local message"
4216 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4217 option sets the value of &$sender_host_authenticated$& (the authenticator
4218 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4219 This option can be used with &%-bh%& and &%-bs%& to set up an
4220 authenticated SMTP session without actually using the SMTP AUTH command.
4221
4222 .vitem &%-oMai%&&~<&'string'&>
4223 .oindex "&%-oMai%&"
4224 .cindex "authentication" "id, specifying for local message"
4225 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4226 option sets the value of &$authenticated_id$& (the id that was authenticated).
4227 This overrides the default value (the caller's login id, except with &%-bh%&,
4228 where there is no default) for messages from local sources. See chapter
4229 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4230
4231 .vitem &%-oMas%&&~<&'address'&>
4232 .oindex "&%-oMas%&"
4233 .cindex "authentication" "sender, specifying for local message"
4234 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4235 option sets the authenticated sender value in &$authenticated_sender$&. It
4236 overrides the sender address that is created from the caller's login id for
4237 messages from local sources, except when &%-bh%& is used, when there is no
4238 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4239 specified on a MAIL command overrides this value. See chapter
4240 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4241
4242 .vitem &%-oMi%&&~<&'interface&~address'&>
4243 .oindex "&%-oMi%&"
4244 .cindex "interface" "address, specifying for local message"
4245 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4246 option sets the IP interface address value. A port number may be included,
4247 using the same syntax as for &%-oMa%&. The interface address is placed in
4248 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4249
4250 .vitem &%-oMm%&&~<&'message&~reference'&>
4251 .oindex "&%-oMm%&"
4252 .cindex "message reference" "message reference, specifying for local message"
4253 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4254 option sets the message reference, e.g. message-id, and is logged during
4255 delivery. This is useful when some kind of audit trail is required to tie
4256 messages together. The format of the message reference is checked and will
4257 abort if the format is invalid. The option will only be accepted if exim is
4258 running in trusted mode, not as any regular user.
4259
4260 The best example of a message reference is when Exim sends a bounce message.
4261 The message reference is the message-id of the original message for which Exim
4262 is sending the bounce.
4263
4264 .vitem &%-oMr%&&~<&'protocol&~name'&>
4265 .oindex "&%-oMr%&"
4266 .cindex "protocol, specifying for local message"
4267 .vindex "&$received_protocol$&"
4268 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4269 option sets the received protocol value that is stored in
4270 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4271 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4272 SMTP protocol names (see the description of &$received_protocol$& in section
4273 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4274 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4275 be set by &%-oMr%&.
4276
4277 .vitem &%-oMs%&&~<&'host&~name'&>
4278 .oindex "&%-oMs%&"
4279 .cindex "sender" "host name, specifying for local message"
4280 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4281 option sets the sender host name in &$sender_host_name$&. When this option is
4282 present, Exim does not attempt to look up a host name from an IP address; it
4283 uses the name it is given.
4284
4285 .vitem &%-oMt%&&~<&'ident&~string'&>
4286 .oindex "&%-oMt%&"
4287 .cindex "sender" "ident string, specifying for local message"
4288 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4289 option sets the sender ident value in &$sender_ident$&. The default setting for
4290 local callers is the login id of the calling process, except when &%-bh%& is
4291 used, when there is no default.
4292
4293 .vitem &%-om%&
4294 .oindex "&%-om%&"
4295 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4296 In Sendmail, this option means &"me too"&, indicating that the sender of a
4297 message should receive a copy of the message if the sender appears in an alias
4298 expansion. Exim always does this, so the option does nothing.
4299
4300 .vitem &%-oo%&
4301 .oindex "&%-oo%&"
4302 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4303 This option is ignored. In Sendmail it specifies &"old style headers"&,
4304 whatever that means.
4305
4306 .vitem &%-oP%&&~<&'path'&>
4307 .oindex "&%-oP%&"
4308 .cindex "pid (process id)" "of daemon"
4309 .cindex "daemon" "process id (pid)"
4310 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4311 value. The option specifies the file to which the process id of the daemon is
4312 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4313 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4314 because in those cases, the normal pid file is not used.
4315
4316 .vitem &%-or%&&~<&'time'&>
4317 .oindex "&%-or%&"
4318 .cindex "timeout" "for non-SMTP input"
4319 This option sets a timeout value for incoming non-SMTP messages. If it is not
4320 set, Exim will wait forever for the standard input. The value can also be set
4321 by the &%receive_timeout%& option. The format used for specifying times is
4322 described in section &<<SECTtimeformat>>&.
4323
4324 .vitem &%-os%&&~<&'time'&>
4325 .oindex "&%-os%&"
4326 .cindex "timeout" "for SMTP input"
4327 .cindex "SMTP" "input timeout"
4328 This option sets a timeout value for incoming SMTP messages. The timeout
4329 applies to each SMTP command and block of data. The value can also be set by
4330 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4331 for specifying times is described in section &<<SECTtimeformat>>&.
4332
4333 .vitem &%-ov%&
4334 .oindex "&%-ov%&"
4335 This option has exactly the same effect as &%-v%&.
4336
4337 .vitem &%-oX%&&~<&'number&~or&~string'&>
4338 .oindex "&%-oX%&"
4339 .cindex "TCP/IP" "setting listening ports"
4340 .cindex "TCP/IP" "setting listening interfaces"
4341 .cindex "port" "receiving TCP/IP"
4342 This option is relevant only when the &%-bd%& (start listening daemon) option
4343 is also given. It controls which ports and interfaces the daemon uses. Details
4344 of the syntax, and how it interacts with configuration file options, are given
4345 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4346 file is written unless &%-oP%& is also present to specify a pid file name.
4347
4348 .vitem &%-pd%&
4349 .oindex "&%-pd%&"
4350 .cindex "Perl" "starting the interpreter"
4351 This option applies when an embedded Perl interpreter is linked with Exim (see
4352 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4353 option, forcing the starting of the interpreter to be delayed until it is
4354 needed.
4355
4356 .vitem &%-ps%&
4357 .oindex "&%-ps%&"
4358 .cindex "Perl" "starting the interpreter"
4359 This option applies when an embedded Perl interpreter is linked with Exim (see
4360 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4361 option, forcing the starting of the interpreter to occur as soon as Exim is
4362 started.
4363
4364 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4365 .oindex "&%-p%&"
4366 For compatibility with Sendmail, this option is equivalent to
4367 .display
4368 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4369 .endd
4370 It sets the incoming protocol and host name (for trusted callers). The
4371 host name and its colon can be omitted when only the protocol is to be set.
4372 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4373 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4374 or &`s`& using this option (but that does not seem a real limitation).
4375
4376 .vitem &%-q%&
4377 .oindex "&%-q%&"
4378 .cindex "queue runner" "starting manually"
4379 This option is normally restricted to admin users. However, there is a
4380 configuration option called &%prod_requires_admin%& which can be set false to
4381 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4382 and &%-S%& options).
4383
4384 .cindex "queue runner" "description of operation"
4385 .new
4386 If other commandline options do not specify an action,
4387 .wen
4388 the &%-q%& option starts one queue runner process. This scans the queue of
4389 waiting messages, and runs a delivery process for each one in turn. It waits
4390 for each delivery process to finish before starting the next one. A delivery
4391 process may not actually do any deliveries if the retry times for the addresses
4392 have not been reached. Use &%-qf%& (see below) if you want to override this.
4393
4394 If
4395 .cindex "SMTP" "passed connection"
4396 .cindex "SMTP" "multiple deliveries"
4397 .cindex "multiple SMTP deliveries"
4398 the delivery process spawns other processes to deliver other messages down
4399 passed SMTP connections, the queue runner waits for these to finish before
4400 proceeding.
4401
4402 When all the queued messages have been considered, the original queue runner
4403 process terminates. In other words, a single pass is made over the waiting
4404 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4405 this to be repeated periodically.
4406
4407 Exim processes the waiting messages in an unpredictable order. It isn't very
4408 random, but it is likely to be different each time, which is all that matters.
4409 If one particular message screws up a remote MTA, other messages to the same
4410 MTA have a chance of getting through if they get tried first.
4411
4412 It is possible to cause the messages to be processed in lexical message id
4413 order, which is essentially the order in which they arrived, by setting the
4414 &%queue_run_in_order%& option, but this is not recommended for normal use.
4415
4416 .vitem &%-q%&<&'qflags'&>
4417 The &%-q%& option may be followed by one or more flag letters that change its
4418 behaviour. They are all optional, but if more than one is present, they must
4419 appear in the correct order. Each flag is described in a separate item below.
4420
4421 .vitem &%-qq...%&
4422 .oindex "&%-qq%&"
4423 .cindex "queue" "double scanning"
4424 .cindex "queue" "routing"
4425 .cindex "routing" "whole queue before delivery"
4426 An option starting with &%-qq%& requests a two-stage queue run. In the first
4427 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4428 every domain. Addresses are routed, local deliveries happen, but no remote
4429 transports are run.
4430
4431 .cindex "hints database" "remembering routing"
4432 The hints database that remembers which messages are waiting for specific hosts
4433 is updated, as if delivery to those hosts had been deferred. After this is
4434 complete, a second, normal queue scan happens, with routing and delivery taking
4435 place as normal. Messages that are routed to the same host should mostly be
4436 delivered down a single SMTP
4437 .cindex "SMTP" "passed connection"
4438 .cindex "SMTP" "multiple deliveries"
4439 .cindex "multiple SMTP deliveries"
4440 connection because of the hints that were set up during the first queue scan.
4441 This option may be useful for hosts that are connected to the Internet
4442 intermittently.
4443
4444 .vitem &%-q[q]i...%&
4445 .oindex "&%-qi%&"
4446 .cindex "queue" "initial delivery"
4447 If the &'i'& flag is present, the queue runner runs delivery processes only for
4448 those messages that haven't previously been tried. (&'i'& stands for &"initial
4449 delivery"&.) This can be helpful if you are putting messages on the queue using
4450 &%-odq%& and want a queue runner just to process the new messages.
4451
4452 .vitem &%-q[q][i]f...%&
4453 .oindex "&%-qf%&"
4454 .cindex "queue" "forcing delivery"
4455 .cindex "delivery" "forcing in queue run"
4456 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4457 message, whereas without &'f'& only those non-frozen addresses that have passed
4458 their retry times are tried.
4459
4460 .vitem &%-q[q][i]ff...%&
4461 .oindex "&%-qff%&"
4462 .cindex "frozen messages" "forcing delivery"
4463 If &'ff'& is present, a delivery attempt is forced for every message, whether
4464 frozen or not.
4465
4466 .vitem &%-q[q][i][f[f]]l%&
4467 .oindex "&%-ql%&"
4468 .cindex "queue" "local deliveries only"
4469 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4470 be done. If a message requires any remote deliveries, it remains on the queue
4471 for later delivery.
4472
4473 .new
4474 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4475 .oindex "&%-qG%&"
4476 .cindex queue named
4477 .cindex "named queues"
4478 .cindex "queue" "delivering specific messages"
4479 If the &'G'& flag and a name is present, the queue runner operates on the
4480 queue with the given name rather than the default queue.
4481 The name should not contain a &'/'& character.
4482 For a periodic queue run (see below)
4483 append to the name a slash and a time value.
4484
4485 If other commandline options specify an action, a &'-qG<name>'& option
4486 will specify a queue to operate on.
4487 For example:
4488 .code
4489 exim -bp -qGquarantine
4490 mailq -qGquarantine
4491 exim -qGoffpeak -Rf @special.domain.example
4492 .endd
4493 .wen
4494
4495 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4496 When scanning the queue, Exim can be made to skip over messages whose ids are
4497 lexically less than a given value by following the &%-q%& option with a
4498 starting message id. For example:
4499 .code
4500 exim -q 0t5C6f-0000c8-00
4501 .endd
4502 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4503 second message id is given, messages whose ids are lexically greater than it
4504 are also skipped. If the same id is given twice, for example,
4505 .code
4506 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4507 .endd
4508 just one delivery process is started, for that message. This differs from
4509 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4510 that it counts as a delivery from a queue run. Note that the selection
4511 mechanism does not affect the order in which the messages are scanned. There
4512 are also other ways of selecting specific sets of messages for delivery in a
4513 queue run &-- see &%-R%& and &%-S%&.
4514
4515 .vitem &%-q%&<&'qflags'&><&'time'&>
4516 .cindex "queue runner" "starting periodically"
4517 .cindex "periodic queue running"
4518 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4519 starting a queue runner process at intervals specified by the given time value
4520 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4521 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4522 single daemon process handles both functions. A common way of starting up a
4523 combined daemon at system boot time is to use a command such as
4524 .code
4525 /usr/exim/bin/exim -bd -q30m
4526 .endd
4527 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4528 process every 30 minutes.
4529
4530 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4531 pid file is written unless one is explicitly requested by the &%-oP%& option.
4532
4533 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4534 .oindex "&%-qR%&"
4535 This option is synonymous with &%-R%&. It is provided for Sendmail
4536 compatibility.
4537
4538 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4539 .oindex "&%-qS%&"
4540 This option is synonymous with &%-S%&.
4541
4542 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4543 .oindex "&%-R%&"
4544 .cindex "queue runner" "for specific recipients"
4545 .cindex "delivery" "to given domain"
4546 .cindex "domain" "delivery to"
4547 The <&'rsflags'&> may be empty, in which case the white space before the string
4548 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4549 which are the possible values for <&'rsflags'&>. White space is required if
4550 <&'rsflags'&> is not empty.
4551
4552 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4553 perform a single queue run, except that, when scanning the messages on the
4554 queue, Exim processes only those that have at least one undelivered recipient
4555 address containing the given string, which is checked in a case-independent
4556 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4557 regular expression; otherwise it is a literal string.
4558
4559 If you want to do periodic queue runs for messages with specific recipients,
4560 you can combine &%-R%& with &%-q%& and a time value. For example:
4561 .code
4562 exim -q25m -R @special.domain.example
4563 .endd
4564 This example does a queue run for messages with recipients in the given domain
4565 every 25 minutes. Any additional flags that are specified with &%-q%& are
4566 applied to each queue run.
4567
4568 Once a message is selected for delivery by this mechanism, all its addresses
4569 are processed. For the first selected message, Exim overrides any retry
4570 information and forces a delivery attempt for each undelivered address. This
4571 means that if delivery of any address in the first message is successful, any
4572 existing retry information is deleted, and so delivery attempts for that
4573 address in subsequently selected messages (which are processed without forcing)
4574 will run. However, if delivery of any address does not succeed, the retry
4575 information is updated, and in subsequently selected messages, the failing
4576 address will be skipped.
4577
4578 .cindex "frozen messages" "forcing delivery"
4579 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4580 all selected messages, not just the first; frozen messages are included when
4581 &'ff'& is present.
4582
4583 The &%-R%& option makes it straightforward to initiate delivery of all messages
4584 to a given domain after a host has been down for some time. When the SMTP
4585 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4586 effect is to run Exim with the &%-R%& option, but it can be configured to run
4587 an arbitrary command instead.
4588
4589 .vitem &%-r%&
4590 .oindex "&%-r%&"
4591 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4592
4593 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4594 .oindex "&%-S%&"
4595 .cindex "delivery" "from given sender"
4596 .cindex "queue runner" "for specific senders"
4597 This option acts like &%-R%& except that it checks the string against each
4598 message's sender instead of against the recipients. If &%-R%& is also set, both
4599 conditions must be met for a message to be selected. If either of the options
4600 has &'f'& or &'ff'& in its flags, the associated action is taken.
4601
4602 .vitem &%-Tqt%&&~<&'times'&>
4603 .oindex "&%-Tqt%&"
4604 This is an option that is exclusively for use by the Exim testing suite. It is not
4605 recognized when Exim is run normally. It allows for the setting up of explicit
4606 &"queue times"& so that various warning/retry features can be tested.
4607
4608 .vitem &%-t%&
4609 .oindex "&%-t%&"
4610 .cindex "recipient" "extracting from header lines"
4611 .cindex "&'Bcc:'& header line"
4612 .cindex "&'Cc:'& header line"
4613 .cindex "&'To:'& header line"
4614 When Exim is receiving a locally-generated, non-SMTP message on its standard
4615 input, the &%-t%& option causes the recipients of the message to be obtained
4616 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4617 from the command arguments. The addresses are extracted before any rewriting
4618 takes place and the &'Bcc:'& header line, if present, is then removed.
4619
4620 .cindex "Sendmail compatibility" "&%-t%& option"
4621 If the command has any arguments, they specify addresses to which the message
4622 is &'not'& to be delivered. That is, the argument addresses are removed from
4623 the recipients list obtained from the headers. This is compatible with Smail 3
4624 and in accordance with the documented behaviour of several versions of
4625 Sendmail, as described in man pages on a number of operating systems (e.g.
4626 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4627 argument addresses to those obtained from the headers, and the O'Reilly
4628 Sendmail book documents it that way. Exim can be made to add argument addresses
4629 instead of subtracting them by setting the option
4630 &%extract_addresses_remove_arguments%& false.
4631
4632 .cindex "&%Resent-%& header lines" "with &%-t%&"
4633 If there are any &%Resent-%& header lines in the message, Exim extracts
4634 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4635 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4636 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4637 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4638
4639 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4640 message is resent several times). The RFC also specifies that they should be
4641 added at the front of the message, and separated by &'Received:'& lines. It is
4642 not at all clear how &%-t%& should operate in the present of multiple sets,
4643 nor indeed exactly what constitutes a &"set"&.
4644 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4645 are often added at the end of the header, and if a message is resent more than
4646 once, it is common for the original set of &%Resent-%& headers to be renamed as
4647 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4648
4649 .vitem &%-ti%&
4650 .oindex "&%-ti%&"
4651 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4652 compatibility with Sendmail.
4653
4654 .vitem &%-tls-on-connect%&
4655 .oindex "&%-tls-on-connect%&"
4656 .cindex "TLS" "use without STARTTLS"
4657 .cindex "TLS" "automatic start"
4658 This option is available when Exim is compiled with TLS support. It forces all
4659 incoming SMTP connections to behave as if the incoming port is listed in the
4660 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4661 &<<CHAPTLS>>& for further details.
4662
4663
4664 .vitem &%-U%&
4665 .oindex "&%-U%&"
4666 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4667 Sendmail uses this option for &"initial message submission"&, and its
4668 documentation states that in future releases, it may complain about
4669 syntactically invalid messages rather than fixing them when this flag is not
4670 set. Exim ignores this option.
4671
4672 .vitem &%-v%&
4673 .oindex "&%-v%&"
4674 This option causes Exim to write information to the standard error stream,
4675 describing what it is doing. In particular, it shows the log lines for
4676 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4677 dialogue is shown. Some of the log lines shown may not actually be written to
4678 the log if the setting of &%log_selector%& discards them. Any relevant
4679 selectors are shown with each log line. If none are shown, the logging is
4680 unconditional.
4681
4682 .vitem &%-x%&
4683 .oindex "&%-x%&"
4684 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4685 National Language Support extended characters in the body of the mail item"&).
4686 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4687 this option.
4688
4689 .vitem &%-X%&&~<&'logfile'&>
4690 .oindex "&%-X%&"
4691 This option is interpreted by Sendmail to cause debug information to be sent
4692 to the named file.  It is ignored by Exim.
4693
4694 .vitem &%-z%&&~<&'log-line'&>
4695 .oindex "&%-z%&"
4696 This option writes its argument to Exim's logfile.
4697 Use is restricted to administrators; the intent is for operational notes.
4698 Quotes should be used to maintain a multi-word item as a single argument,
4699 under most shells.
4700 .endlist
4701
4702 .ecindex IIDclo1
4703 .ecindex IIDclo2
4704
4705
4706 . ////////////////////////////////////////////////////////////////////////////
4707 . Insert a stylized DocBook comment here, to identify the end of the command
4708 . line options. This is for the benefit of the Perl script that automatically
4709 . creates a man page for the options.
4710 . ////////////////////////////////////////////////////////////////////////////
4711
4712 .literal xml
4713 <!-- === End of command line options === -->
4714 .literal off
4715
4716
4717
4718
4719
4720 . ////////////////////////////////////////////////////////////////////////////
4721 . ////////////////////////////////////////////////////////////////////////////
4722
4723
4724 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4725          "The runtime configuration file"
4726
4727 .cindex "run time configuration"
4728 .cindex "configuration file" "general description"
4729 .cindex "CONFIGURE_FILE"
4730 .cindex "configuration file" "errors in"
4731 .cindex "error" "in configuration file"
4732 .cindex "return code" "for bad configuration"
4733 Exim uses a single run time configuration file that is read whenever an Exim
4734 binary is executed. Note that in normal operation, this happens frequently,
4735 because Exim is designed to operate in a distributed manner, without central
4736 control.
4737
4738 If a syntax error is detected while reading the configuration file, Exim
4739 writes a message on the standard error, and exits with a non-zero return code.
4740 The message is also written to the panic log. &*Note*&: Only simple syntax
4741 errors can be detected at this time. The values of any expanded options are
4742 not checked until the expansion happens, even when the expansion does not
4743 actually alter the string.
4744
4745 The name of the configuration file is compiled into the binary for security
4746 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4747 most configurations, this specifies a single file. However, it is permitted to
4748 give a colon-separated list of file names, in which case Exim uses the first
4749 existing file in the list.
4750
4751 .cindex "EXIM_USER"
4752 .cindex "EXIM_GROUP"
4753 .cindex "CONFIGURE_OWNER"
4754 .cindex "CONFIGURE_GROUP"
4755 .cindex "configuration file" "ownership"
4756 .cindex "ownership" "configuration file"
4757 The run time configuration file must be owned by root or by the user that is
4758 specified at compile time by the CONFIGURE_OWNER option (if set). The
4759 configuration file must not be world-writeable, or group-writeable unless its
4760 group is the root group or the one specified at compile time by the
4761 CONFIGURE_GROUP option.
4762
4763 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4764 to root, anybody who is able to edit the run time configuration file has an
4765 easy way to run commands as root. If you specify a user or group in the
4766 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4767 who are members of that group will trivially be able to obtain root privileges.
4768
4769 Up to Exim version 4.72, the run time configuration file was also permitted to
4770 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4771 since it offered a simple privilege escalation for any attacker who managed to
4772 compromise the Exim user account.
4773
4774 A default configuration file, which will work correctly in simple situations,
4775 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4776 defines just one file name, the installation process copies the default
4777 configuration to a new file of that name if it did not previously exist. If
4778 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4779 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4780 configuration.
4781
4782
4783
4784 .section "Using a different configuration file" "SECID40"
4785 .cindex "configuration file" "alternate"
4786 A one-off alternate configuration can be specified by the &%-C%& command line
4787 option, which may specify a single file or a list of files. However, when
4788 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4789 unless the argument for &%-C%& is identical to the built-in value from
4790 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4791 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4792 is useful mainly for checking the syntax of configuration files before
4793 installing them. No owner or group checks are done on a configuration file
4794 specified by &%-C%&, if root privilege has been dropped.
4795
4796 Even the Exim user is not trusted to specify an arbitrary configuration file
4797 with the &%-C%& option to be used with root privileges, unless that file is
4798 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4799 testing a configuration using &%-C%& right through message reception and
4800 delivery, even if the caller is root. The reception works, but by that time,
4801 Exim is running as the Exim user, so when it re-execs to regain privilege for
4802 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4803 can test reception and delivery using two separate commands (one to put a
4804 message on the queue, using &%-odq%&, and another to do the delivery, using
4805 &%-M%&).
4806
4807 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4808 prefix string with which any file named in a &%-C%& command line option must
4809 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4810 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4811 name can be used with &%-C%&.
4812
4813 One-off changes to a configuration can be specified by the &%-D%& command line
4814 option, which defines and overrides values for macros used inside the
4815 configuration file. However, like &%-C%&, the use of this option by a
4816 non-privileged user causes Exim to discard its root privilege.
4817 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4818 completely disabled, and its use causes an immediate error exit.
4819
4820 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4821 to declare certain macro names trusted, such that root privilege will not
4822 necessarily be discarded.
4823 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4824 considered safe and, if &%-D%& only supplies macros from this list, and the
4825 values are acceptable, then Exim will not give up root privilege if the caller
4826 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4827 transition mechanism and is expected to be removed in the future.  Acceptable
4828 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4829
4830 Some sites may wish to use the same Exim binary on different machines that
4831 share a file system, but to use different configuration files on each machine.
4832 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4833 looks for a file whose name is the configuration file name followed by a dot
4834 and the machine's node name, as obtained from the &[uname()]& function. If this
4835 file does not exist, the standard name is tried. This processing occurs for
4836 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4837
4838 In some esoteric situations different versions of Exim may be run under
4839 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4840 help with this. See the comments in &_src/EDITME_& for details.
4841
4842
4843
4844 .section "Configuration file format" "SECTconffilfor"
4845 .cindex "configuration file" "format of"
4846 .cindex "format" "configuration file"
4847 Exim's configuration file is divided into a number of different parts. General
4848 option settings must always appear at the start of the file. The other parts
4849 are all optional, and may appear in any order. Each part other than the first
4850 is introduced by the word &"begin"& followed by at least one literal
4851 space, and the name of the part. The optional parts are:
4852
4853 .ilist
4854 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4855 &<<CHAPACL>>&).
4856 .next
4857 .cindex "AUTH" "configuration"
4858 &'authenticators'&: Configuration settings for the authenticator drivers. These
4859 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4860 .next
4861 &'routers'&: Configuration settings for the router drivers. Routers process
4862 addresses and determine how the message is to be delivered (see chapters
4863 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4864 .next
4865 &'transports'&: Configuration settings for the transport drivers. Transports
4866 define mechanisms for copying messages to destinations (see chapters
4867 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4868 .next
4869 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4870 If there is no retry section, or if it is empty (that is, no retry rules are
4871 defined), Exim will not retry deliveries. In this situation, temporary errors
4872 are treated the same as permanent errors. Retry rules are discussed in chapter
4873 &<<CHAPretry>>&.
4874 .next
4875 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4876 when new addresses are generated during delivery. Rewriting is discussed in
4877 chapter &<<CHAPrewrite>>&.
4878 .next
4879 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4880 want to use this feature, you must set
4881 .code
4882 LOCAL_SCAN_HAS_OPTIONS=yes
4883 .endd
4884 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4885 facility are given in chapter &<<CHAPlocalscan>>&.
4886 .endlist
4887
4888 .cindex "configuration file" "leading white space in"
4889 .cindex "configuration file" "trailing white space in"
4890 .cindex "white space" "in configuration file"
4891 Leading and trailing white space in configuration lines is always ignored.
4892
4893 Blank lines in the file, and lines starting with a # character (ignoring
4894 leading white space) are treated as comments and are ignored. &*Note*&: A
4895 # character other than at the beginning of a line is not treated specially,
4896 and does not introduce a comment.
4897
4898 Any non-comment line can be continued by ending it with a backslash. Note that
4899 the general rule for white space means that trailing white space after the
4900 backslash and leading white space at the start of continuation
4901 lines is ignored. Comment lines beginning with # (but not empty lines) may
4902 appear in the middle of a sequence of continuation lines.
4903
4904 A convenient way to create a configuration file is to start from the
4905 default, which is supplied in &_src/configure.default_&, and add, delete, or
4906 change settings as required.
4907
4908 The ACLs, retry rules, and rewriting rules have their own syntax which is
4909 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4910 respectively. The other parts of the configuration file have some syntactic
4911 items in common, and these are described below, from section &<<SECTcos>>&
4912 onwards. Before that, the inclusion, macro, and conditional facilities are
4913 described.
4914
4915
4916
4917 .section "File inclusions in the configuration file" "SECID41"
4918 .cindex "inclusions in configuration file"
4919 .cindex "configuration file" "including other files"
4920 .cindex "&`.include`& in configuration file"
4921 .cindex "&`.include_if_exists`& in configuration file"
4922 You can include other files inside Exim's run time configuration file by
4923 using this syntax:
4924 .display
4925 &`.include`& <&'file name'&>
4926 &`.include_if_exists`& <&'file name'&>
4927 .endd
4928 on a line by itself. Double quotes round the file name are optional. If you use
4929 the first form, a configuration error occurs if the file does not exist; the
4930 second form does nothing for non-existent files.
4931 .new
4932 The first form allows a relative name. It is resolved relative to
4933 the directory of the including file. For the second form an absolute file
4934 name is required.
4935 .wen
4936
4937 Includes may be nested to any depth, but remember that Exim reads its
4938 configuration file often, so it is a good idea to keep them to a minimum.
4939 If you change the contents of an included file, you must HUP the daemon,
4940 because an included file is read only when the configuration itself is read.
4941
4942 The processing of inclusions happens early, at a physical line level, so, like
4943 comment lines, an inclusion can be used in the middle of an option setting,
4944 for example:
4945 .code
4946 hosts_lookup = a.b.c \
4947                .include /some/file
4948 .endd
4949 Include processing happens after macro processing (see below). Its effect is to
4950 process the lines of the included file as if they occurred inline where the
4951 inclusion appears.
4952
4953
4954
4955 .section "Macros in the configuration file" "SECTmacrodefs"
4956 .cindex "macro" "description of"
4957 .cindex "configuration file" "macros"
4958 If a line in the main part of the configuration (that is, before the first
4959 &"begin"& line) begins with an upper case letter, it is taken as a macro
4960 definition, and must be of the form
4961 .display
4962 <&'name'&> = <&'rest of line'&>
4963 .endd
4964 The name must consist of letters, digits, and underscores, and need not all be
4965 in upper case, though that is recommended. The rest of the line, including any
4966 continuations, is the replacement text, and has leading and trailing white
4967 space removed. Quotes are not removed. The replacement text can never end with
4968 a backslash character, but this doesn't seem to be a serious limitation.
4969
4970 Macros may also be defined between router, transport, authenticator, or ACL
4971 definitions. They may not, however, be defined within an individual driver or
4972 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4973
4974 .section "Macro substitution" "SECID42"
4975 Once a macro is defined, all subsequent lines in the file (and any included
4976 files) are scanned for the macro name; if there are several macros, the line is
4977 scanned for each in turn, in the order in which the macros are defined. The
4978 replacement text is not re-scanned for the current macro, though it is scanned
4979 for subsequently defined macros. For this reason, a macro name may not contain
4980 the name of a previously defined macro as a substring. You could, for example,
4981 define
4982 .display
4983 &`ABCD_XYZ = `&<&'something'&>
4984 &`ABCD = `&<&'something else'&>
4985 .endd
4986 but putting the definitions in the opposite order would provoke a configuration
4987 error. Macro expansion is applied to individual physical lines from the file,
4988 before checking for line continuation or file inclusion (see above). If a line
4989 consists solely of a macro name, and the expansion of the macro is empty, the
4990 line is ignored. A macro at the start of a line may turn the line into a
4991 comment line or a &`.include`& line.
4992
4993
4994 .section "Redefining macros" "SECID43"
4995 Once defined, the value of a macro can be redefined later in the configuration
4996 (or in an included file). Redefinition is specified by using &'=='& instead of
4997 &'='&. For example:
4998 .code
4999 MAC =  initial value
5000 ...
5001 MAC == updated value
5002 .endd
5003 Redefinition does not alter the order in which the macros are applied to the
5004 subsequent lines of the configuration file. It is still the same order in which
5005 the macros were originally defined. All that changes is the macro's value.
5006 Redefinition makes it possible to accumulate values. For example:
5007 .code
5008 MAC =  initial value
5009 ...
5010 MAC == MAC and something added
5011 .endd
5012 This can be helpful in situations where the configuration file is built
5013 from a number of other files.
5014
5015 .section "Overriding macro values" "SECID44"
5016 The values set for macros in the configuration file can be overridden by the
5017 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5018 used, unless called by root or the Exim user. A definition on the command line
5019 using the &%-D%& option causes all definitions and redefinitions within the
5020 file to be ignored.
5021
5022
5023
5024 .section "Example of macro usage" "SECID45"
5025 As an example of macro usage, consider a configuration where aliases are looked
5026 up in a MySQL database. It helps to keep the file less cluttered if long
5027 strings such as SQL statements are defined separately as macros, for example:
5028 .code
5029 ALIAS_QUERY = select mailbox from user where \
5030               login='${quote_mysql:$local_part}';
5031 .endd
5032 This can then be used in a &(redirect)& router setting like this:
5033 .code
5034 data = ${lookup mysql{ALIAS_QUERY}}
5035 .endd
5036 In earlier versions of Exim macros were sometimes used for domain, host, or
5037 address lists. In Exim 4 these are handled better by named lists &-- see
5038 section &<<SECTnamedlists>>&.
5039
5040
5041 .new
5042 .section "Builtin macros" "SECTbuiltinmacros"
5043 Exim defines some macros depending on facilities available, which may
5044 differ due to build-time definitions and from one release to another.
5045 All of these macros start with an underscore.
5046 They can be used to conditionally include parts of a configuration
5047 (see below).
5048
5049 The following classes of macros are defined:
5050 .display
5051 &` _HAVE_*                    `&  build-time defines
5052 &` _DRIVER_ROUTER_*           `&  router drivers
5053 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5054 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5055 &` _OPT_MAIN_*                `&  main config options
5056 &` _OPT_ROUTERS_*             `&  generic router options
5057 &` _OPT_TRANSPORTS_*          `&  generic transport options
5058 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5059 &` _OPT_ROUTER_*_*            `&  private router options
5060 &` _OPT_TRANSPORT_*_*         `&  private transport options
5061 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5062 .endd
5063
5064 Use an &"exim -bP macros"& command to get the list of macros.
5065 .wen
5066
5067
5068 .section "Conditional skips in the configuration file" "SECID46"
5069 .cindex "configuration file" "conditional skips"
5070 .cindex "&`.ifdef`&"
5071 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5072 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5073 portions of the configuration file. The processing happens whenever the file is
5074 read (that is, when an Exim binary starts to run).
5075
5076 The implementation is very simple. Instances of the first four directives must
5077 be followed by text that includes the names of one or macros. The condition
5078 that is tested is whether or not any macro substitution has taken place in the
5079 line. Thus:
5080 .code
5081 .ifdef AAA
5082 message_size_limit = 50M
5083 .else
5084 message_size_limit = 100M
5085 .endif
5086 .endd
5087 sets a message size limit of 50M if the macro &`AAA`& is defined
5088 (or &`A`& or &`AA`&), and 100M
5089 otherwise. If there is more than one macro named on the line, the condition
5090 is true if any of them are defined. That is, it is an &"or"& condition. To
5091 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5092
5093 Although you can use a macro expansion to generate one of these directives,
5094 it is not very useful, because the condition &"there was a macro substitution
5095 in this line"& will always be true.
5096
5097 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5098 to clarify complicated nestings.
5099
5100
5101
5102 .section "Common option syntax" "SECTcos"
5103 .cindex "common option syntax"
5104 .cindex "syntax of common options"
5105 .cindex "configuration file" "common option syntax"
5106 For the main set of options, driver options, and &[local_scan()]& options,
5107 each setting is on a line by itself, and starts with a name consisting of
5108 lower-case letters and underscores. Many options require a data value, and in
5109 these cases the name must be followed by an equals sign (with optional white
5110 space) and then the value. For example:
5111 .code
5112 qualify_domain = mydomain.example.com
5113 .endd
5114 .cindex "hiding configuration option values"
5115 .cindex "configuration options" "hiding value of"
5116 .cindex "options" "hiding value of"
5117 Some option settings may contain sensitive data, for example, passwords for
5118 accessing databases. To stop non-admin users from using the &%-bP%& command
5119 line option to read these values, you can precede the option settings with the
5120 word &"hide"&. For example:
5121 .code
5122 hide mysql_servers = localhost/users/admin/secret-password
5123 .endd
5124 For non-admin users, such options are displayed like this:
5125 .code
5126 mysql_servers = <value not displayable>
5127 .endd
5128 If &"hide"& is used on a driver option, it hides the value of that option on
5129 all instances of the same driver.
5130
5131 The following sections describe the syntax used for the different data types
5132 that are found in option settings.
5133
5134
5135 .section "Boolean options" "SECID47"
5136 .cindex "format" "boolean"
5137 .cindex "boolean configuration values"
5138 .oindex "&%no_%&&'xxx'&"
5139 .oindex "&%not_%&&'xxx'&"
5140 Options whose type is given as boolean are on/off switches. There are two
5141 different ways of specifying such options: with and without a data value. If
5142 the option name is specified on its own without data, the switch is turned on;
5143 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5144 boolean options may be followed by an equals sign and one of the words
5145 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5146 the following two settings have exactly the same effect:
5147 .code
5148 queue_only
5149 queue_only = true
5150 .endd
5151 The following two lines also have the same (opposite) effect:
5152 .code
5153 no_queue_only
5154 queue_only = false
5155 .endd
5156 You can use whichever syntax you prefer.
5157
5158
5159
5160
5161 .section "Integer values" "SECID48"
5162 .cindex "integer configuration values"
5163 .cindex "format" "integer"
5164 If an option's type is given as &"integer"&, the value can be given in decimal,
5165 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5166 number is assumed. Otherwise, it is treated as an octal number unless it starts
5167 with the characters &"0x"&, in which case the remainder is interpreted as a
5168 hexadecimal number.
5169
5170 If an integer value is followed by the letter K, it is multiplied by 1024; if
5171 it is followed by the letter M, it is multiplied by 1024x1024;
5172 .new
5173 if by the letter G, 1024x1024x1024.
5174 .wen
5175 When the values
5176 of integer option settings are output, values which are an exact multiple of
5177 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5178 and M. The printing style is independent of the actual input format that was
5179 used.
5180
5181
5182 .section "Octal integer values" "SECID49"
5183 .cindex "integer format"
5184 .cindex "format" "octal integer"
5185 If an option's type is given as &"octal integer"&, its value is always
5186 interpreted as an octal number, whether or not it starts with the digit zero.
5187 Such options are always output in octal.
5188
5189
5190 .section "Fixed point numbers" "SECID50"
5191 .cindex "fixed point configuration values"
5192 .cindex "format" "fixed point"
5193 If an option's type is given as &"fixed-point"&, its value must be a decimal
5194 integer, optionally followed by a decimal point and up to three further digits.
5195
5196
5197
5198 .section "Time intervals" "SECTtimeformat"
5199 .cindex "time interval" "specifying in configuration"
5200 .cindex "format" "time interval"
5201 A time interval is specified as a sequence of numbers, each followed by one of
5202 the following letters, with no intervening white space:
5203
5204 .table2 30pt
5205 .irow &%s%& seconds
5206 .irow &%m%& minutes
5207 .irow &%h%& hours
5208 .irow &%d%& days
5209 .irow &%w%& weeks
5210 .endtable
5211
5212 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5213 intervals are output in the same format. Exim does not restrict the values; it
5214 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5215
5216
5217
5218 .section "String values" "SECTstrings"
5219 .cindex "string" "format of configuration values"
5220 .cindex "format" "string"
5221 If an option's type is specified as &"string"&, the value can be specified with
5222 or without double-quotes. If it does not start with a double-quote, the value
5223 consists of the remainder of the line plus any continuation lines, starting at
5224 the first character after any leading white space, with trailing white space
5225 removed, and with no interpretation of the characters in the string. Because
5226 Exim removes comment lines (those beginning with #) at an early stage, they can
5227 appear in the middle of a multi-line string. The following two settings are
5228 therefore equivalent:
5229 .code
5230 trusted_users = uucp:mail
5231 trusted_users = uucp:\
5232                 # This comment line is ignored
5233                 mail
5234 .endd
5235 .cindex "string" "quoted"
5236 .cindex "escape characters in quoted strings"
5237 If a string does start with a double-quote, it must end with a closing
5238 double-quote, and any backslash characters other than those used for line
5239 continuation are interpreted as escape characters, as follows:
5240
5241 .table2 100pt
5242 .irow &`\\`&                     "single backslash"
5243 .irow &`\n`&                     "newline"
5244 .irow &`\r`&                     "carriage return"
5245 .irow &`\t`&                     "tab"
5246 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5247 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5248                                    character"
5249 .endtable
5250
5251 If a backslash is followed by some other character, including a double-quote
5252 character, that character replaces the pair.
5253
5254 Quoting is necessary only if you want to make use of the backslash escapes to
5255 insert special characters, or if you need to specify a value with leading or
5256 trailing spaces. These cases are rare, so quoting is almost never needed in
5257 current versions of Exim. In versions of Exim before 3.14, quoting was required
5258 in order to continue lines, so you may come across older configuration files
5259 and examples that apparently quote unnecessarily.
5260
5261
5262 .section "Expanded strings" "SECID51"
5263 .cindex "expansion" "definition of"
5264 Some strings in the configuration file are subjected to &'string expansion'&,
5265 by which means various parts of the string may be changed according to the
5266 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5267 is as just described; in particular, the handling of backslashes in quoted
5268 strings is done as part of the input process, before expansion takes place.
5269 However, backslash is also an escape character for the expander, so any
5270 backslashes that are required for that reason must be doubled if they are
5271 within a quoted configuration string.
5272
5273
5274 .section "User and group names" "SECID52"
5275 .cindex "user name" "format of"
5276 .cindex "format" "user name"
5277 .cindex "groups" "name format"
5278 .cindex "format" "group name"
5279 User and group names are specified as strings, using the syntax described
5280 above, but the strings are interpreted specially. A user or group name must
5281 either consist entirely of digits, or be a name that can be looked up using the
5282 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5283
5284
5285 .section "List construction" "SECTlistconstruct"
5286 .cindex "list" "syntax of in configuration"
5287 .cindex "format" "list item in configuration"
5288 .cindex "string" "list, definition of"
5289 The data for some configuration options is a list of items, with colon as the
5290 default separator. Many of these options are shown with type &"string list"& in
5291 the descriptions later in this document. Others are listed as &"domain list"&,
5292 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5293 are all the same; however, those other than &"string list"& are subject to
5294 particular kinds of interpretation, as described in chapter
5295 &<<CHAPdomhosaddlists>>&.
5296
5297 In all these cases, the entire list is treated as a single string as far as the
5298 input syntax is concerned. The &%trusted_users%& setting in section
5299 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5300 in a list, it must be entered as two colons. Leading and trailing white space
5301 on each item in a list is ignored. This makes it possible to include items that
5302 start with a colon, and in particular, certain forms of IPv6 address. For
5303 example, the list
5304 .code
5305 local_interfaces = 127.0.0.1 : ::::1
5306 .endd
5307 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5308
5309 &*Note*&: Although leading and trailing white space is ignored in individual
5310 list items, it is not ignored when parsing the list. The space after the first
5311 colon in the example above is necessary. If it were not there, the list would
5312 be interpreted as the two items 127.0.0.1:: and 1.
5313
5314 .section "Changing list separators" "SECTlistsepchange"
5315 .cindex "list separator" "changing"
5316 .cindex "IPv6" "addresses in lists"
5317 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5318 introduced to allow the separator character to be changed. If a list begins
5319 with a left angle bracket, followed by any punctuation character, that
5320 character is used instead of colon as the list separator. For example, the list
5321 above can be rewritten to use a semicolon separator like this:
5322 .code
5323 local_interfaces = <; 127.0.0.1 ; ::1
5324 .endd
5325 This facility applies to all lists, with the exception of the list in
5326 &%log_file_path%&. It is recommended that the use of non-colon separators be
5327 confined to circumstances where they really are needed.
5328
5329 .cindex "list separator" "newline as"
5330 .cindex "newline" "as list separator"
5331 It is also possible to use newline and other control characters (those with
5332 code values less than 32, plus DEL) as separators in lists. Such separators
5333 must be provided literally at the time the list is processed. For options that
5334 are string-expanded, you can write the separator using a normal escape
5335 sequence. This will be processed by the expander before the string is
5336 interpreted as a list. For example, if a newline-separated list of domains is
5337 generated by a lookup, you can process it directly by a line such as this:
5338 .code
5339 domains = <\n ${lookup mysql{.....}}
5340 .endd
5341 This avoids having to change the list separator in such data. You are unlikely
5342 to want to use a control character as a separator in an option that is not
5343 expanded, because the value is literal text. However, it can be done by giving
5344 the value in quotes. For example:
5345 .code
5346 local_interfaces = "<\n 127.0.0.1 \n ::1"
5347 .endd
5348 Unlike printing character separators, which can be included in list items by
5349 doubling, it is not possible to include a control character as data when it is
5350 set as the separator. Two such characters in succession are interpreted as
5351 enclosing an empty list item.
5352
5353
5354
5355 .section "Empty items in lists" "SECTempitelis"
5356 .cindex "list" "empty item in"
5357 An empty item at the end of a list is always ignored. In other words, trailing
5358 separator characters are ignored. Thus, the list in
5359 .code
5360 senders = user@domain :
5361 .endd
5362 contains only a single item. If you want to include an empty string as one item
5363 in a list, it must not be the last item. For example, this list contains three
5364 items, the second of which is empty:
5365 .code
5366 senders = user1@domain : : user2@domain
5367 .endd
5368 &*Note*&: There must be white space between the two colons, as otherwise they
5369 are interpreted as representing a single colon data character (and the list
5370 would then contain just one item). If you want to specify a list that contains
5371 just one, empty item, you can do it as in this example:
5372 .code
5373 senders = :
5374 .endd
5375 In this case, the first item is empty, and the second is discarded because it
5376 is at the end of the list.
5377
5378
5379
5380
5381 .section "Format of driver configurations" "SECTfordricon"
5382 .cindex "drivers" "configuration format"
5383 There are separate parts in the configuration for defining routers, transports,
5384 and authenticators. In each part, you are defining a number of driver
5385 instances, each with its own set of options. Each driver instance is defined by
5386 a sequence of lines like this:
5387 .display
5388 <&'instance name'&>:
5389   <&'option'&>
5390   ...
5391   <&'option'&>
5392 .endd
5393 In the following example, the instance name is &(localuser)&, and it is
5394 followed by three options settings:
5395 .code
5396 localuser:
5397   driver = accept
5398   check_local_user
5399   transport = local_delivery
5400 .endd
5401 For each driver instance, you specify which Exim code module it uses &-- by the
5402 setting of the &%driver%& option &-- and (optionally) some configuration
5403 settings. For example, in the case of transports, if you want a transport to
5404 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5405 a local file you would use the &(appendfile)& driver. Each of the drivers is
5406 described in detail in its own separate chapter later in this manual.
5407
5408 You can have several routers, transports, or authenticators that are based on
5409 the same underlying driver (each must have a different instance name).
5410
5411 The order in which routers are defined is important, because addresses are
5412 passed to individual routers one by one, in order. The order in which
5413 transports are defined does not matter at all. The order in which
5414 authenticators are defined is used only when Exim, as a client, is searching
5415 them to find one that matches an authentication mechanism offered by the
5416 server.
5417
5418 .cindex "generic options"
5419 .cindex "options" "generic &-- definition of"
5420 Within a driver instance definition, there are two kinds of option: &'generic'&
5421 and &'private'&. The generic options are those that apply to all drivers of the
5422 same type (that is, all routers, all transports or all authenticators). The
5423 &%driver%& option is a generic option that must appear in every definition.
5424 .cindex "private options"
5425 The private options are special for each driver, and none need appear, because
5426 they all have default values.
5427
5428 The options may appear in any order, except that the &%driver%& option must
5429 precede any private options, since these depend on the particular driver. For
5430 this reason, it is recommended that &%driver%& always be the first option.
5431
5432 Driver instance names, which are used for reference in log entries and
5433 elsewhere, can be any sequence of letters, digits, and underscores (starting
5434 with a letter) and must be unique among drivers of the same type. A router and
5435 a transport (for example) can each have the same name, but no two router
5436 instances can have the same name. The name of a driver instance should not be
5437 confused with the name of the underlying driver module. For example, the
5438 configuration lines:
5439 .code
5440 remote_smtp:
5441   driver = smtp
5442 .endd
5443 create an instance of the &(smtp)& transport driver whose name is
5444 &(remote_smtp)&. The same driver code can be used more than once, with
5445 different instance names and different option settings each time. A second
5446 instance of the &(smtp)& transport, with different options, might be defined
5447 thus:
5448 .code
5449 special_smtp:
5450   driver = smtp
5451   port = 1234
5452   command_timeout = 10s
5453 .endd
5454 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5455 these transport instances from routers, and these names would appear in log
5456 lines.
5457
5458 Comment lines may be present in the middle of driver specifications. The full
5459 list of option settings for any particular driver instance, including all the
5460 defaulted values, can be extracted by making use of the &%-bP%& command line
5461 option.
5462
5463
5464
5465
5466
5467
5468 . ////////////////////////////////////////////////////////////////////////////
5469 . ////////////////////////////////////////////////////////////////////////////
5470
5471 .chapter "The default configuration file" "CHAPdefconfil"
5472 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5473 .cindex "default" "configuration file &""walk through""&"
5474 The default configuration file supplied with Exim as &_src/configure.default_&
5475 is sufficient for a host with simple mail requirements. As an introduction to
5476 the way Exim is configured, this chapter &"walks through"& the default
5477 configuration, giving brief explanations of the settings. Detailed descriptions
5478 of the options are given in subsequent chapters. The default configuration file
5479 itself contains extensive comments about ways you might want to modify the
5480 initial settings. However, note that there are many options that are not
5481 mentioned at all in the default configuration.
5482
5483
5484
5485 .section "Main configuration settings" "SECTdefconfmain"
5486 The main (global) configuration option settings must always come first in the
5487 file. The first thing you'll see in the file, after some initial comments, is
5488 the line
5489 .code
5490 # primary_hostname =
5491 .endd
5492 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5493 to know the official, fully qualified name of your host, and this is where you
5494 can specify it. However, in most cases you do not need to set this option. When
5495 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5496
5497 The first three non-comment configuration lines are as follows:
5498 .code
5499 domainlist local_domains    = @
5500 domainlist relay_to_domains =
5501 hostlist   relay_from_hosts = 127.0.0.1
5502 .endd
5503 These are not, in fact, option settings. They are definitions of two named
5504 domain lists and one named host list. Exim allows you to give names to lists of
5505 domains, hosts, and email addresses, in order to make it easier to manage the
5506 configuration file (see section &<<SECTnamedlists>>&).
5507
5508 The first line defines a domain list called &'local_domains'&; this is used
5509 later in the configuration to identify domains that are to be delivered
5510 on the local host.
5511
5512 .cindex "@ in a domain list"
5513 There is just one item in this list, the string &"@"&. This is a special form
5514 of entry which means &"the name of the local host"&. Thus, if the local host is
5515 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5516 be delivered locally. Because the local host's name is referenced indirectly,
5517 the same configuration file can be used on different hosts.
5518
5519 The second line defines a domain list called &'relay_to_domains'&, but the
5520 list itself is empty. Later in the configuration we will come to the part that
5521 controls mail relaying through the local host; it allows relaying to any
5522 domains in this list. By default, therefore, no relaying on the basis of a mail
5523 domain is permitted.
5524
5525 The third line defines a host list called &'relay_from_hosts'&. This list is
5526 used later in the configuration to permit relaying from any host or IP address
5527 that matches the list. The default contains just the IP address of the IPv4
5528 loopback interface, which means that processes on the local host are able to
5529 submit mail for relaying by sending it over TCP/IP to that interface. No other
5530 hosts are permitted to submit messages for relaying.
5531
5532 Just to be sure there's no misunderstanding: at this point in the configuration
5533 we aren't actually setting up any controls. We are just defining some domains
5534 and hosts that will be used in the controls that are specified later.
5535
5536 The next two configuration lines are genuine option settings:
5537 .code
5538 acl_smtp_rcpt = acl_check_rcpt
5539 acl_smtp_data = acl_check_data
5540 .endd
5541 These options specify &'Access Control Lists'& (ACLs) that are to be used
5542 during an incoming SMTP session for every recipient of a message (every RCPT
5543 command), and after the contents of the message have been received,
5544 respectively. The names of the lists are &'acl_check_rcpt'& and
5545 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5546 section of the configuration. The RCPT ACL controls which recipients are
5547 accepted for an incoming message &-- if a configuration does not provide an ACL
5548 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5549 contents of a message to be checked.
5550
5551 Two commented-out option settings are next:
5552 .code
5553 # av_scanner = clamd:/tmp/clamd
5554 # spamd_address = 127.0.0.1 783
5555 .endd
5556 These are example settings that can be used when Exim is compiled with the
5557 content-scanning extension. The first specifies the interface to the virus
5558 scanner, and the second specifies the interface to SpamAssassin. Further
5559 details are given in chapter &<<CHAPexiscan>>&.
5560
5561 Three more commented-out option settings follow:
5562 .code
5563 # tls_advertise_hosts = *
5564 # tls_certificate = /etc/ssl/exim.crt
5565 # tls_privatekey = /etc/ssl/exim.pem
5566 .endd
5567 These are example settings that can be used when Exim is compiled with
5568 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5569 first one specifies the list of clients that are allowed to use TLS when
5570 connecting to this server; in this case the wildcard means all clients. The
5571 other options specify where Exim should find its TLS certificate and private
5572 key, which together prove the server's identity to any clients that connect.
5573 More details are given in chapter &<<CHAPTLS>>&.
5574
5575 Another two commented-out option settings follow:
5576 .code
5577 # daemon_smtp_ports = 25 : 465 : 587
5578 # tls_on_connect_ports = 465
5579 .endd
5580 .cindex "port" "465 and 587"
5581 .cindex "port" "for message submission"
5582 .cindex "message" "submission, ports for"
5583 .cindex "ssmtp protocol"
5584 .cindex "smtps protocol"
5585 .cindex "SMTP" "ssmtp protocol"
5586 .cindex "SMTP" "smtps protocol"
5587 These options provide better support for roaming users who wish to use this
5588 server for message submission. They are not much use unless you have turned on
5589 TLS (as described in the previous paragraph) and authentication (about which
5590 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5591 on end-user networks, so RFC 4409 specifies that message submission should use
5592 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5593 configured to use port 587 correctly, so these settings also enable the
5594 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5595 &<<SECTsupobssmt>>&).
5596
5597 Two more commented-out options settings follow:
5598 .code
5599 # qualify_domain =
5600 # qualify_recipient =
5601 .endd
5602 The first of these specifies a domain that Exim uses when it constructs a
5603 complete email address from a local login name. This is often needed when Exim
5604 receives a message from a local process. If you do not set &%qualify_domain%&,
5605 the value of &%primary_hostname%& is used. If you set both of these options,
5606 you can have different qualification domains for sender and recipient
5607 addresses. If you set only the first one, its value is used in both cases.
5608
5609 .cindex "domain literal" "recognizing format"
5610 The following line must be uncommented if you want Exim to recognize
5611 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5612 (an IP address within square brackets) instead of a named domain.
5613 .code
5614 # allow_domain_literals
5615 .endd
5616 The RFCs still require this form, but many people think that in the modern
5617 Internet it makes little sense to permit mail to be sent to specific hosts by
5618 quoting their IP addresses. This ancient format has been used by people who
5619 try to abuse hosts by using them for unwanted relaying. However, some
5620 people believe there are circumstances (for example, messages addressed to
5621 &'postmaster'&) where domain literals are still useful.
5622
5623 The next configuration line is a kind of trigger guard:
5624 .code
5625 never_users = root
5626 .endd
5627 It specifies that no delivery must ever be run as the root user. The normal
5628 convention is to set up &'root'& as an alias for the system administrator. This
5629 setting is a guard against slips in the configuration.
5630 The list of users specified by &%never_users%& is not, however, the complete
5631 list; the build-time configuration in &_Local/Makefile_& has an option called
5632 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5633 contents of &%never_users%& are added to this list. By default
5634 FIXED_NEVER_USERS also specifies root.
5635
5636 When a remote host connects to Exim in order to send mail, the only information
5637 Exim has about the host's identity is its IP address. The next configuration
5638 line,
5639 .code
5640 host_lookup = *
5641 .endd
5642 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5643 in order to get a host name. This improves the quality of the logging
5644 information, but if you feel it is too expensive, you can remove it entirely,
5645 or restrict the lookup to hosts on &"nearby"& networks.
5646 Note that it is not always possible to find a host name from an IP address,
5647 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5648 unreachable.
5649
5650 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5651 1413 (hence their names):
5652 .code
5653 rfc1413_hosts = *
5654 rfc1413_query_timeout = 0s
5655 .endd
5656 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5657 Few hosts offer RFC1413 service these days; calls have to be
5658 terminated by a timeout and this needlessly delays the startup
5659 of an incoming SMTP connection.
5660 If you have hosts for which you trust RFC1413 and need this
5661 information, you can change this.
5662
5663 This line enables an efficiency SMTP option.  It is negotiated by clients
5664 and not expected to cause problems but can be disabled if needed.
5665 .code
5666 prdr_enable = true
5667 .endd
5668
5669 When Exim receives messages over SMTP connections, it expects all addresses to
5670 be fully qualified with a domain, as required by the SMTP definition. However,
5671 if you are running a server to which simple clients submit messages, you may
5672 find that they send unqualified addresses. The two commented-out options:
5673 .code
5674 # sender_unqualified_hosts =
5675 # recipient_unqualified_hosts =
5676 .endd
5677 show how you can specify hosts that are permitted to send unqualified sender
5678 and recipient addresses, respectively.
5679
5680 The &%log_selector%& option is used to increase the detail of logging
5681 over the default:
5682 .code
5683 log_selector = +smtp_protocol_error +smtp_syntax_error \
5684                +tls_certificate_verified
5685 .endd
5686
5687 The &%percent_hack_domains%& option is also commented out:
5688 .code
5689 # percent_hack_domains =
5690 .endd
5691 It provides a list of domains for which the &"percent hack"& is to operate.
5692 This is an almost obsolete form of explicit email routing. If you do not know
5693 anything about it, you can safely ignore this topic.
5694
5695 The next two settings in the main part of the default configuration are
5696 concerned with messages that have been &"frozen"& on Exim's queue. When a
5697 message is frozen, Exim no longer continues to try to deliver it. Freezing
5698 occurs when a bounce message encounters a permanent failure because the sender
5699 address of the original message that caused the bounce is invalid, so the
5700 bounce cannot be delivered. This is probably the most common case, but there
5701 are also other conditions that cause freezing, and frozen messages are not
5702 always bounce messages.
5703 .code
5704 ignore_bounce_errors_after = 2d
5705 timeout_frozen_after = 7d
5706 .endd
5707 The first of these options specifies that failing bounce messages are to be
5708 discarded after 2 days on the queue. The second specifies that any frozen
5709 message (whether a bounce message or not) is to be timed out (and discarded)
5710 after a week. In this configuration, the first setting ensures that no failing
5711 bounce message ever lasts a week.
5712
5713 Exim queues it's messages in a spool directory. If you expect to have
5714 large queues, you may consider using this option. It splits the spool
5715 directory into subdirectories to avoid file system degradation from
5716 many files in a single directory, resulting in better performance.
5717 Manual manipulation of queued messages becomes more complex (though fortunately
5718 not often needed).
5719 .code
5720 # split_spool_directory = true
5721 .endd
5722
5723 In an ideal world everybody follows the standards. For non-ASCII
5724 messages RFC 2047 is a standard, allowing a maximum line length of 76
5725 characters. Exim adheres that standard and won't process messages which
5726 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5727 In particular, the Exim maintainers have had multiple reports of
5728 problems from Russian administrators of issues until they disable this
5729 check, because of some popular, yet buggy, mail composition software.
5730 .code
5731 # check_rfc2047_length = false
5732 .endd
5733
5734 If you need to be strictly RFC compliant you may wish to disable the
5735 8BITMIME advertisement. Use this, if you exchange mails with systems
5736 that are not 8-bit clean.
5737 .code
5738 # accept_8bitmime = false
5739 .endd
5740
5741 Libraries you use may depend on specific environment settings.  This
5742 imposes a security risk (e.g. PATH). There are two lists:
5743 &%keep_environment%& for the variables to import as they are, and
5744 &%add_environment%& for variables we want to set to a fixed value.
5745 Note that TZ is handled separately, by the $%timezone%$ runtime
5746 option and by the TIMEZONE_DEFAULT buildtime option.
5747 .code
5748 # keep_environment = ^LDAP
5749 # add_environment = PATH=/usr/bin::/bin
5750 .endd
5751
5752
5753 .section "ACL configuration" "SECID54"
5754 .cindex "default" "ACLs"
5755 .cindex "&ACL;" "default configuration"
5756 In the default configuration, the ACL section follows the main configuration.
5757 It starts with the line
5758 .code
5759 begin acl
5760 .endd
5761 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5762 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5763 and &%acl_smtp_data%& above.
5764
5765 .cindex "RCPT" "ACL for"
5766 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5767 RCPT command specifies one of the message's recipients. The ACL statements
5768 are considered in order, until the recipient address is either accepted or
5769 rejected. The RCPT command is then accepted or rejected, according to the
5770 result of the ACL processing.
5771 .code
5772 acl_check_rcpt:
5773 .endd
5774 This line, consisting of a name terminated by a colon, marks the start of the
5775 ACL, and names it.
5776 .code
5777 accept  hosts = :
5778 .endd
5779 This ACL statement accepts the recipient if the sending host matches the list.
5780 But what does that strange list mean? It doesn't actually contain any host
5781 names or IP addresses. The presence of the colon puts an empty item in the
5782 list; Exim matches this only if the incoming message did not come from a remote
5783 host, because in that case, the remote hostname is empty. The colon is
5784 important. Without it, the list itself is empty, and can never match anything.
5785
5786 What this statement is doing is to accept unconditionally all recipients in
5787 messages that are submitted by SMTP from local processes using the standard
5788 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5789 manner.
5790 .code
5791 deny    message       = Restricted characters in address
5792         domains       = +local_domains
5793         local_parts   = ^[.] : ^.*[@%!/|]
5794
5795 deny    message       = Restricted characters in address
5796         domains       = !+local_domains
5797         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5798 .endd
5799 These statements are concerned with local parts that contain any of the
5800 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5801 Although these characters are entirely legal in local parts (in the case of
5802 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5803 in Internet mail addresses.
5804
5805 The first three have in the past been associated with explicitly routed
5806 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5807 option). Addresses containing these characters are regularly tried by spammers
5808 in an attempt to bypass relaying restrictions, and also by open relay testing
5809 programs. Unless you really need them it is safest to reject these characters
5810 at this early stage. This configuration is heavy-handed in rejecting these
5811 characters for all messages it accepts from remote hosts. This is a deliberate
5812 policy of being as safe as possible.
5813
5814 The first rule above is stricter, and is applied to messages that are addressed
5815 to one of the local domains handled by this host. This is implemented by the
5816 first condition, which restricts it to domains that are 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 second condition on the first statement uses two regular expressions to
5822 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5823 or &"|"&. If you have local accounts that include these characters, you will
5824 have to modify this rule.
5825
5826 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5827 allows them because they have been encountered in practice. (Consider the
5828 common convention of local parts constructed as
5829 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5830 the author of Exim, who has no second initial.) However, a local part starting
5831 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5832 file name (for example, for a mailing list). This is also true for local parts
5833 that contain slashes. A pipe symbol can also be troublesome if the local part
5834 is incorporated unthinkingly into a shell command line.
5835
5836 The second rule above applies to all other domains, and is less strict. This
5837 allows your own users to send outgoing messages to sites that use slashes
5838 and vertical bars in their local parts. It blocks local parts that begin
5839 with a dot, slash, or vertical bar, but allows these characters within the
5840 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5841 and &"!"& is blocked, as before. The motivation here is to prevent your users
5842 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5843 .code
5844 accept  local_parts   = postmaster
5845         domains       = +local_domains
5846 .endd
5847 This statement, which has two conditions, accepts an incoming address if the
5848 local part is &'postmaster'& and the domain is one of those listed in the
5849 &'local_domains'& domain list. The &"+"& character is used to indicate a
5850 reference to a named list. In this configuration, there is just one domain in
5851 &'local_domains'&, but in general there may be many.
5852
5853 The presence of this statement means that mail to postmaster is never blocked
5854 by any of the subsequent tests. This can be helpful while sorting out problems
5855 in cases where the subsequent tests are incorrectly denying access.
5856 .code
5857 require verify        = sender
5858 .endd
5859 This statement requires the sender address to be verified before any subsequent
5860 ACL statement can be used. If verification fails, the incoming recipient
5861 address is refused. Verification consists of trying to route the address, to
5862 see if a bounce message could be delivered to it. In the case of remote
5863 addresses, basic verification checks only the domain, but &'callouts'& can be
5864 used for more verification if required. Section &<<SECTaddressverification>>&
5865 discusses the details of address verification.
5866 .code
5867 accept  hosts         = +relay_from_hosts
5868         control       = submission
5869 .endd
5870 This statement accepts the address if the message is coming from one of the
5871 hosts that are defined as being allowed to relay through this host. Recipient
5872 verification is omitted here, because in many cases the clients are dumb MUAs
5873 that do not cope well with SMTP error responses. For the same reason, the
5874 second line specifies &"submission mode"& for messages that are accepted. This
5875 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5876 messages that are deficient in some way, for example, because they lack a
5877 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5878 probably add recipient verification here, and disable submission mode.
5879 .code
5880 accept  authenticated = *
5881         control       = submission
5882 .endd
5883 This statement accepts the address if the client host has authenticated itself.
5884 Submission mode is again specified, on the grounds that such messages are most
5885 likely to come from MUAs. The default configuration does not define any
5886 authenticators, though it does include some nearly complete commented-out
5887 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5888 fact authenticate until you complete the authenticator definitions.
5889 .code
5890 require message = relay not permitted
5891         domains = +local_domains : +relay_to_domains
5892 .endd
5893 This statement rejects the address if its domain is neither a local domain nor
5894 one of the domains for which this host is a relay.
5895 .code
5896 require verify = recipient
5897 .endd
5898 This statement requires the recipient address to be verified; if verification
5899 fails, the address is rejected.
5900 .code
5901 # deny    message     = rejected because $sender_host_address \
5902 #                       is in a black list at $dnslist_domain\n\
5903 #                       $dnslist_text
5904 #         dnslists    = black.list.example
5905 #
5906 # warn    dnslists    = black.list.example
5907 #         add_header  = X-Warning: $sender_host_address is in \
5908 #                       a black list at $dnslist_domain
5909 #         log_message = found in $dnslist_domain
5910 .endd
5911 These commented-out lines are examples of how you could configure Exim to check
5912 sending hosts against a DNS black list. The first statement rejects messages
5913 from blacklisted hosts, whereas the second just inserts a warning header
5914 line.
5915 .code
5916 # require verify = csa
5917 .endd
5918 This commented-out line is an example of how you could turn on client SMTP
5919 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5920 records.
5921 .code
5922 accept
5923 .endd
5924 The final statement in the first ACL unconditionally accepts any recipient
5925 address that has successfully passed all the previous tests.
5926 .code
5927 acl_check_data:
5928 .endd
5929 This line marks the start of the second ACL, and names it. Most of the contents
5930 of this ACL are commented out:
5931 .code
5932 # deny    malware   = *
5933 #         message   = This message contains a virus \
5934 #                     ($malware_name).
5935 .endd
5936 These lines are examples of how to arrange for messages to be scanned for
5937 viruses when Exim has been compiled with the content-scanning extension, and a
5938 suitable virus scanner is installed. If the message is found to contain a
5939 virus, it is rejected with the given custom error message.
5940 .code
5941 # warn    spam      = nobody
5942 #         message   = X-Spam_score: $spam_score\n\
5943 #                     X-Spam_score_int: $spam_score_int\n\
5944 #                     X-Spam_bar: $spam_bar\n\
5945 #                     X-Spam_report: $spam_report
5946 .endd
5947 These lines are an example of how to arrange for messages to be scanned by
5948 SpamAssassin when Exim has been compiled with the content-scanning extension,
5949 and SpamAssassin has been installed. The SpamAssassin check is run with
5950 &`nobody`& as its user parameter, and the results are added to the message as a
5951 series of extra header line. In this case, the message is not rejected,
5952 whatever the spam score.
5953 .code
5954 accept
5955 .endd
5956 This final line in the DATA ACL accepts the message unconditionally.
5957
5958
5959 .section "Router configuration" "SECID55"
5960 .cindex "default" "routers"
5961 .cindex "routers" "default"
5962 The router configuration comes next in the default configuration, introduced
5963 by the line
5964 .code
5965 begin routers
5966 .endd
5967 Routers are the modules in Exim that make decisions about where to send
5968 messages. An address is passed to each router in turn, until it is either
5969 accepted, or failed. This means that the order in which you define the routers
5970 matters. Each router is fully described in its own chapter later in this
5971 manual. Here we give only brief overviews.
5972 .code
5973 # domain_literal:
5974 #   driver = ipliteral
5975 #   domains = !+local_domains
5976 #   transport = remote_smtp
5977 .endd
5978 .cindex "domain literal" "default router"
5979 This router is commented out because the majority of sites do not want to
5980 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5981 you uncomment this router, you also need to uncomment the setting of
5982 &%allow_domain_literals%& in the main part of the configuration.
5983 .code
5984 dnslookup:
5985   driver = dnslookup
5986   domains = ! +local_domains
5987   transport = remote_smtp
5988   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5989   no_more
5990 .endd
5991 The first uncommented router handles addresses that do not involve any local
5992 domains. This is specified by the line
5993 .code
5994 domains = ! +local_domains
5995 .endd
5996 The &%domains%& option lists the domains to which this router applies, but the
5997 exclamation mark is a negation sign, so the router is used only for domains
5998 that are not in the domain list called &'local_domains'& (which was defined at
5999 the start of the configuration). The plus sign before &'local_domains'&
6000 indicates that it is referring to a named list. Addresses in other domains are
6001 passed on to the following routers.
6002
6003 The name of the router driver is &(dnslookup)&,
6004 and is specified by the &%driver%& option. Do not be confused by the fact that
6005 the name of this router instance is the same as the name of the driver. The
6006 instance name is arbitrary, but the name set in the &%driver%& option must be
6007 one of the driver modules that is in the Exim binary.
6008
6009 The &(dnslookup)& router routes addresses by looking up their domains in the
6010 DNS in order to obtain a list of hosts to which the address is routed. If the
6011 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6012 specified by the &%transport%& option. If the router does not find the domain
6013 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6014 the address fails and is bounced.
6015
6016 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6017 be entirely ignored. This option is present because a number of cases have been
6018 encountered where MX records in the DNS point to host names
6019 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6020 Completely ignoring these IP addresses causes Exim to fail to route the
6021 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6022 continue to try to deliver the message periodically until the address timed
6023 out.
6024 .code
6025 system_aliases:
6026   driver = redirect
6027   allow_fail
6028   allow_defer
6029   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6030 # user = exim
6031   file_transport = address_file
6032   pipe_transport = address_pipe
6033 .endd
6034 Control reaches this and subsequent routers only for addresses in the local
6035 domains. This router checks to see whether the local part is defined as an
6036 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6037 data that it looks up from that file. If no data is found for the local part,
6038 the value of the &%data%& option is empty, causing the address to be passed to
6039 the next router.
6040
6041 &_/etc/aliases_& is a conventional name for the system aliases file that is
6042 often used. That is why it is referenced by from the default configuration
6043 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6044 &_Local/Makefile_& before building Exim.
6045 .code
6046 userforward:
6047   driver = redirect
6048   check_local_user
6049 # local_part_suffix = +* : -*
6050 # local_part_suffix_optional
6051   file = $home/.forward
6052 # allow_filter
6053   no_verify
6054   no_expn
6055   check_ancestor
6056   file_transport = address_file
6057   pipe_transport = address_pipe
6058   reply_transport = address_reply
6059 .endd
6060 This is the most complicated router in the default configuration. It is another
6061 redirection router, but this time it is looking for forwarding data set up by
6062 individual users. The &%check_local_user%& setting specifies a check that the
6063 local part of the address is the login name of a local user. If it is not, the
6064 router is skipped. The two commented options that follow &%check_local_user%&,
6065 namely:
6066 .code
6067 # local_part_suffix = +* : -*
6068 # local_part_suffix_optional
6069 .endd
6070 .vindex "&$local_part_suffix$&"
6071 show how you can specify the recognition of local part suffixes. If the first
6072 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6073 by any sequence of characters, is removed from the local part and placed in the
6074 variable &$local_part_suffix$&. The second suffix option specifies that the
6075 presence of a suffix in the local part is optional. When a suffix is present,
6076 the check for a local login uses the local part with the suffix removed.
6077
6078 When a local user account is found, the file called &_.forward_& in the user's
6079 home directory is consulted. If it does not exist, or is empty, the router
6080 declines. Otherwise, the contents of &_.forward_& are interpreted as
6081 redirection data (see chapter &<<CHAPredirect>>& for more details).
6082
6083 .cindex "Sieve filter" "enabling in default router"
6084 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6085 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6086 is commented out by default), the contents of the file are interpreted as a set
6087 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6088 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6089 separate document entitled &'Exim's interfaces to mail filtering'&.
6090
6091 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6092 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6093 There are two reasons for doing this:
6094
6095 .olist
6096 Whether or not a local user has a &_.forward_& file is not really relevant when
6097 checking an address for validity; it makes sense not to waste resources doing
6098 unnecessary work.
6099 .next
6100 More importantly, when Exim is verifying addresses or handling an EXPN
6101 command during an SMTP session, it is running as the Exim user, not as root.
6102 The group is the Exim group, and no additional groups are set up.
6103 It may therefore not be possible for Exim to read users' &_.forward_& files at
6104 this time.
6105 .endlist
6106
6107 The setting of &%check_ancestor%& prevents the router from generating a new
6108 address that is the same as any previous address that was redirected. (This
6109 works round a problem concerning a bad interaction between aliasing and
6110 forwarding &-- see section &<<SECTredlocmai>>&).
6111
6112 The final three option settings specify the transports that are to be used when
6113 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6114 auto-reply, respectively. For example, if a &_.forward_& file contains
6115 .code
6116 a.nother@elsewhere.example, /home/spqr/archive
6117 .endd
6118 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6119 transport.
6120 .code
6121 localuser:
6122   driver = accept
6123   check_local_user
6124 # local_part_suffix = +* : -*
6125 # local_part_suffix_optional
6126   transport = local_delivery
6127 .endd
6128 The final router sets up delivery into local mailboxes, provided that the local
6129 part is the name of a local login, by accepting the address and assigning it to
6130 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6131 routers, so the address is bounced. The commented suffix settings fulfil the
6132 same purpose as they do for the &(userforward)& router.
6133
6134
6135 .section "Transport configuration" "SECID56"
6136 .cindex "default" "transports"
6137 .cindex "transports" "default"
6138 Transports define mechanisms for actually delivering messages. They operate
6139 only when referenced from routers, so the order in which they are defined does
6140 not matter. The transports section of the configuration starts with
6141 .code
6142 begin transports
6143 .endd
6144 One remote transport and four local transports are defined.
6145 .code
6146 remote_smtp:
6147   driver = smtp
6148   hosts_try_prdr = *
6149 .endd
6150 This transport is used for delivering messages over SMTP connections.
6151 The list of remote hosts comes from the router.
6152 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6153 It is negotiated between client and server
6154 and not expected to cause problems but can be disabled if needed.
6155 All other options are defaulted.
6156 .code
6157 local_delivery:
6158   driver = appendfile
6159   file = /var/mail/$local_part
6160   delivery_date_add
6161   envelope_to_add
6162   return_path_add
6163 # group = mail
6164 # mode = 0660
6165 .endd
6166 This &(appendfile)& transport is used for local delivery to user mailboxes in
6167 traditional BSD mailbox format. By default it runs under the uid and gid of the
6168 local user, which requires the sticky bit to be set on the &_/var/mail_&
6169 directory. Some systems use the alternative approach of running mail deliveries
6170 under a particular group instead of using the sticky bit. The commented options
6171 show how this can be done.
6172
6173 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6174 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6175 similarly-named options above.
6176 .code
6177 address_pipe:
6178   driver = pipe
6179   return_output
6180 .endd
6181 This transport is used for handling deliveries to pipes that are generated by
6182 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6183 option specifies that any output on stdout or stderr generated by the pipe is to
6184 be returned to the sender.
6185 .code
6186 address_file:
6187   driver = appendfile
6188   delivery_date_add
6189   envelope_to_add
6190   return_path_add
6191 .endd
6192 This transport is used for handling deliveries to files that are generated by
6193 redirection. The name of the file is not specified in this instance of
6194 &(appendfile)&, because it comes from the &(redirect)& router.
6195 .code
6196 address_reply:
6197   driver = autoreply
6198 .endd
6199 This transport is used for handling automatic replies generated by users'
6200 filter files.
6201
6202
6203
6204 .section "Default retry rule" "SECID57"
6205 .cindex "retry" "default rule"
6206 .cindex "default" "retry rule"
6207 The retry section of the configuration file contains rules which affect the way
6208 Exim retries deliveries that cannot be completed at the first attempt. It is
6209 introduced by the line
6210 .code
6211 begin retry
6212 .endd
6213 In the default configuration, there is just one rule, which applies to all
6214 errors:
6215 .code
6216 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6217 .endd
6218 This causes any temporarily failing address to be retried every 15 minutes for
6219 2 hours, then at intervals starting at one hour and increasing by a factor of
6220 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6221 is not delivered after 4 days of temporary failure, it is bounced. The time is
6222 measured from first failure, not from the time the message was received.
6223
6224 If the retry section is removed from the configuration, or is empty (that is,
6225 if no retry rules are defined), Exim will not retry deliveries. This turns
6226 temporary errors into permanent errors.
6227
6228
6229 .section "Rewriting configuration" "SECID58"
6230 The rewriting section of the configuration, introduced by
6231 .code
6232 begin rewrite
6233 .endd
6234 contains rules for rewriting addresses in messages as they arrive. There are no
6235 rewriting rules in the default configuration file.
6236
6237
6238
6239 .section "Authenticators configuration" "SECTdefconfauth"
6240 .cindex "AUTH" "configuration"
6241 The authenticators section of the configuration, introduced by
6242 .code
6243 begin authenticators
6244 .endd
6245 defines mechanisms for the use of the SMTP AUTH command. The default
6246 configuration file contains two commented-out example authenticators
6247 which support plaintext username/password authentication using the
6248 standard PLAIN mechanism and the traditional but non-standard LOGIN
6249 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6250 to support most MUA software.
6251
6252 The example PLAIN authenticator looks like this:
6253 .code
6254 #PLAIN:
6255 #  driver                  = plaintext
6256 #  server_set_id           = $auth2
6257 #  server_prompts          = :
6258 #  server_condition        = Authentication is not yet configured
6259 #  server_advertise_condition = ${if def:tls_in_cipher }
6260 .endd
6261 And the example LOGIN authenticator looks like this:
6262 .code
6263 #LOGIN:
6264 #  driver                  = plaintext
6265 #  server_set_id           = $auth1
6266 #  server_prompts          = <| Username: | Password:
6267 #  server_condition        = Authentication is not yet configured
6268 #  server_advertise_condition = ${if def:tls_in_cipher }
6269 .endd
6270
6271 The &%server_set_id%& option makes Exim remember the authenticated username
6272 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6273 &%server_prompts%& option configures the &(plaintext)& authenticator so
6274 that it implements the details of the specific authentication mechanism,
6275 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6276 when Exim offers authentication to clients; in the examples, this is only
6277 when TLS or SSL has been started, so to enable the authenticators you also
6278 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6279
6280 The &%server_condition%& setting defines how to verify that the username and
6281 password are correct. In the examples it just produces an error message.
6282 To make the authenticators work, you can use a string expansion
6283 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6284
6285 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6286 usercode and password are in different positions.
6287 Chapter &<<CHAPplaintext>>& covers both.
6288
6289 .ecindex IIDconfiwal
6290
6291
6292
6293 . ////////////////////////////////////////////////////////////////////////////
6294 . ////////////////////////////////////////////////////////////////////////////
6295
6296 .chapter "Regular expressions" "CHAPregexp"
6297
6298 .cindex "regular expressions" "library"
6299 .cindex "PCRE"
6300 Exim supports the use of regular expressions in many of its options. It
6301 uses the PCRE regular expression library; this provides regular expression
6302 matching that is compatible with Perl 5. The syntax and semantics of
6303 regular expressions is discussed in
6304 .new
6305 online Perl manpages, in
6306 .wen
6307 many Perl reference books, and also in
6308 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6309 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6310
6311 The documentation for the syntax and semantics of the regular expressions that
6312 are supported by PCRE is included in the PCRE distribution, and no further
6313 description is included here. The PCRE functions are called from Exim using
6314 the default option settings (that is, with no PCRE options set), except that
6315 the PCRE_CASELESS option is set when the matching is required to be
6316 case-insensitive.
6317
6318 In most cases, when a regular expression is required in an Exim configuration,
6319 it has to start with a circumflex, in order to distinguish it from plain text
6320 or an &"ends with"& wildcard. In this example of a configuration setting, the
6321 second item in the colon-separated list is a regular expression.
6322 .code
6323 domains = a.b.c : ^\\d{3} : *.y.z : ...
6324 .endd
6325 The doubling of the backslash is required because of string expansion that
6326 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6327 of this issue, and a way of avoiding the need for doubling backslashes. The
6328 regular expression that is eventually used in this example contains just one
6329 backslash. The circumflex is included in the regular expression, and has the
6330 normal effect of &"anchoring"& it to the start of the string that is being
6331 matched.
6332
6333 There are, however, two cases where a circumflex is not required for the
6334 recognition of a regular expression: these are the &%match%& condition in a
6335 string expansion, and the &%matches%& condition in an Exim filter file. In
6336 these cases, the relevant string is always treated as a regular expression; if
6337 it does not start with a circumflex, the expression is not anchored, and can
6338 match anywhere in the subject string.
6339
6340 In all cases, if you want a regular expression to match at the end of a string,
6341 you must code the $ metacharacter to indicate this. For example:
6342 .code
6343 domains = ^\\d{3}\\.example
6344 .endd
6345 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6346 You need to use:
6347 .code
6348 domains = ^\\d{3}\\.example\$
6349 .endd
6350 if you want &'example'& to be the top-level domain. The backslash before the
6351 $ is needed because string expansion also interprets dollar characters.
6352
6353
6354
6355 . ////////////////////////////////////////////////////////////////////////////
6356 . ////////////////////////////////////////////////////////////////////////////
6357
6358 .chapter "File and database lookups" "CHAPfdlookup"
6359 .scindex IIDfidalo1 "file" "lookups"
6360 .scindex IIDfidalo2 "database" "lookups"
6361 .cindex "lookup" "description of"
6362 Exim can be configured to look up data in files or databases as it processes
6363 messages. Two different kinds of syntax are used:
6364
6365 .olist
6366 A string that is to be expanded may contain explicit lookup requests. These
6367 cause parts of the string to be replaced by data that is obtained from the
6368 lookup. Lookups of this type are conditional expansion items. Different results
6369 can be defined for the cases of lookup success and failure. See chapter
6370 &<<CHAPexpand>>&, where string expansions are described in detail.
6371 The key for the lookup is specified as part of the string expansion.
6372 .next
6373 Lists of domains, hosts, and email addresses can contain lookup requests as a
6374 way of avoiding excessively long linear lists. In this case, the data that is
6375 returned by the lookup is often (but not always) discarded; whether the lookup
6376 succeeds or fails is what really counts. These kinds of list are described in
6377 chapter &<<CHAPdomhosaddlists>>&.
6378 The key for the lookup is given by the context in which the list is expanded.
6379 .endlist
6380
6381 String expansions, lists, and lookups interact with each other in such a way
6382 that there is no order in which to describe any one of them that does not
6383 involve references to the others. Each of these three chapters makes more sense
6384 if you have read the other two first. If you are reading this for the first
6385 time, be aware that some of it will make a lot more sense after you have read
6386 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6387
6388 .section "Examples of different lookup syntax" "SECID60"
6389 It is easy to confuse the two different kinds of lookup, especially as the
6390 lists that may contain the second kind are always expanded before being
6391 processed as lists. Therefore, they may also contain lookups of the first kind.
6392 Be careful to distinguish between the following two examples:
6393 .code
6394 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6395 domains = lsearch;/some/file
6396 .endd
6397 The first uses a string expansion, the result of which must be a domain list.
6398 No strings have been specified for a successful or a failing lookup; the
6399 defaults in this case are the looked-up data and an empty string, respectively.
6400 The expansion takes place before the string is processed as a list, and the
6401 file that is searched could contain lines like this:
6402 .code
6403 192.168.3.4: domain1:domain2:...
6404 192.168.1.9: domain3:domain4:...
6405 .endd
6406 When the lookup succeeds, the result of the expansion is a list of domains (and
6407 possibly other types of item that are allowed in domain lists).
6408
6409 In the second example, the lookup is a single item in a domain list. It causes
6410 Exim to use a lookup to see if the domain that is being processed can be found
6411 in the file. The file could contains lines like this:
6412 .code
6413 domain1:
6414 domain2:
6415 .endd
6416 Any data that follows the keys is not relevant when checking that the domain
6417 matches the list item.
6418
6419 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6420 Consider a file containing lines like this:
6421 .code
6422 192.168.5.6: lsearch;/another/file
6423 .endd
6424 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6425 first &%domains%& setting above generates the second setting, which therefore
6426 causes a second lookup to occur.
6427
6428 The rest of this chapter describes the different lookup types that are
6429 available. Any of them can be used in any part of the configuration where a
6430 lookup is permitted.
6431
6432
6433 .section "Lookup types" "SECID61"
6434 .cindex "lookup" "types of"
6435 .cindex "single-key lookup" "definition of"
6436 Two different types of data lookup are implemented:
6437
6438 .ilist
6439 The &'single-key'& type requires the specification of a file in which to look,
6440 and a single key to search for. The key must be a non-empty string for the
6441 lookup to succeed. The lookup type determines how the file is searched.
6442 .next
6443 .cindex "query-style lookup" "definition of"
6444 The &'query-style'& type accepts a generalized database query. No particular
6445 key value is assumed by Exim for query-style lookups. You can use whichever
6446 Exim variables you need to construct the database query.
6447 .endlist
6448
6449 The code for each lookup type is in a separate source file that is included in
6450 the binary of Exim only if the corresponding compile-time option is set. The
6451 default settings in &_src/EDITME_& are:
6452 .code
6453 LOOKUP_DBM=yes
6454 LOOKUP_LSEARCH=yes
6455 .endd
6456 which means that only linear searching and DBM lookups are included by default.
6457 For some types of lookup (e.g. SQL databases), you need to install appropriate
6458 libraries and header files before building Exim.
6459
6460
6461
6462
6463 .section "Single-key lookup types" "SECTsinglekeylookups"
6464 .cindex "lookup" "single-key types"
6465 .cindex "single-key lookup" "list of types"
6466 The following single-key lookup types are implemented:
6467
6468 .ilist
6469 .cindex "cdb" "description of"
6470 .cindex "lookup" "cdb"
6471 .cindex "binary zero" "in lookup key"
6472 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6473 string without a terminating binary zero. The cdb format is designed for
6474 indexed files that are read frequently and never updated, except by total
6475 re-creation. As such, it is particularly suitable for large files containing
6476 aliases or other indexed data referenced by an MTA. Information about cdb can
6477 be found in several places:
6478 .display
6479 &url(http://www.pobox.com/~djb/cdb.html)
6480 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6481 &url(http://packages.debian.org/stable/utils/freecdb.html)
6482 .endd
6483 A cdb distribution is not needed in order to build Exim with cdb support,
6484 because the code for reading cdb files is included directly in Exim itself.
6485 However, no means of building or testing cdb files is provided with Exim, so
6486 you need to obtain a cdb distribution in order to do this.
6487 .next
6488 .cindex "DBM" "lookup type"
6489 .cindex "lookup" "dbm"
6490 .cindex "binary zero" "in lookup key"
6491 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6492 DBM file by looking up the record with the given key. A terminating binary
6493 zero is included in the key that is passed to the DBM library. See section
6494 &<<SECTdb>>& for a discussion of DBM libraries.
6495
6496 .cindex "Berkeley DB library" "file format"
6497 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6498 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6499 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6500 the DB_UNKNOWN option. This enables it to handle any of the types of database
6501 that the library supports, and can be useful for accessing DBM files created by
6502 other applications. (For earlier DB versions, DB_HASH is always used.)
6503 .next
6504 .cindex "lookup" "dbmjz"
6505 .cindex "lookup" "dbm &-- embedded NULs"
6506 .cindex "sasldb2"
6507 .cindex "dbmjz lookup type"
6508 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6509 interpreted as an Exim list; the elements of the list are joined together with
6510 ASCII NUL characters to form the lookup key.  An example usage would be to
6511 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6512 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6513 &(cram_md5)& authenticator.
6514 .next
6515 .cindex "lookup" "dbmnz"
6516 .cindex "lookup" "dbm &-- terminating zero"
6517 .cindex "binary zero" "in lookup key"
6518 .cindex "Courier"
6519 .cindex "&_/etc/userdbshadow.dat_&"
6520 .cindex "dbmnz lookup type"
6521 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6522 is not included in the key that is passed to the DBM library. You may need this
6523 if you want to look up data in files that are created by or shared with some
6524 other application that does not use terminating zeros. For example, you need to
6525 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6526 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6527 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6528 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6529 .next
6530 .cindex "lookup" "dsearch"
6531 .cindex "dsearch lookup type"
6532 &(dsearch)&: The given file must be a directory; this is searched for an entry
6533 whose name is the key by calling the &[lstat()]& function. The key may not
6534 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6535 the lookup is the name of the entry, which may be a file, directory,
6536 symbolic link, or any other kind of directory entry. An example of how this
6537 lookup can be used to support virtual domains is given in section
6538 &<<SECTvirtualdomains>>&.
6539 .next
6540 .cindex "lookup" "iplsearch"
6541 .cindex "iplsearch lookup type"
6542 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6543 terminated by a colon or white space or the end of the line. The keys in the
6544 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6545 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6546 being interpreted as a key terminator. For example:
6547 .code
6548 1.2.3.4:           data for 1.2.3.4
6549 192.168.0.0/16:    data for 192.168.0.0/16
6550 "abcd::cdab":      data for abcd::cdab
6551 "abcd:abcd::/32"   data for abcd:abcd::/32
6552 .endd
6553 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6554 file is searched linearly, using the CIDR masks where present, until a matching
6555 key is found. The first key that matches is used; there is no attempt to find a
6556 &"best"& match. Apart from the way the keys are matched, the processing for
6557 &(iplsearch)& is the same as for &(lsearch)&.
6558
6559 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6560 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6561 lookup types support only literal keys.
6562
6563 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6564 the implicit key is the host's IP address rather than its name (see section
6565 &<<SECThoslispatsikey>>&).
6566 .next
6567 .cindex "linear search"
6568 .cindex "lookup" "lsearch"
6569 .cindex "lsearch lookup type"
6570 .cindex "case sensitivity" "in lsearch lookup"
6571 &(lsearch)&: The given file is a text file that is searched linearly for a
6572 line beginning with the search key, terminated by a colon or white space or the
6573 end of the line. The search is case-insensitive; that is, upper and lower case
6574 letters are treated as the same. The first occurrence of the key that is found
6575 in the file is used.
6576
6577 White space between the key and the colon is permitted. The remainder of the
6578 line, with leading and trailing white space removed, is the data. This can be
6579 continued onto subsequent lines by starting them with any amount of white
6580 space, but only a single space character is included in the data at such a
6581 junction. If the data begins with a colon, the key must be terminated by a
6582 colon, for example:
6583 .code
6584 baduser:  :fail:
6585 .endd
6586 Empty lines and lines beginning with # are ignored, even if they occur in the
6587 middle of an item. This is the traditional textual format of alias files. Note
6588 that the keys in an &(lsearch)& file are literal strings. There is no
6589 wildcarding of any kind.
6590
6591 .cindex "lookup" "lsearch &-- colons in keys"
6592 .cindex "white space" "in lsearch key"
6593 In most &(lsearch)& files, keys are not required to contain colons or #
6594 characters, or white space. However, if you need this feature, it is available.
6595 If a key begins with a doublequote character, it is terminated only by a
6596 matching quote (or end of line), and the normal escaping rules apply to its
6597 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6598 quoted keys (exactly as for unquoted keys). There is no special handling of
6599 quotes for the data part of an &(lsearch)& line.
6600
6601 .next
6602 .cindex "NIS lookup type"
6603 .cindex "lookup" "NIS"
6604 .cindex "binary zero" "in lookup key"
6605 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6606 the given key, without a terminating binary zero. There is a variant called
6607 &(nis0)& which does include the terminating binary zero in the key. This is
6608 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6609 aliases; the full map names must be used.
6610
6611 .next
6612 .cindex "wildlsearch lookup type"
6613 .cindex "lookup" "wildlsearch"
6614 .cindex "nwildlsearch lookup type"
6615 .cindex "lookup" "nwildlsearch"
6616 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6617 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6618 the file may be wildcarded. The difference between these two lookup types is
6619 that for &(wildlsearch)&, each key in the file is string-expanded before being
6620 used, whereas for &(nwildlsearch)&, no expansion takes place.
6621
6622 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6623 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6624 file that are regular expressions can be made case-sensitive by the use of
6625 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6626
6627 . ==== As this is a nested list, any displays it contains must be indented
6628 . ==== as otherwise they are too far to the left.
6629
6630 .olist
6631 The string may begin with an asterisk to mean &"ends with"&. For example:
6632 .code
6633     *.a.b.c       data for anything.a.b.c
6634     *fish         data for anythingfish
6635 .endd
6636 .next
6637 The string may begin with a circumflex to indicate a regular expression. For
6638 example, for &(wildlsearch)&:
6639 .code
6640     ^\N\d+\.a\.b\N    data for <digits>.a.b
6641 .endd
6642 Note the use of &`\N`& to disable expansion of the contents of the regular
6643 expression. If you are using &(nwildlsearch)&, where the keys are not
6644 string-expanded, the equivalent entry is:
6645 .code
6646     ^\d+\.a\.b        data for <digits>.a.b
6647 .endd
6648 The case-insensitive flag is set at the start of compiling the regular
6649 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6650 For example, to make the entire pattern case-sensitive:
6651 .code
6652     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6653 .endd
6654
6655 If the regular expression contains white space or colon characters, you must
6656 either quote it (see &(lsearch)& above), or represent these characters in other
6657 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6658 colon. This may be easier than quoting, because if you quote, you have to
6659 escape all the backslashes inside the quotes.
6660
6661 &*Note*&: It is not possible to capture substrings in a regular expression
6662 match for later use, because the results of all lookups are cached. If a lookup
6663 is repeated, the result is taken from the cache, and no actual pattern matching
6664 takes place. The values of all the numeric variables are unset after a
6665 &((n)wildlsearch)& match.
6666
6667 .next
6668 Although I cannot see it being of much use, the general matching function that
6669 is used to implement &((n)wildlsearch)& means that the string may begin with a
6670 lookup name terminated by a semicolon, and followed by lookup data. For
6671 example:
6672 .code
6673     cdb;/some/file  data for keys that match the file
6674 .endd
6675 The data that is obtained from the nested lookup is discarded.
6676 .endlist olist
6677
6678 Keys that do not match any of these patterns are interpreted literally. The
6679 continuation rules for the data are the same as for &(lsearch)&, and keys may
6680 be followed by optional colons.
6681
6682 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6683 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6684 lookup types support only literal keys.
6685 .endlist ilist
6686
6687
6688 .section "Query-style lookup types" "SECTquerystylelookups"
6689 .cindex "lookup" "query-style types"
6690 .cindex "query-style lookup" "list of types"
6691 The supported query-style lookup types are listed below. Further details about
6692 many of them are given in later sections.
6693
6694 .ilist
6695 .cindex "DNS" "as a lookup type"
6696 .cindex "lookup" "DNS"
6697 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6698 are given in the supplied query. The resulting data is the contents of the
6699 records. See section &<<SECTdnsdb>>&.
6700 .next
6701 .cindex "InterBase lookup type"
6702 .cindex "lookup" "InterBase"
6703 &(ibase)&: This does a lookup in an InterBase database.
6704 .next
6705 .cindex "LDAP" "lookup type"
6706 .cindex "lookup" "LDAP"
6707 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6708 returns attributes from a single entry. There is a variant called &(ldapm)&
6709 that permits values from multiple entries to be returned. A third variant
6710 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6711 any attribute values. See section &<<SECTldap>>&.
6712 .next
6713 .cindex "MySQL" "lookup type"
6714 .cindex "lookup" "MySQL"
6715 &(mysql)&: The format of the query is an SQL statement that is passed to a
6716 MySQL database. See section &<<SECTsql>>&.
6717 .next
6718 .cindex "NIS+ lookup type"
6719 .cindex "lookup" "NIS+"
6720 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6721 the field to be returned. See section &<<SECTnisplus>>&.
6722 .next
6723 .cindex "Oracle" "lookup type"
6724 .cindex "lookup" "Oracle"
6725 &(oracle)&: The format of the query is an SQL statement that is passed to an
6726 Oracle database. See section &<<SECTsql>>&.
6727 .next
6728 .cindex "lookup" "passwd"
6729 .cindex "passwd lookup type"
6730 .cindex "&_/etc/passwd_&"
6731 &(passwd)& is a query-style lookup with queries that are just user names. The
6732 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6733 success, the result string is the same as you would get from an &(lsearch)&
6734 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6735 password value. For example:
6736 .code
6737 *:42:42:King Rat:/home/kr:/bin/bash
6738 .endd
6739 .next
6740 .cindex "PostgreSQL lookup type"
6741 .cindex "lookup" "PostgreSQL"
6742 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6743 PostgreSQL database. See section &<<SECTsql>>&.
6744
6745 .next
6746 .cindex "Redis lookup type"
6747 .cindex lookup Redis
6748 &(redis)&: The format of the query is an SQL statement that is passed to a
6749 Redis database. See section &<<SECTsql>>&.
6750
6751 .next
6752 .cindex "sqlite lookup type"
6753 .cindex "lookup" "sqlite"
6754 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6755 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6756
6757 .next
6758 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6759 not likely to be useful in normal operation.
6760 .next
6761 .cindex "whoson lookup type"
6762 .cindex "lookup" "whoson"
6763 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6764 allows a server to check whether a particular (dynamically allocated) IP
6765 address is currently allocated to a known (trusted) user and, optionally, to
6766 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6767 at one time for &"POP before SMTP"& authentication, but that approach has been
6768 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6769 &"POP before SMTP"& checking using ACL statements such as
6770 .code
6771 require condition = \
6772   ${lookup whoson {$sender_host_address}{yes}{no}}
6773 .endd
6774 The query consists of a single IP address. The value returned is the name of
6775 the authenticated user, which is stored in the variable &$value$&. However, in
6776 this example, the data in &$value$& is not used; the result of the lookup is
6777 one of the fixed strings &"yes"& or &"no"&.
6778 .endlist
6779
6780
6781
6782 .section "Temporary errors in lookups" "SECID63"
6783 .cindex "lookup" "temporary error in"
6784 Lookup functions can return temporary error codes if the lookup cannot be
6785 completed. For example, an SQL or LDAP database might be unavailable. For this
6786 reason, it is not advisable to use a lookup that might do this for critical
6787 options such as a list of local domains.
6788
6789 When a lookup cannot be completed in a router or transport, delivery
6790 of the message (to the relevant address) is deferred, as for any other
6791 temporary error. In other circumstances Exim may assume the lookup has failed,
6792 or may give up altogether.
6793
6794
6795
6796 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6797 .cindex "wildcard lookups"
6798 .cindex "lookup" "default values"
6799 .cindex "lookup" "wildcard"
6800 .cindex "lookup" "* added to type"
6801 .cindex "default" "in single-key lookups"
6802 In this context, a &"default value"& is a value specified by the administrator
6803 that is to be used if a lookup fails.
6804
6805 &*Note:*& This section applies only to single-key lookups. For query-style
6806 lookups, the facilities of the query language must be used. An attempt to
6807 specify a default for a query-style lookup provokes an error.
6808
6809 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6810 and the initial lookup fails, the key &"*"& is looked up in the file to
6811 provide a default value. See also the section on partial matching below.
6812
6813 .cindex "*@ with single-key lookup"
6814 .cindex "lookup" "*@ added to type"
6815 .cindex "alias file" "per-domain default"
6816 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6817 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6818 character, a second lookup is done with everything before the last @ replaced
6819 by *. This makes it possible to provide per-domain defaults in alias files
6820 that include the domains in the keys. If the second lookup fails (or doesn't
6821 take place because there is no @ in the key), &"*"& is looked up.
6822 For example, a &(redirect)& router might contain:
6823 .code
6824 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6825 .endd
6826 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6827 looks up these keys, in this order:
6828 .code
6829 jane@eyre.example
6830 *@eyre.example
6831 *
6832 .endd
6833 The data is taken from whichever key it finds first. &*Note*&: In an
6834 &(lsearch)& file, this does not mean the first of these keys in the file. A
6835 complete scan is done for each key, and only if it is not found at all does
6836 Exim move on to try the next key.
6837
6838
6839
6840 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6841 .cindex "partial matching"
6842 .cindex "wildcard lookups"
6843 .cindex "lookup" "partial matching"
6844 .cindex "lookup" "wildcard"
6845 .cindex "asterisk" "in search type"
6846 The normal operation of a single-key lookup is to search the file for an exact
6847 match with the given key. However, in a number of situations where domains are
6848 being looked up, it is useful to be able to do partial matching. In this case,
6849 information in the file that has a key starting with &"*."& is matched by any
6850 domain that ends with the components that follow the full stop. For example, if
6851 a key in a DBM file is
6852 .code
6853 *.dates.fict.example
6854 .endd
6855 then when partial matching is enabled this is matched by (amongst others)
6856 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6857 by &'dates.fict.example'&, if that does not appear as a separate key in the
6858 file.
6859
6860 &*Note*&: Partial matching is not available for query-style lookups. It is
6861 also not available for any lookup items in address lists (see section
6862 &<<SECTaddresslist>>&).
6863
6864 Partial matching is implemented by doing a series of separate lookups using
6865 keys constructed by modifying the original subject key. This means that it can
6866 be used with any of the single-key lookup types, provided that
6867 partial matching keys
6868 beginning with a special prefix (default &"*."&) are included in the data file.
6869 Keys in the file that do not begin with the prefix are matched only by
6870 unmodified subject keys when partial matching is in use.
6871
6872 Partial matching is requested by adding the string &"partial-"& to the front of
6873 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6874 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6875 is added at the start of the subject key, and it is looked up again. If that
6876 fails, further lookups are tried with dot-separated components removed from the
6877 start of the subject key, one-by-one, and &"*."& added on the front of what
6878 remains.
6879
6880 A minimum number of two non-* components are required. This can be adjusted
6881 by including a number before the hyphen in the search type. For example,
6882 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6883 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6884 subject key is &'2250.dates.fict.example'& then the following keys are looked
6885 up when the minimum number of non-* components is two:
6886 .code
6887 2250.dates.fict.example
6888 *.2250.dates.fict.example
6889 *.dates.fict.example
6890 *.fict.example
6891 .endd
6892 As soon as one key in the sequence is successfully looked up, the lookup
6893 finishes.
6894
6895 .cindex "lookup" "partial matching &-- changing prefix"
6896 .cindex "prefix" "for partial matching"
6897 The use of &"*."& as the partial matching prefix is a default that can be
6898 changed. The motivation for this feature is to allow Exim to operate with file
6899 formats that are used by other MTAs. A different prefix can be supplied in
6900 parentheses instead of the hyphen after &"partial"&. For example:
6901 .code
6902 domains = partial(.)lsearch;/some/file
6903 .endd
6904 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6905 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6906 components is unchanged). The prefix may consist of any punctuation characters
6907 other than a closing parenthesis. It may be empty, for example:
6908 .code
6909 domains = partial1()cdb;/some/file
6910 .endd
6911 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6912 &`a.b.c`&, &`b.c`&, and &`c`&.
6913
6914 If &"partial0"& is specified, what happens at the end (when the lookup with
6915 just one non-wild component has failed, and the original key is shortened right
6916 down to the null string) depends on the prefix:
6917
6918 .ilist
6919 If the prefix has zero length, the whole lookup fails.
6920 .next
6921 If the prefix has length 1, a lookup for just the prefix is done. For
6922 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6923 .next
6924 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6925 remainder is looked up. With the default prefix, therefore, the final lookup is
6926 for &"*"& on its own.
6927 .next
6928 Otherwise, the whole prefix is looked up.
6929 .endlist
6930
6931
6932 If the search type ends in &"*"& or &"*@"& (see section
6933 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6934 this implies happens after all partial lookups have failed. If &"partial0"& is
6935 specified, adding &"*"& to the search type has no effect with the default
6936 prefix, because the &"*"& key is already included in the sequence of partial
6937 lookups. However, there might be a use for lookup types such as
6938 &"partial0(.)lsearch*"&.
6939
6940 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6941 in domain lists and the like. Partial matching works only in terms of
6942 dot-separated components; a key such as &`*fict.example`&
6943 in a database file is useless, because the asterisk in a partial matching
6944 subject key is always followed by a dot.
6945
6946
6947
6948
6949 .section "Lookup caching" "SECID64"
6950 .cindex "lookup" "caching"
6951 .cindex "caching" "lookup data"
6952 Exim caches all lookup results in order to avoid needless repetition of
6953 lookups. However, because (apart from the daemon) Exim operates as a collection
6954 of independent, short-lived processes, this caching applies only within a
6955 single Exim process. There is no inter-process lookup caching facility.
6956
6957 For single-key lookups, Exim keeps the relevant files open in case there is
6958 another lookup that needs them. In some types of configuration this can lead to
6959 many files being kept open for messages with many recipients. To avoid hitting
6960 the operating system limit on the number of simultaneously open files, Exim
6961 closes the least recently used file when it needs to open more files than its
6962 own internal limit, which can be changed via the &%lookup_open_max%& option.
6963
6964 The single-key lookup files are closed and the lookup caches are flushed at
6965 strategic points during delivery &-- for example, after all routing is
6966 complete.
6967
6968
6969
6970
6971 .section "Quoting lookup data" "SECID65"
6972 .cindex "lookup" "quoting"
6973 .cindex "quoting" "in lookups"
6974 When data from an incoming message is included in a query-style lookup, there
6975 is the possibility of special characters in the data messing up the syntax of
6976 the query. For example, a NIS+ query that contains
6977 .code
6978 [name=$local_part]
6979 .endd
6980 will be broken if the local part happens to contain a closing square bracket.
6981 For NIS+, data can be enclosed in double quotes like this:
6982 .code
6983 [name="$local_part"]
6984 .endd
6985 but this still leaves the problem of a double quote in the data. The rule for
6986 NIS+ is that double quotes must be doubled. Other lookup types have different
6987 rules, and to cope with the differing requirements, an expansion operator
6988 of the following form is provided:
6989 .code
6990 ${quote_<lookup-type>:<string>}
6991 .endd
6992 For example, the safest way to write the NIS+ query is
6993 .code
6994 [name="${quote_nisplus:$local_part}"]
6995 .endd
6996 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6997 operator can be used for all lookup types, but has no effect for single-key
6998 lookups, since no quoting is ever needed in their key strings.
6999
7000
7001
7002
7003 .section "More about dnsdb" "SECTdnsdb"
7004 .cindex "dnsdb lookup"
7005 .cindex "lookup" "dnsdb"
7006 .cindex "DNS" "as a lookup type"
7007 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7008 of a record type and a domain name, separated by an equals sign. For example,
7009 an expansion string could contain:
7010 .code
7011 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7012 .endd
7013 If the lookup succeeds, the result is placed in &$value$&, which in this case
7014 is used on its own as the result. If the lookup does not succeed, the
7015 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7016 &<<SECTforexpfai>>& for an explanation of what this means.
7017
7018 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7019 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7020 If no type is given, TXT is assumed.
7021
7022 For any record type, if multiple records are found, the data is returned as a
7023 concatenation, with newline as the default separator. The order, of course,
7024 depends on the DNS resolver. You can specify a different separator character
7025 between multiple records by putting a right angle-bracket followed immediately
7026 by the new separator at the start of the query. For example:
7027 .code
7028 ${lookup dnsdb{>: a=host1.example}}
7029 .endd
7030 It is permitted to specify a space as the separator character. Further
7031 white space is ignored.
7032 For lookup types that return multiple fields per record,
7033 an alternate field separator can be specified using a comma after the main
7034 separator character, followed immediately by the field separator.
7035
7036 .cindex "PTR record" "in &(dnsdb)& lookup"
7037 When the type is PTR,
7038 the data can be an IP address, written as normal; inversion and the addition of
7039 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7040 .code
7041 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7042 .endd
7043 If the data for a PTR record is not a syntactically valid IP address, it is not
7044 altered and nothing is added.
7045
7046 .cindex "MX record" "in &(dnsdb)& lookup"
7047 .cindex "SRV record" "in &(dnsdb)& lookup"
7048 For an MX lookup, both the preference value and the host name are returned for
7049 each record, separated by a space. For an SRV lookup, the priority, weight,
7050 port, and host name are returned for each record, separated by spaces.
7051 The field separator can be modified as above.
7052
7053 .cindex "TXT record" "in &(dnsdb)& lookup"
7054 .cindex "SPF record" "in &(dnsdb)& lookup"
7055 For TXT records with multiple items of data, only the first item is returned,
7056 unless a field separator is specified.
7057 To concatenate items without a separator, use a semicolon instead.
7058 For SPF records the
7059 default behaviour is to concatenate multiple items without using a separator.
7060 .code
7061 ${lookup dnsdb{>\n,: txt=a.b.example}}
7062 ${lookup dnsdb{>\n; txt=a.b.example}}
7063 ${lookup dnsdb{spf=example.org}}
7064 .endd
7065 It is permitted to specify a space as the separator character. Further
7066 white space is ignored.
7067
7068 .cindex "SOA record" "in &(dnsdb)& lookup"
7069 For an SOA lookup, while no result is obtained the lookup is redone with
7070 successively more leading components dropped from the given domain.
7071 Only the primary-nameserver field is returned unless a field separator is
7072 specified.
7073 .code
7074 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7075 .endd
7076
7077 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7078 .cindex "dnsdb modifiers"
7079 .cindex "modifiers" "dnsdb"
7080 .cindex "options" "dnsdb"
7081 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7082 each followed by a comma,
7083 that may appear before the record type.
7084
7085 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7086 temporary DNS error for any of them, the behaviour is controlled by
7087 a defer-option modifier.
7088 The possible keywords are
7089 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7090 With &"strict"& behaviour, any temporary DNS error causes the
7091 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7092 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7093 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7094 error causes the whole lookup to defer only if none of the other lookups
7095 succeed. The default is &"lax"&, so the following lookups are equivalent:
7096 .code
7097 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7098 ${lookup dnsdb{a=one.host.com:two.host.com}}
7099 .endd
7100 Thus, in the default case, as long as at least one of the DNS lookups
7101 yields some data, the lookup succeeds.
7102
7103 .cindex "DNSSEC" "dns lookup"
7104 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7105 The possible keywords are
7106 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7107 With &"strict"& or &"lax"& DNSSEC information is requested
7108 with the lookup.
7109 With &"strict"& a response from the DNS resolver that
7110 is not labelled as authenticated data
7111 is treated as equivalent to a temporary DNS error.
7112 The default is &"never"&.
7113
7114 See also the &$lookup_dnssec_authenticated$& variable.
7115
7116 .cindex timeout "dns lookup"
7117 .cindex "DNS" timeout
7118 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7119 The form is &"retrans_VAL"& where VAL is an Exim time specification
7120 (e.g. &"5s"&).
7121 The default value is set by the main configuration option &%dns_retrans%&.
7122
7123 Retries for the dnsdb lookup can be controlled by a retry modifier.
7124 The form if &"retry_VAL"& where VAL is an integer.
7125 The default count is set by the main configuration option &%dns_retry%&.
7126
7127 .cindex caching "of dns lookup"
7128 .cindex TTL "of dns lookup"
7129 .cindex DNS TTL
7130 Dnsdb lookup results are cached within a single process (and its children).
7131 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7132 value of the set of returned DNS records.
7133
7134
7135 .section "Pseudo dnsdb record types" "SECID66"
7136 .cindex "MX record" "in &(dnsdb)& lookup"
7137 By default, both the preference value and the host name are returned for
7138 each MX record, separated by a space. If you want only host names, you can use
7139 the pseudo-type MXH:
7140 .code
7141 ${lookup dnsdb{mxh=a.b.example}}
7142 .endd
7143 In this case, the preference values are omitted, and just the host names are
7144 returned.
7145
7146 .cindex "name server for enclosing domain"
7147 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7148 records on the given domain, but if none are found, it removes the first
7149 component of the domain name, and tries again. This process continues until NS
7150 records are found or there are no more components left (or there is a DNS
7151 error). In other words, it may return the name servers for a top-level domain,
7152 but it never returns the root name servers. If there are no NS records for the
7153 top-level domain, the lookup fails. Consider these examples:
7154 .code
7155 ${lookup dnsdb{zns=xxx.quercite.com}}
7156 ${lookup dnsdb{zns=xxx.edu}}
7157 .endd
7158 Assuming that in each case there are no NS records for the full domain name,
7159 the first returns the name servers for &%quercite.com%&, and the second returns
7160 the name servers for &%edu%&.
7161
7162 You should be careful about how you use this lookup because, unless the
7163 top-level domain does not exist, the lookup always returns some host names. The
7164 sort of use to which this might be put is for seeing if the name servers for a
7165 given domain are on a blacklist. You can probably assume that the name servers
7166 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7167 such a list.
7168
7169 .cindex "CSA" "in &(dnsdb)& lookup"
7170 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7171 records according to the CSA rules, which are described in section
7172 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7173 not sufficient because of the extra parent domain search behaviour of CSA. The
7174 result of a successful lookup such as:
7175 .code
7176 ${lookup dnsdb {csa=$sender_helo_name}}
7177 .endd
7178 has two space-separated fields: an authorization code and a target host name.
7179 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7180 authorization required but absent, or &"?"& for unknown.
7181
7182 .cindex "A+" "in &(dnsdb)& lookup"
7183 The pseudo-type A+ performs an AAAA
7184 and then an A lookup.  All results are returned; defer processing
7185 (see below) is handled separately for each lookup.  Example:
7186 .code
7187 ${lookup dnsdb {>; a+=$sender_helo_name}}
7188 .endd
7189
7190
7191 .section "Multiple dnsdb lookups" "SECID67"
7192 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7193 However, you can specify a list of domains or IP addresses in a single
7194 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7195 the default separator, but with the ability to change this. For example:
7196 .code
7197 ${lookup dnsdb{one.domain.com:two.domain.com}}
7198 ${lookup dnsdb{a=one.host.com:two.host.com}}
7199 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7200 .endd
7201 In order to retain backwards compatibility, there is one special case: if
7202 the lookup type is PTR and no change of separator is specified, Exim looks
7203 to see if the rest of the string is precisely one IPv6 address. In this
7204 case, it does not treat it as a list.
7205
7206 The data from each lookup is concatenated, with newline separators by default,
7207 in the same way that multiple DNS records for a single item are handled. A
7208 different separator can be specified, as described above.
7209
7210
7211
7212
7213 .section "More about LDAP" "SECTldap"
7214 .cindex "LDAP" "lookup, more about"
7215 .cindex "lookup" "LDAP"
7216 .cindex "Solaris" "LDAP"
7217 The original LDAP implementation came from the University of Michigan; this has
7218 become &"Open LDAP"&, and there are now two different releases. Another
7219 implementation comes from Netscape, and Solaris 7 and subsequent releases
7220 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7221 the lookup function level, their error handling is different. For this reason
7222 it is necessary to set a compile-time variable when building Exim with LDAP, to
7223 indicate which LDAP library is in use. One of the following should appear in
7224 your &_Local/Makefile_&:
7225 .code
7226 LDAP_LIB_TYPE=UMICHIGAN
7227 LDAP_LIB_TYPE=OPENLDAP1
7228 LDAP_LIB_TYPE=OPENLDAP2
7229 LDAP_LIB_TYPE=NETSCAPE
7230 LDAP_LIB_TYPE=SOLARIS
7231 .endd
7232 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7233 same interface as the University of Michigan version.
7234
7235 There are three LDAP lookup types in Exim. These behave slightly differently in
7236 the way they handle the results of a query:
7237
7238 .ilist
7239 &(ldap)& requires the result to contain just one entry; if there are more, it
7240 gives an error.
7241 .next
7242 &(ldapdn)& also requires the result to contain just one entry, but it is the
7243 Distinguished Name that is returned rather than any attribute values.
7244 .next
7245 &(ldapm)& permits the result to contain more than one entry; the attributes
7246 from all of them are returned.
7247 .endlist
7248
7249
7250 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7251 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7252 the data returned by a successful lookup is described in the next section.
7253 First we explain how LDAP queries are coded.
7254
7255
7256 .section "Format of LDAP queries" "SECTforldaque"
7257 .cindex "LDAP" "query format"
7258 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7259 the configuration of a &(redirect)& router one might have this setting:
7260 .code
7261 data = ${lookup ldap \
7262   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7263   c=UK?mailbox?base?}}
7264 .endd
7265 .cindex "LDAP" "with TLS"
7266 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7267 secure (encrypted) LDAP connections. The second of these ensures that an
7268 encrypted TLS connection is used.
7269
7270 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7271 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7272 See the &%ldap_start_tls%& option.
7273
7274 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7275 controlled. Every part of the TLS configuration can be configured by settings in
7276 &_exim.conf_&. Depending on the version of the client libraries installed on
7277 your system, some of the initialization may have required setting options in
7278 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7279 certificates. This revealed a nuance where the current UID that exim was
7280 running as could affect which config files it read. With Exim 4.83, these
7281 methods become optional, only taking effect if not specifically set in
7282 &_exim.conf_&.
7283
7284
7285 .section "LDAP quoting" "SECID68"
7286 .cindex "LDAP" "quoting"
7287 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7288 and the second because the LDAP query is represented as a URL. Furthermore,
7289 within an LDAP query, two different kinds of quoting are required. For this
7290 reason, there are two different LDAP-specific quoting operators.
7291
7292 The &%quote_ldap%& operator is designed for use on strings that are part of
7293 filter specifications. Conceptually, it first does the following conversions on
7294 the string:
7295 .code
7296 *   =>   \2A
7297 (   =>   \28
7298 )   =>   \29
7299 \   =>   \5C
7300 .endd
7301 in accordance with RFC 2254. The resulting string is then quoted according
7302 to the rules for URLs, that is, all non-alphanumeric characters except
7303 .code
7304 ! $ ' - . _ ( ) * +
7305 .endd
7306 are converted to their hex values, preceded by a percent sign. For example:
7307 .code
7308 ${quote_ldap: a(bc)*, a<yz>; }
7309 .endd
7310 yields
7311 .code
7312 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7313 .endd
7314 Removing the URL quoting, this is (with a leading and a trailing space):
7315 .code
7316 a\28bc\29\2A, a<yz>;
7317 .endd
7318 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7319 base DN specifications in queries. Conceptually, it first converts the string
7320 by inserting a backslash in front of any of the following characters:
7321 .code
7322 , + " \ < > ;
7323 .endd
7324 It also inserts a backslash before any leading spaces or # characters, and
7325 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7326 is then quoted according to the rules for URLs. For example:
7327 .code
7328 ${quote_ldap_dn: a(bc)*, a<yz>; }
7329 .endd
7330 yields
7331 .code
7332 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7333 .endd
7334 Removing the URL quoting, this is (with a trailing space):
7335 .code
7336 \ a(bc)*\, a\<yz\>\;\
7337 .endd
7338 There are some further comments about quoting in the section on LDAP
7339 authentication below.
7340
7341
7342 .section "LDAP connections" "SECID69"
7343 .cindex "LDAP" "connections"
7344 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7345 is in use, via a Unix domain socket. The example given above does not specify
7346 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7347 by starting it with
7348 .code
7349 ldap://<hostname>:<port>/...
7350 .endd
7351 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7352 used. When no server is specified in a query, a list of default servers is
7353 taken from the &%ldap_default_servers%& configuration option. This supplies a
7354 colon-separated list of servers which are tried in turn until one successfully
7355 handles a query, or there is a serious error. Successful handling either
7356 returns the requested data, or indicates that it does not exist. Serious errors
7357 are syntactical, or multiple values when only a single value is expected.
7358 Errors which cause the next server to be tried are connection failures, bind
7359 failures, and timeouts.
7360
7361 For each server name in the list, a port number can be given. The standard way
7362 of specifying a host and port is to use a colon separator (RFC 1738). Because
7363 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7364 doubled. For example
7365 .code
7366 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7367 .endd
7368 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7369 to the LDAP library with no server name, and the library's default (normally
7370 the local host) is used.
7371
7372 If you are using the OpenLDAP library, you can connect to an LDAP server using
7373 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7374 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7375 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7376 not available.
7377
7378 For this type of connection, instead of a host name for the server, a pathname
7379 for the socket is required, and the port number is not relevant. The pathname
7380 can be specified either as an item in &%ldap_default_servers%&, or inline in
7381 the query. In the former case, you can have settings such as
7382 .code
7383 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7384 .endd
7385 When the pathname is given in the query, you have to escape the slashes as
7386 &`%2F`& to fit in with the LDAP URL syntax. For example:
7387 .code
7388 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7389 .endd
7390 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7391 a pathname, it uses the Unix domain socket code, even if the query actually
7392 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7393 socket connection. This behaviour means that you can use a setting of
7394 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7395 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7396 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7397 backup host.
7398
7399 If an explicit &`ldapi`& type is given in a query when a host name is
7400 specified, an error is diagnosed. However, if there are more items in
7401 &%ldap_default_servers%&, they are tried. In other words:
7402
7403 .ilist
7404 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7405 interface.
7406 .next
7407 Using &`ldapi`& with a host name causes an error.
7408 .endlist
7409
7410
7411 Using &`ldapi`& with no host or path in the query, and no setting of
7412 &%ldap_default_servers%&, does whatever the library does by default.
7413
7414
7415
7416 .section "LDAP authentication and control information" "SECID70"
7417 .cindex "LDAP" "authentication"
7418 The LDAP URL syntax provides no way of passing authentication and other control
7419 information to the server. To make this possible, the URL in an LDAP query may
7420 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7421 spaces. If a value contains spaces it must be enclosed in double quotes, and
7422 when double quotes are used, backslash is interpreted in the usual way inside
7423 them. The following names are recognized:
7424 .display
7425 &`DEREFERENCE`&  set the dereferencing parameter
7426 &`NETTIME    `&  set a timeout for a network operation
7427 &`USER       `&  set the DN, for authenticating the LDAP bind
7428 &`PASS       `&  set the password, likewise
7429 &`REFERRALS  `&  set the referrals parameter
7430 &`SERVERS    `&  set alternate server list for this query only
7431 &`SIZE       `&  set the limit for the number of entries returned
7432 &`TIME       `&  set the maximum waiting time for a query
7433 .endd
7434 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7435 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7436 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7437 library from trying to follow referrals issued by the LDAP server.
7438
7439 .cindex LDAP timeout
7440 .cindex timeout "LDAP lookup"
7441 The name CONNECT is an obsolete name for NETTIME, retained for
7442 backwards compatibility. This timeout (specified as a number of seconds) is
7443 enforced from the client end for operations that can be carried out over a
7444 network. Specifically, it applies to network connections and calls to the
7445 &'ldap_result()'& function. If the value is greater than zero, it is used if
7446 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7447 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7448 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7449 Netscape SDK; for OpenLDAP no action is taken.
7450
7451 The TIME parameter (also a number of seconds) is passed to the server to
7452 set a server-side limit on the time taken to complete a search.
7453
7454 The SERVERS parameter allows you to specify an alternate list of ldap servers
7455 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7456 default list of ldap servers, and a single lookup can specify a single ldap
7457 server to use.  But when you need to do a lookup with a list of servers that is
7458 different than the default list (maybe different order, maybe a completely
7459 different set of servers), the SERVERS parameter allows you to specify this
7460 alternate list (colon-separated).
7461
7462 Here is an example of an LDAP query in an Exim lookup that uses some of these
7463 values. This is a single line, folded to fit on the page:
7464 .code
7465 ${lookup ldap
7466   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7467   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7468   {$value}fail}
7469 .endd
7470 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7471 any of the auxiliary data. Exim configuration settings that include lookups
7472 which contain password information should be preceded by &"hide"& to prevent
7473 non-admin users from using the &%-bP%& option to see their values.
7474
7475 The auxiliary data items may be given in any order. The default is no
7476 connection timeout (the system timeout is used), no user or password, no limit
7477 on the number of entries returned, and no time limit on queries.
7478
7479 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7480 removes any URL quoting that it may contain before passing it LDAP. Apparently
7481 some libraries do this for themselves, but some do not. Removing the URL
7482 quoting has two advantages:
7483
7484 .ilist
7485 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7486 DNs as with DNs inside actual queries.
7487 .next
7488 It permits spaces inside USER= DNs.
7489 .endlist
7490
7491 For example, a setting such as
7492 .code
7493 USER=cn=${quote_ldap_dn:$1}
7494 .endd
7495 should work even if &$1$& contains spaces.
7496
7497 Expanded data for the PASS= value should be quoted using the &%quote%&
7498 expansion operator, rather than the LDAP quote operators. The only reason this
7499 field needs quoting is to ensure that it conforms to the Exim syntax, which
7500 does not allow unquoted spaces. For example:
7501 .code
7502 PASS=${quote:$3}
7503 .endd
7504 The LDAP authentication mechanism can be used to check passwords as part of
7505 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7506 &<<CHAPexpand>>&.
7507
7508
7509
7510 .section "Format of data returned by LDAP" "SECID71"
7511 .cindex "LDAP" "returned data formats"
7512 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7513 as a sequence of values, for example
7514 .code
7515 cn=manager,o=University of Cambridge,c=UK
7516 .endd
7517 The &(ldap)& lookup type generates an error if more than one entry matches the
7518 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7519 the result between the data from different entries. It is possible for multiple
7520 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7521 you know that whatever values are returned all came from a single entry in the
7522 directory.
7523
7524 In the common case where you specify a single attribute in your LDAP query, the
7525 result is not quoted, and does not contain the attribute name. If the attribute
7526 has multiple values, they are separated by commas. Any comma that is
7527 part of an attribute's value is doubled.
7528
7529 If you specify multiple attributes, the result contains space-separated, quoted
7530 strings, each preceded by the attribute name and an equals sign. Within the
7531 quotes, the quote character, backslash, and newline are escaped with
7532 backslashes, and commas are used to separate multiple values for the attribute.
7533 Any commas in attribute values are doubled
7534 (permitting treatment of the values as a comma-separated list).
7535 Apart from the escaping, the string within quotes takes the same form as the
7536 output when a single attribute is requested. Specifying no attributes is the
7537 same as specifying all of an entry's attributes.
7538
7539 Here are some examples of the output format. The first line of each pair is an
7540 LDAP query, and the second is the data that is returned. The attribute called
7541 &%attr1%& has two values, one of them with an embedded comma, whereas
7542 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7543 (they have SUP &%attr%& in their schema definitions).
7544
7545 .code
7546 ldap:///o=base?attr1?sub?(uid=fred)
7547 value1.1,value1,,2
7548
7549 ldap:///o=base?attr2?sub?(uid=fred)
7550 value two
7551
7552 ldap:///o=base?attr?sub?(uid=fred)
7553 value1.1,value1,,2,value two
7554
7555 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7556 attr1="value1.1,value1,,2" attr2="value two"
7557
7558 ldap:///o=base??sub?(uid=fred)
7559 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7560 .endd
7561 You can
7562 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7563 results of LDAP lookups.
7564 The &%extract%& operator in string expansions can be used to pick out
7565 individual fields from data that consists of &'key'&=&'value'& pairs.
7566 The &%listextract%& operator should be used to pick out individual values
7567 of attributes, even when only a single value is expected.
7568 The doubling of embedded commas allows you to use the returned data as a
7569 comma separated list (using the "<," syntax for changing the input list separator).
7570
7571
7572
7573
7574 .section "More about NIS+" "SECTnisplus"
7575 .cindex "NIS+ lookup type"
7576 .cindex "lookup" "NIS+"
7577 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7578 and field name. If this is given, the result of a successful query is the
7579 contents of the named field; otherwise the result consists of a concatenation
7580 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7581 values containing spaces are quoted. For example, the query
7582 .code
7583 [name=mg1456],passwd.org_dir
7584 .endd
7585 might return the string
7586 .code
7587 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7588 home=/home/mg1456 shell=/bin/bash shadow=""
7589 .endd
7590 (split over two lines here to fit on the page), whereas
7591 .code
7592 [name=mg1456],passwd.org_dir:gcos
7593 .endd
7594 would just return
7595 .code
7596 Martin Guerre
7597 .endd
7598 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7599 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7600 operator is to double any quote characters within the text.
7601
7602
7603
7604 .section "SQL lookups" "SECTsql"
7605 .cindex "SQL lookup types"
7606 .cindex "MySQL" "lookup type"
7607 .cindex "PostgreSQL lookup type"
7608 .cindex "lookup" "MySQL"
7609 .cindex "lookup" "PostgreSQL"
7610 .cindex "Oracle" "lookup type"
7611 .cindex "lookup" "Oracle"
7612 .cindex "InterBase lookup type"
7613 .cindex "lookup" "InterBase"
7614 .cindex "Redis lookup type"
7615 .cindex lookup Redis
7616 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7617 and SQLite
7618 databases. Queries for these databases contain SQL statements, so an example
7619 might be
7620 .code
7621 ${lookup mysql{select mailbox from users where id='userx'}\
7622   {$value}fail}
7623 .endd
7624 If the result of the query contains more than one field, the data for each
7625 field in the row is returned, preceded by its name, so the result of
7626 .code
7627 ${lookup pgsql{select home,name from users where id='userx'}\
7628   {$value}}
7629 .endd
7630 might be
7631 .code
7632 home=/home/userx name="Mister X"
7633 .endd
7634 Empty values and values containing spaces are double quoted, with embedded
7635 quotes escaped by a backslash. If the result of the query contains just one
7636 field, the value is passed back verbatim, without a field name, for example:
7637 .code
7638 Mister X
7639 .endd
7640 If the result of the query yields more than one row, it is all concatenated,
7641 with a newline between the data for each row.
7642
7643
7644 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7645 .cindex "MySQL" "lookup type"
7646 .cindex "PostgreSQL lookup type"
7647 .cindex "lookup" "MySQL"
7648 .cindex "lookup" "PostgreSQL"
7649 .cindex "Oracle" "lookup type"
7650 .cindex "lookup" "Oracle"
7651 .cindex "InterBase lookup type"
7652 .cindex "lookup" "InterBase"
7653 .cindex "Redis lookup type"
7654 .cindex lookup Redis
7655 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7656 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7657 or &%redis_servers%&
7658 option (as appropriate) must be set to a colon-separated list of server
7659 information.
7660 (For MySQL and PostgreSQL, the global option need not be set if all
7661 queries contain their own server information &-- see section
7662 &<<SECTspeserque>>&.)
7663 For all but Redis
7664 each item in the list is a slash-separated list of four
7665 items: host name, database name, user name, and password. In the case of
7666 Oracle, the host name field is used for the &"service name"&, and the database
7667 name field is not used and should be empty. For example:
7668 .code
7669 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7670 .endd
7671 Because password data is sensitive, you should always precede the setting with
7672 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7673 option. Here is an example where two MySQL servers are listed:
7674 .code
7675 hide mysql_servers = localhost/users/root/secret:\
7676                      otherhost/users/root/othersecret
7677 .endd
7678 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7679 because this is a colon-separated list, the colon has to be doubled. For each
7680 query, these parameter groups are tried in order until a connection is made and
7681 a query is successfully processed. The result of a query may be that no data is
7682 found, but that is still a successful query. In other words, the list of
7683 servers provides a backup facility, not a list of different places to look.
7684
7685 For Redis the global option need not be specified if all queries contain their
7686 own server information &-- see section &<<SECTspeserque>>&.
7687 If specified, the option must be set to a colon-separated list of server
7688 information.
7689 Each item in the list is a slash-separated list of three items:
7690 host, database number, and password.
7691 .olist
7692 The host is required and may be either an IPv4 address and optional
7693 port number (separated by a colon, which needs doubling due to the
7694 higher-level list), or a Unix socket pathname enclosed in parentheses
7695 .next
7696 The database number is optional; if present that number is selected in the backend
7697 .next
7698 The password is optional; if present it is used to authenticate to the backend
7699 .endlist
7700
7701 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7702 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7703 respectively, and the characters single-quote, double-quote, and backslash
7704 itself are escaped with backslashes.
7705
7706 The &%quote_redis%& expansion operator
7707 escapes whitespace and backslash characters with a backslash.
7708
7709 .section "Specifying the server in the query" "SECTspeserque"
7710 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7711 it is possible to specify a list of servers with an individual query. This is
7712 done by starting the query with
7713 .display
7714 &`servers=`&&'server1:server2:server3:...'&&`;`&
7715 .endd
7716 Each item in the list may take one of two forms:
7717 .olist
7718 If it contains no slashes it is assumed to be just a host name. The appropriate
7719 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7720 of the same name, and the remaining parameters (database, user, password) are
7721 taken from there.
7722 .next
7723 If it contains any slashes, it is taken as a complete parameter set.
7724 .endlist
7725 The list of servers is used in exactly the same way as the global list.
7726 Once a connection to a server has happened and a query has been
7727 successfully executed, processing of the lookup ceases.
7728
7729 This feature is intended for use in master/slave situations where updates
7730 are occurring and you want to update the master rather than a slave. If the
7731 master is in the list as a backup for reading, you might have a global setting
7732 like this:
7733 .code
7734 mysql_servers = slave1/db/name/pw:\
7735                 slave2/db/name/pw:\
7736                 master/db/name/pw
7737 .endd
7738 In an updating lookup, you could then write:
7739 .code
7740 ${lookup mysql{servers=master; UPDATE ...} }
7741 .endd
7742 That query would then be sent only to the master server. If, on the other hand,
7743 the master is not to be used for reading, and so is not present in the global
7744 option, you can still update it by a query of this form:
7745 .code
7746 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7747 .endd
7748
7749
7750 .section "Special MySQL features" "SECID73"
7751 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7752 causes a connection to the server on the local host by means of a Unix domain
7753 socket. An alternate socket can be specified in parentheses.
7754 An option group name for MySQL option files can be specified in square brackets;
7755 the default value is &"exim"&.
7756 The full syntax of each item in &%mysql_servers%& is:
7757 .display
7758 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7759   <&'database'&>/<&'user'&>/<&'password'&>
7760 .endd
7761 Any of the four sub-parts of the first field can be omitted. For normal use on
7762 the local host it can be left blank or set to just &"localhost"&.
7763
7764 No database need be supplied &-- but if it is absent here, it must be given in
7765 the queries.
7766
7767 If a MySQL query is issued that does not request any data (an insert, update,
7768 or delete command), the result of the lookup is the number of rows affected.
7769
7770 &*Warning*&: This can be misleading. If an update does not actually change
7771 anything (for example, setting a field to the value it already has), the result
7772 is zero because no rows are affected.
7773
7774
7775 .section "Special PostgreSQL features" "SECID74"
7776 PostgreSQL lookups can also use Unix domain socket connections to the database.
7777 This is usually faster and costs less CPU time than a TCP/IP connection.
7778 However it can be used only if the mail server runs on the same machine as the
7779 database server. A configuration line for PostgreSQL via Unix domain sockets
7780 looks like this:
7781 .code
7782 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7783 .endd
7784 In other words, instead of supplying a host name, a path to the socket is
7785 given. The path name is enclosed in parentheses so that its slashes aren't
7786 visually confused with the delimiters for the other server parameters.
7787
7788 If a PostgreSQL query is issued that does not request any data (an insert,
7789 update, or delete command), the result of the lookup is the number of rows
7790 affected.
7791
7792 .section "More about SQLite" "SECTsqlite"
7793 .cindex "lookup" "SQLite"
7794 .cindex "sqlite lookup type"
7795 SQLite is different to the other SQL lookups because a file name is required in
7796 addition to the SQL query. An SQLite database is a single file, and there is no
7797 daemon as in the other SQL databases. The interface to Exim requires the name
7798 of the file, as an absolute path, to be given at the start of the query. It is
7799 separated from the query by white space. This means that the path name cannot
7800 contain white space. Here is a lookup expansion example:
7801 .code
7802 ${lookup sqlite {/some/thing/sqlitedb \
7803   select name from aliases where id='userx';}}
7804 .endd
7805 In a list, the syntax is similar. For example:
7806 .code
7807 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7808    select * from relays where ip='$sender_host_address';
7809 .endd
7810 The only character affected by the &%quote_sqlite%& operator is a single
7811 quote, which it doubles.
7812
7813 .cindex timeout SQLite
7814 .cindex sqlite "lookup timeout"
7815 The SQLite library handles multiple simultaneous accesses to the database
7816 internally. Multiple readers are permitted, but only one process can
7817 update at once. Attempts to access the database while it is being updated
7818 are rejected after a timeout period, during which the SQLite library
7819 waits for the lock to be released. In Exim, the default timeout is set
7820 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7821 option.
7822 .ecindex IIDfidalo1
7823 .ecindex IIDfidalo2
7824
7825
7826 . ////////////////////////////////////////////////////////////////////////////
7827 . ////////////////////////////////////////////////////////////////////////////
7828
7829 .chapter "Domain, host, address, and local part lists" &&&
7830          "CHAPdomhosaddlists" &&&
7831          "Domain, host, and address lists"
7832 .scindex IIDdohoadli "lists of domains; hosts; etc."
7833 A number of Exim configuration options contain lists of domains, hosts,
7834 email addresses, or local parts. For example, the &%hold_domains%& option
7835 contains a list of domains whose delivery is currently suspended. These lists
7836 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7837 arguments to expansion conditions such as &%match_domain%&.
7838
7839 Each item in one of these lists is a pattern to be matched against a domain,
7840 host, email address, or local part, respectively. In the sections below, the
7841 different types of pattern for each case are described, but first we cover some
7842 general facilities that apply to all four kinds of list.
7843
7844 Note that other parts of Exim use a &'string list'& which does not
7845 support all the complexity available in
7846 domain, host, address and local part lists.
7847
7848
7849
7850 .section "Expansion of lists" "SECTlistexpand"
7851 .cindex "expansion" "of lists"
7852 Each list is expanded as a single string before it is used.
7853
7854 .new
7855 &'Exception: the router headers_remove option, where list-item
7856 splitting is done before string-expansion.'&
7857 .wen
7858
7859 The result of
7860 expansion must be a list, possibly containing empty items, which is split up
7861 into separate items for matching. By default, colon is the separator character,
7862 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7863 &<<SECTempitelis>>& for details of the list syntax; the second of these
7864 discusses the way to specify empty list items.
7865
7866
7867 If the string expansion is forced to fail, Exim behaves as if the item it is
7868 testing (domain, host, address, or local part) is not in the list. Other
7869 expansion failures cause temporary errors.
7870
7871 If an item in a list is a regular expression, backslashes, dollars and possibly
7872 other special characters in the expression must be protected against
7873 misinterpretation by the string expander. The easiest way to do this is to use
7874 the &`\N`& expansion feature to indicate that the contents of the regular
7875 expression should not be expanded. For example, in an ACL you might have:
7876 .code
7877 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7878                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7879 .endd
7880 The first item is a regular expression that is protected from expansion by
7881 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7882 senders based on the receiving domain.
7883
7884
7885
7886
7887 .section "Negated items in lists" "SECID76"
7888 .cindex "list" "negation"
7889 .cindex "negation" "in lists"
7890 Items in a list may be positive or negative. Negative items are indicated by a
7891 leading exclamation mark, which may be followed by optional white space. A list
7892 defines a set of items (domains, etc). When Exim processes one of these lists,
7893 it is trying to find out whether a domain, host, address, or local part
7894 (respectively) is in the set that is defined by the list. It works like this:
7895
7896 The list is scanned from left to right. If a positive item is matched, the
7897 subject that is being checked is in the set; if a negative item is matched, the
7898 subject is not in the set. If the end of the list is reached without the
7899 subject having matched any of the patterns, it is in the set if the last item
7900 was a negative one, but not if it was a positive one. For example, the list in
7901 .code
7902 domainlist relay_to_domains = !a.b.c : *.b.c
7903 .endd
7904 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7905 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7906 list is positive. However, if the setting were
7907 .code
7908 domainlist relay_to_domains = !a.b.c
7909 .endd
7910 then all domains other than &'a.b.c'& would match because the last item in the
7911 list is negative. In other words, a list that ends with a negative item behaves
7912 as if it had an extra item &`:*`& on the end.
7913
7914 Another way of thinking about positive and negative items in lists is to read
7915 the connector as &"or"& after a positive item and as &"and"& after a negative
7916 item.
7917
7918
7919
7920 .section "File names in lists" "SECTfilnamlis"
7921 .cindex "list" "file name in"
7922 If an item in a domain, host, address, or local part list is an absolute file
7923 name (beginning with a slash character), each line of the file is read and
7924 processed as if it were an independent item in the list, except that further
7925 file names are not allowed,
7926 and no expansion of the data from the file takes place.
7927 Empty lines in the file are ignored, and the file may also contain comment
7928 lines:
7929
7930 .ilist
7931 For domain and host lists, if a # character appears anywhere in a line of the
7932 file, it and all following characters are ignored.
7933 .next
7934 Because local parts may legitimately contain # characters, a comment in an
7935 address list or local part list file is recognized only if # is preceded by
7936 white space or the start of the line. For example:
7937 .code
7938 not#comment@x.y.z   # but this is a comment
7939 .endd
7940 .endlist
7941
7942 Putting a file name in a list has the same effect as inserting each line of the
7943 file as an item in the list (blank lines and comments excepted). However, there
7944 is one important difference: the file is read each time the list is processed,
7945 so if its contents vary over time, Exim's behaviour changes.
7946
7947 If a file name is preceded by an exclamation mark, the sense of any match
7948 within the file is inverted. For example, if
7949 .code
7950 hold_domains = !/etc/nohold-domains
7951 .endd
7952 and the file contains the lines
7953 .code
7954 !a.b.c
7955 *.b.c
7956 .endd
7957 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7958 any domain matching &`*.b.c`& is not.
7959
7960
7961
7962 .section "An lsearch file is not an out-of-line list" "SECID77"
7963 As will be described in the sections that follow, lookups can be used in lists
7964 to provide indexed methods of checking list membership. There has been some
7965 confusion about the way &(lsearch)& lookups work in lists. Because
7966 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7967 sometimes thought that it is allowed to contain wild cards and other kinds of
7968 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7969 always fixed strings, just as for any other single-key lookup type.
7970
7971 If you want to use a file to contain wild-card patterns that form part of a
7972 list, just give the file name on its own, without a search type, as described
7973 in the previous section. You could also use the &(wildlsearch)& or
7974 &(nwildlsearch)&, but there is no advantage in doing this.
7975
7976
7977
7978
7979 .section "Named lists" "SECTnamedlists"
7980 .cindex "named lists"
7981 .cindex "list" "named"
7982 A list of domains, hosts, email addresses, or local parts can be given a name
7983 which is then used to refer to the list elsewhere in the configuration. This is
7984 particularly convenient if the same list is required in several different
7985 places. It also allows lists to be given meaningful names, which can improve
7986 the readability of the configuration. For example, it is conventional to define
7987 a domain list called &'local_domains'& for all the domains that are handled
7988 locally on a host, using a configuration line such as
7989 .code
7990 domainlist local_domains = localhost:my.dom.example
7991 .endd
7992 Named lists are referenced by giving their name preceded by a plus sign, so,
7993 for example, a router that is intended to handle local domains would be
7994 configured with the line
7995 .code
7996 domains = +local_domains
7997 .endd
7998 The first router in a configuration is often one that handles all domains
7999 except the local ones, using a configuration with a negated item like this:
8000 .code
8001 dnslookup:
8002   driver = dnslookup
8003   domains = ! +local_domains
8004   transport = remote_smtp
8005   no_more
8006 .endd
8007 The four kinds of named list are created by configuration lines starting with
8008 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8009 respectively. Then there follows the name that you are defining, followed by an
8010 equals sign and the list itself. For example:
8011 .code
8012 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8013 addresslist bad_senders = cdb;/etc/badsenders
8014 .endd
8015 A named list may refer to other named lists:
8016 .code
8017 domainlist  dom1 = first.example : second.example
8018 domainlist  dom2 = +dom1 : third.example
8019 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8020 .endd
8021 &*Warning*&: If the last item in a referenced list is a negative one, the
8022 effect may not be what you intended, because the negation does not propagate
8023 out to the higher level. For example, consider:
8024 .code
8025 domainlist  dom1 = !a.b
8026 domainlist  dom2 = +dom1 : *.b
8027 .endd
8028 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8029 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8030 means it matches the second list as well. The effect is not the same as
8031 .code
8032 domainlist  dom2 = !a.b : *.b
8033 .endd
8034 where &'x.y'& does not match. It's best to avoid negation altogether in
8035 referenced lists if you can.
8036
8037 Named lists may have a performance advantage. When Exim is routing an
8038 address or checking an incoming message, it caches the result of tests on named
8039 lists. So, if you have a setting such as
8040 .code
8041 domains = +local_domains
8042 .endd
8043 on several of your routers
8044 or in several ACL statements,
8045 the actual test is done only for the first one. However, the caching works only
8046 if there are no expansions within the list itself or any sublists that it
8047 references. In other words, caching happens only for lists that are known to be
8048 the same each time they are referenced.
8049
8050 By default, there may be up to 16 named lists of each type. This limit can be
8051 extended by changing a compile-time variable. The use of domain and host lists
8052 is recommended for concepts such as local domains, relay domains, and relay
8053 hosts. The default configuration is set up like this.
8054
8055
8056
8057 .section "Named lists compared with macros" "SECID78"
8058 .cindex "list" "named compared with macro"
8059 .cindex "macro" "compared with named list"
8060 At first sight, named lists might seem to be no different from macros in the
8061 configuration file. However, macros are just textual substitutions. If you
8062 write
8063 .code
8064 ALIST = host1 : host2
8065 auth_advertise_hosts = !ALIST
8066 .endd
8067 it probably won't do what you want, because that is exactly the same as
8068 .code
8069 auth_advertise_hosts = !host1 : host2
8070 .endd
8071 Notice that the second host name is not negated. However, if you use a host
8072 list, and write
8073 .code
8074 hostlist alist = host1 : host2
8075 auth_advertise_hosts = ! +alist
8076 .endd
8077 the negation applies to the whole list, and so that is equivalent to
8078 .code
8079 auth_advertise_hosts = !host1 : !host2
8080 .endd
8081
8082
8083 .section "Named list caching" "SECID79"
8084 .cindex "list" "caching of named"
8085 .cindex "caching" "named lists"
8086 While processing a message, Exim caches the result of checking a named list if
8087 it is sure that the list is the same each time. In practice, this means that
8088 the cache operates only if the list contains no $ characters, which guarantees
8089 that it will not change when it is expanded. Sometimes, however, you may have
8090 an expanded list that you know will be the same each time within a given
8091 message. For example:
8092 .code
8093 domainlist special_domains = \
8094            ${lookup{$sender_host_address}cdb{/some/file}}
8095 .endd
8096 This provides a list of domains that depends only on the sending host's IP
8097 address. If this domain list is referenced a number of times (for example,
8098 in several ACL lines, or in several routers) the result of the check is not
8099 cached by default, because Exim does not know that it is going to be the
8100 same list each time.
8101
8102 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8103 cache the result anyway. For example:
8104 .code
8105 domainlist_cache special_domains = ${lookup{...
8106 .endd
8107 If you do this, you should be absolutely sure that caching is going to do
8108 the right thing in all cases. When in doubt, leave it out.
8109
8110
8111
8112 .section "Domain lists" "SECTdomainlist"
8113 .cindex "domain list" "patterns for"
8114 .cindex "list" "domain list"
8115 Domain lists contain patterns that are to be matched against a mail domain.
8116 The following types of item may appear in domain lists:
8117
8118 .ilist
8119 .cindex "primary host name"
8120 .cindex "host name" "matched in domain list"
8121 .oindex "&%primary_hostname%&"
8122 .cindex "domain list" "matching primary host name"
8123 .cindex "@ in a domain list"
8124 If a pattern consists of a single @ character, it matches the local host name,
8125 as set by the &%primary_hostname%& option (or defaulted). This makes it
8126 possible to use the same configuration file on several different hosts that
8127 differ only in their names.
8128 .next
8129 .cindex "@[] in a domain list"
8130 .cindex "domain list" "matching local IP interfaces"
8131 .cindex "domain literal"
8132 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8133 in square brackets (as in an email address that contains a domain literal), but
8134 only if that IP address is recognized as local for email routing purposes. The
8135 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8136 control which of a host's several IP addresses are treated as local.
8137 In today's Internet, the use of domain literals is controversial.
8138 .next
8139 .cindex "@mx_any"
8140 .cindex "@mx_primary"
8141 .cindex "@mx_secondary"
8142 .cindex "domain list" "matching MX pointers to local host"
8143 If a pattern consists of the string &`@mx_any`& it matches any domain that
8144 has an MX record pointing to the local host or to any host that is listed in
8145 .oindex "&%hosts_treat_as_local%&"
8146 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8147 are similar, except that the first matches only when a primary MX target is the
8148 local host, and the second only when no primary MX target is the local host,
8149 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8150 preference value &-- there may of course be more than one of them.
8151
8152 The MX lookup that takes place when matching a pattern of this type is
8153 performed with the resolver options for widening names turned off. Thus, for
8154 example, a single-component domain will &'not'& be expanded by adding the
8155 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8156 options of the &(dnslookup)& router for a discussion of domain widening.
8157
8158 Sometimes you may want to ignore certain IP addresses when using one of these
8159 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8160 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8161 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8162 on a router). For example:
8163 .code
8164 domains = @mx_any/ignore=127.0.0.1
8165 .endd
8166 This example matches any domain that has an MX record pointing to one of
8167 the local host's IP addresses other than 127.0.0.1.
8168
8169 The list of IP addresses is in fact processed by the same code that processes
8170 host lists, so it may contain CIDR-coded network specifications and it may also
8171 contain negative items.
8172
8173 Because the list of IP addresses is a sublist within a domain list, you have to
8174 be careful about delimiters if there is more than one address. Like any other
8175 list, the default delimiter can be changed. Thus, you might have:
8176 .code
8177 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8178           an.other.domain : ...
8179 .endd
8180 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8181 involved, it is easiest to change the delimiter for the main list as well:
8182 .code
8183 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8184           an.other.domain ? ...
8185 .endd
8186 .next
8187 .cindex "asterisk" "in domain list"
8188 .cindex "domain list" "asterisk in"
8189 .cindex "domain list" "matching &""ends with""&"
8190 If a pattern starts with an asterisk, the remaining characters of the pattern
8191 are compared with the terminating characters of the domain. The use of &"*"& in
8192 domain lists differs from its use in partial matching lookups. In a domain
8193 list, the character following the asterisk need not be a dot, whereas partial
8194 matching works only in terms of dot-separated components. For example, a domain
8195 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8196 &'cipher.key.ex'&.
8197
8198 .next
8199 .cindex "regular expressions" "in domain list"
8200 .cindex "domain list" "matching regular expression"
8201 If a pattern starts with a circumflex character, it is treated as a regular
8202 expression, and matched against the domain using a regular expression matching
8203 function. The circumflex is treated as part of the regular expression.
8204 Email domains are case-independent, so this regular expression match is by
8205 default case-independent, but you can make it case-dependent by starting it
8206 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8207 are given in chapter &<<CHAPregexp>>&.
8208
8209 &*Warning*&: Because domain lists are expanded before being processed, you
8210 must escape any backslash and dollar characters in the regular expression, or
8211 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8212 it is not to be expanded (unless you really do want to build a regular
8213 expression by expansion, of course).
8214 .next
8215 .cindex "lookup" "in domain list"
8216 .cindex "domain list" "matching by lookup"
8217 If a pattern starts with the name of a single-key lookup type followed by a
8218 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8219 must be a file name in a suitable format for the lookup type. For example, for
8220 &"cdb;"& it must be an absolute path:
8221 .code
8222 domains = cdb;/etc/mail/local_domains.cdb
8223 .endd
8224 The appropriate type of lookup is done on the file using the domain name as the
8225 key. In most cases, the data that is looked up is not used; Exim is interested
8226 only in whether or not the key is present in the file. However, when a lookup
8227 is used for the &%domains%& option on a router
8228 or a &%domains%& condition in an ACL statement, the data is preserved in the
8229 &$domain_data$& variable and can be referred to in other router options or
8230 other statements in the same ACL.
8231
8232 .next
8233 Any of the single-key lookup type names may be preceded by
8234 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8235 .code
8236 domains = partial-dbm;/partial/domains
8237 .endd
8238 This causes partial matching logic to be invoked; a description of how this
8239 works is given in section &<<SECTpartiallookup>>&.
8240
8241 .next
8242 .cindex "asterisk" "in lookup type"
8243 Any of the single-key lookup types may be followed by an asterisk. This causes
8244 a default lookup for a key consisting of a single asterisk to be done if the
8245 original lookup fails. This is not a useful feature when using a domain list to
8246 select particular domains (because any domain would match), but it might have
8247 value if the result of the lookup is being used via the &$domain_data$&
8248 expansion variable.
8249 .next
8250 If the pattern starts with the name of a query-style lookup type followed by a
8251 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8252 pattern must be an appropriate query for the lookup type, as described in
8253 chapter &<<CHAPfdlookup>>&. For example:
8254 .code
8255 hold_domains = mysql;select domain from holdlist \
8256   where domain = '${quote_mysql:$domain}';
8257 .endd
8258 In most cases, the data that is looked up is not used (so for an SQL query, for
8259 example, it doesn't matter what field you select). Exim is interested only in
8260 whether or not the query succeeds. However, when a lookup is used for the
8261 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8262 variable and can be referred to in other options.
8263 .next
8264 .cindex "domain list" "matching literal domain name"
8265 If none of the above cases apply, a caseless textual comparison is made
8266 between the pattern and the domain.
8267 .endlist
8268
8269 Here is an example that uses several different kinds of pattern:
8270 .code
8271 domainlist funny_domains = \
8272   @ : \
8273   lib.unseen.edu : \
8274   *.foundation.fict.example : \
8275   \N^[1-2]\d{3}\.fict\.example$\N : \
8276   partial-dbm;/opt/data/penguin/book : \
8277   nis;domains.byname : \
8278   nisplus;[name=$domain,status=local],domains.org_dir
8279 .endd
8280 There are obvious processing trade-offs among the various matching modes. Using
8281 an asterisk is faster than a regular expression, and listing a few names
8282 explicitly probably is too. The use of a file or database lookup is expensive,
8283 but may be the only option if hundreds of names are required. Because the
8284 patterns are tested in order, it makes sense to put the most commonly matched
8285 patterns earlier.
8286
8287
8288
8289 .section "Host lists" "SECThostlist"
8290 .cindex "host list" "patterns in"
8291 .cindex "list" "host list"
8292 Host lists are used to control what remote hosts are allowed to do. For
8293 example, some hosts may be allowed to use the local host as a relay, and some
8294 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8295 two different ways, by name or by IP address. In a host list, some types of
8296 pattern are matched to a host name, and some are matched to an IP address.
8297 You need to be particularly careful with this when single-key lookups are
8298 involved, to ensure that the right value is being used as the key.
8299
8300
8301 .section "Special host list patterns" "SECID80"
8302 .cindex "empty item in hosts list"
8303 .cindex "host list" "empty string in"
8304 If a host list item is the empty string, it matches only when no remote host is
8305 involved. This is the case when a message is being received from a local
8306 process using SMTP on the standard input, that is, when a TCP/IP connection is
8307 not used.
8308
8309 .cindex "asterisk" "in host list"
8310 The special pattern &"*"& in a host list matches any host or no host. Neither
8311 the IP address nor the name is actually inspected.
8312
8313
8314
8315 .section "Host list patterns that match by IP address" "SECThoslispatip"
8316 .cindex "host list" "matching IP addresses"
8317 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8318 the incoming address actually appears in the IPv6 host as
8319 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8320 list, it is converted into a traditional IPv4 address first. (Not all operating
8321 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8322 concerns.)
8323
8324 The following types of pattern in a host list check the remote host by
8325 inspecting its IP address:
8326
8327 .ilist
8328 If the pattern is a plain domain name (not a regular expression, not starting
8329 with *, not a lookup of any kind), Exim calls the operating system function
8330 to find the associated IP address(es). Exim uses the newer
8331 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8332 This typically causes a forward DNS lookup of the name. The result is compared
8333 with the IP address of the subject host.
8334
8335 If there is a temporary problem (such as a DNS timeout) with the host name
8336 lookup, a temporary error occurs. For example, if the list is being used in an
8337 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8338 temporary SMTP error code. If no IP address can be found for the host name,
8339 what happens is described in section &<<SECTbehipnot>>& below.
8340
8341 .next
8342 .cindex "@ in a host list"
8343 If the pattern is &"@"&, the primary host name is substituted and used as a
8344 domain name, as just described.
8345
8346 .next
8347 If the pattern is an IP address, it is matched against the IP address of the
8348 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8349 IPv6 addresses can be given in colon-separated format, but the colons have to
8350 be doubled so as not to be taken as item separators when the default list
8351 separator is used. IPv6 addresses are recognized even when Exim is compiled
8352 without IPv6 support. This means that if they appear in a host list on an
8353 IPv4-only host, Exim will not treat them as host names. They are just addresses
8354 that can never match a client host.
8355
8356 .next
8357 .cindex "@[] in a host list"
8358 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8359 the local host. For example, if the local host is an IPv4 host with one
8360 interface address 10.45.23.56, these two ACL statements have the same effect:
8361 .code
8362 accept hosts = 127.0.0.1 : 10.45.23.56
8363 accept hosts = @[]
8364 .endd
8365 .next
8366 .cindex "CIDR notation"
8367 If the pattern is an IP address followed by a slash and a mask length (for
8368 example 10.11.42.0/24), it is matched against the IP address of the subject
8369 host under the given mask. This allows, an entire network of hosts to be
8370 included (or excluded) by a single item. The mask uses CIDR notation; it
8371 specifies the number of address bits that must match, starting from the most
8372 significant end of the address.
8373
8374 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8375 of a range of addresses. It is the number of bits in the network portion of the
8376 address. The above example specifies a 24-bit netmask, so it matches all 256
8377 addresses in the 10.11.42.0 network. An item such as
8378 .code
8379 192.168.23.236/31
8380 .endd
8381 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8382 32 for an IPv4 address is the same as no mask at all; just a single address
8383 matches.
8384
8385 Here is another example which shows an IPv4 and an IPv6 network:
8386 .code
8387 recipient_unqualified_hosts = 192.168.0.0/16: \
8388                               3ffe::ffff::836f::::/48
8389 .endd
8390 The doubling of list separator characters applies only when these items
8391 appear inline in a host list. It is not required when indirecting via a file.
8392 For example:
8393 .code
8394 recipient_unqualified_hosts = /opt/exim/unqualnets
8395 .endd
8396 could make use of a file containing
8397 .code
8398 172.16.0.0/12
8399 3ffe:ffff:836f::/48
8400 .endd
8401 to have exactly the same effect as the previous example. When listing IPv6
8402 addresses inline, it is usually more convenient to use the facility for
8403 changing separator characters. This list contains the same two networks:
8404 .code
8405 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8406                                  3ffe:ffff:836f::/48
8407 .endd
8408 The separator is changed to semicolon by the leading &"<;"& at the start of the
8409 list.
8410 .endlist
8411
8412
8413
8414 .section "Host list patterns for single-key lookups by host address" &&&
8415          "SECThoslispatsikey"
8416 .cindex "host list" "lookup of IP address"
8417 When a host is to be identified by a single-key lookup of its complete IP
8418 address, the pattern takes this form:
8419 .display
8420 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8421 .endd
8422 For example:
8423 .code
8424 hosts_lookup = net-cdb;/hosts-by-ip.db
8425 .endd
8426 The text form of the IP address of the subject host is used as the lookup key.
8427 IPv6 addresses are converted to an unabbreviated form, using lower case
8428 letters, with dots as separators because colon is the key terminator in
8429 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8430 quoting the keys, but this is a facility that was added later.] The data
8431 returned by the lookup is not used.
8432
8433 .cindex "IP address" "masking"
8434 .cindex "host list" "masked IP address"
8435 Single-key lookups can also be performed using masked IP addresses, using
8436 patterns of this form:
8437 .display
8438 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8439 .endd
8440 For example:
8441 .code
8442 net24-dbm;/networks.db
8443 .endd
8444 The IP address of the subject host is masked using <&'number'&> as the mask
8445 length. A textual string is constructed from the masked value, followed by the
8446 mask, and this is used as the lookup key. For example, if the host's IP address
8447 is 192.168.34.6, the key that is looked up for the above example is
8448 &"192.168.34.0/24"&.
8449
8450 When an IPv6 address is converted to a string, dots are normally used instead
8451 of colons, so that keys in &(lsearch)& files need not contain colons (which
8452 terminate &(lsearch)& keys). This was implemented some time before the ability
8453 to quote keys was made available in &(lsearch)& files. However, the more
8454 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8455 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8456 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8457 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8458 addresses are always used.
8459
8460 Ideally, it would be nice to tidy up this anomalous situation by changing to
8461 colons in all cases, given that quoting is now available for &(lsearch)&.
8462 However, this would be an incompatible change that might break some existing
8463 configurations.
8464
8465 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8466 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8467 the former case the key strings include the mask value, whereas in the latter
8468 case the IP address is used on its own.
8469
8470
8471
8472 .section "Host list patterns that match by host name" "SECThoslispatnam"
8473 .cindex "host" "lookup failures"
8474 .cindex "unknown host name"
8475 .cindex "host list" "matching host name"
8476 There are several types of pattern that require Exim to know the name of the
8477 remote host. These are either wildcard patterns or lookups by name. (If a
8478 complete hostname is given without any wildcarding, it is used to find an IP
8479 address to match against, as described in section &<<SECThoslispatip>>&
8480 above.)
8481
8482 If the remote host name is not already known when Exim encounters one of these
8483 patterns, it has to be found from the IP address.
8484 Although many sites on the Internet are conscientious about maintaining reverse
8485 DNS data for their hosts, there are also many that do not do this.
8486 Consequently, a name cannot always be found, and this may lead to unwanted
8487 effects. Take care when configuring host lists with wildcarded name patterns.
8488 Consider what will happen if a name cannot be found.
8489
8490 Because of the problems of determining host names from IP addresses, matching
8491 against host names is not as common as matching against IP addresses.
8492
8493 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8494 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8495 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8496 are done can be changed by setting the &%host_lookup_order%& option. For
8497 security, once Exim has found one or more names, it looks up the IP addresses
8498 for these names and compares them with the IP address that it started with.
8499 Only those names whose IP addresses match are accepted. Any other names are
8500 discarded. If no names are left, Exim behaves as if the host name cannot be
8501 found. In the most common case there is only one name and one IP address.
8502
8503 There are some options that control what happens if a host name cannot be
8504 found. These are described in section &<<SECTbehipnot>>& below.
8505
8506 .cindex "host" "alias for"
8507 .cindex "alias for host"
8508 As a result of aliasing, hosts may have more than one name. When processing any
8509 of the following types of pattern, all the host's names are checked:
8510
8511 .ilist
8512 .cindex "asterisk" "in host list"
8513 If a pattern starts with &"*"& the remainder of the item must match the end of
8514 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8515 &'.b.c'&. This special simple form is provided because this is a very common
8516 requirement. Other kinds of wildcarding require the use of a regular
8517 expression.
8518 .next
8519 .cindex "regular expressions" "in host list"
8520 .cindex "host list" "regular expression in"
8521 If the item starts with &"^"& it is taken to be a regular expression which is
8522 matched against the host name. Host names are case-independent, so this regular
8523 expression match is by default case-independent, but you can make it
8524 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8525 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8526 example,
8527 .code
8528 ^(a|b)\.c\.d$
8529 .endd
8530 is a regular expression that matches either of the two hosts &'a.c.d'& or
8531 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8532 that backslash and dollar characters are not misinterpreted as part of the
8533 string expansion. The simplest way to do this is to use &`\N`& to mark that
8534 part of the string as non-expandable. For example:
8535 .code
8536 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8537 .endd
8538 &*Warning*&: If you want to match a complete host name, you must include the
8539 &`$`& terminating metacharacter in the regular expression, as in the above
8540 example. Without it, a match at the start of the host name is all that is
8541 required.
8542 .endlist
8543
8544
8545
8546
8547 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8548 .cindex "host" "lookup failures, permanent"
8549 While processing a host list, Exim may need to look up an IP address from a
8550 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8551 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8552 behaviour when it fails to find the information it is seeking is the same.
8553
8554 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8555 apply to temporary DNS errors, whose handling is described in the next section.
8556
8557 .cindex "&`+include_unknown`&"
8558 .cindex "&`+ignore_unknown`&"
8559 Exim parses a host list from left to right. If it encounters a permanent
8560 lookup failure in any item in the host list before it has found a match,
8561 Exim treats it as a failure and the default behavior is as if the host
8562 does not match the list. This may not always be what you want to happen.
8563 To change Exim's behaviour, the special items &`+include_unknown`& or
8564 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8565 not recognized in an indirected file).
8566
8567 .ilist
8568 If any item that follows &`+include_unknown`& requires information that
8569 cannot found, Exim behaves as if the host does match the list. For example,
8570 .code
8571 host_reject_connection = +include_unknown:*.enemy.ex
8572 .endd
8573 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8574 any hosts whose name it cannot find.
8575
8576 .next
8577 If any item that follows &`+ignore_unknown`& requires information that cannot
8578 be found, Exim ignores that item and proceeds to the rest of the list. For
8579 example:
8580 .code
8581 accept hosts = +ignore_unknown : friend.example : \
8582                192.168.4.5
8583 .endd
8584 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8585 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8586 name can be found for 192.168.4.5, it is rejected.
8587 .endlist
8588
8589 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8590 list. The effect of each one lasts until the next, or until the end of the
8591 list.
8592
8593 .section "Mixing wildcarded host names and addresses in host lists" &&&
8594          "SECTmixwilhos"
8595 .cindex "host list" "mixing names and addresses in"
8596
8597 This section explains the host/ip processing logic with the same concepts
8598 as the previous section, but specifically addresses what happens when a
8599 wildcarded hostname is one of the items in the hostlist.
8600
8601 .ilist
8602 If you have name lookups or wildcarded host names and
8603 IP addresses in the same host list, you should normally put the IP
8604 addresses first. For example, in an ACL you could have:
8605 .code
8606 accept hosts = 10.9.8.7 : *.friend.example
8607 .endd
8608 The reason you normally would order it this way lies in the
8609 left-to-right way that Exim processes lists.  It can test IP addresses
8610 without doing any DNS lookups, but when it reaches an item that requires
8611 a host name, it fails if it cannot find a host name to compare with the
8612 pattern. If the above list is given in the opposite order, the
8613 &%accept%& statement fails for a host whose name cannot be found, even
8614 if its IP address is 10.9.8.7.
8615
8616 .next
8617 If you really do want to do the name check first, and still recognize the IP
8618 address, you can rewrite the ACL like this:
8619 .code
8620 accept hosts = *.friend.example
8621 accept hosts = 10.9.8.7
8622 .endd
8623 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8624 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8625 &`+ignore_unknown`&, which was discussed in depth in the first example in
8626 this section.
8627 .endlist
8628
8629
8630 .section "Temporary DNS errors when looking up host information" &&&
8631          "SECTtemdnserr"
8632 .cindex "host" "lookup failures, temporary"
8633 .cindex "&`+include_defer`&"
8634 .cindex "&`+ignore_defer`&"
8635 A temporary DNS lookup failure normally causes a defer action (except when
8636 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8637 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8638 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8639 section. These options should be used with care, probably only in non-critical
8640 host lists such as whitelists.
8641
8642
8643
8644 .section "Host list patterns for single-key lookups by host name" &&&
8645          "SECThoslispatnamsk"
8646 .cindex "unknown host name"
8647 .cindex "host list" "matching host name"
8648 If a pattern is of the form
8649 .display
8650 <&'single-key-search-type'&>;<&'search-data'&>
8651 .endd
8652 for example
8653 .code
8654 dbm;/host/accept/list
8655 .endd
8656 a single-key lookup is performed, using the host name as its key. If the
8657 lookup succeeds, the host matches the item. The actual data that is looked up
8658 is not used.
8659
8660 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8661 keys in the file, not IP addresses. If you want to do lookups based on IP
8662 addresses, you must precede the search type with &"net-"& (see section
8663 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8664 two items in the same list, one doing an address lookup and one doing a name
8665 lookup, both using the same file.
8666
8667
8668
8669 .section "Host list patterns for query-style lookups" "SECID81"
8670 If a pattern is of the form
8671 .display
8672 <&'query-style-search-type'&>;<&'query'&>
8673 .endd
8674 the query is obeyed, and if it succeeds, the host matches the item. The actual
8675 data that is looked up is not used. The variables &$sender_host_address$& and
8676 &$sender_host_name$& can be used in the query. For example:
8677 .code
8678 hosts_lookup = pgsql;\
8679   select ip from hostlist where ip='$sender_host_address'
8680 .endd
8681 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8682 can use the &%sg%& expansion item to change this if you need to. If you want to
8683 use masked IP addresses in database queries, you can use the &%mask%& expansion
8684 operator.
8685
8686 If the query contains a reference to &$sender_host_name$&, Exim automatically
8687 looks up the host name if it has not already done so. (See section
8688 &<<SECThoslispatnam>>& for comments on finding host names.)
8689
8690 Historical note: prior to release 4.30, Exim would always attempt to find a
8691 host name before running the query, unless the search type was preceded by
8692 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8693 still recognized for query-style lookups, but its presence or absence has no
8694 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8695 See section &<<SECThoslispatsikey>>&.)
8696
8697
8698
8699
8700
8701 .section "Address lists" "SECTaddresslist"
8702 .cindex "list" "address list"
8703 .cindex "address list" "empty item"
8704 .cindex "address list" "patterns"
8705 Address lists contain patterns that are matched against mail addresses. There
8706 is one special case to be considered: the sender address of a bounce message is
8707 always empty. You can test for this by providing an empty item in an address
8708 list. For example, you can set up a router to process bounce messages by
8709 using this option setting:
8710 .code
8711 senders = :
8712 .endd
8713 The presence of the colon creates an empty item. If you do not provide any
8714 data, the list is empty and matches nothing. The empty sender can also be
8715 detected by a regular expression that matches an empty string,
8716 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8717
8718 Non-empty items in an address list can be straightforward email addresses. For
8719 example:
8720 .code
8721 senders = jbc@askone.example : hs@anacreon.example
8722 .endd
8723 A certain amount of wildcarding is permitted. If a pattern contains an @
8724 character, but is not a regular expression and does not begin with a
8725 semicolon-terminated lookup type (described below), the local part of the
8726 subject address is compared with the local part of the pattern, which may start
8727 with an asterisk. If the local parts match, the domain is checked in exactly
8728 the same way as for a pattern in a domain list. For example, the domain can be
8729 wildcarded, refer to a named list, or be a lookup:
8730 .code
8731 deny senders = *@*.spamming.site:\
8732                *@+hostile_domains:\
8733                bozo@partial-lsearch;/list/of/dodgy/sites:\
8734                *@dbm;/bad/domains.db
8735 .endd
8736 .cindex "local part" "starting with !"
8737 .cindex "address list" "local part starting with !"
8738 If a local part that begins with an exclamation mark is required, it has to be
8739 specified using a regular expression, because otherwise the exclamation mark is
8740 treated as a sign of negation, as is standard in lists.
8741
8742 If a non-empty pattern that is not a regular expression or a lookup does not
8743 contain an @ character, it is matched against the domain part of the subject
8744 address. The only two formats that are recognized this way are a literal
8745 domain, or a domain pattern that starts with *. In both these cases, the effect
8746 is the same as if &`*@`& preceded the pattern. For example:
8747 .code
8748 deny senders = enemy.domain : *.enemy.domain
8749 .endd
8750
8751 The following kinds of more complicated address list pattern can match any
8752 address, including the empty address that is characteristic of bounce message
8753 senders:
8754
8755 .ilist
8756 .cindex "regular expressions" "in address list"
8757 .cindex "address list" "regular expression in"
8758 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8759 done against the complete address, with the pattern as the regular expression.
8760 You must take care that backslash and dollar characters are not misinterpreted
8761 as part of the string expansion. The simplest way to do this is to use &`\N`&
8762 to mark that part of the string as non-expandable. For example:
8763 .code
8764 deny senders = \N^.*this.*@example\.com$\N : \
8765                \N^\d{8}.+@spamhaus.example$\N : ...
8766 .endd
8767 The &`\N`& sequences are removed by the expansion, so these items do indeed
8768 start with &"^"& by the time they are being interpreted as address patterns.
8769
8770 .next
8771 .cindex "address list" "lookup for complete address"
8772 Complete addresses can be looked up by using a pattern that starts with a
8773 lookup type terminated by a semicolon, followed by the data for the lookup. For
8774 example:
8775 .code
8776 deny senders = cdb;/etc/blocked.senders : \
8777   mysql;select address from blocked where \
8778   address='${quote_mysql:$sender_address}'
8779 .endd
8780 Both query-style and single-key lookup types can be used. For a single-key
8781 lookup type, Exim uses the complete address as the key. However, empty keys are
8782 not supported for single-key lookups, so a match against the empty address
8783 always fails. This restriction does not apply to query-style lookups.
8784
8785 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8786 cannot be used, and is ignored if specified, with an entry being written to the
8787 panic log.
8788 .cindex "*@ with single-key lookup"
8789 However, you can configure lookup defaults, as described in section
8790 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8791 default. For example, with this lookup:
8792 .code
8793 accept senders = lsearch*@;/some/file
8794 .endd
8795 the file could contains lines like this:
8796 .code
8797 user1@domain1.example
8798 *@domain2.example
8799 .endd
8800 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8801 that are tried is:
8802 .code
8803 nimrod@jaeger.example
8804 *@jaeger.example
8805 *
8806 .endd
8807 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8808 would mean that every address matches, thus rendering the test useless.
8809
8810 &*Warning 2*&: Do not confuse these two kinds of item:
8811 .code
8812 deny recipients = dbm*@;/some/file
8813 deny recipients = *@dbm;/some/file
8814 .endd
8815 The first does a whole address lookup, with defaulting, as just described,
8816 because it starts with a lookup type. The second matches the local part and
8817 domain independently, as described in a bullet point below.
8818 .endlist
8819
8820
8821 The following kinds of address list pattern can match only non-empty addresses.
8822 If the subject address is empty, a match against any of these pattern types
8823 always fails.
8824
8825
8826 .ilist
8827 .cindex "@@ with single-key lookup"
8828 .cindex "address list" "@@ lookup type"
8829 .cindex "address list" "split local part and domain"
8830 If a pattern starts with &"@@"& followed by a single-key lookup item
8831 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8832 split into a local part and a domain. The domain is looked up in the file. If
8833 it is not found, there is no match. If it is found, the data that is looked up
8834 from the file is treated as a colon-separated list of local part patterns, each
8835 of which is matched against the subject local part in turn.
8836
8837 .cindex "asterisk" "in address list"
8838 The lookup may be a partial one, and/or one involving a search for a default
8839 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8840 patterns that are looked up can be regular expressions or begin with &"*"&, or
8841 even be further lookups. They may also be independently negated. For example,
8842 with
8843 .code
8844 deny senders = @@dbm;/etc/reject-by-domain
8845 .endd
8846 the data from which the DBM file is built could contain lines like
8847 .code
8848 baddomain.com:  !postmaster : *
8849 .endd
8850 to reject all senders except &%postmaster%& from that domain.
8851
8852 .cindex "local part" "starting with !"
8853 If a local part that actually begins with an exclamation mark is required, it
8854 has to be specified using a regular expression. In &(lsearch)& files, an entry
8855 may be split over several lines by indenting the second and subsequent lines,
8856 but the separating colon must still be included at line breaks. White space
8857 surrounding the colons is ignored. For example:
8858 .code
8859 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8860   spammer3 : spammer4
8861 .endd
8862 As in all colon-separated lists in Exim, a colon can be included in an item by
8863 doubling.
8864
8865 If the last item in the list starts with a right angle-bracket, the remainder
8866 of the item is taken as a new key to look up in order to obtain a continuation
8867 list of local parts. The new key can be any sequence of characters. Thus one
8868 might have entries like
8869 .code
8870 aol.com: spammer1 : spammer 2 : >*
8871 xyz.com: spammer3 : >*
8872 *:       ^\d{8}$
8873 .endd
8874 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8875 local parts for all domains, in addition to the specific local parts listed for
8876 each domain. Of course, using this feature costs another lookup each time a
8877 chain is followed, but the effort needed to maintain the data is reduced.
8878
8879 .cindex "loop" "in lookups"
8880 It is possible to construct loops using this facility, and in order to catch
8881 them, the chains may be no more than fifty items long.
8882
8883 .next
8884 The @@<&'lookup'&> style of item can also be used with a query-style
8885 lookup, but in this case, the chaining facility is not available. The lookup
8886 can only return a single list of local parts.
8887 .endlist
8888
8889 &*Warning*&: There is an important difference between the address list items
8890 in these two examples:
8891 .code
8892 senders = +my_list
8893 senders = *@+my_list
8894 .endd
8895 In the first one, &`my_list`& is a named address list, whereas in the second
8896 example it is a named domain list.
8897
8898
8899
8900
8901 .section "Case of letters in address lists" "SECTcasletadd"
8902 .cindex "case of local parts"
8903 .cindex "address list" "case forcing"
8904 .cindex "case forcing in address lists"
8905 Domains in email addresses are always handled caselessly, but for local parts
8906 case may be significant on some systems (see &%caseful_local_part%& for how
8907 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8908 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8909 blocking lists should be done in a case-independent manner. Since most address
8910 lists in Exim are used for this kind of control, Exim attempts to do this by
8911 default.
8912
8913 The domain portion of an address is always lowercased before matching it to an
8914 address list. The local part is lowercased by default, and any string
8915 comparisons that take place are done caselessly. This means that the data in
8916 the address list itself, in files included as plain file names, and in any file
8917 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8918 keys in files that are looked up by a search type other than &(lsearch)& (which
8919 works caselessly) must be in lower case, because these lookups are not
8920 case-independent.
8921
8922 .cindex "&`+caseful`&"
8923 To allow for the possibility of caseful address list matching, if an item in
8924 an address list is the string &"+caseful"&, the original case of the local
8925 part is restored for any comparisons that follow, and string comparisons are no
8926 longer case-independent. This does not affect the domain, which remains in
8927 lower case. However, although independent matches on the domain alone are still
8928 performed caselessly, regular expressions that match against an entire address
8929 become case-sensitive after &"+caseful"& has been seen.
8930
8931
8932
8933 .section "Local part lists" "SECTlocparlis"
8934 .cindex "list" "local part list"
8935 .cindex "local part" "list"
8936 Case-sensitivity in local part lists is handled in the same way as for address
8937 lists, as just described. The &"+caseful"& item can be used if required. In a
8938 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8939 set false, the subject is lowercased and the matching is initially
8940 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8941 matching in the local part list, but not elsewhere in the router. If
8942 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8943 option is case-sensitive from the start.
8944
8945 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8946 comments are handled in the same way as address lists &-- they are recognized
8947 only if the # is preceded by white space or the start of the line.
8948 Otherwise, local part lists are matched in the same way as domain lists, except
8949 that the special items that refer to the local host (&`@`&, &`@[]`&,
8950 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8951 Refer to section &<<SECTdomainlist>>& for details of the other available item
8952 types.
8953 .ecindex IIDdohoadli
8954
8955
8956
8957
8958 . ////////////////////////////////////////////////////////////////////////////
8959 . ////////////////////////////////////////////////////////////////////////////
8960
8961 .chapter "String expansions" "CHAPexpand"
8962 .scindex IIDstrexp "expansion" "of strings"
8963 Many strings in Exim's run time configuration are expanded before use. Some of
8964 them are expanded every time they are used; others are expanded only once.
8965
8966 When a string is being expanded it is copied verbatim from left to right except
8967 when a dollar or backslash character is encountered. A dollar specifies the
8968 start of a portion of the string that is interpreted and replaced as described
8969 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8970 escape character, as described in the following section.
8971
8972 Whether a string is expanded depends upon the context.  Usually this is solely
8973 dependent upon the option for which a value is sought; in this documentation,
8974 options for which string expansion is performed are marked with &dagger; after
8975 the data type.  ACL rules always expand strings.  A couple of expansion
8976 conditions do not expand some of the brace-delimited branches, for security
8977 reasons.
8978
8979
8980
8981 .section "Literal text in expanded strings" "SECTlittext"
8982 .cindex "expansion" "including literal text"
8983 An uninterpreted dollar can be included in an expanded string by putting a
8984 backslash in front of it. A backslash can be used to prevent any special
8985 character being treated specially in an expansion, including backslash itself.
8986 If the string appears in quotes in the configuration file, two backslashes are
8987 required because the quotes themselves cause interpretation of backslashes when
8988 the string is read in (see section &<<SECTstrings>>&).
8989
8990 .cindex "expansion" "non-expandable substrings"
8991 A portion of the string can specified as non-expandable by placing it between
8992 two occurrences of &`\N`&. This is particularly useful for protecting regular
8993 expressions, which often contain backslashes and dollar signs. For example:
8994 .code
8995 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8996 .endd
8997 On encountering the first &`\N`&, the expander copies subsequent characters
8998 without interpretation until it reaches the next &`\N`& or the end of the
8999 string.
9000
9001
9002
9003 .section "Character escape sequences in expanded strings" "SECID82"
9004 .cindex "expansion" "escape sequences"
9005 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9006 expanded string is recognized as an escape sequence for the character newline,
9007 carriage return, or tab, respectively. A backslash followed by up to three
9008 octal digits is recognized as an octal encoding for a single character, and a
9009 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9010 encoding.
9011
9012 These escape sequences are also recognized in quoted strings when they are read
9013 in. Their interpretation in expansions as well is useful for unquoted strings,
9014 and for other cases such as looked-up strings that are then expanded.
9015
9016
9017 .section "Testing string expansions" "SECID83"
9018 .cindex "expansion" "testing"
9019 .cindex "testing" "string expansion"
9020 .oindex "&%-be%&"
9021 Many expansions can be tested by calling Exim with the &%-be%& option. This
9022 takes the command arguments, or lines from the standard input if there are no
9023 arguments, runs them through the string expansion code, and writes the results
9024 to the standard output. Variables based on configuration values are set up, but
9025 since no message is being processed, variables such as &$local_part$& have no
9026 value. Nevertheless the &%-be%& option can be useful for checking out file and
9027 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9028 and &%nhash%&.
9029
9030 Exim gives up its root privilege when it is called with the &%-be%& option, and
9031 instead runs under the uid and gid it was called with, to prevent users from
9032 using &%-be%& for reading files to which they do not have access.
9033
9034 .oindex "&%-bem%&"
9035 If you want to test expansions that include variables whose values are taken
9036 from a message, there are two other options that can be used. The &%-bem%&
9037 option is like &%-be%& except that it is followed by a file name. The file is
9038 read as a message before doing the test expansions. For example:
9039 .code
9040 exim -bem /tmp/test.message '$h_subject:'
9041 .endd
9042 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9043 Exim message identifier. For example:
9044 .code
9045 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9046 .endd
9047 This loads the message from Exim's spool before doing the test expansions, and
9048 is therefore restricted to admin users.
9049
9050
9051 .section "Forced expansion failure" "SECTforexpfai"
9052 .cindex "expansion" "forced failure"
9053 A number of expansions that are described in the following section have
9054 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9055 (which are sometimes called &"curly brackets"&). Which of the two strings is
9056 used depends on some condition that is evaluated as part of the expansion. If,
9057 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9058 the entire string expansion fails in a way that can be detected by the code
9059 that requested the expansion. This is called &"forced expansion failure"&, and
9060 its consequences depend on the circumstances. In some cases it is no different
9061 from any other expansion failure, but in others a different action may be
9062 taken. Such variations are mentioned in the documentation of the option that is
9063 being expanded.
9064
9065
9066
9067
9068 .section "Expansion items" "SECTexpansionitems"
9069 The following items are recognized in expanded strings. White space may be used
9070 between sub-items that are keywords or substrings enclosed in braces inside an
9071 outer set of braces, to improve readability. &*Warning*&: Within braces,
9072 white space is significant.
9073
9074 .vlist
9075 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9076 .cindex "expansion" "variables"
9077 Substitute the contents of the named variable, for example:
9078 .code
9079 $local_part
9080 ${domain}
9081 .endd
9082 The second form can be used to separate the name from subsequent alphanumeric
9083 characters. This form (using braces) is available only for variables; it does
9084 &'not'& apply to message headers. The names of the variables are given in
9085 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9086 given, the expansion fails.
9087
9088 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9089 .cindex "expansion" "operators"
9090 The string is first itself expanded, and then the operation specified by
9091 <&'op'&> is applied to it. For example:
9092 .code
9093 ${lc:$local_part}
9094 .endd
9095 The string starts with the first character after the colon, which may be
9096 leading white space. A list of operators is given in section &<<SECTexpop>>&
9097 below. The operator notation is used for simple expansion items that have just
9098 one argument, because it reduces the number of braces and therefore makes the
9099 string easier to understand.
9100
9101 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9102 This item inserts &"basic"& header lines. It is described with the &%header%&
9103 expansion item below.
9104
9105
9106 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9107 .cindex "expansion" "calling an acl"
9108 .cindex "&%acl%&" "call from expansion"
9109 The name and zero to nine argument strings are first expanded separately.  The expanded
9110 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9111 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9112 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9113 and may use the variables; if another acl expansion is used the values
9114 are restored after it returns.  If the ACL sets
9115 a value using a "message =" modifier and returns accept or deny, the value becomes
9116 the result of the expansion.
9117 If no message is set and the ACL returns accept or deny
9118 the expansion result is an empty string.
9119 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9120
9121
9122 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9123        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9124 .cindex "expansion" "extracting certificate fields"
9125 .cindex "&%certextract%&" "certificate fields"
9126 .cindex "certificate" "extracting fields"
9127 The <&'certificate'&> must be a variable of type certificate.
9128 The field name is expanded and used to retrieve the relevant field from
9129 the certificate.  Supported fields are:
9130 .display
9131 &`version        `&
9132 &`serial_number  `&
9133 &`subject        `& RFC4514 DN
9134 &`issuer         `& RFC4514 DN
9135 &`notbefore      `& time
9136 &`notafter       `& time
9137 &`sig_algorithm  `&
9138 &`signature      `&
9139 &`subj_altname   `& tagged list
9140 &`ocsp_uri       `& list
9141 &`crl_uri        `& list
9142 .endd
9143 If the field is found,
9144 <&'string2'&> is expanded, and replaces the whole item;
9145 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9146 variable &$value$& contains the value that has been extracted. Afterwards, it
9147 is restored to any previous value it might have had.
9148
9149 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9150 key is not found. If {<&'string2'&>} is also omitted, the value that was
9151 extracted is used.
9152
9153 Some field names take optional modifiers, appended and separated by commas.
9154
9155 The field selectors marked as "RFC4514" above
9156 output a Distinguished Name string which is
9157 not quite
9158 parseable by Exim as a comma-separated tagged list
9159 (the exceptions being elements containing commas).
9160 RDN elements of a single type may be selected by
9161 a modifier of the type label; if so the expansion
9162 result is a list (newline-separated by default).
9163 The separator may be changed by another modifier of
9164 a right angle-bracket followed immediately by the new separator.
9165 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9166
9167 The field selectors marked as "time" above
9168 take an optional modifier of "int"
9169 for which the result is the number of seconds since epoch.
9170 Otherwise the result is a human-readable string
9171 in the timezone selected by the main "timezone" option.
9172
9173 The field selectors marked as "list" above return a list,
9174 newline-separated by default,
9175 (embedded separator characters in elements are doubled).
9176 The separator may be changed by a modifier of
9177 a right angle-bracket followed immediately by the new separator.
9178
9179 The field selectors marked as "tagged" above
9180 prefix each list element with a type string and an equals sign.
9181 Elements of only one type may be selected by a modifier
9182 which is one of "dns", "uri" or "mail";
9183 if so the element tags are omitted.
9184
9185 If not otherwise noted field values are presented in human-readable form.
9186
9187 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9188        {*&<&'arg'&>&*}...}*&"
9189 .cindex &%dlfunc%&
9190 This expansion dynamically loads and then calls a locally-written C function.
9191 This functionality is available only if Exim is compiled with
9192 .code
9193 EXPAND_DLFUNC=yes
9194 .endd
9195 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9196 object so that it doesn't reload the same object file in the same Exim process
9197 (but of course Exim does start new processes frequently).
9198
9199 There may be from zero to eight arguments to the function. When compiling
9200 a local function that is to be called in this way, &_local_scan.h_& should be
9201 included. The Exim variables and functions that are defined by that API
9202 are also available for dynamically loaded functions. The function itself
9203 must have the following type:
9204 .code
9205 int dlfunction(uschar **yield, int argc, uschar *argv[])
9206 .endd
9207 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9208 function should return one of the following values:
9209
9210 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9211 into the expanded string that is being built.
9212
9213 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9214 from &'yield'&, if it is set.
9215
9216 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9217 taken from &'yield'& if it is set.
9218
9219 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9220
9221 When compiling a function that is to be used in this way with gcc,
9222 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9223 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9224
9225
9226 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9227 .cindex "expansion" "extracting value from environment"
9228 .cindex "environment" "values from"
9229 The key is first expanded separately, and leading and trailing white space
9230 removed.
9231 This is then searched for as a name in the environment.
9232 If a variable is found then its value is placed in &$value$&
9233 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9234
9235 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9236 appear, for example:
9237 .code
9238 ${env{USER}{$value} fail }
9239 .endd
9240 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9241 {<&'string1'&>} must be present for &"fail"& to be recognized.
9242
9243 If {<&'string2'&>} is omitted an empty string is substituted on
9244 search failure.
9245 If {<&'string1'&>} is omitted the search result is substituted on
9246 search success.
9247
9248 The environment is adjusted by the &%keep_environment%& and
9249 &%add_environment%& main section options.
9250
9251
9252 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9253        {*&<&'string3'&>&*}}*&"
9254 .cindex "expansion" "extracting substrings by key"
9255 .cindex "&%extract%&" "substrings by key"
9256 The key and <&'string1'&> are first expanded separately. Leading and trailing
9257 white space is removed from the key (but not from any of the strings). The key
9258 must not be empty and must not consist entirely of digits.
9259 The expanded <&'string1'&> must be of the form:
9260 .display
9261 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9262 .endd
9263 .vindex "&$value$&"
9264 where the equals signs and spaces (but not both) are optional. If any of the
9265 values contain white space, they must be enclosed in double quotes, and any
9266 values that are enclosed in double quotes are subject to escape processing as
9267 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9268 for the value that corresponds to the key. The search is case-insensitive. If
9269 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9270 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9271 variable &$value$& contains the value that has been extracted. Afterwards, it
9272 is restored to any previous value it might have had.
9273
9274 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9275 key is not found. If {<&'string2'&>} is also omitted, the value that was
9276 extracted is used. Thus, for example, these two expansions are identical, and
9277 yield &"2001"&:
9278 .code
9279 ${extract{gid}{uid=1984 gid=2001}}
9280 ${extract{gid}{uid=1984 gid=2001}{$value}}
9281 .endd
9282 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9283 appear, for example:
9284 .code
9285 ${extract{Z}{A=... B=...}{$value} fail }
9286 .endd
9287 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9288 {<&'string2'&>} must be present for &"fail"& to be recognized.
9289
9290
9291 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9292         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9293 .cindex "expansion" "extracting substrings by number"
9294 .cindex "&%extract%&" "substrings by number"
9295 The <&'number'&> argument must consist entirely of decimal digits,
9296 apart from leading and trailing white space, which is ignored.
9297 This is what distinguishes this form of &%extract%& from the previous kind. It
9298 behaves in the same way, except that, instead of extracting a named field, it
9299 extracts from <&'string1'&> the field whose number is given as the first
9300 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9301 <&'string3'&> as before.
9302
9303 The fields in the string are separated by any one of the characters in the
9304 separator string. These may include space or tab characters.
9305 The first field is numbered one. If the number is negative, the fields are
9306 counted from the end of the string, with the rightmost one numbered -1. If the
9307 number given is zero, the entire string is returned. If the modulus of the
9308 number is greater than the number of fields in the string, the result is the
9309 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9310 provided. For example:
9311 .code
9312 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9313 .endd
9314 yields &"42"&, and
9315 .code
9316 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9317 .endd
9318 yields &"99"&. Two successive separators mean that the field between them is
9319 empty (for example, the fifth field above).
9320
9321
9322 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9323 .cindex "list" "selecting by condition"
9324 .cindex "expansion" "selecting from list by condition"
9325 .vindex "&$item$&"
9326 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9327 default, but the separator can be changed in the usual way. For each item
9328 in this list, its value is place in &$item$&, and then the condition is
9329 evaluated. If the condition is true, &$item$& is added to the output as an
9330 item in a new list; if the condition is false, the item is discarded. The
9331 separator used for the output list is the same as the one used for the
9332 input, but a separator setting is not included in the output. For example:
9333 .code
9334 ${filter{a:b:c}{!eq{$item}{b}}
9335 .endd
9336 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9337 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9338
9339
9340 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9341 .cindex "hash function" "textual"
9342 .cindex "expansion" "textual hash"
9343 This is a textual hashing function, and was the first to be implemented in
9344 early versions of Exim. In current releases, there are other hashing functions
9345 (numeric, MD5, and SHA-1), which are described below.
9346
9347 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9348 <&'n'&>. If you are using fixed values for these numbers, that is, if
9349 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9350 use the simpler operator notation that avoids some of the braces:
9351 .code
9352 ${hash_<n>_<m>:<string>}
9353 .endd
9354 The second number is optional (in both notations). If <&'n'&> is greater than
9355 or equal to the length of the string, the expansion item returns the string.
9356 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9357 function to the string. The new string consists of characters taken from the
9358 first <&'m'&> characters of the string
9359 .code
9360 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9361 .endd
9362 If <&'m'&> is not present the value 26 is used, so that only lower case
9363 letters appear. For example:
9364 .display
9365 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9366 &`$hash{5}{monty}}           `&   yields  &`monty`&
9367 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9368 .endd
9369
9370 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9371         &*$h_*&<&'header&~name'&>&*:*&" &&&
9372        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9373         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9374        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9375         &*$rh_*&<&'header&~name'&>&*:*&"
9376 .cindex "expansion" "header insertion"
9377 .vindex "&$header_$&"
9378 .vindex "&$bheader_$&"
9379 .vindex "&$rheader_$&"
9380 .cindex "header lines" "in expansion strings"
9381 .cindex "header lines" "character sets"
9382 .cindex "header lines" "decoding"
9383 Substitute the contents of the named message header line, for example
9384 .code
9385 $header_reply-to:
9386 .endd
9387 The newline that terminates a header line is not included in the expansion, but
9388 internal newlines (caused by splitting the header line over several physical
9389 lines) may be present.
9390
9391 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9392 the data in the header line is interpreted.
9393
9394 .ilist
9395 .cindex "white space" "in header lines"
9396 &%rheader%& gives the original &"raw"& content of the header line, with no
9397 processing at all, and without the removal of leading and trailing white space.
9398
9399 .next
9400 .cindex "base64 encoding" "in header lines"
9401 &%bheader%& removes leading and trailing white space, and then decodes base64
9402 or quoted-printable MIME &"words"& within the header text, but does no
9403 character set translation. If decoding of what looks superficially like a MIME
9404 &"word"& fails, the raw string is returned. If decoding
9405 .cindex "binary zero" "in header line"
9406 produces a binary zero character, it is replaced by a question mark &-- this is
9407 what Exim does for binary zeros that are actually received in header lines.
9408
9409 .next
9410 &%header%& tries to translate the string as decoded by &%bheader%& to a
9411 standard character set. This is an attempt to produce the same string as would
9412 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9413 returned. Translation is attempted only on operating systems that support the
9414 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9415 a system Makefile or in &_Local/Makefile_&.
9416 .endlist ilist
9417
9418 In a filter file, the target character set for &%header%& can be specified by a
9419 command of the following form:
9420 .code
9421 headers charset "UTF-8"
9422 .endd
9423 This command affects all references to &$h_$& (or &$header_$&) expansions in
9424 subsequently obeyed filter commands. In the absence of this command, the target
9425 character set in a filter is taken from the setting of the &%headers_charset%&
9426 option in the runtime configuration. The value of this option defaults to the
9427 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9428 ISO-8859-1.
9429
9430 Header names follow the syntax of RFC 2822, which states that they may contain
9431 any printing characters except space and colon. Consequently, curly brackets
9432 &'do not'& terminate header names, and should not be used to enclose them as
9433 if they were variables. Attempting to do so causes a syntax error.
9434
9435 Only header lines that are common to all copies of a message are visible to
9436 this mechanism. These are the original header lines that are received with the
9437 message, and any that are added by an ACL statement or by a system
9438 filter. Header lines that are added to a particular copy of a message by a
9439 router or transport are not accessible.
9440
9441 For incoming SMTP messages, no header lines are visible in
9442 .new
9443 ACLs that are obeyed before the data phase completes,
9444 .wen
9445 because the header structure is not set up until the message is received.
9446 They are visible in DKIM, PRDR and DATA ACLs.
9447 Header lines that are added in a RCPT ACL (for example)
9448 are saved until the message's incoming header lines are available, at which
9449 point they are added.
9450 .new
9451 When any of the above ACLs ar
9452 .wen
9453 running, however, header lines added by earlier ACLs are visible.
9454
9455 Upper case and lower case letters are synonymous in header names. If the
9456 following character is white space, the terminating colon may be omitted, but
9457 this is not recommended, because you may then forget it when it is needed. When
9458 white space terminates the header name, this white space is included in the
9459 expanded string.  If the message does not contain the given header, the
9460 expansion item is replaced by an empty string. (See the &%def%& condition in
9461 section &<<SECTexpcond>>& for a means of testing for the existence of a
9462 header.)
9463
9464 If there is more than one header with the same name, they are all concatenated
9465 to form the substitution string, up to a maximum length of 64K. Unless
9466 &%rheader%& is being used, leading and trailing white space is removed from
9467 each header before concatenation, and a completely empty header is ignored. A
9468 newline character is then inserted between non-empty headers, but there is no
9469 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9470 those headers that contain lists of addresses, a comma is also inserted at the
9471 junctions between headers. This does not happen for the &%rheader%& expansion.
9472
9473
9474 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9475 .cindex "expansion" "hmac hashing"
9476 .cindex &%hmac%&
9477 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9478 shared secret and some text into a message authentication code, as specified in
9479 RFC 2104. This differs from &`${md5:secret_text...}`& or
9480 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9481 cryptographic hash, allowing for authentication that is not possible with MD5
9482 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9483 present. For example:
9484 .code
9485 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9486 .endd
9487 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9488 produces:
9489 .code
9490 dd97e3ba5d1a61b5006108f8c8252953
9491 .endd
9492 As an example of how this might be used, you might put in the main part of
9493 an Exim configuration:
9494 .code
9495 SPAMSCAN_SECRET=cohgheeLei2thahw
9496 .endd
9497 In a router or a transport you could then have:
9498 .code
9499 headers_add = \
9500   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9501   ${hmac{md5}{SPAMSCAN_SECRET}\
9502   {${primary_hostname},${message_exim_id},$h_message-id:}}
9503 .endd
9504 Then given a message, you can check where it was scanned by looking at the
9505 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9506 this header line is authentic by recomputing the authentication code from the
9507 host name, message ID and the &'Message-id:'& header line. This can be done
9508 using Exim's &%-be%& option, or by other means, for example by using the
9509 &'hmac_md5_hex()'& function in Perl.
9510
9511
9512 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9513 .cindex "expansion" "conditional"
9514 .cindex "&%if%&, expansion item"
9515 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9516 item; otherwise <&'string2'&> is used. The available conditions are described
9517 in section &<<SECTexpcond>>& below. For example:
9518 .code
9519 ${if eq {$local_part}{postmaster} {yes}{no} }
9520 .endd
9521 The second string need not be present; if it is not and the condition is not
9522 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9523 be present instead of the second string (without any curly brackets). In this
9524 case, the expansion is forced to fail if the condition is not true (see section
9525 &<<SECTforexpfai>>&).
9526
9527 If both strings are omitted, the result is the string &`true`& if the condition
9528 is true, and the empty string if the condition is false. This makes it less
9529 cumbersome to write custom ACL and router conditions. For example, instead of
9530 .code
9531 condition = ${if >{$acl_m4}{3}{true}{false}}
9532 .endd
9533 you can use
9534 .code
9535 condition = ${if >{$acl_m4}{3}}
9536 .endd
9537
9538
9539
9540 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9541 .cindex expansion "imap folder"
9542 .cindex "&%imapfolder%& expansion item"
9543 This item converts a (possibly multilevel, or with non-ASCII characters)
9544 folder specification to a Maildir name for filesystem use.
9545 For information on internationalisation support see &<<SECTi18nMDA>>&.
9546
9547
9548
9549 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9550 .cindex "expansion" "string truncation"
9551 .cindex "&%length%& expansion item"
9552 The &%length%& item is used to extract the initial portion of a string. Both
9553 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9554 you are using a fixed value for the number, that is, if <&'string1'&> does not
9555 change when expanded, you can use the simpler operator notation that avoids
9556 some of the braces:
9557 .code
9558 ${length_<n>:<string>}
9559 .endd
9560 The result of this item is either the first <&'n'&> characters or the whole
9561 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9562 &%strlen%&, which gives the length of a string.
9563
9564
9565 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9566         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9567 .cindex "expansion" "extracting list elements by number"
9568 .cindex "&%listextract%&" "extract list elements by number"
9569 .cindex "list" "extracting elements by number"
9570 The <&'number'&> argument must consist entirely of decimal digits,
9571 apart from an optional leading minus,
9572 and leading and trailing white space (which is ignored).
9573
9574 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9575 default, but the separator can be changed in the usual way.
9576
9577 The first field of the list is numbered one.
9578 If the number is negative, the fields are
9579 counted from the end of the list, with the rightmost one numbered -1.
9580 The numbered element of the list is extracted and placed in &$value$&,
9581 then <&'string2'&> is expanded as the result.
9582
9583 If the modulus of the
9584 number is zero or greater than the number of fields in the string,
9585 the result is the expansion of <&'string3'&>.
9586
9587 For example:
9588 .code
9589 ${listextract{2}{x:42:99}}
9590 .endd
9591 yields &"42"&, and
9592 .code
9593 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9594 .endd
9595 yields &"result: 42"&.
9596
9597 If {<&'string3'&>} is omitted, an empty string is used for string3.
9598 If {<&'string2'&>} is also omitted, the value that was
9599 extracted is used.
9600 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9601
9602
9603 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9604         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9605 This is the first of one of two different types of lookup item, which are both
9606 described in the next item.
9607
9608 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9609         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9610 .cindex "expansion" "lookup in"
9611 .cindex "file" "lookups"
9612 .cindex "lookup" "in expanded string"
9613 The two forms of lookup item specify data lookups in files and databases, as
9614 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9615 lookups, and the second is used for query-style lookups. The <&'key'&>,
9616 <&'file'&>, and <&'query'&> strings are expanded before use.
9617
9618 If there is any white space in a lookup item which is part of a filter command,
9619 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9620 other place where white space is significant, the lookup item must be enclosed
9621 in double quotes. The use of data lookups in users' filter files may be locked
9622 out by the system administrator.
9623
9624 .vindex "&$value$&"
9625 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9626 During its expansion, the variable &$value$& contains the data returned by the
9627 lookup. Afterwards it reverts to the value it had previously (at the outer
9628 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9629 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9630 string on failure. If <&'string2'&> is provided, it can itself be a nested
9631 lookup, thus providing a mechanism for looking up a default value when the
9632 original lookup fails.
9633
9634 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9635 data for the outer lookup while the parameters of the second lookup are
9636 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9637 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9638 appear, and in this case, if the lookup fails, the entire expansion is forced
9639 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9640 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9641 successful lookup, and nothing in the case of failure.
9642
9643 For single-key lookups, the string &"partial"& is permitted to precede the
9644 search type in order to do partial matching, and * or *@ may follow a search
9645 type to request default lookups if the key does not match (see sections
9646 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9647
9648 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9649 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9650 and non-wild parts of the key during the expansion of the replacement text.
9651 They return to their previous values at the end of the lookup item.
9652
9653 This example looks up the postmaster alias in the conventional alias file:
9654 .code
9655 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9656 .endd
9657 This example uses NIS+ to look up the full name of the user corresponding to
9658 the local part of an address, forcing the expansion to fail if it is not found:
9659 .code
9660 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9661   {$value}fail}
9662 .endd
9663
9664
9665 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9666 .cindex "expansion" "list creation"
9667 .vindex "&$item$&"
9668 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9669 default, but the separator can be changed in the usual way. For each item
9670 in this list, its value is place in &$item$&, and then <&'string2'&> is
9671 expanded and added to the output as an item in a new list. The separator used
9672 for the output list is the same as the one used for the input, but a separator
9673 setting is not included in the output. For example:
9674 .code
9675 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9676 .endd
9677 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9678 value of &$item$& is restored to what it was before. See also the &*filter*&
9679 and &*reduce*& expansion items.
9680
9681 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9682 .cindex "expansion" "numeric hash"
9683 .cindex "hash function" "numeric"
9684 The three strings are expanded; the first two must yield numbers. Call them
9685 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9686 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9687 can use the simpler operator notation that avoids some of the braces:
9688 .code
9689 ${nhash_<n>_<m>:<string>}
9690 .endd
9691 The second number is optional (in both notations). If there is only one number,
9692 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9693 processed by a div/mod hash function that returns two numbers, separated by a
9694 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9695 example,
9696 .code
9697 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9698 .endd
9699 returns the string &"6/33"&.
9700
9701
9702
9703 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9704 .cindex "Perl" "use in expanded string"
9705 .cindex "expansion" "calling Perl from"
9706 This item is available only if Exim has been built to include an embedded Perl
9707 interpreter. The subroutine name and the arguments are first separately
9708 expanded, and then the Perl subroutine is called with those arguments. No
9709 additional arguments need be given; the maximum number permitted, including the
9710 name of the subroutine, is nine.
9711
9712 The return value of the subroutine is inserted into the expanded string, unless
9713 the return value is &%undef%&. In that case, the expansion fails in the same
9714 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9715 Whatever you return is evaluated in a scalar context. For example, if you
9716 return the name of a Perl vector, the return value is the size of the vector,
9717 not its contents.
9718
9719 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9720 with the error message that was passed to &%die%&. More details of the embedded
9721 Perl facility are given in chapter &<<CHAPperl>>&.
9722
9723 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9724 out the use of this expansion item in filter files.
9725
9726
9727 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9728 .cindex "&%prvs%& expansion item"
9729 The first argument is a complete email address and the second is secret
9730 keystring. The third argument, specifying a key number, is optional. If absent,
9731 it defaults to 0. The result of the expansion is a prvs-signed email address,
9732 to be typically used with the &%return_path%& option on an &(smtp)& transport
9733 as part of a bounce address tag validation (BATV) scheme. For more discussion
9734 and an example, see section &<<SECTverifyPRVS>>&.
9735
9736 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9737         {*&<&'string'&>&*}}*&"
9738 .cindex "&%prvscheck%& expansion item"
9739 This expansion item is the complement of the &%prvs%& item. It is used for
9740 checking prvs-signed addresses. If the expansion of the first argument does not
9741 yield a syntactically valid prvs-signed address, the whole item expands to the
9742 empty string. When the first argument does expand to a syntactically valid
9743 prvs-signed address, the second argument is expanded, with the prvs-decoded
9744 version of the address and the key number extracted from the address in the
9745 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9746
9747 These two variables can be used in the expansion of the second argument to
9748 retrieve the secret. The validity of the prvs-signed address is then checked
9749 against the secret. The result is stored in the variable &$prvscheck_result$&,
9750 which is empty for failure or &"1"& for success.
9751
9752 The third argument is optional; if it is missing, it defaults to an empty
9753 string. This argument is now expanded. If the result is an empty string, the
9754 result of the expansion is the decoded version of the address. This is the case
9755 whether or not the signature was valid. Otherwise, the result of the expansion
9756 is the expansion of the third argument.
9757
9758 All three variables can be used in the expansion of the third argument.
9759 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9760 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9761
9762 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9763 .cindex "expansion" "inserting an entire file"
9764 .cindex "file" "inserting into expansion"
9765 .cindex "&%readfile%& expansion item"
9766 The file name and end-of-line string are first expanded separately. The file is
9767 then read, and its contents replace the entire item. All newline characters in
9768 the file are replaced by the end-of-line string if it is present. Otherwise,
9769 newlines are left in the string.
9770 String expansion is not applied to the contents of the file. If you want this,
9771 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9772 the string expansion fails.
9773
9774 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9775 locks out the use of this expansion item in filter files.
9776
9777
9778
9779 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9780         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9781 .cindex "expansion" "inserting from a socket"
9782 .cindex "socket, use of in expansion"
9783 .cindex "&%readsocket%& expansion item"
9784 This item inserts data from a Unix domain or TCP socket into the expanded
9785 string. The minimal way of using it uses just two arguments, as in these
9786 examples:
9787 .code
9788 ${readsocket{/socket/name}{request string}}
9789 ${readsocket{inet:some.host:1234}{request string}}
9790 .endd
9791 For a Unix domain socket, the first substring must be the path to the socket.
9792 For an Internet socket, the first substring must contain &`inet:`& followed by
9793 a host name or IP address, followed by a colon and a port, which can be a
9794 number or the name of a TCP port in &_/etc/services_&. An IP address may
9795 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9796 example:
9797 .code
9798 ${readsocket{inet:[::1]:1234}{request string}}
9799 .endd
9800 Only a single host name may be given, but if looking it up yields more than
9801 one IP address, they are each tried in turn until a connection is made. For
9802 both kinds of socket, Exim makes a connection, writes the request string
9803 unless it is an empty string; and no terminating NUL is ever sent)
9804 and reads from the socket until an end-of-file
9805 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9806 extend what can be done. Firstly, you can vary the timeout. For example:
9807 .code
9808 ${readsocket{/socket/name}{request string}{3s}}
9809 .endd
9810 A fourth argument allows you to change any newlines that are in the data
9811 that is read, in the same way as for &%readfile%& (see above). This example
9812 turns them into spaces:
9813 .code
9814 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9815 .endd
9816 As with all expansions, the substrings are expanded before the processing
9817 happens. Errors in these sub-expansions cause the expansion to fail. In
9818 addition, the following errors can occur:
9819
9820 .ilist
9821 Failure to create a socket file descriptor;
9822 .next
9823 Failure to connect the socket;
9824 .next
9825 Failure to write the request string;
9826 .next
9827 Timeout on reading from the socket.
9828 .endlist
9829
9830 By default, any of these errors causes the expansion to fail. However, if
9831 you supply a fifth substring, it is expanded and used when any of the above
9832 errors occurs. For example:
9833 .code
9834 ${readsocket{/socket/name}{request string}{3s}{\n}\
9835   {socket failure}}
9836 .endd
9837 You can test for the existence of a Unix domain socket by wrapping this
9838 expansion in &`${if exists`&, but there is a race condition between that test
9839 and the actual opening of the socket, so it is safer to use the fifth argument
9840 if you want to be absolutely sure of avoiding an expansion error for a
9841 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9842
9843 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9844 locks out the use of this expansion item in filter files.
9845
9846
9847 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9848 .cindex "expansion" "reducing a list to a scalar"
9849 .cindex "list" "reducing to a scalar"
9850 .vindex "&$value$&"
9851 .vindex "&$item$&"
9852 This operation reduces a list to a single, scalar string. After expansion,
9853 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9854 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9855 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9856 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9857 them. The result of that expansion is assigned to &$value$& before the next
9858 iteration. When the end of the list is reached, the final value of &$value$& is
9859 added to the expansion output. The &*reduce*& expansion item can be used in a
9860 number of ways. For example, to add up a list of numbers:
9861 .code
9862 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9863 .endd
9864 The result of that expansion would be &`6`&. The maximum of a list of numbers
9865 can be found:
9866 .code
9867 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9868 .endd
9869 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9870 restored to what they were before. See also the &*filter*& and &*map*&
9871 expansion items.
9872
9873 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9874 This item inserts &"raw"& header lines. It is described with the &%header%&
9875 expansion item above.
9876
9877 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9878         {*&<&'string2'&>&*}}*&"
9879 .cindex "expansion" "running a command"
9880 .cindex "&%run%& expansion item"
9881 The command and its arguments are first expanded as one string. The string is
9882 split apart into individual arguments by spaces, and then the command is run
9883 in a separate process, but under the same uid and gid.  As in other command
9884 executions from Exim, a shell is not used by default. If the command requires
9885 a shell, you must explicitly code it.
9886
9887 Since the arguments are split by spaces, when there is a variable expansion
9888 which has an empty result, it will cause the situation that the argument will
9889 simply be omitted when the program is actually executed by Exim. If the
9890 script/program requires a specific number of arguments and the expanded
9891 variable could possibly result in this empty expansion, the variable must be
9892 quoted. This is more difficult if the expanded variable itself could result
9893 in a string containing quotes, because it would interfere with the quotes
9894 around the command arguments. A possible guard against this is to wrap the
9895 variable in the &%sg%& operator to change any quote marks to some other
9896 character.
9897
9898 The standard input for the command exists, but is empty. The standard output
9899 and standard error are set to the same file descriptor.
9900 .cindex "return code" "from &%run%& expansion"
9901 .vindex "&$value$&"
9902 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9903 and replaces the entire item; during this expansion, the standard output/error
9904 from the command is in the variable &$value$&. If the command fails,
9905 <&'string2'&>, if present, is expanded and used. Once again, during the
9906 expansion, the standard output/error from the command is in the variable
9907 &$value$&.
9908
9909 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9910 can be the word &"fail"& (not in braces) to force expansion failure if the
9911 command does not succeed. If both strings are omitted, the result is contents
9912 of the standard output/error on success, and nothing on failure.
9913
9914 .vindex "&$run_in_acl$&"
9915 The standard output/error of the command is put in the variable &$value$&.
9916 In this ACL example, the output of a command is logged for the admin to
9917 troubleshoot:
9918 .code
9919 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9920       log_message  = Output of id: $value
9921 .endd
9922 If the command requires shell idioms, such as the > redirect operator, the
9923 shell must be invoked directly, such as with:
9924 .code
9925 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9926 .endd
9927
9928 .vindex "&$runrc$&"
9929 The return code from the command is put in the variable &$runrc$&, and this
9930 remains set afterwards, so in a filter file you can do things like this:
9931 .code
9932 if "${run{x y z}{}}$runrc" is 1 then ...
9933   elif $runrc is 2 then ...
9934   ...
9935 endif
9936 .endd
9937 If execution of the command fails (for example, the command does not exist),
9938 the return code is 127 &-- the same code that shells use for non-existent
9939 commands.
9940
9941 &*Warning*&: In a router or transport, you cannot assume the order in which
9942 option values are expanded, except for those preconditions whose order of
9943 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9944 by the expansion of one option, and use it in another.
9945
9946 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9947 out the use of this expansion item in filter files.
9948
9949
9950 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9951 .cindex "expansion" "string substitution"
9952 .cindex "&%sg%& expansion item"
9953 This item works like Perl's substitution operator (s) with the global (/g)
9954 option; hence its name. However, unlike the Perl equivalent, Exim does not
9955 modify the subject string; instead it returns the modified string for insertion
9956 into the overall expansion. The item takes three arguments: the subject string,
9957 a regular expression, and a substitution string. For example:
9958 .code
9959 ${sg{abcdefabcdef}{abc}{xyz}}
9960 .endd
9961 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9962 if any $ or \ characters are required in the regular expression or in the
9963 substitution string, they have to be escaped. For example:
9964 .code
9965 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9966 .endd
9967 yields &"defabc"&, and
9968 .code
9969 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9970 .endd
9971 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9972 the regular expression from string expansion.
9973
9974
9975
9976 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9977 .cindex sorting "a list"
9978 .cindex list sorting
9979 .cindex expansion "list sorting"
9980 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9981 default, but the separator can be changed in the usual way.
9982 The <&'comparator'&> argument is interpreted as the operator
9983 of a two-argument expansion condition.
9984 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9985 The comparison should return true when applied to two values
9986 if the first value should sort before the second value.
9987 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9988 the element being placed in &$item$&,
9989 to give values for comparison.
9990
9991 The item result is a sorted list,
9992 with the original list separator,
9993 of the list elements (in full) of the original.
9994
9995 Examples:
9996 .code
9997 ${sort{3:2:1:4}{<}{$item}}
9998 .endd
9999 sorts a list of numbers, and
10000 .code
10001 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10002 .endd
10003 will sort an MX lookup into priority order.
10004
10005
10006 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10007 .cindex "&%substr%& expansion item"
10008 .cindex "substring extraction"
10009 .cindex "expansion" "substring extraction"
10010 The three strings are expanded; the first two must yield numbers. Call them
10011 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10012 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10013 can use the simpler operator notation that avoids some of the braces:
10014 .code
10015 ${substr_<n>_<m>:<string>}
10016 .endd
10017 The second number is optional (in both notations).
10018 If it is absent in the simpler format, the preceding underscore must also be
10019 omitted.
10020
10021 The &%substr%& item can be used to extract more general substrings than
10022 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10023 length required. For example
10024 .code
10025 ${substr{3}{2}{$local_part}}
10026 .endd
10027 If the starting offset is greater than the string length the result is the
10028 null string; if the length plus starting offset is greater than the string
10029 length, the result is the right-hand part of the string, starting from the
10030 given offset. The first character in the string has offset zero.
10031
10032 The &%substr%& expansion item can take negative offset values to count
10033 from the right-hand end of its operand. The last character is offset -1, the
10034 second-last is offset -2, and so on. Thus, for example,
10035 .code
10036 ${substr{-5}{2}{1234567}}
10037 .endd
10038 yields &"34"&. If the absolute value of a negative offset is greater than the
10039 length of the string, the substring starts at the beginning of the string, and
10040 the length is reduced by the amount of overshoot. Thus, for example,
10041 .code
10042 ${substr{-5}{2}{12}}
10043 .endd
10044 yields an empty string, but
10045 .code
10046 ${substr{-3}{2}{12}}
10047 .endd
10048 yields &"1"&.
10049
10050 When the second number is omitted from &%substr%&, the remainder of the string
10051 is taken if the offset is positive. If it is negative, all characters in the
10052 string preceding the offset point are taken. For example, an offset of -1 and
10053 no length, as in these semantically identical examples:
10054 .code
10055 ${substr_-1:abcde}
10056 ${substr{-1}{abcde}}
10057 .endd
10058 yields all but the last character of the string, that is, &"abcd"&.
10059
10060
10061
10062 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10063         {*&<&'replacements'&>&*}}*&"
10064 .cindex "expansion" "character translation"
10065 .cindex "&%tr%& expansion item"
10066 This item does single-character translation on its subject string. The second
10067 argument is a list of characters to be translated in the subject string. Each
10068 matching character is replaced by the corresponding character from the
10069 replacement list. For example
10070 .code
10071 ${tr{abcdea}{ac}{13}}
10072 .endd
10073 yields &`1b3de1`&. If there are duplicates in the second character string, the
10074 last occurrence is used. If the third string is shorter than the second, its
10075 last character is replicated. However, if it is empty, no translation takes
10076 place.
10077 .endlist
10078
10079
10080
10081 .section "Expansion operators" "SECTexpop"
10082 .cindex "expansion" "operators"
10083 For expansion items that perform transformations on a single argument string,
10084 the &"operator"& notation is used because it is simpler and uses fewer braces.
10085 The substring is first expanded before the operation is applied to it. The
10086 following operations can be performed:
10087
10088 .vlist
10089 .vitem &*${address:*&<&'string'&>&*}*&
10090 .cindex "expansion" "RFC 2822 address handling"
10091 .cindex "&%address%& expansion item"
10092 The string is interpreted as an RFC 2822 address, as it might appear in a
10093 header line, and the effective address is extracted from it. If the string does
10094 not parse successfully, the result is empty.
10095
10096
10097 .vitem &*${addresses:*&<&'string'&>&*}*&
10098 .cindex "expansion" "RFC 2822 address handling"
10099 .cindex "&%addresses%& expansion item"
10100 The string (after expansion) is interpreted as a list of addresses in RFC
10101 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10102 operative address (&'local-part@domain'&) is extracted from each item, and the
10103 result of the expansion is a colon-separated list, with appropriate
10104 doubling of colons should any happen to be present in the email addresses.
10105 Syntactically invalid RFC2822 address items are omitted from the output.
10106
10107 It is possible to specify a character other than colon for the output
10108 separator by starting the string with > followed by the new separator
10109 character. For example:
10110 .code
10111 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10112 .endd
10113 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10114 expansion item, which extracts the working address from a single RFC2822
10115 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10116 processing lists.
10117
10118 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10119 a strict interpretation of header line formatting.  Exim parses the bare,
10120 unquoted portion of an email address and if it finds a comma, treats it as an
10121 email address separator. For the example header line:
10122 .code
10123 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10124 .endd
10125 The first example below demonstrates that Q-encoded email addresses are parsed
10126 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10127 It does not see the comma because it's still encoded as "=2C".  The second
10128 example below is passed the contents of &`$header_from:`&, meaning it gets
10129 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10130 The third example shows that the presence of a comma is skipped when it is
10131 quoted.
10132 .code
10133 # exim -be '${addresses:From: \
10134 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10135 user@example.com
10136 # exim -be '${addresses:From: Last, First <user@example.com>}'
10137 Last:user@example.com
10138 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10139 user@example.com
10140 .endd
10141
10142 .new
10143 .vitem &*${base32:*&<&'digits'&>&*}*&
10144 .cindex "&%base32%& expansion item"
10145 .cindex "expansion" "conversion to base 32"
10146 The string must consist entirely of decimal digits. The number is converted to
10147 base 32 and output as a (empty, for zero) string of characters.
10148 Only lowercase letters are used.
10149
10150 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10151 .cindex "&%base32d%& expansion item"
10152 .cindex "expansion" "conversion to base 32"
10153 The string must consist entirely of base-32 digits.
10154 The number is converted to decimal and output as a string.
10155 .wen
10156
10157 .vitem &*${base62:*&<&'digits'&>&*}*&
10158 .cindex "&%base62%& expansion item"
10159 .cindex "expansion" "conversion to base 62"
10160 The string must consist entirely of decimal digits. The number is converted to
10161 base 62 and output as a string of six characters, including leading zeros. In
10162 the few operating environments where Exim uses base 36 instead of base 62 for
10163 its message identifiers (because those systems do not have case-sensitive file
10164 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10165 be absolutely clear: this is &'not'& base64 encoding.
10166
10167 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10168 .cindex "&%base62d%& expansion item"
10169 .cindex "expansion" "conversion to base 62"
10170 The string must consist entirely of base-62 digits, or, in operating
10171 environments where Exim uses base 36 instead of base 62 for its message
10172 identifiers, base-36 digits. The number is converted to decimal and output as a
10173 string.
10174
10175 .vitem &*${base64:*&<&'string'&>&*}*&
10176 .cindex "expansion" "base64 encoding"
10177 .cindex "base64 encoding" "in string expansion"
10178 .cindex "&%base64%& expansion item"
10179 .cindex certificate "base64 of DER"
10180 This operator converts a string into one that is base64 encoded.
10181
10182 If the string is a single variable of type certificate,
10183 returns the base64 encoding of the DER form of the certificate.
10184
10185
10186 .vitem &*${base64d:*&<&'string'&>&*}*&
10187 .cindex "expansion" "base64 decoding"
10188 .cindex "base64 decoding" "in string expansion"
10189 .cindex "&%base64d%& expansion item"
10190 This operator converts a base64-encoded string into the un-coded form.
10191
10192
10193 .vitem &*${domain:*&<&'string'&>&*}*&
10194 .cindex "domain" "extraction"
10195 .cindex "expansion" "domain extraction"
10196 The string is interpreted as an RFC 2822 address and the domain is extracted
10197 from it. If the string does not parse successfully, the result is empty.
10198
10199
10200 .vitem &*${escape:*&<&'string'&>&*}*&
10201 .cindex "expansion" "escaping non-printing characters"
10202 .cindex "&%escape%& expansion item"
10203 If the string contains any non-printing characters, they are converted to
10204 escape sequences starting with a backslash. Whether characters with the most
10205 significant bit set (so-called &"8-bit characters"&) count as printing or not
10206 is controlled by the &%print_topbitchars%& option.
10207
10208 .new
10209 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10210 .cindex "expansion" "escaping 8-bit characters"
10211 .cindex "&%escape8bit%& expansion item"
10212 If the string contains and characters with the most significant bit set,
10213 they are converted to escape sequences starting with a backslash.
10214 Backslashes and DEL characters are also converted.
10215 .wen
10216
10217
10218 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10219 .cindex "expansion" "expression evaluation"
10220 .cindex "expansion" "arithmetic expression"
10221 .cindex "&%eval%& expansion item"
10222 These items supports simple arithmetic and bitwise logical operations in
10223 expansion strings. The string (after expansion) must be a conventional
10224 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10225 logical operators, and parentheses. All operations are carried out using
10226 integer arithmetic. The operator priorities are as follows (the same as in the
10227 C programming language):
10228 .table2 70pt 300pt
10229 .irow &'highest:'& "not (~), negate (-)"
10230 .irow ""   "multiply (*), divide (/), remainder (%)"
10231 .irow ""   "plus (+), minus (-)"
10232 .irow ""   "shift-left (<<), shift-right (>>)"
10233 .irow ""   "and (&&)"
10234 .irow ""   "xor (^)"
10235 .irow &'lowest:'&  "or (|)"
10236 .endtable
10237 Binary operators with the same priority are evaluated from left to right. White
10238 space is permitted before or after operators.
10239
10240 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10241 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10242 decimal, even if they start with a leading zero; hexadecimal numbers are not
10243 permitted. This can be useful when processing numbers extracted from dates or
10244 times, which often do have leading zeros.
10245
10246 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10247 or 1024*1024*1024,
10248 respectively. Negative numbers are supported. The result of the computation is
10249 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10250
10251 .display
10252 &`${eval:1+1}            `&  yields 2
10253 &`${eval:1+2*3}          `&  yields 7
10254 &`${eval:(1+2)*3}        `&  yields 9
10255 &`${eval:2+42%5}         `&  yields 4
10256 &`${eval:0xc&amp;5}          `&  yields 4
10257 &`${eval:0xc|5}          `&  yields 13
10258 &`${eval:0xc^5}          `&  yields 9
10259 &`${eval:0xc>>1}         `&  yields 6
10260 &`${eval:0xc<<1}         `&  yields 24
10261 &`${eval:~255&amp;0x1234}    `&  yields 4608
10262 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10263 .endd
10264
10265 As a more realistic example, in an ACL you might have
10266 .code
10267 deny   message = Too many bad recipients
10268        condition =                    \
10269          ${if and {                   \
10270            {>{$rcpt_count}{10}}       \
10271            {                          \
10272            <                          \
10273              {$recipients_count}      \
10274              {${eval:$rcpt_count/2}}  \
10275            }                          \
10276          }{yes}{no}}
10277 .endd
10278 The condition is true if there have been more than 10 RCPT commands and
10279 fewer than half of them have resulted in a valid recipient.
10280
10281
10282 .vitem &*${expand:*&<&'string'&>&*}*&
10283 .cindex "expansion" "re-expansion of substring"
10284 The &%expand%& operator causes a string to be expanded for a second time. For
10285 example,
10286 .code
10287 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10288 .endd
10289 first looks up a string in a file while expanding the operand for &%expand%&,
10290 and then re-expands what it has found.
10291
10292
10293 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10294 .cindex "Unicode"
10295 .cindex "UTF-8" "conversion from"
10296 .cindex "expansion" "UTF-8 conversion"
10297 .cindex "&%from_utf8%& expansion item"
10298 The world is slowly moving towards Unicode, although there are no standards for
10299 email yet. However, other applications (including some databases) are starting
10300 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10301 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10302 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10303 the result is an undefined sequence of bytes.
10304
10305 Unicode code points with values less than 256 are compatible with ASCII and
10306 ISO-8859-1 (also known as Latin-1).
10307 For example, character 169 is the copyright symbol in both cases, though the
10308 way it is encoded is different. In UTF-8, more than one byte is needed for
10309 characters with code values greater than 127, whereas ISO-8859-1 is a
10310 single-byte encoding (but thereby limited to 256 characters). This makes
10311 translation from UTF-8 to ISO-8859-1 straightforward.
10312
10313
10314 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10315 .cindex "hash function" "textual"
10316 .cindex "expansion" "textual hash"
10317 The &%hash%& operator is a simpler interface to the hashing function that can
10318 be used when the two parameters are fixed numbers (as opposed to strings that
10319 change when expanded). The effect is the same as
10320 .code
10321 ${hash{<n>}{<m>}{<string>}}
10322 .endd
10323 See the description of the general &%hash%& item above for details. The
10324 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10325
10326
10327
10328 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10329 .cindex "base64 encoding" "conversion from hex"
10330 .cindex "expansion" "hex to base64"
10331 .cindex "&%hex2b64%& expansion item"
10332 This operator converts a hex string into one that is base64 encoded. This can
10333 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10334
10335
10336
10337 .vitem &*${hexquote:*&<&'string'&>&*}*&
10338 .cindex "quoting" "hex-encoded unprintable characters"
10339 .cindex "&%hexquote%& expansion item"
10340 This operator converts non-printable characters in a string into a hex
10341 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10342 as is, and other byte values are converted to &`\xNN`&, for example a
10343 byte value 127 is converted to &`\x7f`&.
10344
10345
10346 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10347 .cindex "&%ipv6denorm%& expansion item"
10348 .cindex "IP address" normalisation
10349 This expands an IPv6 address to a full eight-element colon-separated set
10350 of hex digits including leading zeroes.
10351 A trailing ipv4-style dotted-decimal set is converted to hex.
10352 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10353
10354 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10355 .cindex "&%ipv6norm%& expansion item"
10356 .cindex "IP address" normalisation
10357 .cindex "IP address" "canonical form"
10358 This converts an IPv6 address to canonical form.
10359 Leading zeroes of groups are omitted, and the longest
10360 set of zero-valued groups is replaced with a double colon.
10361 A trailing ipv4-style dotted-decimal set is converted to hex.
10362 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10363
10364
10365 .vitem &*${lc:*&<&'string'&>&*}*&
10366 .cindex "case forcing in strings"
10367 .cindex "string" "case forcing"
10368 .cindex "lower casing"
10369 .cindex "expansion" "case forcing"
10370 .cindex "&%lc%& expansion item"
10371 This forces the letters in the string into lower-case, for example:
10372 .code
10373 ${lc:$local_part}
10374 .endd
10375
10376 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10377 .cindex "expansion" "string truncation"
10378 .cindex "&%length%& expansion item"
10379 The &%length%& operator is a simpler interface to the &%length%& function that
10380 can be used when the parameter is a fixed number (as opposed to a string that
10381 changes when expanded). The effect is the same as
10382 .code
10383 ${length{<number>}{<string>}}
10384 .endd
10385 See the description of the general &%length%& item above for details. Note that
10386 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10387 when &%length%& is used as an operator.
10388
10389
10390 .vitem &*${listcount:*&<&'string'&>&*}*&
10391 .cindex "expansion" "list item count"
10392 .cindex "list" "item count"
10393 .cindex "list" "count of items"
10394 .cindex "&%listcount%& expansion item"
10395 The string is interpreted as a list and the number of items is returned.
10396
10397
10398 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10399 .cindex "expansion" "named list"
10400 .cindex "&%listnamed%& expansion item"
10401 The name is interpreted as a named list and the content of the list is returned,
10402 expanding any referenced lists, re-quoting as needed for colon-separation.
10403 If the optional type is given it must be one of "a", "d", "h" or "l"
10404 and selects address-, domain-, host- or localpart- lists to search among respectively.
10405 Otherwise all types are searched in an undefined order and the first
10406 matching list is returned.
10407
10408
10409 .vitem &*${local_part:*&<&'string'&>&*}*&
10410 .cindex "expansion" "local part extraction"
10411 .cindex "&%local_part%& expansion item"
10412 The string is interpreted as an RFC 2822 address and the local part is
10413 extracted from it. If the string does not parse successfully, the result is
10414 empty.
10415
10416
10417 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10418 .cindex "masked IP address"
10419 .cindex "IP address" "masking"
10420 .cindex "CIDR notation"
10421 .cindex "expansion" "IP address masking"
10422 .cindex "&%mask%& expansion item"
10423 If the form of the string to be operated on is not an IP address followed by a
10424 slash and an integer (that is, a network address in CIDR notation), the
10425 expansion fails. Otherwise, this operator converts the IP address to binary,
10426 masks off the least significant bits according to the bit count, and converts
10427 the result back to text, with mask appended. For example,
10428 .code
10429 ${mask:10.111.131.206/28}
10430 .endd
10431 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10432 be mostly used for looking up masked addresses in files, the result for an IPv6
10433 address uses dots to separate components instead of colons, because colon
10434 terminates a key string in lsearch files. So, for example,
10435 .code
10436 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10437 .endd
10438 returns the string
10439 .code
10440 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10441 .endd
10442 Letters in IPv6 addresses are always output in lower case.
10443
10444
10445 .vitem &*${md5:*&<&'string'&>&*}*&
10446 .cindex "MD5 hash"
10447 .cindex "expansion" "MD5 hash"
10448 .cindex certificate fingerprint
10449 .cindex "&%md5%& expansion item"
10450 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10451 as a 32-digit hexadecimal number, in which any letters are in lower case.
10452
10453 If the string is a single variable of type certificate,
10454 returns the MD5 hash fingerprint of the certificate.
10455
10456
10457 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10458 .cindex "expansion" "numeric hash"
10459 .cindex "hash function" "numeric"
10460 The &%nhash%& operator is a simpler interface to the numeric hashing function
10461 that can be used when the two parameters are fixed numbers (as opposed to
10462 strings that change when expanded). The effect is the same as
10463 .code
10464 ${nhash{<n>}{<m>}{<string>}}
10465 .endd
10466 See the description of the general &%nhash%& item above for details.
10467
10468
10469 .vitem &*${quote:*&<&'string'&>&*}*&
10470 .cindex "quoting" "in string expansions"
10471 .cindex "expansion" "quoting"
10472 .cindex "&%quote%& expansion item"
10473 The &%quote%& operator puts its argument into double quotes if it
10474 is an empty string or
10475 contains anything other than letters, digits, underscores, dots, and hyphens.
10476 Any occurrences of double quotes and backslashes are escaped with a backslash.
10477 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10478 respectively For example,
10479 .code
10480 ${quote:ab"*"cd}
10481 .endd
10482 becomes
10483 .code
10484 "ab\"*\"cd"
10485 .endd
10486 The place where this is useful is when the argument is a substitution from a
10487 variable or a message header.
10488
10489 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10490 .cindex "&%quote_local_part%& expansion item"
10491 This operator is like &%quote%&, except that it quotes the string only if
10492 required to do so by the rules of RFC 2822 for quoting local parts. For
10493 example, a plus sign would not cause quoting (but it would for &%quote%&).
10494 If you are creating a new email address from the contents of &$local_part$&
10495 (or any other unknown data), you should always use this operator.
10496
10497
10498 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10499 .cindex "quoting" "lookup-specific"
10500 This operator applies lookup-specific quoting rules to the string. Each
10501 query-style lookup type has its own quoting rules which are described with
10502 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10503 .code
10504 ${quote_ldap:two * two}
10505 .endd
10506 returns
10507 .code
10508 two%20%5C2A%20two
10509 .endd
10510 For single-key lookup types, no quoting is ever necessary and this operator
10511 yields an unchanged string.
10512
10513
10514 .vitem &*${randint:*&<&'n'&>&*}*&
10515 .cindex "random number"
10516 This operator returns a somewhat random number which is less than the
10517 supplied number and is at least 0.  The quality of this randomness depends
10518 on how Exim was built; the values are not suitable for keying material.
10519 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10520 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10521 for versions of GnuTLS with that function.
10522 Otherwise, the implementation may be arc4random(), random() seeded by
10523 srandomdev() or srandom(), or a custom implementation even weaker than
10524 random().
10525
10526
10527 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10528 .cindex "expansion" "IP address"
10529 This operator reverses an IP address; for IPv4 addresses, the result is in
10530 dotted-quad decimal form, while for IPv6 addresses the result is in
10531 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10532 for DNS.  For example,
10533 .code
10534 ${reverse_ip:192.0.2.4}
10535 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10536 .endd
10537 returns
10538 .code
10539 4.2.0.192
10540 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
10541 .endd
10542
10543
10544 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10545 .cindex "expansion" "RFC 2047"
10546 .cindex "RFC 2047" "expansion operator"
10547 .cindex "&%rfc2047%& expansion item"
10548 This operator encodes text according to the rules of RFC 2047. This is an
10549 encoding that is used in header lines to encode non-ASCII characters. It is
10550 assumed that the input string is in the encoding specified by the
10551 &%headers_charset%& option, which gets its default at build time. If the string
10552 contains only characters in the range 33&--126, and no instances of the
10553 characters
10554 .code
10555 ? = ( ) < > @ , ; : \ " . [ ] _
10556 .endd
10557 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10558 string, using as many &"encoded words"& as necessary to encode all the
10559 characters.
10560
10561
10562 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10563 .cindex "expansion" "RFC 2047"
10564 .cindex "RFC 2047" "decoding"
10565 .cindex "&%rfc2047d%& expansion item"
10566 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10567 bytes are replaced by question marks. Characters are converted into the
10568 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10569 not recognized unless &%check_rfc2047_length%& is set false.
10570
10571 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10572 access a header line, RFC 2047 decoding is done automatically. You do not need
10573 to use this operator as well.
10574
10575
10576
10577 .vitem &*${rxquote:*&<&'string'&>&*}*&
10578 .cindex "quoting" "in regular expressions"
10579 .cindex "regular expressions" "quoting"
10580 .cindex "&%rxquote%& expansion item"
10581 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10582 characters in its argument. This is useful when substituting the values of
10583 variables or headers inside regular expressions.
10584
10585
10586 .vitem &*${sha1:*&<&'string'&>&*}*&
10587 .cindex "SHA-1 hash"
10588 .cindex "expansion" "SHA-1 hashing"
10589 .cindex certificate fingerprint
10590 .cindex "&%sha1%& expansion item"
10591 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10592 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10593
10594 If the string is a single variable of type certificate,
10595 returns the SHA-1 hash fingerprint of the certificate.
10596
10597
10598 .vitem &*${sha256:*&<&'string'&>&*}*&
10599 .cindex "SHA-256 hash"
10600 .cindex certificate fingerprint
10601 .cindex "expansion" "SHA-256 hashing"
10602 .cindex "&%sha256%& expansion item"
10603 .new
10604 The &%sha256%& operator computes the SHA-256 hash value of the string
10605 and returns
10606 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10607 .wen
10608
10609 If the string is a single variable of type certificate,
10610 returns the SHA-256 hash fingerprint of the certificate.
10611
10612
10613 .new
10614 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10615        &*${sha3_<n>:*&<&'string'&>&*}*&
10616 .cindex "SHA3 hash"
10617 .cindex "expansion" "SHA3 hashing"
10618 .cindex "&%sha3%& expansion item"
10619 The &%sha3%& operator computes the SHA3-256 hash value of the string
10620 and returns
10621 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10622
10623 If a number is appended, separated by an underbar, it specifies
10624 the output length.  Values of 224, 256, 384 and 512 are accepted;
10625 with 256 being the default.
10626
10627 The &%sha3%& expansion item is only supported if Exim has been
10628 compiled with GnuTLS 3.5.0 or later.
10629 .wen
10630
10631
10632 .vitem &*${stat:*&<&'string'&>&*}*&
10633 .cindex "expansion" "statting a file"
10634 .cindex "file" "extracting characteristics"
10635 .cindex "&%stat%& expansion item"
10636 The string, after expansion, must be a file path. A call to the &[stat()]&
10637 function is made for this path. If &[stat()]& fails, an error occurs and the
10638 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10639 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10640 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10641 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10642 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10643 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10644 can extract individual fields using the &%extract%& expansion item.
10645
10646 The use of the &%stat%& expansion in users' filter files can be locked out by
10647 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10648 systems for files larger than 2GB.
10649
10650 .vitem &*${str2b64:*&<&'string'&>&*}*&
10651 .cindex "&%str2b64%& expansion item"
10652 Now deprecated, a synonym for the &%base64%& expansion operator.
10653
10654
10655
10656 .vitem &*${strlen:*&<&'string'&>&*}*&
10657 .cindex "expansion" "string length"
10658 .cindex "string" "length in expansion"
10659 .cindex "&%strlen%& expansion item"
10660 The item is replace by the length of the expanded string, expressed as a
10661 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10662
10663
10664 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10665 .cindex "&%substr%& expansion item"
10666 .cindex "substring extraction"
10667 .cindex "expansion" "substring expansion"
10668 The &%substr%& operator is a simpler interface to the &%substr%& function that
10669 can be used when the two parameters are fixed numbers (as opposed to strings
10670 that change when expanded). The effect is the same as
10671 .code
10672 ${substr{<start>}{<length>}{<string>}}
10673 .endd
10674 See the description of the general &%substr%& item above for details. The
10675 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10676
10677 .vitem &*${time_eval:*&<&'string'&>&*}*&
10678 .cindex "&%time_eval%& expansion item"
10679 .cindex "time interval" "decoding"
10680 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10681 seconds.
10682
10683 .vitem &*${time_interval:*&<&'string'&>&*}*&
10684 .cindex "&%time_interval%& expansion item"
10685 .cindex "time interval" "formatting"
10686 The argument (after sub-expansion) must be a sequence of decimal digits that
10687 represents an interval of time as a number of seconds. It is converted into a
10688 number of larger units and output in Exim's normal time format, for example,
10689 &`1w3d4h2m6s`&.
10690
10691 .vitem &*${uc:*&<&'string'&>&*}*&
10692 .cindex "case forcing in strings"
10693 .cindex "string" "case forcing"
10694 .cindex "upper casing"
10695 .cindex "expansion" "case forcing"
10696 .cindex "&%uc%& expansion item"
10697 This forces the letters in the string into upper-case.
10698
10699 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10700 .cindex "correction of invalid utf-8 sequences in strings"
10701 .cindex "utf-8" "utf-8 sequences"
10702 .cindex "incorrect utf-8"
10703 .cindex "expansion" "utf-8 forcing"
10704 .cindex "&%utf8clean%& expansion item"
10705 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10706
10707 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10708        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10709        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10710        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10711 .cindex expansion UTF-8
10712 .cindex UTF-8 expansion
10713 .cindex EAI
10714 .cindex internationalisation
10715 .cindex "&%utf8_domain_to_alabel%& expansion item"
10716 .cindex "&%utf8_domain_from_alabel%& expansion item"
10717 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10718 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10719 These convert EAI mail name components between UTF-8 and a-label forms.
10720 For information on internationalisation support see &<<SECTi18nMTA>>&.
10721 .endlist
10722
10723
10724
10725
10726
10727
10728 .section "Expansion conditions" "SECTexpcond"
10729 .scindex IIDexpcond "expansion" "conditions"
10730 The following conditions are available for testing by the &%${if%& construct
10731 while expanding strings:
10732
10733 .vlist
10734 .vitem &*!*&<&'condition'&>
10735 .cindex "expansion" "negating a condition"
10736 .cindex "negation" "in expansion condition"
10737 Preceding any condition with an exclamation mark negates the result of the
10738 condition.
10739
10740 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10741 .cindex "numeric comparison"
10742 .cindex "expansion" "numeric comparison"
10743 There are a number of symbolic operators for doing numeric comparisons. They
10744 are:
10745 .display
10746 &`=   `&   equal
10747 &`==  `&   equal
10748 &`>   `&   greater
10749 &`>=  `&   greater or equal
10750 &`<   `&   less
10751 &`<=  `&   less or equal
10752 .endd
10753 For example:
10754 .code
10755 ${if >{$message_size}{10M} ...
10756 .endd
10757 Note that the general negation operator provides for inequality testing. The
10758 two strings must take the form of optionally signed decimal integers,
10759 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10760 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10761 As a special case, the numerical value of an empty string is taken as
10762 zero.
10763
10764 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10765 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10766 10M, not if 10M is larger than &$message_size$&.
10767
10768
10769 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10770         {*&<&'arg2'&>&*}...}*&
10771 .cindex "expansion" "calling an acl"
10772 .cindex "&%acl%&" "expansion condition"
10773 The name and zero to nine argument strings are first expanded separately.  The expanded
10774 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10775 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10776 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10777 and may use the variables; if another acl expansion is used the values
10778 are restored after it returns.  If the ACL sets
10779 a value using a "message =" modifier the variable $value becomes
10780 the result of the expansion, otherwise it is empty.
10781 If the ACL returns accept the condition is true; if deny, false.
10782 If the ACL returns defer the result is a forced-fail.
10783
10784 .vitem &*bool&~{*&<&'string'&>&*}*&
10785 .cindex "expansion" "boolean parsing"
10786 .cindex "&%bool%& expansion condition"
10787 This condition turns a string holding a true or false representation into
10788 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10789 (case-insensitively); also integer numbers map to true if non-zero,
10790 false if zero.
10791 An empty string is treated as false.
10792 Leading and trailing whitespace is ignored;
10793 thus a string consisting only of whitespace is false.
10794 All other string values will result in expansion failure.
10795
10796 When combined with ACL variables, this expansion condition will let you
10797 make decisions in one place and act on those decisions in another place.
10798 For example:
10799 .code
10800 ${if bool{$acl_m_privileged_sender} ...
10801 .endd
10802
10803
10804 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10805 .cindex "expansion" "boolean parsing"
10806 .cindex "&%bool_lax%& expansion condition"
10807 Like &%bool%&, this condition turns a string into a boolean state.  But
10808 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10809 loose definition that the Router &%condition%& option uses.  The empty string
10810 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10811 true.  Leading and trailing whitespace is ignored.
10812
10813 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10814
10815 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10816 .cindex "expansion" "encrypted comparison"
10817 .cindex "encrypted strings, comparing"
10818 .cindex "&%crypteq%& expansion condition"
10819 This condition is included in the Exim binary if it is built to support any
10820 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10821 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10822 included in the binary.
10823
10824 The &%crypteq%& condition has two arguments. The first is encrypted and
10825 compared against the second, which is already encrypted. The second string may
10826 be in the LDAP form for storing encrypted strings, which starts with the
10827 encryption type in curly brackets, followed by the data. If the second string
10828 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10829 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10830 Typically this will be a field from a password file. An example of an encrypted
10831 string in LDAP form is:
10832 .code
10833 {md5}CY9rzUYh03PK3k6DJie09g==
10834 .endd
10835 If such a string appears directly in an expansion, the curly brackets have to
10836 be quoted, because they are part of the expansion syntax. For example:
10837 .code
10838 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10839 .endd
10840 The following encryption types (whose names are matched case-independently) are
10841 supported:
10842
10843 .ilist
10844 .cindex "MD5 hash"
10845 .cindex "base64 encoding" "in encrypted password"
10846 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10847 printable characters to compare with the remainder of the second string. If the
10848 length of the comparison string is 24, Exim assumes that it is base64 encoded
10849 (as in the above example). If the length is 32, Exim assumes that it is a
10850 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10851 comparison fails.
10852
10853 .next
10854 .cindex "SHA-1 hash"
10855 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10856 printable characters to compare with the remainder of the second string. If the
10857 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10858 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10859 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10860
10861 .next
10862 .cindex "&[crypt()]&"
10863 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10864 only the first eight characters of the password. However, in modern operating
10865 systems this is no longer true, and in many cases the entire password is used,
10866 whatever its length.
10867
10868 .next
10869 .cindex "&[crypt16()]&"
10870 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10871 use up to 16 characters of the password in some operating systems. Again, in
10872 modern operating systems, more characters may be used.
10873 .endlist
10874 Exim has its own version of &[crypt16()]&, which is just a double call to
10875 &[crypt()]&. For operating systems that have their own version, setting
10876 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10877 operating system version instead of its own. This option is set by default in
10878 the OS-dependent &_Makefile_& for those operating systems that are known to
10879 support &[crypt16()]&.
10880
10881 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10882 it was not using the same algorithm as some operating systems' versions. It
10883 turns out that as well as &[crypt16()]& there is a function called
10884 &[bigcrypt()]& in some operating systems. This may or may not use the same
10885 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10886
10887 However, since there is now a move away from the traditional &[crypt()]&
10888 functions towards using SHA1 and other algorithms, tidying up this area of
10889 Exim is seen as very low priority.
10890
10891 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10892 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10893 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10894 default is &`{crypt}`&. Whatever the default, you can always use either
10895 function by specifying it explicitly in curly brackets.
10896
10897 .vitem &*def:*&<&'variable&~name'&>
10898 .cindex "expansion" "checking for empty variable"
10899 .cindex "&%def%& expansion condition"
10900 The &%def%& condition must be followed by the name of one of the expansion
10901 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10902 variable does not contain the empty string. For example:
10903 .code
10904 ${if def:sender_ident {from $sender_ident}}
10905 .endd
10906 Note that the variable name is given without a leading &%$%& character. If the
10907 variable does not exist, the expansion fails.
10908
10909 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10910         &~&*def:h_*&<&'header&~name'&>&*:*&"
10911 .cindex "expansion" "checking header line existence"
10912 This condition is true if a message is being processed and the named header
10913 exists in the message. For example,
10914 .code
10915 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10916 .endd
10917 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10918 the header name must be terminated by a colon if white space does not follow.
10919
10920 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10921        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10922 .cindex "string" "comparison"
10923 .cindex "expansion" "string comparison"
10924 .cindex "&%eq%& expansion condition"
10925 .cindex "&%eqi%& expansion condition"
10926 The two substrings are first expanded. The condition is true if the two
10927 resulting strings are identical. For &%eq%& the comparison includes the case of
10928 letters, whereas for &%eqi%& the comparison is case-independent.
10929
10930 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10931 .cindex "expansion" "file existence test"
10932 .cindex "file" "existence test"
10933 .cindex "&%exists%&, expansion condition"
10934 The substring is first expanded and then interpreted as an absolute path. The
10935 condition is true if the named file (or directory) exists. The existence test
10936 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10937 users' filter files may be locked out by the system administrator.
10938
10939 .vitem &*first_delivery*&
10940 .cindex "delivery" "first"
10941 .cindex "first delivery"
10942 .cindex "expansion" "first delivery test"
10943 .cindex "&%first_delivery%& expansion condition"
10944 This condition, which has no data, is true during a message's first delivery
10945 attempt. It is false during any subsequent delivery attempts.
10946
10947
10948 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10949        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10950 .cindex "list" "iterative conditions"
10951 .cindex "expansion" "&*forall*& condition"
10952 .cindex "expansion" "&*forany*& condition"
10953 .vindex "&$item$&"
10954 These conditions iterate over a list. The first argument is expanded to form
10955 the list. By default, the list separator is a colon, but it can be changed by
10956 the normal method. The second argument is interpreted as a condition that is to
10957 be applied to each item in the list in turn. During the interpretation of the
10958 condition, the current list item is placed in a variable called &$item$&.
10959 .ilist
10960 For &*forany*&, interpretation stops if the condition is true for any item, and
10961 the result of the whole condition is true. If the condition is false for all
10962 items in the list, the overall condition is false.
10963 .next
10964 For &*forall*&, interpretation stops if the condition is false for any item,
10965 and the result of the whole condition is false. If the condition is true for
10966 all items in the list, the overall condition is true.
10967 .endlist
10968 Note that negation of &*forany*& means that the condition must be false for all
10969 items for the overall condition to succeed, and negation of &*forall*& means
10970 that the condition must be false for at least one item. In this example, the
10971 list separator is changed to a comma:
10972 .code
10973 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10974 .endd
10975 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10976 being processed, to enable these expansion items to be nested.
10977
10978 To scan a named list, expand it with the &*listnamed*& operator.
10979
10980
10981 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10982        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10983 .cindex "string" "comparison"
10984 .cindex "expansion" "string comparison"
10985 .cindex "&%ge%& expansion condition"
10986 .cindex "&%gei%& expansion condition"
10987 The two substrings are first expanded. The condition is true if the first
10988 string is lexically greater than or equal to the second string. For &%ge%& the
10989 comparison includes the case of letters, whereas for &%gei%& the comparison is
10990 case-independent.
10991
10992 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10993        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10994 .cindex "string" "comparison"
10995 .cindex "expansion" "string comparison"
10996 .cindex "&%gt%& expansion condition"
10997 .cindex "&%gti%& expansion condition"
10998 The two substrings are first expanded. The condition is true if the first
10999 string is lexically greater than the second string. For &%gt%& the comparison
11000 includes the case of letters, whereas for &%gti%& the comparison is
11001 case-independent.
11002
11003 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11004        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11005 .cindex "string" "comparison"
11006 .cindex "list" "iterative conditions"
11007 Both strings are expanded; the second string is treated as a list of simple
11008 strings; if the first string is a member of the second, then the condition
11009 is true.
11010
11011 These are simpler to use versions of the more powerful &*forany*& condition.
11012 Examples, and the &*forany*& equivalents:
11013 .code
11014 ${if inlist{needle}{foo:needle:bar}}
11015   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11016 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11017   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11018 .endd
11019
11020 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11021        &*isip4&~{*&<&'string'&>&*}*& &&&
11022        &*isip6&~{*&<&'string'&>&*}*&
11023 .cindex "IP address" "testing string format"
11024 .cindex "string" "testing for IP address"
11025 .cindex "&%isip%& expansion condition"
11026 .cindex "&%isip4%& expansion condition"
11027 .cindex "&%isip6%& expansion condition"
11028 The substring is first expanded, and then tested to see if it has the form of
11029 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11030 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11031
11032 For an IPv4 address, the test is for four dot-separated components, each of
11033 which consists of from one to three digits. For an IPv6 address, up to eight
11034 colon-separated components are permitted, each containing from one to four
11035 hexadecimal digits. There may be fewer than eight components if an empty
11036 component (adjacent colons) is present. Only one empty component is permitted.
11037
11038 &*Note*&: The checks are just on the form of the address; actual numerical
11039 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
11040 check. The main use of these tests is to distinguish between IP addresses and
11041 host names, or between IPv4 and IPv6 addresses. For example, you could use
11042 .code
11043 ${if isip4{$sender_host_address}...
11044 .endd
11045 to test which IP version an incoming SMTP connection is using.
11046
11047 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11048 .cindex "LDAP" "use for authentication"
11049 .cindex "expansion" "LDAP authentication test"
11050 .cindex "&%ldapauth%& expansion condition"
11051 This condition supports user authentication using LDAP. See section
11052 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11053 queries. For this use, the query must contain a user name and password. The
11054 query itself is not used, and can be empty. The condition is true if the
11055 password is not empty, and the user name and password are accepted by the LDAP
11056 server. An empty password is rejected without calling LDAP because LDAP binds
11057 with an empty password are considered anonymous regardless of the username, and
11058 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11059 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11060 this can be used.
11061
11062
11063 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11064        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11065 .cindex "string" "comparison"
11066 .cindex "expansion" "string comparison"
11067 .cindex "&%le%& expansion condition"
11068 .cindex "&%lei%& expansion condition"
11069 The two substrings are first expanded. The condition is true if the first
11070 string is lexically less than or equal to the second string. For &%le%& the
11071 comparison includes the case of letters, whereas for &%lei%& the comparison is
11072 case-independent.
11073
11074 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11075        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11076 .cindex "string" "comparison"
11077 .cindex "expansion" "string comparison"
11078 .cindex "&%lt%& expansion condition"
11079 .cindex "&%lti%& expansion condition"
11080 The two substrings are first expanded. The condition is true if the first
11081 string is lexically less than the second string. For &%lt%& the comparison
11082 includes the case of letters, whereas for &%lti%& the comparison is
11083 case-independent.
11084
11085
11086 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11087 .cindex "expansion" "regular expression comparison"
11088 .cindex "regular expressions" "match in expanded string"
11089 .cindex "&%match%& expansion condition"
11090 The two substrings are first expanded. The second is then treated as a regular
11091 expression and applied to the first. Because of the pre-expansion, if the
11092 regular expression contains dollar, or backslash characters, they must be
11093 escaped. Care must also be taken if the regular expression contains braces
11094 (curly brackets). A closing brace must be escaped so that it is not taken as a
11095 premature termination of <&'string2'&>. The easiest approach is to use the
11096 &`\N`& feature to disable expansion of the regular expression.
11097 For example,
11098 .code
11099 ${if match {$local_part}{\N^\d{3}\N} ...
11100 .endd
11101 If the whole expansion string is in double quotes, further escaping of
11102 backslashes is also required.
11103
11104 The condition is true if the regular expression match succeeds.
11105 The regular expression is not required to begin with a circumflex
11106 metacharacter, but if there is no circumflex, the expression is not anchored,
11107 and it may match anywhere in the subject, not just at the start. If you want
11108 the pattern to match at the end of the subject, you must include the &`$`&
11109 metacharacter at an appropriate point.
11110
11111 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11112 At the start of an &%if%& expansion the values of the numeric variable
11113 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11114 succeeds causes them to be reset to the substrings of that condition and they
11115 will have these values during the expansion of the success string. At the end
11116 of the &%if%& expansion, the previous values are restored. After testing a
11117 combination of conditions using &%or%&, the subsequent values of the numeric
11118 variables are those of the condition that succeeded.
11119
11120 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11121 .cindex "&%match_address%& expansion condition"
11122 See &*match_local_part*&.
11123
11124 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11125 .cindex "&%match_domain%& expansion condition"
11126 See &*match_local_part*&.
11127
11128 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11129 .cindex "&%match_ip%& expansion condition"
11130 This condition matches an IP address to a list of IP address patterns. It must
11131 be followed by two argument strings. The first (after expansion) must be an IP
11132 address or an empty string. The second (not expanded) is a restricted host
11133 list that can match only an IP address, not a host name. For example:
11134 .code
11135 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11136 .endd
11137 The specific types of host list item that are permitted in the list are:
11138
11139 .ilist
11140 An IP address, optionally with a CIDR mask.
11141 .next
11142 A single asterisk, which matches any IP address.
11143 .next
11144 An empty item, which matches only if the IP address is empty. This could be
11145 useful for testing for a locally submitted message or one from specific hosts
11146 in a single test such as
11147 . ==== As this is a nested list, any displays it contains must be indented
11148 . ==== as otherwise they are too far to the left. This comment applies to
11149 . ==== the use of xmlto plus fop. There's no problem when formatting with
11150 . ==== sdop, with or without the extra indent.
11151 .code
11152   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11153 .endd
11154 where the first item in the list is the empty string.
11155 .next
11156 The item @[] matches any of the local host's interface addresses.
11157 .next
11158 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11159 even if &`net-`& is not specified. There is never any attempt to turn the IP
11160 address into a host name. The most common type of linear search for
11161 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11162 masks. For example:
11163 .code
11164   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11165 .endd
11166 It is of course possible to use other kinds of lookup, and in such a case, you
11167 do need to specify the &`net-`& prefix if you want to specify a specific
11168 address mask, for example:
11169 .code
11170   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11171 .endd
11172 However, unless you are combining a &%match_ip%& condition with others, it is
11173 just as easy to use the fact that a lookup is itself a condition, and write:
11174 .code
11175   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11176 .endd
11177 .endlist ilist
11178
11179 Note that <&'string2'&> is not itself subject to string expansion, unless
11180 Exim was built with the EXPAND_LISTMATCH_RHS option.
11181
11182 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11183
11184 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11185 .cindex "domain list" "in expansion condition"
11186 .cindex "address list" "in expansion condition"
11187 .cindex "local part" "list, in expansion condition"
11188 .cindex "&%match_local_part%& expansion condition"
11189 This condition, together with &%match_address%& and &%match_domain%&, make it
11190 possible to test domain, address, and local part lists within expansions. Each
11191 condition requires two arguments: an item and a list to match. A trivial
11192 example is:
11193 .code
11194 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11195 .endd
11196 In each case, the second argument may contain any of the allowable items for a
11197 list of the appropriate type. Also, because the second argument (after
11198 expansion) is a standard form of list, it is possible to refer to a named list.
11199 Thus, you can use conditions like this:
11200 .code
11201 ${if match_domain{$domain}{+local_domains}{...
11202 .endd
11203 .cindex "&`+caseful`&"
11204 For address lists, the matching starts off caselessly, but the &`+caseful`&
11205 item can be used, as in all address lists, to cause subsequent items to
11206 have their local parts matched casefully. Domains are always matched
11207 caselessly.
11208
11209 Note that <&'string2'&> is not itself subject to string expansion, unless
11210 Exim was built with the EXPAND_LISTMATCH_RHS option.
11211
11212 &*Note*&: Host lists are &'not'& supported in this way. This is because
11213 hosts have two identities: a name and an IP address, and it is not clear
11214 how to specify cleanly how such a test would work. However, IP addresses can be
11215 matched using &%match_ip%&.
11216
11217 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11218 .cindex "PAM authentication"
11219 .cindex "AUTH" "with PAM"
11220 .cindex "Solaris" "PAM support"
11221 .cindex "expansion" "PAM authentication test"
11222 .cindex "&%pam%& expansion condition"
11223 &'Pluggable Authentication Modules'&
11224 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11225 available in the latest releases of Solaris and in some GNU/Linux
11226 distributions. The Exim support, which is intended for use in conjunction with
11227 the SMTP AUTH command, is available only if Exim is compiled with
11228 .code
11229 SUPPORT_PAM=yes
11230 .endd
11231 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11232 in some releases of GNU/Linux &%-ldl%& is also needed.
11233
11234 The argument string is first expanded, and the result must be a
11235 colon-separated list of strings. Leading and trailing white space is ignored.
11236 The PAM module is initialized with the service name &"exim"& and the user name
11237 taken from the first item in the colon-separated data string (<&'string1'&>).
11238 The remaining items in the data string are passed over in response to requests
11239 from the authentication function. In the simple case there will only be one
11240 request, for a password, so the data consists of just two strings.
11241
11242 There can be problems if any of the strings are permitted to contain colon
11243 characters. In the usual way, these have to be doubled to avoid being taken as
11244 separators. If the data is being inserted from a variable, the &%sg%& expansion
11245 item can be used to double any existing colons. For example, the configuration
11246 of a LOGIN authenticator might contain this setting:
11247 .code
11248 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11249 .endd
11250 For a PLAIN authenticator you could use:
11251 .code
11252 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11253 .endd
11254 In some operating systems, PAM authentication can be done only from a process
11255 running as root. Since Exim is running as the Exim user when receiving
11256 messages, this means that PAM cannot be used directly in those systems.
11257 A patched version of the &'pam_unix'& module that comes with the
11258 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11259 The patched module allows one special uid/gid combination, in addition to root,
11260 to authenticate. If you build the patched module to allow the Exim user and
11261 group, PAM can then be used from an Exim authenticator.
11262
11263
11264 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11265 .cindex "&'pwcheck'& daemon"
11266 .cindex "Cyrus"
11267 .cindex "expansion" "&'pwcheck'& authentication test"
11268 .cindex "&%pwcheck%& expansion condition"
11269 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11270 This is one way of making it possible for passwords to be checked by a process
11271 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11272 deprecated. Its replacement is &'saslauthd'& (see below).
11273
11274 The pwcheck support is not included in Exim by default. You need to specify
11275 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11276 building Exim. For example:
11277 .code
11278 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11279 .endd
11280 You do not need to install the full Cyrus software suite in order to use
11281 the pwcheck daemon. You can compile and install just the daemon alone
11282 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11283 access to the &_/var/pwcheck_& directory.
11284
11285 The &%pwcheck%& condition takes one argument, which must be the user name and
11286 password, separated by a colon. For example, in a LOGIN authenticator
11287 configuration, you might have this:
11288 .code
11289 server_condition = ${if pwcheck{$auth1:$auth2}}
11290 .endd
11291 Again, for a PLAIN authenticator configuration, this would be:
11292 .code
11293 server_condition = ${if pwcheck{$auth2:$auth3}}
11294 .endd
11295 .vitem &*queue_running*&
11296 .cindex "queue runner" "detecting when delivering from"
11297 .cindex "expansion" "queue runner test"
11298 .cindex "&%queue_running%& expansion condition"
11299 This condition, which has no data, is true during delivery attempts that are
11300 initiated by queue runner processes, and false otherwise.
11301
11302
11303 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11304 .cindex "Radius"
11305 .cindex "expansion" "Radius authentication"
11306 .cindex "&%radius%& expansion condition"
11307 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11308 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11309 the Radius client configuration file in order to build Exim with Radius
11310 support.
11311
11312 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11313 library, using the original API. If you are using release 0.4.0 or later of
11314 this library, you need to set
11315 .code
11316 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11317 .endd
11318 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11319 &%libradius%& library that comes with FreeBSD. To do this, set
11320 .code
11321 RADIUS_LIB_TYPE=RADLIB
11322 .endd
11323 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11324 You may also have to supply a suitable setting in EXTRALIBS so that the
11325 Radius library can be found when Exim is linked.
11326
11327 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11328 Radius client library, which calls the Radius server. The condition is true if
11329 the authentication is successful. For example:
11330 .code
11331 server_condition = ${if radius{<arguments>}}
11332 .endd
11333
11334
11335 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11336         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11337 .cindex "&'saslauthd'& daemon"
11338 .cindex "Cyrus"
11339 .cindex "expansion" "&'saslauthd'& authentication test"
11340 .cindex "&%saslauthd%& expansion condition"
11341 This condition supports user authentication using the Cyrus &'saslauthd'&
11342 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11343 Using this daemon is one way of making it possible for passwords to be checked
11344 by a process that is not running as root.
11345
11346 The saslauthd support is not included in Exim by default. You need to specify
11347 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11348 building Exim. For example:
11349 .code
11350 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11351 .endd
11352 You do not need to install the full Cyrus software suite in order to use
11353 the saslauthd daemon. You can compile and install just the daemon alone
11354 from the Cyrus SASL library.
11355
11356 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11357 two are mandatory. For example:
11358 .code
11359 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11360 .endd
11361 The service and the realm are optional (which is why the arguments are enclosed
11362 in their own set of braces). For details of the meaning of the service and
11363 realm, and how to run the daemon, consult the Cyrus documentation.
11364 .endlist vlist
11365
11366
11367
11368 .section "Combining expansion conditions" "SECID84"
11369 .cindex "expansion" "combining conditions"
11370 Several conditions can be tested at once by combining them using the &%and%&
11371 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11372 conditions on their own, and precede their lists of sub-conditions. Each
11373 sub-condition must be enclosed in braces within the overall braces that contain
11374 the list. No repetition of &%if%& is used.
11375
11376
11377 .vlist
11378 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11379 .cindex "&""or""& expansion condition"
11380 .cindex "expansion" "&""or""& of conditions"
11381 The sub-conditions are evaluated from left to right. The condition is true if
11382 any one of the sub-conditions is true.
11383 For example,
11384 .code
11385 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11386 .endd
11387 When a true sub-condition is found, the following ones are parsed but not
11388 evaluated. If there are several &"match"& sub-conditions the values of the
11389 numeric variables afterwards are taken from the first one that succeeds.
11390
11391 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11392 .cindex "&""and""& expansion condition"
11393 .cindex "expansion" "&""and""& of conditions"
11394 The sub-conditions are evaluated from left to right. The condition is true if
11395 all of the sub-conditions are true. If there are several &"match"&
11396 sub-conditions, the values of the numeric variables afterwards are taken from
11397 the last one. When a false sub-condition is found, the following ones are
11398 parsed but not evaluated.
11399 .endlist
11400 .ecindex IIDexpcond
11401
11402
11403
11404
11405 .section "Expansion variables" "SECTexpvar"
11406 .cindex "expansion" "variables, list of"
11407 This section contains an alphabetical list of all the expansion variables. Some
11408 of them are available only when Exim is compiled with specific options such as
11409 support for TLS or the content scanning extension.
11410
11411 .vlist
11412 .vitem "&$0$&, &$1$&, etc"
11413 .cindex "numerical variables (&$1$& &$2$& etc)"
11414 When a &%match%& expansion condition succeeds, these variables contain the
11415 captured substrings identified by the regular expression during subsequent
11416 processing of the success string of the containing &%if%& expansion item.
11417 In the expansion condition case
11418 they do not retain their values afterwards; in fact, their previous
11419 values are restored at the end of processing an &%if%& item. The numerical
11420 variables may also be set externally by some other matching process which
11421 precedes the expansion of the string. For example, the commands available in
11422 Exim filter files include an &%if%& command with its own regular expression
11423 matching condition.
11424
11425 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11426 Within an acl condition, expansion condition or expansion item
11427 any arguments are copied to these variables,
11428 any unused variables being made empty.
11429
11430 .vitem "&$acl_c...$&"
11431 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11432 can be given any name that starts with &$acl_c$& and is at least six characters
11433 long, but the sixth character must be either a digit or an underscore. For
11434 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11435 variables persist throughout the lifetime of an SMTP connection. They can be
11436 used to pass information between ACLs and between different invocations of the
11437 same ACL. When a message is received, the values of these variables are saved
11438 with the message, and can be accessed by filters, routers, and transports
11439 during subsequent delivery.
11440
11441 .vitem "&$acl_m...$&"
11442 These variables are like the &$acl_c...$& variables, except that their values
11443 are reset after a message has been received. Thus, if several messages are
11444 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11445 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11446 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11447 message is received, the values of these variables are saved with the message,
11448 and can be accessed by filters, routers, and transports during subsequent
11449 delivery.
11450
11451 .vitem &$acl_narg$&
11452 Within an acl condition, expansion condition or expansion item
11453 this variable has the number of arguments.
11454
11455 .vitem &$acl_verify_message$&
11456 .vindex "&$acl_verify_message$&"
11457 After an address verification has failed, this variable contains the failure
11458 message. It retains its value for use in subsequent modifiers. The message can
11459 be preserved by coding like this:
11460 .code
11461 warn !verify = sender
11462      set acl_m0 = $acl_verify_message
11463 .endd
11464 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11465 &%log_message%& modifiers, to include information about the verification
11466 failure.
11467
11468 .vitem &$address_data$&
11469 .vindex "&$address_data$&"
11470 This variable is set by means of the &%address_data%& option in routers. The
11471 value then remains with the address while it is processed by subsequent routers
11472 and eventually a transport. If the transport is handling multiple addresses,
11473 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11474 for more details. &*Note*&: The contents of &$address_data$& are visible in
11475 user filter files.
11476
11477 If &$address_data$& is set when the routers are called from an ACL to verify
11478 a recipient address, the final value is still in the variable for subsequent
11479 conditions and modifiers of the ACL statement. If routing the address caused it
11480 to be redirected to just one address, the child address is also routed as part
11481 of the verification, and in this case the final value of &$address_data$& is
11482 from the child's routing.
11483
11484 If &$address_data$& is set when the routers are called from an ACL to verify a
11485 sender address, the final value is also preserved, but this time in
11486 &$sender_address_data$&, to distinguish it from data from a recipient
11487 address.
11488
11489 In both cases (recipient and sender verification), the value does not persist
11490 after the end of the current ACL statement. If you want to preserve
11491 these values for longer, you can save them in ACL variables.
11492
11493 .vitem &$address_file$&
11494 .vindex "&$address_file$&"
11495 When, as a result of aliasing, forwarding, or filtering, a message is directed
11496 to a specific file, this variable holds the name of the file when the transport
11497 is running. At other times, the variable is empty. For example, using the
11498 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11499 .code
11500 /home/r2d2/savemail
11501 .endd
11502 then when the &(address_file)& transport is running, &$address_file$&
11503 contains the text string &`/home/r2d2/savemail`&.
11504 .cindex "Sieve filter" "value of &$address_file$&"
11505 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11506 then up to the transport configuration to generate an appropriate absolute path
11507 to the relevant file.
11508
11509 .vitem &$address_pipe$&
11510 .vindex "&$address_pipe$&"
11511 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11512 this variable holds the pipe command when the transport is running.
11513
11514 .vitem "&$auth1$& &-- &$auth3$&"
11515 .vindex "&$auth1$&, &$auth2$&, etc"
11516 These variables are used in SMTP authenticators (see chapters
11517 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11518
11519 .vitem &$authenticated_id$&
11520 .cindex "authentication" "id"
11521 .vindex "&$authenticated_id$&"
11522 When a server successfully authenticates a client it may be configured to
11523 preserve some of the authentication information in the variable
11524 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11525 user/password authenticator configuration might preserve the user name for use
11526 in the routers. Note that this is not the same information that is saved in
11527 &$sender_host_authenticated$&.
11528 When a message is submitted locally (that is, not over a TCP connection)
11529 the value of &$authenticated_id$& is normally the login name of the calling
11530 process. However, a trusted user can override this by means of the &%-oMai%&
11531 command line option.
11532
11533 .vitem &$authenticated_fail_id$&
11534 .cindex "authentication" "fail" "id"
11535 .vindex "&$authenticated_fail_id$&"
11536 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11537 will contain the failed authentication id. If more than one authentication
11538 id is attempted, it will contain only the last one. The variable is
11539 available for processing in the ACL's, generally the quit or notquit ACL.
11540 A message to a local recipient could still be accepted without requiring
11541 authentication, which means this variable could also be visible in all of
11542 the ACL's as well.
11543
11544
11545 .vitem &$authenticated_sender$&
11546 .cindex "sender" "authenticated"
11547 .cindex "authentication" "sender"
11548 .cindex "AUTH" "on MAIL command"
11549 .vindex "&$authenticated_sender$&"
11550 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11551 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11552 described in section &<<SECTauthparamail>>&. Unless the data is the string
11553 &"<>"&, it is set as the authenticated sender of the message, and the value is
11554 available during delivery in the &$authenticated_sender$& variable. If the
11555 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11556
11557 .vindex "&$qualify_domain$&"
11558 When a message is submitted locally (that is, not over a TCP connection), the
11559 value of &$authenticated_sender$& is an address constructed from the login
11560 name of the calling process and &$qualify_domain$&, except that a trusted user
11561 can override this by means of the &%-oMas%& command line option.
11562
11563
11564 .vitem &$authentication_failed$&
11565 .cindex "authentication" "failure"
11566 .vindex "&$authentication_failed$&"
11567 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11568 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11569 possible to distinguish between &"did not try to authenticate"&
11570 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11571 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11572 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11573 negative response to an AUTH command, including (for example) an attempt to use
11574 an undefined mechanism.
11575
11576 .vitem &$av_failed$&
11577 .cindex "content scanning" "AV scanner failure"
11578 This variable is available when Exim is compiled with the content-scanning
11579 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11580 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11581 the ACL malware condition.
11582
11583 .vitem &$body_linecount$&
11584 .cindex "message body" "line count"
11585 .cindex "body of message" "line count"
11586 .vindex "&$body_linecount$&"
11587 When a message is being received or delivered, this variable contains the
11588 number of lines in the message's body. See also &$message_linecount$&.
11589
11590 .vitem &$body_zerocount$&
11591 .cindex "message body" "binary zero count"
11592 .cindex "body of message" "binary zero count"
11593 .cindex "binary zero" "in message body"
11594 .vindex "&$body_zerocount$&"
11595 When a message is being received or delivered, this variable contains the
11596 number of binary zero bytes (ASCII NULs) in the message's body.
11597
11598 .vitem &$bounce_recipient$&
11599 .vindex "&$bounce_recipient$&"
11600 This is set to the recipient address of a bounce message while Exim is creating
11601 it. It is useful if a customized bounce message text file is in use (see
11602 chapter &<<CHAPemsgcust>>&).
11603
11604 .vitem &$bounce_return_size_limit$&
11605 .vindex "&$bounce_return_size_limit$&"
11606 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11607 up to a multiple of 1000. It is useful when a customized error message text
11608 file is in use (see chapter &<<CHAPemsgcust>>&).
11609
11610 .vitem &$caller_gid$&
11611 .cindex "gid (group id)" "caller"
11612 .vindex "&$caller_gid$&"
11613 The real group id under which the process that called Exim was running. This is
11614 not the same as the group id of the originator of a message (see
11615 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11616 incarnation normally contains the Exim gid.
11617
11618 .vitem &$caller_uid$&
11619 .cindex "uid (user id)" "caller"
11620 .vindex "&$caller_uid$&"
11621 The real user id under which the process that called Exim was running. This is
11622 not the same as the user id of the originator of a message (see
11623 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11624 incarnation normally contains the Exim uid.
11625
11626 .vitem &$callout_address$&
11627 .vindex "&$callout_address$&"
11628 After a callout for verification, spamd or malware daemon service, the
11629 address that was connected to.
11630
11631 .vitem &$compile_number$&
11632 .vindex "&$compile_number$&"
11633 The building process for Exim keeps a count of the number
11634 of times it has been compiled. This serves to distinguish different
11635 compilations of the same version of the program.
11636
11637 .vitem &$config_dir$&
11638 .vindex "&$config_dir$&"
11639 The directory name of the main configuration file. That is, the content of
11640 &$config_file$& with the last component stripped. The value does not
11641 contain the trailing slash. If &$config_file$& does not contain a slash,
11642 &$config_dir$& is ".".
11643
11644 .vitem &$config_file$&
11645 .vindex "&$config_file$&"
11646 The name of the main configuration file Exim is using.
11647
11648 .vitem &$dkim_cur_signer$& &&&
11649        &$dkim_verify_status$& &&&
11650        &$dkim_verify_reason$& &&&
11651        &$dkim_domain$& &&&
11652        &$dkim_identity$& &&&
11653        &$dkim_selector$& &&&
11654        &$dkim_algo$& &&&
11655        &$dkim_canon_body$& &&&
11656        &$dkim_canon_headers$& &&&
11657        &$dkim_copiedheaders$& &&&
11658        &$dkim_bodylength$& &&&
11659        &$dkim_created$& &&&
11660        &$dkim_expires$& &&&
11661        &$dkim_headernames$& &&&
11662        &$dkim_key_testing$& &&&
11663        &$dkim_key_nosubdomains$& &&&
11664        &$dkim_key_srvtype$& &&&
11665        &$dkim_key_granularity$& &&&
11666        &$dkim_key_notes$& &&&
11667        &$dkim_key_length$&
11668 These variables are only available within the DKIM ACL.
11669 For details see chapter &<<CHAPdkim>>&.
11670
11671 .vitem &$dkim_signers$&
11672 .vindex &$dkim_signers$&
11673 When a message has been received this variable contains
11674 a colon-separated list of signer domains and identities for the message.
11675 For details see chapter &<<CHAPdkim>>&.
11676
11677 .vitem &$dnslist_domain$& &&&
11678        &$dnslist_matched$& &&&
11679        &$dnslist_text$& &&&
11680        &$dnslist_value$&
11681 .vindex "&$dnslist_domain$&"
11682 .vindex "&$dnslist_matched$&"
11683 .vindex "&$dnslist_text$&"
11684 .vindex "&$dnslist_value$&"
11685 .cindex "black list (DNS)"
11686 When a DNS (black) list lookup succeeds, these variables are set to contain
11687 the following data from the lookup: the list's domain name, the key that was
11688 looked up, the contents of any associated TXT record, and the value from the
11689 main A record. See section &<<SECID204>>& for more details.
11690
11691 .vitem &$domain$&
11692 .vindex "&$domain$&"
11693 When an address is being routed, or delivered on its own, this variable
11694 contains the domain. Uppercase letters in the domain are converted into lower
11695 case for &$domain$&.
11696
11697 Global address rewriting happens when a message is received, so the value of
11698 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11699 is set during user filtering, but not during system filtering, because a
11700 message may have many recipients and the system filter is called just once.
11701
11702 When more than one address is being delivered at once (for example, several
11703 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11704 have the same domain. Transports can be restricted to handling only one domain
11705 at a time if the value of &$domain$& is required at transport time &-- this is
11706 the default for local transports. For further details of the environment in
11707 which local transports are run, see chapter &<<CHAPenvironment>>&.
11708
11709 .oindex "&%delay_warning_condition%&"
11710 At the end of a delivery, if all deferred addresses have the same domain, it is
11711 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11712
11713 The &$domain$& variable is also used in some other circumstances:
11714
11715 .ilist
11716 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11717 the recipient address. The domain of the &'sender'& address is in
11718 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11719 normally set during the running of the MAIL ACL. However, if the sender address
11720 is verified with a callout during the MAIL ACL, the sender domain is placed in
11721 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11722 the &(smtp)& transport.
11723
11724 .next
11725 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11726 &$domain$& contains the domain portion of the address that is being rewritten;
11727 it can be used in the expansion of the replacement address, for example, to
11728 rewrite domains by file lookup.
11729
11730 .next
11731 With one important exception, whenever a domain list is being scanned,
11732 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11733 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11734 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11735 that, in a RCPT ACL, the sender domain list can be dependent on the
11736 recipient domain (which is what is in &$domain$& at this time).
11737
11738 .next
11739 .cindex "ETRN" "value of &$domain$&"
11740 .oindex "&%smtp_etrn_command%&"
11741 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11742 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11743 .endlist
11744
11745
11746 .vitem &$domain_data$&
11747 .vindex "&$domain_data$&"
11748 When the &%domains%& option on a router matches a domain by
11749 means of a lookup, the data read by the lookup is available during the running
11750 of the router as &$domain_data$&. In addition, if the driver routes the
11751 address to a transport, the value is available in that transport. If the
11752 transport is handling multiple addresses, the value from the first address is
11753 used.
11754
11755 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11756 domain by means of a lookup. The data read by the lookup is available during
11757 the rest of the ACL statement. In all other situations, this variable expands
11758 to nothing.
11759
11760 .vitem &$exim_gid$&
11761 .vindex "&$exim_gid$&"
11762 This variable contains the numerical value of the Exim group id.
11763
11764 .vitem &$exim_path$&
11765 .vindex "&$exim_path$&"
11766 This variable contains the path to the Exim binary.
11767
11768 .vitem &$exim_uid$&
11769 .vindex "&$exim_uid$&"
11770 This variable contains the numerical value of the Exim user id.
11771
11772 .vitem &$exim_version$&
11773 .vindex "&$exim_version$&"
11774 This variable contains the version string of the Exim build.
11775 The first character is a major version number, currently 4.
11776 Then after a dot, the next group of digits is a minor version number.
11777 There may be other characters following the minor version.
11778
11779 .vitem &$header_$&<&'name'&>
11780 This is not strictly an expansion variable. It is expansion syntax for
11781 inserting the message header line with the given name. Note that the name must
11782 be terminated by colon or white space, because it may contain a wide variety of
11783 characters. Note also that braces must &'not'& be used.
11784
11785 .vitem &$headers_added$&
11786 .vindex "&$headers_added$&"
11787 Within an ACL this variable contains the headers added so far by
11788 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11789 The headers are a newline-separated list.
11790
11791 .vitem &$home$&
11792 .vindex "&$home$&"
11793 When the &%check_local_user%& option is set for a router, the user's home
11794 directory is placed in &$home$& when the check succeeds. In particular, this
11795 means it is set during the running of users' filter files. A router may also
11796 explicitly set a home directory for use by a transport; this can be overridden
11797 by a setting on the transport itself.
11798
11799 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11800 of the environment variable HOME, which is subject to the
11801 &%keep_environment%& and &%add_environment%& main config options.
11802
11803 .vitem &$host$&
11804 .vindex "&$host$&"
11805 If a router assigns an address to a transport (any transport), and passes a
11806 list of hosts with the address, the value of &$host$& when the transport starts
11807 to run is the name of the first host on the list. Note that this applies both
11808 to local and remote transports.
11809
11810 .cindex "transport" "filter"
11811 .cindex "filter" "transport filter"
11812 For the &(smtp)& transport, if there is more than one host, the value of
11813 &$host$& changes as the transport works its way through the list. In
11814 particular, when the &(smtp)& transport is expanding its options for encryption
11815 using TLS, or for specifying a transport filter (see chapter
11816 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11817 is connected.
11818
11819 When used in the client part of an authenticator configuration (see chapter
11820 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11821 client is connected.
11822
11823
11824 .vitem &$host_address$&
11825 .vindex "&$host_address$&"
11826 This variable is set to the remote host's IP address whenever &$host$& is set
11827 for a remote connection. It is also set to the IP address that is being checked
11828 when the &%ignore_target_hosts%& option is being processed.
11829
11830 .vitem &$host_data$&
11831 .vindex "&$host_data$&"
11832 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11833 result of the lookup is made available in the &$host_data$& variable. This
11834 allows you, for example, to do things like this:
11835 .code
11836 deny  hosts = net-lsearch;/some/file
11837 message = $host_data
11838 .endd
11839 .vitem &$host_lookup_deferred$&
11840 .cindex "host name" "lookup, failure of"
11841 .vindex "&$host_lookup_deferred$&"
11842 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11843 message comes from a remote host and there is an attempt to look up the host's
11844 name from its IP address, and the attempt is not successful, one of these
11845 variables is set to &"1"&.
11846
11847 .ilist
11848 If the lookup receives a definite negative response (for example, a DNS lookup
11849 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11850
11851 .next
11852 If there is any kind of problem during the lookup, such that Exim cannot
11853 tell whether or not the host name is defined (for example, a timeout for a DNS
11854 lookup), &$host_lookup_deferred$& is set to &"1"&.
11855 .endlist ilist
11856
11857 Looking up a host's name from its IP address consists of more than just a
11858 single reverse lookup. Exim checks that a forward lookup of at least one of the
11859 names it receives from a reverse lookup yields the original IP address. If this
11860 is not the case, Exim does not accept the looked up name(s), and
11861 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11862 IP address (for example, the existence of a PTR record in the DNS) is not
11863 sufficient on its own for the success of a host name lookup. If the reverse
11864 lookup succeeds, but there is a lookup problem such as a timeout when checking
11865 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11866 &"1"&. See also &$sender_host_name$&.
11867
11868 .vitem &$host_lookup_failed$&
11869 .vindex "&$host_lookup_failed$&"
11870 See &$host_lookup_deferred$&.
11871
11872 .vitem &$host_port$&
11873 .vindex "&$host_port$&"
11874 This variable is set to the remote host's TCP port whenever &$host$& is set
11875 for an outbound connection.
11876
11877 .vitem &$initial_cwd$&
11878 .vindex "&$initial_cwd$&
11879 This variable contains the full path name of the initial working
11880 directory of the current Exim process. This may differ from the current
11881 working directory, as Exim changes this to "/" during early startup, and
11882 to &$spool_directory$& later.
11883
11884 .vitem &$inode$&
11885 .vindex "&$inode$&"
11886 The only time this variable is set is while expanding the &%directory_file%&
11887 option in the &(appendfile)& transport. The variable contains the inode number
11888 of the temporary file which is about to be renamed. It can be used to construct
11889 a unique name for the file.
11890
11891 .vitem &$interface_address$&
11892 .vindex "&$interface_address$&"
11893 This is an obsolete name for &$received_ip_address$&.
11894
11895 .vitem &$interface_port$&
11896 .vindex "&$interface_port$&"
11897 This is an obsolete name for &$received_port$&.
11898
11899 .vitem &$item$&
11900 .vindex "&$item$&"
11901 This variable is used during the expansion of &*forall*& and &*forany*&
11902 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11903 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11904 empty.
11905
11906 .vitem &$ldap_dn$&
11907 .vindex "&$ldap_dn$&"
11908 This variable, which is available only when Exim is compiled with LDAP support,
11909 contains the DN from the last entry in the most recently successful LDAP
11910 lookup.
11911
11912 .vitem &$load_average$&
11913 .vindex "&$load_average$&"
11914 This variable contains the system load average, multiplied by 1000 so that it
11915 is an integer. For example, if the load average is 0.21, the value of the
11916 variable is 210. The value is recomputed every time the variable is referenced.
11917
11918 .vitem &$local_part$&
11919 .vindex "&$local_part$&"
11920 When an address is being routed, or delivered on its own, this
11921 variable contains the local part. When a number of addresses are being
11922 delivered together (for example, multiple RCPT commands in an SMTP
11923 session), &$local_part$& is not set.
11924
11925 Global address rewriting happens when a message is received, so the value of
11926 &$local_part$& during routing and delivery is the value after rewriting.
11927 &$local_part$& is set during user filtering, but not during system filtering,
11928 because a message may have many recipients and the system filter is called just
11929 once.
11930
11931 .vindex "&$local_part_prefix$&"
11932 .vindex "&$local_part_suffix$&"
11933 If a local part prefix or suffix has been recognized, it is not included in the
11934 value of &$local_part$& during routing and subsequent delivery. The values of
11935 any prefix or suffix are in &$local_part_prefix$& and
11936 &$local_part_suffix$&, respectively.
11937
11938 When a message is being delivered to a file, pipe, or autoreply transport as a
11939 result of aliasing or forwarding, &$local_part$& is set to the local part of
11940 the parent address, not to the file name or command (see &$address_file$& and
11941 &$address_pipe$&).
11942
11943 When an ACL is running for a RCPT command, &$local_part$& contains the
11944 local part of the recipient address.
11945
11946 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11947 &$local_part$& contains the local part of the address that is being rewritten;
11948 it can be used in the expansion of the replacement address, for example.
11949
11950 In all cases, all quoting is removed from the local part. For example, for both
11951 the addresses
11952 .code
11953 "abc:xyz"@test.example
11954 abc\:xyz@test.example
11955 .endd
11956 the value of &$local_part$& is
11957 .code
11958 abc:xyz
11959 .endd
11960 If you use &$local_part$& to create another address, you should always wrap it
11961 inside a quoting operator. For example, in a &(redirect)& router you could
11962 have:
11963 .code
11964 data = ${quote_local_part:$local_part}@new.domain.example
11965 .endd
11966 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11967 to process local parts in a case-dependent manner in a router, you can set the
11968 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11969
11970 .vitem &$local_part_data$&
11971 .vindex "&$local_part_data$&"
11972 When the &%local_parts%& option on a router matches a local part by means of a
11973 lookup, the data read by the lookup is available during the running of the
11974 router as &$local_part_data$&. In addition, if the driver routes the address
11975 to a transport, the value is available in that transport. If the transport is
11976 handling multiple addresses, the value from the first address is used.
11977
11978 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11979 matches a local part by means of a lookup. The data read by the lookup is
11980 available during the rest of the ACL statement. In all other situations, this
11981 variable expands to nothing.
11982
11983 .vitem &$local_part_prefix$&
11984 .vindex "&$local_part_prefix$&"
11985 When an address is being routed or delivered, and a
11986 specific prefix for the local part was recognized, it is available in this
11987 variable, having been removed from &$local_part$&.
11988
11989 .vitem &$local_part_suffix$&
11990 .vindex "&$local_part_suffix$&"
11991 When an address is being routed or delivered, and a
11992 specific suffix for the local part was recognized, it is available in this
11993 variable, having been removed from &$local_part$&.
11994
11995 .vitem &$local_scan_data$&
11996 .vindex "&$local_scan_data$&"
11997 This variable contains the text returned by the &[local_scan()]& function when
11998 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11999
12000 .vitem &$local_user_gid$&
12001 .vindex "&$local_user_gid$&"
12002 See &$local_user_uid$&.
12003
12004 .vitem &$local_user_uid$&
12005 .vindex "&$local_user_uid$&"
12006 This variable and &$local_user_gid$& are set to the uid and gid after the
12007 &%check_local_user%& router precondition succeeds. This means that their values
12008 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12009 and &%condition%&), for the &%address_data%& expansion, and for any
12010 router-specific expansions. At all other times, the values in these variables
12011 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12012
12013 .vitem &$localhost_number$&
12014 .vindex "&$localhost_number$&"
12015 This contains the expanded value of the
12016 &%localhost_number%& option. The expansion happens after the main options have
12017 been read.
12018
12019 .vitem &$log_inodes$&
12020 .vindex "&$log_inodes$&"
12021 The number of free inodes in the disk partition where Exim's
12022 log files are being written. The value is recalculated whenever the variable is
12023 referenced. If the relevant file system does not have the concept of inodes,
12024 the value of is -1. See also the &%check_log_inodes%& option.
12025
12026 .vitem &$log_space$&
12027 .vindex "&$log_space$&"
12028 The amount of free space (as a number of kilobytes) in the disk
12029 partition where Exim's log files are being written. The value is recalculated
12030 whenever the variable is referenced. If the operating system does not have the
12031 ability to find the amount of free space (only true for experimental systems),
12032 the space value is -1. See also the &%check_log_space%& option.
12033
12034
12035 .vitem &$lookup_dnssec_authenticated$&
12036 .vindex "&$lookup_dnssec_authenticated$&"
12037 This variable is set after a DNS lookup done by
12038 a dnsdb lookup expansion, dnslookup router or smtp transport.
12039 .cindex "DNS" "DNSSEC"
12040 It will be empty if &(DNSSEC)& was not requested,
12041 &"no"& if the result was not labelled as authenticated data
12042 and &"yes"& if it was.
12043 Results that are labelled as authoritative answer that match
12044 the &%dns_trust_aa%& configuration variable count also
12045 as authenticated data.
12046
12047 .vitem &$mailstore_basename$&
12048 .vindex "&$mailstore_basename$&"
12049 This variable is set only when doing deliveries in &"mailstore"& format in the
12050 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12051 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12052 contains the basename of the files that are being written, that is, the name
12053 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12054 variable is empty.
12055
12056 .vitem &$malware_name$&
12057 .vindex "&$malware_name$&"
12058 This variable is available when Exim is compiled with the
12059 content-scanning extension. It is set to the name of the virus that was found
12060 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12061
12062 .vitem &$max_received_linelength$&
12063 .vindex "&$max_received_linelength$&"
12064 .cindex "maximum" "line length"
12065 .cindex "line length" "maximum"
12066 This variable contains the number of bytes in the longest line that was
12067 received as part of the message, not counting the line termination
12068 character(s).
12069
12070 .vitem &$message_age$&
12071 .cindex "message" "age of"
12072 .vindex "&$message_age$&"
12073 This variable is set at the start of a delivery attempt to contain the number
12074 of seconds since the message was received. It does not change during a single
12075 delivery attempt.
12076
12077 .vitem &$message_body$&
12078 .cindex "body of message" "expansion variable"
12079 .cindex "message body" "in expansion"
12080 .cindex "binary zero" "in message body"
12081 .vindex "&$message_body$&"
12082 .oindex "&%message_body_visible%&"
12083 This variable contains the initial portion of a message's body while it is
12084 being delivered, and is intended mainly for use in filter files. The maximum
12085 number of characters of the body that are put into the variable is set by the
12086 &%message_body_visible%& configuration option; the default is 500.
12087
12088 .oindex "&%message_body_newlines%&"
12089 By default, newlines are converted into spaces in &$message_body$&, to make it
12090 easier to search for phrases that might be split over a line break. However,
12091 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12092 zeros are always converted into spaces.
12093
12094 .vitem &$message_body_end$&
12095 .cindex "body of message" "expansion variable"
12096 .cindex "message body" "in expansion"
12097 .vindex "&$message_body_end$&"
12098 This variable contains the final portion of a message's
12099 body while it is being delivered. The format and maximum size are as for
12100 &$message_body$&.
12101
12102 .vitem &$message_body_size$&
12103 .cindex "body of message" "size"
12104 .cindex "message body" "size"
12105 .vindex "&$message_body_size$&"
12106 When a message is being delivered, this variable contains the size of the body
12107 in bytes. The count starts from the character after the blank line that
12108 separates the body from the header. Newlines are included in the count. See
12109 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12110
12111 .vitem &$message_exim_id$&
12112 .vindex "&$message_exim_id$&"
12113 When a message is being received or delivered, this variable contains the
12114 unique message id that is generated and used by Exim to identify the message.
12115 An id is not created for a message until after its header has been successfully
12116 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12117 line; it is the local id that Exim assigns to the message, for example:
12118 &`1BXTIK-0001yO-VA`&.
12119
12120 .vitem &$message_headers$&
12121 .vindex &$message_headers$&
12122 This variable contains a concatenation of all the header lines when a message
12123 is being processed, except for lines added by routers or transports. The header
12124 lines are separated by newline characters. Their contents are decoded in the
12125 same way as a header line that is inserted by &%bheader%&.
12126
12127 .vitem &$message_headers_raw$&
12128 .vindex &$message_headers_raw$&
12129 This variable is like &$message_headers$& except that no processing of the
12130 contents of header lines is done.
12131
12132 .vitem &$message_id$&
12133 This is an old name for &$message_exim_id$&. It is now deprecated.
12134
12135 .vitem &$message_linecount$&
12136 .vindex "&$message_linecount$&"
12137 This variable contains the total number of lines in the header and body of the
12138 message. Compare &$body_linecount$&, which is the count for the body only.
12139 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12140 number of lines received. Before delivery happens (that is, before filters,
12141 routers, and transports run) the count is increased to include the
12142 &'Received:'& header line that Exim standardly adds, and also any other header
12143 lines that are added by ACLs. The blank line that separates the message header
12144 from the body is not counted.
12145
12146 As with the special case of &$message_size$&, during the expansion of the
12147 appendfile transport's maildir_tag option in maildir format, the value of
12148 &$message_linecount$& is the precise size of the number of newlines in the
12149 file that has been written (minus one for the blank line between the
12150 header and the body).
12151
12152 Here is an example of the use of this variable in a DATA ACL:
12153 .code
12154 deny message   = Too many lines in message header
12155      condition = \
12156       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12157 .endd
12158 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12159 message has not yet been received.
12160
12161 .vitem &$message_size$&
12162 .cindex "size" "of message"
12163 .cindex "message" "size"
12164 .vindex "&$message_size$&"
12165 When a message is being processed, this variable contains its size in bytes. In
12166 most cases, the size includes those headers that were received with the
12167 message, but not those (such as &'Envelope-to:'&) that are added to individual
12168 deliveries as they are written. However, there is one special case: during the
12169 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12170 doing a delivery in maildir format, the value of &$message_size$& is the
12171 precise size of the file that has been written. See also
12172 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12173
12174 .cindex "RCPT" "value of &$message_size$&"
12175 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12176 contains the size supplied on the MAIL command, or -1 if no size was given. The
12177 value may not, of course, be truthful.
12178
12179 .vitem &$mime_$&&'xxx'&
12180 A number of variables whose names start with &$mime$& are
12181 available when Exim is compiled with the content-scanning extension. For
12182 details, see section &<<SECTscanmimepart>>&.
12183
12184 .vitem "&$n0$& &-- &$n9$&"
12185 These variables are counters that can be incremented by means
12186 of the &%add%& command in filter files.
12187
12188 .vitem &$original_domain$&
12189 .vindex "&$domain$&"
12190 .vindex "&$original_domain$&"
12191 When a top-level address is being processed for delivery, this contains the
12192 same value as &$domain$&. However, if a &"child"& address (for example,
12193 generated by an alias, forward, or filter file) is being processed, this
12194 variable contains the domain of the original address (lower cased). This
12195 differs from &$parent_domain$& only when there is more than one level of
12196 aliasing or forwarding. When more than one address is being delivered in a
12197 single transport run, &$original_domain$& is not set.
12198
12199 If a new address is created by means of a &%deliver%& command in a system
12200 filter, it is set up with an artificial &"parent"& address. This has the local
12201 part &'system-filter'& and the default qualify domain.
12202
12203 .vitem &$original_local_part$&
12204 .vindex "&$local_part$&"
12205 .vindex "&$original_local_part$&"
12206 When a top-level address is being processed for delivery, this contains the
12207 same value as &$local_part$&, unless a prefix or suffix was removed from the
12208 local part, because &$original_local_part$& always contains the full local
12209 part. When a &"child"& address (for example, generated by an alias, forward, or
12210 filter file) is being processed, this variable contains the full local part of
12211 the original address.
12212
12213 If the router that did the redirection processed the local part
12214 case-insensitively, the value in &$original_local_part$& is in lower case.
12215 This variable differs from &$parent_local_part$& only when there is more than
12216 one level of aliasing or forwarding. When more than one address is being
12217 delivered in a single transport run, &$original_local_part$& is not set.
12218
12219 If a new address is created by means of a &%deliver%& command in a system
12220 filter, it is set up with an artificial &"parent"& address. This has the local
12221 part &'system-filter'& and the default qualify domain.
12222
12223 .vitem &$originator_gid$&
12224 .cindex "gid (group id)" "of originating user"
12225 .cindex "sender" "gid"
12226 .vindex "&$caller_gid$&"
12227 .vindex "&$originator_gid$&"
12228 This variable contains the value of &$caller_gid$& that was set when the
12229 message was received. For messages received via the command line, this is the
12230 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12231 normally the gid of the Exim user.
12232
12233 .vitem &$originator_uid$&
12234 .cindex "uid (user id)" "of originating user"
12235 .cindex "sender" "uid"
12236 .vindex "&$caller_uid$&"
12237 .vindex "&$originator_uid$&"
12238 The value of &$caller_uid$& that was set when the message was received. For
12239 messages received via the command line, this is the uid of the sending user.
12240 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12241 user.
12242
12243 .vitem &$parent_domain$&
12244 .vindex "&$parent_domain$&"
12245 This variable is similar to &$original_domain$& (see
12246 above), except that it refers to the immediately preceding parent address.
12247
12248 .vitem &$parent_local_part$&
12249 .vindex "&$parent_local_part$&"
12250 This variable is similar to &$original_local_part$&
12251 (see above), except that it refers to the immediately preceding parent address.
12252
12253 .vitem &$pid$&
12254 .cindex "pid (process id)" "of current process"
12255 .vindex "&$pid$&"
12256 This variable contains the current process id.
12257
12258 .vitem &$pipe_addresses$&
12259 .cindex "filter" "transport filter"
12260 .cindex "transport" "filter"
12261 .vindex "&$pipe_addresses$&"
12262 This is not an expansion variable, but is mentioned here because the string
12263 &`$pipe_addresses`& is handled specially in the command specification for the
12264 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12265 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12266 It cannot be used in general expansion strings, and provokes an &"unknown
12267 variable"& error if encountered.
12268
12269 .vitem &$primary_hostname$&
12270 .vindex "&$primary_hostname$&"
12271 This variable contains the value set by &%primary_hostname%& in the
12272 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12273 a single-component name, Exim calls &[gethostbyname()]& (or
12274 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12275 qualified host name. See also &$smtp_active_hostname$&.
12276
12277
12278 .new
12279 .vitem &$proxy_external_address$& &&&
12280        &$proxy_external_port$& &&&
12281        &$proxy_local_address$& &&&
12282        &$proxy_local_port$& &&&
12283        &$proxy_session$&
12284 These variables are only available when built with Proxy Protocol
12285 or Socks5 support
12286 For details see chapter &<<SECTproxyInbound>>&.
12287 .wen
12288
12289 .vitem &$prdr_requested$&
12290 .cindex "PRDR" "variable for"
12291 This variable is set to &"yes"& if PRDR was requested by the client for the
12292 current message, otherwise &"no"&.
12293
12294 .vitem &$prvscheck_address$&
12295 This variable is used in conjunction with the &%prvscheck%& expansion item,
12296 which is described in sections &<<SECTexpansionitems>>& and
12297 &<<SECTverifyPRVS>>&.
12298
12299 .vitem &$prvscheck_keynum$&
12300 This variable is used in conjunction with the &%prvscheck%& expansion item,
12301 which is described in sections &<<SECTexpansionitems>>& and
12302 &<<SECTverifyPRVS>>&.
12303
12304 .vitem &$prvscheck_result$&
12305 This variable is used in conjunction with the &%prvscheck%& expansion item,
12306 which is described in sections &<<SECTexpansionitems>>& and
12307 &<<SECTverifyPRVS>>&.
12308
12309 .vitem &$qualify_domain$&
12310 .vindex "&$qualify_domain$&"
12311 The value set for the &%qualify_domain%& option in the configuration file.
12312
12313 .vitem &$qualify_recipient$&
12314 .vindex "&$qualify_recipient$&"
12315 The value set for the &%qualify_recipient%& option in the configuration file,
12316 or if not set, the value of &$qualify_domain$&.
12317
12318 .new
12319 .vitem &$queue_name$&
12320 .vindex &$queue_name$&
12321 .cindex "named queues"
12322 .cindex queues named
12323 The name of the spool queue in use; empty for the default queue.
12324 .wen
12325
12326 .vitem &$rcpt_count$&
12327 .vindex "&$rcpt_count$&"
12328 When a message is being received by SMTP, this variable contains the number of
12329 RCPT commands received for the current message. If this variable is used in a
12330 RCPT ACL, its value includes the current command.
12331
12332 .vitem &$rcpt_defer_count$&
12333 .vindex "&$rcpt_defer_count$&"
12334 .cindex "4&'xx'& responses" "count of"
12335 When a message is being received by SMTP, this variable contains the number of
12336 RCPT commands in the current message that have previously been rejected with a
12337 temporary (4&'xx'&) response.
12338
12339 .vitem &$rcpt_fail_count$&
12340 .vindex "&$rcpt_fail_count$&"
12341 When a message is being received by SMTP, this variable contains the number of
12342 RCPT commands in the current message that have previously been rejected with a
12343 permanent (5&'xx'&) response.
12344
12345 .vitem &$received_count$&
12346 .vindex "&$received_count$&"
12347 This variable contains the number of &'Received:'& header lines in the message,
12348 including the one added by Exim (so its value is always greater than zero). It
12349 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12350 delivering.
12351
12352 .vitem &$received_for$&
12353 .vindex "&$received_for$&"
12354 If there is only a single recipient address in an incoming message, this
12355 variable contains that address when the &'Received:'& header line is being
12356 built. The value is copied after recipient rewriting has happened, but before
12357 the &[local_scan()]& function is run.
12358
12359 .vitem &$received_ip_address$&
12360 .vindex "&$received_ip_address$&"
12361 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12362 variable is set to the address of the local IP interface, and &$received_port$&
12363 is set to the local port number. (The remote IP address and port are in
12364 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12365 the port value is -1 unless it has been set using the &%-oMi%& command line
12366 option.
12367
12368 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12369 could be used, for example, to make the file name for a TLS certificate depend
12370 on which interface and/or port is being used for the incoming connection. The
12371 values of &$received_ip_address$& and &$received_port$& are saved with any
12372 messages that are received, thus making these variables available at delivery
12373 time.
12374 For outbound connections see &$sending_ip_address$&.
12375
12376 .vitem &$received_port$&
12377 .vindex "&$received_port$&"
12378 See &$received_ip_address$&.
12379
12380 .vitem &$received_protocol$&
12381 .vindex "&$received_protocol$&"
12382 When a message is being processed, this variable contains the name of the
12383 protocol by which it was received. Most of the names used by Exim are defined
12384 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12385 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12386 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12387 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12388 connection and the client was successfully authenticated.
12389
12390 Exim uses the protocol name &"smtps"& for the case when encryption is
12391 automatically set up on connection without the use of STARTTLS (see
12392 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12393 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12394 where the client initially uses EHLO, sets up an encrypted connection using
12395 STARTTLS, and then uses HELO afterwards.
12396
12397 The &%-oMr%& option provides a way of specifying a custom protocol name for
12398 messages that are injected locally by trusted callers. This is commonly used to
12399 identify messages that are being re-injected after some kind of scanning.
12400
12401 .vitem &$received_time$&
12402 .vindex "&$received_time$&"
12403 This variable contains the date and time when the current message was received,
12404 as a number of seconds since the start of the Unix epoch.
12405
12406 .vitem &$recipient_data$&
12407 .vindex "&$recipient_data$&"
12408 This variable is set after an indexing lookup success in an ACL &%recipients%&
12409 condition. It contains the data from the lookup, and the value remains set
12410 until the next &%recipients%& test. Thus, you can do things like this:
12411 .display
12412 &`require recipients  = cdb*@;/some/file`&
12413 &`deny    `&&'some further test involving'& &`$recipient_data`&
12414 .endd
12415 &*Warning*&: This variable is set only when a lookup is used as an indexing
12416 method in the address list, using the semicolon syntax as in the example above.
12417 The variable is not set for a lookup that is used as part of the string
12418 expansion that all such lists undergo before being interpreted.
12419
12420 .vitem &$recipient_verify_failure$&
12421 .vindex "&$recipient_verify_failure$&"
12422 In an ACL, when a recipient verification fails, this variable contains
12423 information about the failure. It is set to one of the following words:
12424
12425 .ilist
12426 &"qualify"&: The address was unqualified (no domain), and the message
12427 was neither local nor came from an exempted host.
12428
12429 .next
12430 &"route"&: Routing failed.
12431
12432 .next
12433 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12434 or before the MAIL command (that is, on initial connection, HELO, or
12435 MAIL).
12436
12437 .next
12438 &"recipient"&: The RCPT command in a callout was rejected.
12439 .next
12440
12441 &"postmaster"&: The postmaster check in a callout was rejected.
12442 .endlist
12443
12444 The main use of this variable is expected to be to distinguish between
12445 rejections of MAIL and rejections of RCPT.
12446
12447 .vitem &$recipients$&
12448 .vindex "&$recipients$&"
12449 This variable contains a list of envelope recipients for a message. A comma and
12450 a space separate the addresses in the replacement text. However, the variable
12451 is not generally available, to prevent exposure of Bcc recipients in
12452 unprivileged users' filter files. You can use &$recipients$& only in these
12453 cases:
12454
12455 .olist
12456 In a system filter file.
12457 .next
12458 In the ACLs associated with the DATA command and with non-SMTP messages, that
12459 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12460 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12461 &%acl_not_smtp_mime%&.
12462 .next
12463 From within a &[local_scan()]& function.
12464 .endlist
12465
12466
12467 .vitem &$recipients_count$&
12468 .vindex "&$recipients_count$&"
12469 When a message is being processed, this variable contains the number of
12470 envelope recipients that came with the message. Duplicates are not excluded
12471 from the count. While a message is being received over SMTP, the number
12472 increases for each accepted recipient. It can be referenced in an ACL.
12473
12474
12475 .vitem &$regex_match_string$&
12476 .vindex "&$regex_match_string$&"
12477 This variable is set to contain the matching regular expression after a
12478 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12479
12480 .vitem "&$regex1$&, &$regex2$&, etc"
12481 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12482 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12483 these variables contain the
12484 captured substrings identified by the regular expression.
12485
12486
12487 .vitem &$reply_address$&
12488 .vindex "&$reply_address$&"
12489 When a message is being processed, this variable contains the contents of the
12490 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12491 contents of the &'From:'& header line. Apart from the removal of leading
12492 white space, the value is not processed in any way. In particular, no RFC 2047
12493 decoding or character code translation takes place.
12494
12495 .vitem &$return_path$&
12496 .vindex "&$return_path$&"
12497 When a message is being delivered, this variable contains the return path &--
12498 the sender field that will be sent as part of the envelope. It is not enclosed
12499 in <> characters. At the start of routing an address, &$return_path$& has the
12500 same value as &$sender_address$&, but if, for example, an incoming message to a
12501 mailing list has been expanded by a router which specifies a different address
12502 for bounce messages, &$return_path$& subsequently contains the new bounce
12503 address, whereas &$sender_address$& always contains the original sender address
12504 that was received with the message. In other words, &$sender_address$& contains
12505 the incoming envelope sender, and &$return_path$& contains the outgoing
12506 envelope sender.
12507
12508 .vitem &$return_size_limit$&
12509 .vindex "&$return_size_limit$&"
12510 This is an obsolete name for &$bounce_return_size_limit$&.
12511
12512 .vitem &$router_name$&
12513 .cindex "router" "name"
12514 .cindex "name" "of router"
12515 .vindex "&$router_name$&"
12516 During the running of a router this variable contains its name.
12517
12518 .vitem &$runrc$&
12519 .cindex "return code" "from &%run%& expansion"
12520 .vindex "&$runrc$&"
12521 This variable contains the return code from a command that is run by the
12522 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12523 assume the order in which option values are expanded, except for those
12524 preconditions whose order of testing is documented. Therefore, you cannot
12525 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12526 another.
12527
12528 .vitem &$self_hostname$&
12529 .oindex "&%self%&" "value of host name"
12530 .vindex "&$self_hostname$&"
12531 When an address is routed to a supposedly remote host that turns out to be the
12532 local host, what happens is controlled by the &%self%& generic router option.
12533 One of its values causes the address to be passed to another router. When this
12534 happens, &$self_hostname$& is set to the name of the local host that the
12535 original router encountered. In other circumstances its contents are null.
12536
12537 .vitem &$sender_address$&
12538 .vindex "&$sender_address$&"
12539 When a message is being processed, this variable contains the sender's address
12540 that was received in the message's envelope. The case of letters in the address
12541 is retained, in both the local part and the domain. For bounce messages, the
12542 value of this variable is the empty string. See also &$return_path$&.
12543
12544 .vitem &$sender_address_data$&
12545 .vindex "&$address_data$&"
12546 .vindex "&$sender_address_data$&"
12547 If &$address_data$& is set when the routers are called from an ACL to verify a
12548 sender address, the final value is preserved in &$sender_address_data$&, to
12549 distinguish it from data from a recipient address. The value does not persist
12550 after the end of the current ACL statement. If you want to preserve it for
12551 longer, you can save it in an ACL variable.
12552
12553 .vitem &$sender_address_domain$&
12554 .vindex "&$sender_address_domain$&"
12555 The domain portion of &$sender_address$&.
12556
12557 .vitem &$sender_address_local_part$&
12558 .vindex "&$sender_address_local_part$&"
12559 The local part portion of &$sender_address$&.
12560
12561 .vitem &$sender_data$&
12562 .vindex "&$sender_data$&"
12563 This variable is set after a lookup success in an ACL &%senders%& condition or
12564 in a router &%senders%& option. It contains the data from the lookup, and the
12565 value remains set until the next &%senders%& test. Thus, you can do things like
12566 this:
12567 .display
12568 &`require senders      = cdb*@;/some/file`&
12569 &`deny    `&&'some further test involving'& &`$sender_data`&
12570 .endd
12571 &*Warning*&: This variable is set only when a lookup is used as an indexing
12572 method in the address list, using the semicolon syntax as in the example above.
12573 The variable is not set for a lookup that is used as part of the string
12574 expansion that all such lists undergo before being interpreted.
12575
12576 .vitem &$sender_fullhost$&
12577 .vindex "&$sender_fullhost$&"
12578 When a message is received from a remote host, this variable contains the host
12579 name and IP address in a single string. It ends with the IP address in square
12580 brackets, followed by a colon and a port number if the logging of ports is
12581 enabled. The format of the rest of the string depends on whether the host
12582 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12583 looking up its IP address. (Looking up the IP address can be forced by the
12584 &%host_lookup%& option, independent of verification.) A plain host name at the
12585 start of the string is a verified host name; if this is not present,
12586 verification either failed or was not requested. A host name in parentheses is
12587 the argument of a HELO or EHLO command. This is omitted if it is identical to
12588 the verified host name or to the host's IP address in square brackets.
12589
12590 .vitem &$sender_helo_dnssec$&
12591 .vindex "&$sender_helo_dnssec$&"
12592 This boolean variable is true if a successful HELO verification was
12593 .cindex "DNS" "DNSSEC"
12594 done using DNS information the resolver library stated was authenticated data.
12595
12596 .vitem &$sender_helo_name$&
12597 .vindex "&$sender_helo_name$&"
12598 When a message is received from a remote host that has issued a HELO or EHLO
12599 command, the argument of that command is placed in this variable. It is also
12600 set if HELO or EHLO is used when a message is received using SMTP locally via
12601 the &%-bs%& or &%-bS%& options.
12602
12603 .vitem &$sender_host_address$&
12604 .vindex "&$sender_host_address$&"
12605 When a message is received from a remote host using SMTP,
12606 this variable contains that
12607 host's IP address. For locally non-SMTP submitted messages, it is empty.
12608
12609 .vitem &$sender_host_authenticated$&
12610 .vindex "&$sender_host_authenticated$&"
12611 This variable contains the name (not the public name) of the authenticator
12612 driver that successfully authenticated the client from which the message was
12613 received. It is empty if there was no successful authentication. See also
12614 &$authenticated_id$&.
12615
12616 .vitem &$sender_host_dnssec$&
12617 .vindex "&$sender_host_dnssec$&"
12618 If an attempt to populate &$sender_host_name$& has been made
12619 (by reference, &%hosts_lookup%& or
12620 otherwise) then this boolean will have been set true if, and only if, the
12621 resolver library states that both
12622 the reverse and forward DNS were authenticated data.  At all
12623 other times, this variable is false.
12624
12625 .cindex "DNS" "DNSSEC"
12626 It is likely that you will need to coerce DNSSEC support on in the resolver
12627 library, by setting:
12628 .code
12629 dns_dnssec_ok = 1
12630 .endd
12631
12632 Exim does not perform DNSSEC validation itself, instead leaving that to a
12633 validating resolver (e.g. unbound, or bind with suitable configuration).
12634
12635 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12636 mechanism in the list, then this variable will be false.
12637
12638 .new
12639 This requires that your system resolver library support EDNS0 (and that
12640 DNSSEC flags exist in the system headers).  If the resolver silently drops
12641 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12642 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12643 .wen
12644
12645
12646 .vitem &$sender_host_name$&
12647 .vindex "&$sender_host_name$&"
12648 When a message is received from a remote host, this variable contains the
12649 host's name as obtained by looking up its IP address. For messages received by
12650 other means, this variable is empty.
12651
12652 .vindex "&$host_lookup_failed$&"
12653 If the host name has not previously been looked up, a reference to
12654 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12655 A looked up name is accepted only if it leads back to the original IP address
12656 via a forward lookup. If either the reverse or the forward lookup fails to find
12657 any data, or if the forward lookup does not yield the original IP address,
12658 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12659
12660 .vindex "&$host_lookup_deferred$&"
12661 However, if either of the lookups cannot be completed (for example, there is a
12662 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12663 &$host_lookup_failed$& remains set to &"0"&.
12664
12665 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12666 host name again if there is a subsequent reference to &$sender_host_name$&
12667 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12668 is set to &"1"&.
12669
12670 Exim does not automatically look up every calling host's name. If you want
12671 maximum efficiency, you should arrange your configuration so that it avoids
12672 these lookups altogether. The lookup happens only if one or more of the
12673 following are true:
12674
12675 .ilist
12676 A string containing &$sender_host_name$& is expanded.
12677 .next
12678 The calling host matches the list in &%host_lookup%&. In the default
12679 configuration, this option is set to *, so it must be changed if lookups are
12680 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12681 .next
12682 Exim needs the host name in order to test an item in a host list. The items
12683 that require this are described in sections &<<SECThoslispatnam>>& and
12684 &<<SECThoslispatnamsk>>&.
12685 .next
12686 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12687 In this case, the host name is required to compare with the name quoted in any
12688 EHLO or HELO commands that the client issues.
12689 .next
12690 The remote host issues a EHLO or HELO command that quotes one of the
12691 domains in &%helo_lookup_domains%&. The default value of this option is
12692 . ==== As this is a nested list, any displays it contains must be indented
12693 . ==== as otherwise they are too far to the left.
12694 .code
12695   helo_lookup_domains = @ : @[]
12696 .endd
12697 which causes a lookup if a remote host (incorrectly) gives the server's name or
12698 IP address in an EHLO or HELO command.
12699 .endlist
12700
12701
12702 .vitem &$sender_host_port$&
12703 .vindex "&$sender_host_port$&"
12704 When a message is received from a remote host, this variable contains the port
12705 number that was used on the remote host.
12706
12707 .vitem &$sender_ident$&
12708 .vindex "&$sender_ident$&"
12709 When a message is received from a remote host, this variable contains the
12710 identification received in response to an RFC 1413 request. When a message has
12711 been received locally, this variable contains the login name of the user that
12712 called Exim.
12713
12714 .vitem &$sender_rate_$&&'xxx'&
12715 A number of variables whose names begin &$sender_rate_$& are set as part of the
12716 &%ratelimit%& ACL condition. Details are given in section
12717 &<<SECTratelimiting>>&.
12718
12719 .vitem &$sender_rcvhost$&
12720 .cindex "DNS" "reverse lookup"
12721 .cindex "reverse DNS lookup"
12722 .vindex "&$sender_rcvhost$&"
12723 This is provided specifically for use in &'Received:'& headers. It starts with
12724 either the verified host name (as obtained from a reverse DNS lookup) or, if
12725 there is no verified host name, the IP address in square brackets. After that
12726 there may be text in parentheses. When the first item is a verified host name,
12727 the first thing in the parentheses is the IP address in square brackets,
12728 followed by a colon and a port number if port logging is enabled. When the
12729 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12730 the parentheses.
12731
12732 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12733 was used and its argument was not identical to the real host name or IP
12734 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12735 all three items are present in the parentheses, a newline and tab are inserted
12736 into the string, to improve the formatting of the &'Received:'& header.
12737
12738 .vitem &$sender_verify_failure$&
12739 .vindex "&$sender_verify_failure$&"
12740 In an ACL, when a sender verification fails, this variable contains information
12741 about the failure. The details are the same as for
12742 &$recipient_verify_failure$&.
12743
12744 .vitem &$sending_ip_address$&
12745 .vindex "&$sending_ip_address$&"
12746 This variable is set whenever an outgoing SMTP connection to another host has
12747 been set up. It contains the IP address of the local interface that is being
12748 used. This is useful if a host that has more than one IP address wants to take
12749 on different personalities depending on which one is being used. For incoming
12750 connections, see &$received_ip_address$&.
12751
12752 .vitem &$sending_port$&
12753 .vindex "&$sending_port$&"
12754 This variable is set whenever an outgoing SMTP connection to another host has
12755 been set up. It contains the local port that is being used. For incoming
12756 connections, see &$received_port$&.
12757
12758 .vitem &$smtp_active_hostname$&
12759 .vindex "&$smtp_active_hostname$&"
12760 During an incoming SMTP session, this variable contains the value of the active
12761 host name, as specified by the &%smtp_active_hostname%& option. The value of
12762 &$smtp_active_hostname$& is saved with any message that is received, so its
12763 value can be consulted during routing and delivery.
12764
12765 .vitem &$smtp_command$&
12766 .vindex "&$smtp_command$&"
12767 During the processing of an incoming SMTP command, this variable contains the
12768 entire command. This makes it possible to distinguish between HELO and EHLO in
12769 the HELO ACL, and also to distinguish between commands such as these:
12770 .code
12771 MAIL FROM:<>
12772 MAIL FROM: <>
12773 .endd
12774 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12775 command, the address in &$smtp_command$& is the original address before any
12776 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12777 the address after SMTP-time rewriting.
12778
12779 .vitem &$smtp_command_argument$&
12780 .cindex "SMTP" "command, argument for"
12781 .vindex "&$smtp_command_argument$&"
12782 While an ACL is running to check an SMTP command, this variable contains the
12783 argument, that is, the text that follows the command name, with leading white
12784 space removed. Following the introduction of &$smtp_command$&, this variable is
12785 somewhat redundant, but is retained for backwards compatibility.
12786
12787 .vitem &$smtp_count_at_connection_start$&
12788 .vindex "&$smtp_count_at_connection_start$&"
12789 This variable is set greater than zero only in processes spawned by the Exim
12790 daemon for handling incoming SMTP connections. The name is deliberately long,
12791 in order to emphasize what the contents are. When the daemon accepts a new
12792 connection, it increments this variable. A copy of the variable is passed to
12793 the child process that handles the connection, but its value is fixed, and
12794 never changes. It is only an approximation of how many incoming connections
12795 there actually are, because many other connections may come and go while a
12796 single connection is being processed. When a child process terminates, the
12797 daemon decrements its copy of the variable.
12798
12799 .vitem "&$sn0$& &-- &$sn9$&"
12800 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12801 that were current at the end of the system filter file. This allows a system
12802 filter file to set values that can be tested in users' filter files. For
12803 example, a system filter could set a value indicating how likely it is that a
12804 message is junk mail.
12805
12806 .vitem &$spam_$&&'xxx'&
12807 A number of variables whose names start with &$spam$& are available when Exim
12808 is compiled with the content-scanning extension. For details, see section
12809 &<<SECTscanspamass>>&.
12810
12811
12812 .vitem &$spool_directory$&
12813 .vindex "&$spool_directory$&"
12814 The name of Exim's spool directory.
12815
12816 .vitem &$spool_inodes$&
12817 .vindex "&$spool_inodes$&"
12818 The number of free inodes in the disk partition where Exim's spool files are
12819 being written. The value is recalculated whenever the variable is referenced.
12820 If the relevant file system does not have the concept of inodes, the value of
12821 is -1. See also the &%check_spool_inodes%& option.
12822
12823 .vitem &$spool_space$&
12824 .vindex "&$spool_space$&"
12825 The amount of free space (as a number of kilobytes) in the disk partition where
12826 Exim's spool files are being written. The value is recalculated whenever the
12827 variable is referenced. If the operating system does not have the ability to
12828 find the amount of free space (only true for experimental systems), the space
12829 value is -1. For example, to check in an ACL that there is at least 50
12830 megabytes free on the spool, you could write:
12831 .code
12832 condition = ${if > {$spool_space}{50000}}
12833 .endd
12834 See also the &%check_spool_space%& option.
12835
12836
12837 .vitem &$thisaddress$&
12838 .vindex "&$thisaddress$&"
12839 This variable is set only during the processing of the &%foranyaddress%&
12840 command in a filter file. Its use is explained in the description of that
12841 command, which can be found in the separate document entitled &'Exim's
12842 interfaces to mail filtering'&.
12843
12844 .vitem &$tls_in_bits$&
12845 .vindex "&$tls_in_bits$&"
12846 Contains an approximation of the TLS cipher's bit-strength
12847 on the inbound connection; the meaning of
12848 this depends upon the TLS implementation used.
12849 If TLS has not been negotiated, the value will be 0.
12850 The value of this is automatically fed into the Cyrus SASL authenticator
12851 when acting as a server, to specify the "external SSF" (a SASL term).
12852
12853 The deprecated &$tls_bits$& variable refers to the inbound side
12854 except when used in the context of an outbound SMTP delivery, when it refers to
12855 the outbound.
12856
12857 .vitem &$tls_out_bits$&
12858 .vindex "&$tls_out_bits$&"
12859 Contains an approximation of the TLS cipher's bit-strength
12860 on an outbound SMTP connection; the meaning of
12861 this depends upon the TLS implementation used.
12862 If TLS has not been negotiated, the value will be 0.
12863
12864 .vitem &$tls_in_ourcert$&
12865 .vindex "&$tls_in_ourcert$&"
12866 .cindex certificate variables
12867 This variable refers to the certificate presented to the peer of an
12868 inbound connection when the message was received.
12869 It is only useful as the argument of a
12870 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12871 or a &%def%& condition.
12872
12873 .vitem &$tls_in_peercert$&
12874 .vindex "&$tls_in_peercert$&"
12875 This variable refers to the certificate presented by the peer of an
12876 inbound connection when the message was received.
12877 It is only useful as the argument of a
12878 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12879 or a &%def%& condition.
12880 If certificate verification fails it may refer to a failing chain element
12881 which is not the leaf.
12882
12883 .vitem &$tls_out_ourcert$&
12884 .vindex "&$tls_out_ourcert$&"
12885 This variable refers to the certificate presented to the peer of an
12886 outbound connection.  It is only useful as the argument of a
12887 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12888 or a &%def%& condition.
12889
12890 .vitem &$tls_out_peercert$&
12891 .vindex "&$tls_out_peercert$&"
12892 This variable refers to the certificate presented by the peer of an
12893 outbound connection.  It is only useful as the argument of a
12894 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12895 or a &%def%& condition.
12896 If certificate verification fails it may refer to a failing chain element
12897 which is not the leaf.
12898
12899 .vitem &$tls_in_certificate_verified$&
12900 .vindex "&$tls_in_certificate_verified$&"
12901 This variable is set to &"1"& if a TLS certificate was verified when the
12902 message was received, and &"0"& otherwise.
12903
12904 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12905 except when used in the context of an outbound SMTP delivery, when it refers to
12906 the outbound.
12907
12908 .vitem &$tls_out_certificate_verified$&
12909 .vindex "&$tls_out_certificate_verified$&"
12910 This variable is set to &"1"& if a TLS certificate was verified when an
12911 outbound SMTP connection was made,
12912 and &"0"& otherwise.
12913
12914 .vitem &$tls_in_cipher$&
12915 .vindex "&$tls_in_cipher$&"
12916 .vindex "&$tls_cipher$&"
12917 When a message is received from a remote host over an encrypted SMTP
12918 connection, this variable is set to the cipher suite that was negotiated, for
12919 example DES-CBC3-SHA. In other circumstances, in particular, for message
12920 received over unencrypted connections, the variable is empty. Testing
12921 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12922 non-encrypted connections during ACL processing.
12923
12924 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12925 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12926 becomes the same as &$tls_out_cipher$&.
12927
12928 .vitem &$tls_out_cipher$&
12929 .vindex "&$tls_out_cipher$&"
12930 This variable is
12931 cleared before any outgoing SMTP connection is made,
12932 and then set to the outgoing cipher suite if one is negotiated. See chapter
12933 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12934 details of the &(smtp)& transport.
12935
12936 .vitem &$tls_in_ocsp$&
12937 .vindex "&$tls_in_ocsp$&"
12938 When a message is received from a remote client connection
12939 the result of any OCSP request from the client is encoded in this variable:
12940 .code
12941 0 OCSP proof was not requested (default value)
12942 1 No response to request
12943 2 Response not verified
12944 3 Verification failed
12945 4 Verification succeeded
12946 .endd
12947
12948 .vitem &$tls_out_ocsp$&
12949 .vindex "&$tls_out_ocsp$&"
12950 When a message is sent to a remote host connection
12951 the result of any OCSP request made is encoded in this variable.
12952 See &$tls_in_ocsp$& for values.
12953
12954 .vitem &$tls_in_peerdn$&
12955 .vindex "&$tls_in_peerdn$&"
12956 .vindex "&$tls_peerdn$&"
12957 .cindex certificate "extracting fields"
12958 When a message is received from a remote host over an encrypted SMTP
12959 connection, and Exim is configured to request a certificate from the client,
12960 the value of the Distinguished Name of the certificate is made available in the
12961 &$tls_in_peerdn$& during subsequent processing.
12962 If certificate verification fails it may refer to a failing chain element
12963 which is not the leaf.
12964
12965 The deprecated &$tls_peerdn$& variable refers to the inbound side
12966 except when used in the context of an outbound SMTP delivery, when it refers to
12967 the outbound.
12968
12969 .vitem &$tls_out_peerdn$&
12970 .vindex "&$tls_out_peerdn$&"
12971 When a message is being delivered to a remote host over an encrypted SMTP
12972 connection, and Exim is configured to request a certificate from the server,
12973 the value of the Distinguished Name of the certificate is made available in the
12974 &$tls_out_peerdn$& during subsequent processing.
12975 If certificate verification fails it may refer to a failing chain element
12976 which is not the leaf.
12977
12978 .vitem &$tls_in_sni$&
12979 .vindex "&$tls_in_sni$&"
12980 .vindex "&$tls_sni$&"
12981 .cindex "TLS" "Server Name Indication"
12982 When a TLS session is being established, if the client sends the Server
12983 Name Indication extension, the value will be placed in this variable.
12984 If the variable appears in &%tls_certificate%& then this option and
12985 some others, described in &<<SECTtlssni>>&,
12986 will be re-expanded early in the TLS session, to permit
12987 a different certificate to be presented (and optionally a different key to be
12988 used) to the client, based upon the value of the SNI extension.
12989
12990 The deprecated &$tls_sni$& variable refers to the inbound side
12991 except when used in the context of an outbound SMTP delivery, when it refers to
12992 the outbound.
12993
12994 .vitem &$tls_out_sni$&
12995 .vindex "&$tls_out_sni$&"
12996 .cindex "TLS" "Server Name Indication"
12997 During outbound
12998 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12999 the transport.
13000
13001 .vitem &$tod_bsdinbox$&
13002 .vindex "&$tod_bsdinbox$&"
13003 The time of day and the date, in the format required for BSD-style mailbox
13004 files, for example: Thu Oct 17 17:14:09 1995.
13005
13006 .vitem &$tod_epoch$&
13007 .vindex "&$tod_epoch$&"
13008 The time and date as a number of seconds since the start of the Unix epoch.
13009
13010 .vitem &$tod_epoch_l$&
13011 .vindex "&$tod_epoch_l$&"
13012 The time and date as a number of microseconds since the start of the Unix epoch.
13013
13014 .vitem &$tod_full$&
13015 .vindex "&$tod_full$&"
13016 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13017 +0100. The timezone is always given as a numerical offset from UTC, with
13018 positive values used for timezones that are ahead (east) of UTC, and negative
13019 values for those that are behind (west).
13020
13021 .vitem &$tod_log$&
13022 .vindex "&$tod_log$&"
13023 The time and date in the format used for writing Exim's log files, for example:
13024 1995-10-12 15:32:29, but without a timezone.
13025
13026 .vitem &$tod_logfile$&
13027 .vindex "&$tod_logfile$&"
13028 This variable contains the date in the format yyyymmdd. This is the format that
13029 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13030 flag.
13031
13032 .vitem &$tod_zone$&
13033 .vindex "&$tod_zone$&"
13034 This variable contains the numerical value of the local timezone, for example:
13035 -0500.
13036
13037 .vitem &$tod_zulu$&
13038 .vindex "&$tod_zulu$&"
13039 This variable contains the UTC date and time in &"Zulu"& format, as specified
13040 by ISO 8601, for example: 20030221154023Z.
13041
13042 .vitem &$transport_name$&
13043 .cindex "transport" "name"
13044 .cindex "name" "of transport"
13045 .vindex "&$transport_name$&"
13046 During the running of a transport, this variable contains its name.
13047
13048 .vitem &$value$&
13049 .vindex "&$value$&"
13050 This variable contains the result of an expansion lookup, extraction operation,
13051 or external command, as described above. It is also used during a
13052 &*reduce*& expansion.
13053
13054 .vitem &$verify_mode$&
13055 .vindex "&$verify_mode$&"
13056 While a router or transport is being run in verify mode or for cutthrough delivery,
13057 contains "S" for sender-verification or "R" for recipient-verification.
13058 Otherwise, empty.
13059
13060 .vitem &$version_number$&
13061 .vindex "&$version_number$&"
13062 The version number of Exim.
13063
13064 .vitem &$warn_message_delay$&
13065 .vindex "&$warn_message_delay$&"
13066 This variable is set only during the creation of a message warning about a
13067 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13068
13069 .vitem &$warn_message_recipients$&
13070 .vindex "&$warn_message_recipients$&"
13071 This variable is set only during the creation of a message warning about a
13072 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13073 .endlist
13074 .ecindex IIDstrexp
13075
13076
13077
13078 . ////////////////////////////////////////////////////////////////////////////
13079 . ////////////////////////////////////////////////////////////////////////////
13080
13081 .chapter "Embedded Perl" "CHAPperl"
13082 .scindex IIDperl "Perl" "calling from Exim"
13083 Exim can be built to include an embedded Perl interpreter. When this is done,
13084 Perl subroutines can be called as part of the string expansion process. To make
13085 use of the Perl support, you need version 5.004 or later of Perl installed on
13086 your system. To include the embedded interpreter in the Exim binary, include
13087 the line
13088 .code
13089 EXIM_PERL = perl.o
13090 .endd
13091 in your &_Local/Makefile_& and then build Exim in the normal way.
13092
13093
13094 .section "Setting up so Perl can be used" "SECID85"
13095 .oindex "&%perl_startup%&"
13096 Access to Perl subroutines is via a global configuration option called
13097 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13098 no &%perl_startup%& option in the Exim configuration file then no Perl
13099 interpreter is started and there is almost no overhead for Exim (since none of
13100 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13101 option then the associated value is taken to be Perl code which is executed in
13102 a newly created Perl interpreter.
13103
13104 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13105 need backslashes before any characters to escape special meanings. The option
13106 should usually be something like
13107 .code
13108 perl_startup = do '/etc/exim.pl'
13109 .endd
13110 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13111 use from Exim. Exim can be configured either to start up a Perl interpreter as
13112 soon as it is entered, or to wait until the first time it is needed. Starting
13113 the interpreter at the beginning ensures that it is done while Exim still has
13114 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13115 fact used in a particular run. Also, note that this does not mean that Exim is
13116 necessarily running as root when Perl is called at a later time. By default,
13117 the interpreter is started only when it is needed, but this can be changed in
13118 two ways:
13119
13120 .ilist
13121 .oindex "&%perl_at_start%&"
13122 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13123 a startup when Exim is entered.
13124 .next
13125 The command line option &%-ps%& also requests a startup when Exim is entered,
13126 overriding the setting of &%perl_at_start%&.
13127 .endlist
13128
13129 There is also a command line option &%-pd%& (for delay) which suppresses the
13130 initial startup, even if &%perl_at_start%& is set.
13131
13132 .new
13133 .ilist
13134 .oindex "&%perl_taintmode%&"
13135 .cindex "Perl" "taintmode"
13136 To provide more security executing Perl code via the embedded Perl
13137 interpreter, the &%perl_taintmode%& option can be set. This enables the
13138 taint mode of the Perl interpreter. You are encouraged to set this
13139 option to a true value. To avoid breaking existing installations, it
13140 defaults to false.
13141 .wen
13142
13143
13144 .section "Calling Perl subroutines" "SECID86"
13145 When the configuration file includes a &%perl_startup%& option you can make use
13146 of the string expansion item to call the Perl subroutines that are defined
13147 by the &%perl_startup%& code. The operator is used in any of the following
13148 forms:
13149 .code
13150 ${perl{foo}}
13151 ${perl{foo}{argument}}
13152 ${perl{foo}{argument1}{argument2} ... }
13153 .endd
13154 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13155 arguments may be passed. Passing more than this results in an expansion failure
13156 with an error message of the form
13157 .code
13158 Too many arguments passed to Perl subroutine "foo" (max is 8)
13159 .endd
13160 The return value of the Perl subroutine is evaluated in a scalar context before
13161 it is passed back to Exim to be inserted into the expanded string. If the
13162 return value is &'undef'&, the expansion is forced to fail in the same way as
13163 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13164 by obeying Perl's &%die%& function, the expansion fails with the error message
13165 that was passed to &%die%&.
13166
13167
13168 .section "Calling Exim functions from Perl" "SECID87"
13169 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13170 is available to call back into Exim's string expansion function. For example,
13171 the Perl code
13172 .code
13173 my $lp = Exim::expand_string('$local_part');
13174 .endd
13175 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13176 Note those are single quotes and not double quotes to protect against
13177 &$local_part$& being interpolated as a Perl variable.
13178
13179 If the string expansion is forced to fail by a &"fail"& item, the result of
13180 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13181 expansion string, the Perl call from the original expansion string fails with
13182 an appropriate error message, in the same way as if &%die%& were used.
13183
13184 .cindex "debugging" "from embedded Perl"
13185 .cindex "log" "writing from embedded Perl"
13186 Two other Exim functions are available for use from within Perl code.
13187 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13188 debugging is enabled. If you want a newline at the end, you must supply it.
13189 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13190 timestamp. In this case, you should not supply a terminating newline.
13191
13192
13193 .section "Use of standard output and error by Perl" "SECID88"
13194 .cindex "Perl" "standard output and error"
13195 You should not write to the standard error or output streams from within your
13196 Perl code, as it is not defined how these are set up. In versions of Exim
13197 before 4.50, it is possible for the standard output or error to refer to the
13198 SMTP connection during message reception via the daemon. Writing to this stream
13199 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13200 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13201 avoided, but the output is lost.
13202
13203 .cindex "Perl" "use of &%warn%&"
13204 The Perl &%warn%& statement writes to the standard error stream by default.
13205 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13206 you have no control. When Exim starts up the Perl interpreter, it arranges for
13207 output from the &%warn%& statement to be written to the Exim main log. You can
13208 change this by including appropriate Perl magic somewhere in your Perl code.
13209 For example, to discard &%warn%& output completely, you need this:
13210 .code
13211 $SIG{__WARN__} = sub { };
13212 .endd
13213 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13214 example, the code for the subroutine is empty, so it does nothing, but you can
13215 include any Perl code that you like. The text of the &%warn%& message is passed
13216 as the first subroutine argument.
13217 .ecindex IIDperl
13218
13219
13220 . ////////////////////////////////////////////////////////////////////////////
13221 . ////////////////////////////////////////////////////////////////////////////
13222
13223 .chapter "Starting the daemon and the use of network interfaces" &&&
13224          "CHAPinterfaces" &&&
13225          "Starting the daemon"
13226 .cindex "daemon" "starting"
13227 .cindex "interface" "listening"
13228 .cindex "network interface"
13229 .cindex "interface" "network"
13230 .cindex "IP address" "for listening"
13231 .cindex "daemon" "listening IP addresses"
13232 .cindex "TCP/IP" "setting listening interfaces"
13233 .cindex "TCP/IP" "setting listening ports"
13234 A host that is connected to a TCP/IP network may have one or more physical
13235 hardware network interfaces. Each of these interfaces may be configured as one
13236 or more &"logical"& interfaces, which are the entities that a program actually
13237 works with. Each of these logical interfaces is associated with an IP address.
13238 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13239 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13240 knowledge about the host's interfaces for use in three different circumstances:
13241
13242 .olist
13243 When a listening daemon is started, Exim needs to know which interfaces
13244 and ports to listen on.
13245 .next
13246 When Exim is routing an address, it needs to know which IP addresses
13247 are associated with local interfaces. This is required for the correct
13248 processing of MX lists by removing the local host and others with the
13249 same or higher priority values. Also, Exim needs to detect cases
13250 when an address is routed to an IP address that in fact belongs to the
13251 local host. Unless the &%self%& router option or the &%allow_localhost%&
13252 option of the smtp transport is set (as appropriate), this is treated
13253 as an error situation.
13254 .next
13255 When Exim connects to a remote host, it may need to know which interface to use
13256 for the outgoing connection.
13257 .endlist
13258
13259
13260 Exim's default behaviour is likely to be appropriate in the vast majority
13261 of cases. If your host has only one interface, and you want all its IP
13262 addresses to be treated in the same way, and you are using only the
13263 standard SMTP port, you should not need to take any special action. The
13264 rest of this chapter does not apply to you.
13265
13266 In a more complicated situation you may want to listen only on certain
13267 interfaces, or on different ports, and for this reason there are a number of
13268 options that can be used to influence Exim's behaviour. The rest of this
13269 chapter describes how they operate.
13270
13271 When a message is received over TCP/IP, the interface and port that were
13272 actually used are set in &$received_ip_address$& and &$received_port$&.
13273
13274
13275
13276 .section "Starting a listening daemon" "SECID89"
13277 When a listening daemon is started (by means of the &%-bd%& command line
13278 option), the interfaces and ports on which it listens are controlled by the
13279 following options:
13280
13281 .ilist
13282 &%daemon_smtp_ports%& contains a list of default ports
13283 or service names.
13284 (For backward compatibility, this option can also be specified in the singular.)
13285 .next
13286 &%local_interfaces%& contains list of interface IP addresses on which to
13287 listen. Each item may optionally also specify a port.
13288 .endlist
13289
13290 The default list separator in both cases is a colon, but this can be changed as
13291 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13292 it is usually best to change the separator to avoid having to double all the
13293 colons. For example:
13294 .code
13295 local_interfaces = <; 127.0.0.1 ; \
13296                       192.168.23.65 ; \
13297                       ::1 ; \
13298                       3ffe:ffff:836f::fe86:a061
13299 .endd
13300 There are two different formats for specifying a port along with an IP address
13301 in &%local_interfaces%&:
13302
13303 .olist
13304 The port is added onto the address with a dot separator. For example, to listen
13305 on port 1234 on two different IP addresses:
13306 .code
13307 local_interfaces = <; 192.168.23.65.1234 ; \
13308                       3ffe:ffff:836f::fe86:a061.1234
13309 .endd
13310 .next
13311 The IP address is enclosed in square brackets, and the port is added
13312 with a colon separator, for example:
13313 .code
13314 local_interfaces = <; [192.168.23.65]:1234 ; \
13315                       [3ffe:ffff:836f::fe86:a061]:1234
13316 .endd
13317 .endlist
13318
13319 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13320 default setting contains just one port:
13321 .code
13322 daemon_smtp_ports = smtp
13323 .endd
13324 If more than one port is listed, each interface that does not have its own port
13325 specified listens on all of them. Ports that are listed in
13326 &%daemon_smtp_ports%& can be identified either by name (defined in
13327 &_/etc/services_&) or by number. However, when ports are given with individual
13328 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13329
13330
13331
13332 .section "Special IP listening addresses" "SECID90"
13333 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13334 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13335 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13336 instead of setting up separate listening sockets for each interface. The
13337 default value of &%local_interfaces%& is
13338 .code
13339 local_interfaces = 0.0.0.0
13340 .endd
13341 when Exim is built without IPv6 support; otherwise it is:
13342 .code
13343 local_interfaces = <; ::0 ; 0.0.0.0
13344 .endd
13345 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13346
13347
13348
13349 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13350 The &%-oX%& command line option can be used to override the values of
13351 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13352 instance. Another way of doing this would be to use macros and the &%-D%&
13353 option. However, &%-oX%& can be used by any admin user, whereas modification of
13354 the runtime configuration by &%-D%& is allowed only when the caller is root or
13355 exim.
13356
13357 The value of &%-oX%& is a list of items. The default colon separator can be
13358 changed in the usual way if required. If there are any items that do not
13359 contain dots or colons (that is, are not IP addresses), the value of
13360 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13361 items that do contain dots or colons, the value of &%local_interfaces%& is
13362 replaced by those items. Thus, for example,
13363 .code
13364 -oX 1225
13365 .endd
13366 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13367 whereas
13368 .code
13369 -oX 192.168.34.5.1125
13370 .endd
13371 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13372 (However, since &%local_interfaces%& now contains no items without ports, the
13373 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13374
13375
13376
13377 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13378 .cindex "ssmtp protocol"
13379 .cindex "smtps protocol"
13380 .cindex "SMTP" "ssmtp protocol"
13381 .cindex "SMTP" "smtps protocol"
13382 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13383 before the STARTTLS command was standardized for SMTP. Some legacy clients
13384 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13385 list of port numbers or service names,
13386 connections to those ports must use SSMTP. The most
13387 common use of this option is expected to be
13388 .code
13389 tls_on_connect_ports = 465
13390 .endd
13391 because 465 is the usual port number used by the legacy clients. There is also
13392 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13393 this way when a daemon is started.
13394
13395 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13396 daemon to listen on those ports. You must still specify them in
13397 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13398 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13399 connections via the daemon.)
13400
13401
13402
13403
13404 .section "IPv6 address scopes" "SECID92"
13405 .cindex "IPv6" "address scopes"
13406 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13407 can, in principle, have the same link-local IPv6 address on different
13408 interfaces. Thus, additional information is needed, over and above the IP
13409 address, to distinguish individual interfaces. A convention of using a
13410 percent sign followed by something (often the interface name) has been
13411 adopted in some cases, leading to addresses like this:
13412 .code
13413 fe80::202:b3ff:fe03:45c1%eth0
13414 .endd
13415 To accommodate this usage, a percent sign followed by an arbitrary string is
13416 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13417 to convert a textual IPv6 address for actual use. This function recognizes the
13418 percent convention in operating systems that support it, and it processes the
13419 address appropriately. Unfortunately, some older libraries have problems with
13420 &[getaddrinfo()]&. If
13421 .code
13422 IPV6_USE_INET_PTON=yes
13423 .endd
13424 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13425 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13426 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13427 function.) Of course, this means that the additional functionality of
13428 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13429
13430 .section "Disabling IPv6" "SECID93"
13431 .cindex "IPv6" "disabling"
13432 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13433 run on a host whose kernel does not support IPv6. The binary will fall back to
13434 using IPv4, but it may waste resources looking up AAAA records, and trying to
13435 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13436 .oindex "&%disable_ipv6%&"
13437 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13438 activities take place. AAAA records are never looked up, and any IPv6 addresses
13439 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13440 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13441 to handle IPv6 literal addresses.
13442
13443 On the other hand, when IPv6 is in use, there may be times when you want to
13444 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13445 option to globally suppress the lookup of AAAA records for specified domains,
13446 and you can use the &%ignore_target_hosts%& generic router option to ignore
13447 IPv6 addresses in an individual router.
13448
13449
13450
13451 .section "Examples of starting a listening daemon" "SECID94"
13452 The default case in an IPv6 environment is
13453 .code
13454 daemon_smtp_ports = smtp
13455 local_interfaces = <; ::0 ; 0.0.0.0
13456 .endd
13457 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13458 Either one or two sockets may be used, depending on the characteristics of
13459 the TCP/IP stack. (This is complicated and messy; for more information,
13460 read the comments in the &_daemon.c_& source file.)
13461
13462 To specify listening on ports 25 and 26 on all interfaces:
13463 .code
13464 daemon_smtp_ports = 25 : 26
13465 .endd
13466 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13467 .code
13468 local_interfaces = <; ::0.25     ; ::0.26 \
13469                       0.0.0.0.25 ; 0.0.0.0.26
13470 .endd
13471 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13472 IPv4 loopback address only:
13473 .code
13474 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13475 .endd
13476 To specify listening on the default port on specific interfaces only:
13477 .code
13478 local_interfaces = 10.0.0.67 : 192.168.34.67
13479 .endd
13480 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13481
13482
13483
13484 .section "Recognizing the local host" "SECTreclocipadd"
13485 The &%local_interfaces%& option is also used when Exim needs to determine
13486 whether or not an IP address refers to the local host. That is, the IP
13487 addresses of all the interfaces on which a daemon is listening are always
13488 treated as local.
13489
13490 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13491 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13492 available interfaces from the operating system, and extracts the relevant
13493 (that is, IPv4 or IPv6) addresses to use for checking.
13494
13495 Some systems set up large numbers of virtual interfaces in order to provide
13496 many virtual web servers. In this situation, you may want to listen for
13497 email on only a few of the available interfaces, but nevertheless treat all
13498 interfaces as local when routing. You can do this by setting
13499 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13500 &"all"& wildcard values. These addresses are recognized as local, but are not
13501 used for listening. Consider this example:
13502 .code
13503 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13504                       192.168.53.235 ; \
13505                       3ffe:2101:12:1:a00:20ff:fe86:a061
13506
13507 extra_local_interfaces = <; ::0 ; 0.0.0.0
13508 .endd
13509 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13510 address, but all available interface addresses are treated as local when
13511 Exim is routing.
13512
13513 In some environments the local host name may be in an MX list, but with an IP
13514 address that is not assigned to any local interface. In other cases it may be
13515 desirable to treat other host names as if they referred to the local host. Both
13516 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13517 This contains host names rather than IP addresses. When a host is referenced
13518 during routing, either via an MX record or directly, it is treated as the local
13519 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13520 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13521
13522
13523
13524 .section "Delivering to a remote host" "SECID95"
13525 Delivery to a remote host is handled by the smtp transport. By default, it
13526 allows the system's TCP/IP functions to choose which interface to use (if
13527 there is more than one) when connecting to a remote host. However, the
13528 &%interface%& option can be set to specify which interface is used. See the
13529 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13530 details.
13531
13532
13533
13534
13535 . ////////////////////////////////////////////////////////////////////////////
13536 . ////////////////////////////////////////////////////////////////////////////
13537
13538 .chapter "Main configuration" "CHAPmainconfig"
13539 .scindex IIDconfima "configuration file" "main section"
13540 .scindex IIDmaiconf "main configuration"
13541 The first part of the run time configuration file contains three types of item:
13542
13543 .ilist
13544 Macro definitions: These lines start with an upper case letter. See section
13545 &<<SECTmacrodefs>>& for details of macro processing.
13546 .next
13547 Named list definitions: These lines start with one of the words &"domainlist"&,
13548 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13549 section &<<SECTnamedlists>>&.
13550 .next
13551 Main configuration settings: Each setting occupies one line of the file
13552 (with possible continuations). If any setting is preceded by the word
13553 &"hide"&, the &%-bP%& command line option displays its value to admin users
13554 only. See section &<<SECTcos>>& for a description of the syntax of these option
13555 settings.
13556 .endlist
13557
13558 This chapter specifies all the main configuration options, along with their
13559 types and default values. For ease of finding a particular option, they appear
13560 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13561 are now so many options, they are first listed briefly in functional groups, as
13562 an aid to finding the name of the option you are looking for. Some options are
13563 listed in more than one group.
13564
13565 .section "Miscellaneous" "SECID96"
13566 .table2
13567 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13568 .row &%disable_ipv6%&                "do no IPv6 processing"
13569 .row &%keep_malformed%&              "for broken files &-- should not happen"
13570 .row &%localhost_number%&            "for unique message ids in clusters"
13571 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13572 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13573 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13574 .row &%print_topbitchars%&           "top-bit characters are printing"
13575 .row &%timezone%&                    "force time zone"
13576 .endtable
13577
13578
13579 .section "Exim parameters" "SECID97"
13580 .table2
13581 .row &%exim_group%&                  "override compiled-in value"
13582 .row &%exim_path%&                   "override compiled-in value"
13583 .row &%exim_user%&                   "override compiled-in value"
13584 .row &%primary_hostname%&            "default from &[uname()]&"
13585 .row &%split_spool_directory%&       "use multiple directories"
13586 .row &%spool_directory%&             "override compiled-in value"
13587 .endtable
13588
13589
13590
13591 .section "Privilege controls" "SECID98"
13592 .table2
13593 .row &%admin_groups%&                "groups that are Exim admin users"
13594 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13595 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13596 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13597 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13598 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13599 .row &%never_users%&                 "do not run deliveries as these"
13600 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13601 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13602 .row &%trusted_groups%&              "groups that are trusted"
13603 .row &%trusted_users%&               "users that are trusted"
13604 .endtable
13605
13606
13607
13608 .section "Logging" "SECID99"
13609 .table2
13610 .row &%event_action%&                "custom logging"
13611 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13612 .row &%log_file_path%&               "override compiled-in value"
13613 .row &%log_selector%&                "set/unset optional logging"
13614 .row &%log_timezone%&                "add timezone to log lines"
13615 .row &%message_logs%&                "create per-message logs"
13616 .row &%preserve_message_logs%&       "after message completion"
13617 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13618 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13619 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13620 .row &%syslog_facility%&             "set syslog &""facility""& field"
13621 .row &%syslog_pid%&                  "pid in syslog lines"
13622 .row &%syslog_processname%&          "set syslog &""ident""& field"
13623 .row &%syslog_timestamp%&            "timestamp syslog lines"
13624 .row &%write_rejectlog%&             "control use of message log"
13625 .endtable
13626
13627
13628
13629 .section "Frozen messages" "SECID100"
13630 .table2
13631 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13632 .row &%freeze_tell%&                 "send message when freezing"
13633 .row &%move_frozen_messages%&        "to another directory"
13634 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13635 .endtable
13636
13637
13638
13639 .section "Data lookups" "SECID101"
13640 .table2
13641 .row &%ibase_servers%&               "InterBase servers"
13642 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13643 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13644 .row &%ldap_cert_file%&              "client cert file for LDAP"
13645 .row &%ldap_cert_key%&               "client key file for LDAP"
13646 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13647 .row &%ldap_default_servers%&        "used if no server in query"
13648 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13649 .row &%ldap_start_tls%&              "require TLS within LDAP"
13650 .row &%ldap_version%&                "set protocol version"
13651 .row &%lookup_open_max%&             "lookup files held open"
13652 .row &%mysql_servers%&               "default MySQL servers"
13653 .row &%oracle_servers%&              "Oracle servers"
13654 .row &%pgsql_servers%&               "default PostgreSQL servers"
13655 .row &%sqlite_lock_timeout%&         "as it says"
13656 .endtable
13657
13658
13659
13660 .section "Message ids" "SECID102"
13661 .table2
13662 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13663 .row &%message_id_header_text%&      "ditto"
13664 .endtable
13665
13666
13667
13668 .section "Embedded Perl Startup" "SECID103"
13669 .table2
13670 .row &%perl_at_start%&               "always start the interpreter"
13671 .row &%perl_startup%&                "code to obey when starting Perl"
13672 .row &%perl_taintmode%&              "enable taint mode in Perl"
13673 .endtable
13674
13675
13676
13677 .section "Daemon" "SECID104"
13678 .table2
13679 .row &%daemon_smtp_ports%&           "default ports"
13680 .row &%daemon_startup_retries%&      "number of times to retry"
13681 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13682 .row &%extra_local_interfaces%&      "not necessarily listened on"
13683 .row &%local_interfaces%&            "on which to listen, with optional ports"
13684 .row &%pid_file_path%&               "override compiled-in value"
13685 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13686 .endtable
13687
13688
13689
13690 .section "Resource control" "SECID105"
13691 .table2
13692 .row &%check_log_inodes%&            "before accepting a message"
13693 .row &%check_log_space%&             "before accepting a message"
13694 .row &%check_spool_inodes%&          "before accepting a message"
13695 .row &%check_spool_space%&           "before accepting a message"
13696 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13697 .row &%queue_only_load%&             "queue incoming if load high"
13698 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13699 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13700 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13701 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13702 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13703 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13704 .row &%smtp_accept_max_per_connection%& "messages per connection"
13705 .row &%smtp_accept_max_per_host%&    "connections from one host"
13706 .row &%smtp_accept_queue%&           "queue mail if more connections"
13707 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13708                                            connection"
13709 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13710 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13711 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13712 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13713 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13714 .endtable
13715
13716
13717
13718 .section "Policy controls" "SECID106"
13719 .table2
13720 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13721 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13722 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13723 .row &%acl_smtp_auth%&               "ACL for AUTH"
13724 .row &%acl_smtp_connect%&            "ACL for connection"
13725 .row &%acl_smtp_data%&               "ACL for DATA"
13726 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13727 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13728 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13729 .row &%acl_smtp_expn%&               "ACL for EXPN"
13730 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13731 .row &%acl_smtp_mail%&               "ACL for MAIL"
13732 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13733 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13734 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13735 .row &%acl_smtp_predata%&            "ACL for start of data"
13736 .row &%acl_smtp_quit%&               "ACL for QUIT"
13737 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13738 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13739 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13740 .row &%av_scanner%&                  "specify virus scanner"
13741 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13742                                       words""&"
13743 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13744 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13745 .row &%header_maxsize%&              "total size of message header"
13746 .row &%header_line_maxsize%&         "individual header line limit"
13747 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13748 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13749 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13750 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13751 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13752 .row &%host_lookup%&                 "host name looked up for these hosts"
13753 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13754 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13755 .row &%host_reject_connection%&      "reject connection from these hosts"
13756 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13757 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13758 .row &%message_size_limit%&          "for all messages"
13759 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13760 .row &%spamd_address%&               "set interface to SpamAssassin"
13761 .row &%strict_acl_vars%&             "object to unset ACL variables"
13762 .endtable
13763
13764
13765
13766 .section "Callout cache" "SECID107"
13767 .table2
13768 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13769                                          item"
13770 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13771                                          item"
13772 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13773 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13774 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13775 .endtable
13776
13777
13778
13779 .section "TLS" "SECID108"
13780 .table2
13781 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13782 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13783 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13784 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13785 .row &%tls_certificate%&             "location of server certificate"
13786 .row &%tls_crl%&                     "certificate revocation list"
13787 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13788 .row &%tls_dhparam%&                 "DH parameters for server"
13789 .row &%tls_eccurve%&                 "EC curve selection for server"
13790 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13791 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13792 .row &%tls_privatekey%&              "location of server private key"
13793 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13794 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13795 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13796 .row &%tls_verify_certificates%&     "expected client certificates"
13797 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13798 .endtable
13799
13800
13801
13802 .section "Local user handling" "SECID109"
13803 .table2
13804 .row &%finduser_retries%&            "useful in NIS environments"
13805 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13806 .row &%gecos_pattern%&               "ditto"
13807 .row &%max_username_length%&         "for systems that truncate"
13808 .row &%unknown_login%&               "used when no login name found"
13809 .row &%unknown_username%&            "ditto"
13810 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13811 .row &%uucp_from_sender%&            "ditto"
13812 .endtable
13813
13814
13815
13816 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13817 .table2
13818 .row &%header_maxsize%&              "total size of message header"
13819 .row &%header_line_maxsize%&         "individual header line limit"
13820 .row &%message_size_limit%&          "applies to all messages"
13821 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13822 .row &%received_header_text%&        "expanded to make &'Received:'&"
13823 .row &%received_headers_max%&        "for mail loop detection"
13824 .row &%recipients_max%&              "limit per message"
13825 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13826 .endtable
13827
13828
13829
13830
13831 .section "Non-SMTP incoming messages" "SECID111"
13832 .table2
13833 .row &%receive_timeout%&             "for non-SMTP messages"
13834 .endtable
13835
13836
13837
13838
13839
13840 .section "Incoming SMTP messages" "SECID112"
13841 See also the &'Policy controls'& section above.
13842
13843 .table2
13844 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13845 .row &%host_lookup%&                 "host name looked up for these hosts"
13846 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13847 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13848 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13849 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13850 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13851 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13852 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13853 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13854 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13855 .row &%smtp_accept_max_per_connection%& "messages per connection"
13856 .row &%smtp_accept_max_per_host%&    "connections from one host"
13857 .row &%smtp_accept_queue%&           "queue mail if more connections"
13858 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13859                                            connection"
13860 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13861 .row &%smtp_active_hostname%&        "host name to use in messages"
13862 .row &%smtp_banner%&                 "text for welcome banner"
13863 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13864 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13865 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13866 .row &%smtp_etrn_command%&           "what to run for ETRN"
13867 .row &%smtp_etrn_serialize%&         "only one at once"
13868 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13869 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13870 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13871 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13872 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13873 .row &%smtp_receive_timeout%&        "per command or data line"
13874 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13875 .row &%smtp_return_error_details%&   "give detail on rejections"
13876 .endtable
13877
13878
13879
13880 .section "SMTP extensions" "SECID113"
13881 .table2
13882 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13883 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13884 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13885 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13886 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13887 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13888 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13889 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13890 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13891 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13892 .endtable
13893
13894
13895
13896 .section "Processing messages" "SECID114"
13897 .table2
13898 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13899 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13900 .row &%allow_utf8_domains%&          "in addresses"
13901 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13902                                       words""&"
13903 .row &%delivery_date_remove%&        "from incoming messages"
13904 .row &%envelope_to_remove%&          "from incoming messages"
13905 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13906 .row &%headers_charset%&             "default for translations"
13907 .row &%qualify_domain%&              "default for senders"
13908 .row &%qualify_recipient%&           "default for recipients"
13909 .row &%return_path_remove%&          "from incoming messages"
13910 .row &%strip_excess_angle_brackets%& "in addresses"
13911 .row &%strip_trailing_dot%&          "at end of addresses"
13912 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13913 .endtable
13914
13915
13916
13917 .section "System filter" "SECID115"
13918 .table2
13919 .row &%system_filter%&               "locate system filter"
13920 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13921                                             directory"
13922 .row &%system_filter_file_transport%& "transport for delivery to a file"
13923 .row &%system_filter_group%&         "group for filter running"
13924 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13925 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13926 .row &%system_filter_user%&          "user for filter running"
13927 .endtable
13928
13929
13930
13931 .section "Routing and delivery" "SECID116"
13932 .table2
13933 .row &%disable_ipv6%&                "do no IPv6 processing"
13934 .row &%dns_again_means_nonexist%&    "for broken domains"
13935 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13936 .row &%dns_dnssec_ok%&               "parameter for resolver"
13937 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13938 .row &%dns_retrans%&                 "parameter for resolver"
13939 .row &%dns_retry%&                   "parameter for resolver"
13940 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13941 .row &%dns_use_edns0%&               "parameter for resolver"
13942 .row &%hold_domains%&                "hold delivery for these domains"
13943 .row &%local_interfaces%&            "for routing checks"
13944 .row &%queue_domains%&               "no immediate delivery for these"
13945 .row &%queue_only%&                  "no immediate delivery at all"
13946 .row &%queue_only_file%&             "no immediate delivery if file exists"
13947 .row &%queue_only_load%&             "no immediate delivery if load is high"
13948 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13949 .row &%queue_only_override%&         "allow command line to override"
13950 .row &%queue_run_in_order%&          "order of arrival"
13951 .row &%queue_run_max%&               "of simultaneous queue runners"
13952 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13953 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13954 .row &%remote_sort_domains%&         "order of remote deliveries"
13955 .row &%retry_data_expire%&           "timeout for retry data"
13956 .row &%retry_interval_max%&          "safety net for retry rules"
13957 .endtable
13958
13959
13960
13961 .section "Bounce and warning messages" "SECID117"
13962 .table2
13963 .row &%bounce_message_file%&         "content of bounce"
13964 .row &%bounce_message_text%&         "content of bounce"
13965 .row &%bounce_return_body%&          "include body if returning message"
13966 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13967 .row &%bounce_return_message%&       "include original message in bounce"
13968 .row &%bounce_return_size_limit%&    "limit on returned message"
13969 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13970 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13971 .row &%errors_copy%&                 "copy bounce messages"
13972 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13973 .row &%delay_warning%&               "time schedule"
13974 .row &%delay_warning_condition%&     "condition for warning messages"
13975 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13976 .row &%smtp_return_error_details%&   "give detail on rejections"
13977 .row &%warn_message_file%&           "content of warning message"
13978 .endtable
13979
13980
13981
13982 .section "Alphabetical list of main options" "SECTalomo"
13983 Those options that undergo string expansion before use are marked with
13984 &dagger;.
13985
13986 .option accept_8bitmime main boolean true
13987 .cindex "8BITMIME"
13988 .cindex "8-bit characters"
13989 .cindex "log" "selectors"
13990 .cindex "log" "8BITMIME"
13991 This option causes Exim to send 8BITMIME in its response to an SMTP
13992 EHLO command, and to accept the BODY= parameter on MAIL commands.
13993 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13994 takes no steps to do anything special with messages received by this route.
13995
13996 Historically Exim kept this option off by default, but the maintainers
13997 feel that in today's Internet, this causes more problems than it solves.
13998 It now defaults to true.
13999 A more detailed analysis of the issues is provided by Dan Bernstein:
14000 .display
14001 &url(http://cr.yp.to/smtp/8bitmime.html)
14002 .endd
14003
14004 To log received 8BITMIME status use
14005 .code
14006 log_selector = +8bitmime
14007 .endd
14008
14009 .option acl_not_smtp main string&!! unset
14010 .cindex "&ACL;" "for non-SMTP messages"
14011 .cindex "non-SMTP messages" "ACLs for"
14012 This option defines the ACL that is run when a non-SMTP message has been
14013 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14014 further details.
14015
14016 .option acl_not_smtp_mime main string&!! unset
14017 This option defines the ACL that is run for individual MIME parts of non-SMTP
14018 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14019 SMTP messages.
14020
14021 .option acl_not_smtp_start main string&!! unset
14022 .cindex "&ACL;" "at start of non-SMTP message"
14023 .cindex "non-SMTP messages" "ACLs for"
14024 This option defines the ACL that is run before Exim starts reading a
14025 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14026
14027 .option acl_smtp_auth main string&!! unset
14028 .cindex "&ACL;" "setting up for SMTP commands"
14029 .cindex "AUTH" "ACL for"
14030 This option defines the ACL that is run when an SMTP AUTH command is
14031 received. See chapter &<<CHAPACL>>& for further details.
14032
14033 .option acl_smtp_connect main string&!! unset
14034 .cindex "&ACL;" "on SMTP connection"
14035 This option defines the ACL that is run when an SMTP connection is received.
14036 See chapter &<<CHAPACL>>& for further details.
14037
14038 .option acl_smtp_data main string&!! unset
14039 .cindex "DATA" "ACL for"
14040 This option defines the ACL that is run after an SMTP DATA command has been
14041 processed and the message itself has been received, but before the final
14042 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14043
14044 .option acl_smtp_data_prdr main string&!! accept
14045 .cindex "PRDR" "ACL for"
14046 .cindex "DATA" "PRDR ACL for"
14047 .cindex "&ACL;" "PRDR-related"
14048 .cindex "&ACL;" "per-user data processing"
14049 This option defines the ACL that,
14050 if the PRDR feature has been negotiated,
14051 is run for each recipient after an SMTP DATA command has been
14052 processed and the message itself has been received, but before the
14053 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14054
14055 .option acl_smtp_dkim main string&!! unset
14056 .cindex DKIM "ACL for"
14057 This option defines the ACL that is run for each DKIM signature
14058 (by default, or as specified in the dkim_verify_signers option)
14059 of a received message.
14060 See chapter &<<CHAPdkim>>& for further details.
14061
14062 .option acl_smtp_etrn main string&!! unset
14063 .cindex "ETRN" "ACL for"
14064 This option defines the ACL that is run when an SMTP ETRN command is
14065 received. See chapter &<<CHAPACL>>& for further details.
14066
14067 .option acl_smtp_expn main string&!! unset
14068 .cindex "EXPN" "ACL for"
14069 This option defines the ACL that is run when an SMTP EXPN command is
14070 received. See chapter &<<CHAPACL>>& for further details.
14071
14072 .option acl_smtp_helo main string&!! unset
14073 .cindex "EHLO" "ACL for"
14074 .cindex "HELO" "ACL for"
14075 This option defines the ACL that is run when an SMTP EHLO or HELO
14076 command is received. See chapter &<<CHAPACL>>& for further details.
14077
14078
14079 .option acl_smtp_mail main string&!! unset
14080 .cindex "MAIL" "ACL for"
14081 This option defines the ACL that is run when an SMTP MAIL command is
14082 received. See chapter &<<CHAPACL>>& for further details.
14083
14084 .option acl_smtp_mailauth main string&!! unset
14085 .cindex "AUTH" "on MAIL command"
14086 This option defines the ACL that is run when there is an AUTH parameter on
14087 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14088 &<<CHAPSMTPAUTH>>& for details of authentication.
14089
14090 .option acl_smtp_mime main string&!! unset
14091 .cindex "MIME content scanning" "ACL for"
14092 This option is available when Exim is built with the content-scanning
14093 extension. It defines the ACL that is run for each MIME part in a message. See
14094 section &<<SECTscanmimepart>>& for details.
14095
14096 .option acl_smtp_notquit main string&!! unset
14097 .cindex "not-QUIT, ACL for"
14098 This option defines the ACL that is run when an SMTP session
14099 ends without a QUIT command being received.
14100 See chapter &<<CHAPACL>>& for further details.
14101
14102 .option acl_smtp_predata main string&!! unset
14103 This option defines the ACL that is run when an SMTP DATA command is
14104 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14105 further details.
14106
14107 .option acl_smtp_quit main string&!! unset
14108 .cindex "QUIT, ACL for"
14109 This option defines the ACL that is run when an SMTP QUIT command is
14110 received. See chapter &<<CHAPACL>>& for further details.
14111
14112 .option acl_smtp_rcpt main string&!! unset
14113 .cindex "RCPT" "ACL for"
14114 This option defines the ACL that is run when an SMTP RCPT command is
14115 received. See chapter &<<CHAPACL>>& for further details.
14116
14117 .option acl_smtp_starttls main string&!! unset
14118 .cindex "STARTTLS, ACL for"
14119 This option defines the ACL that is run when an SMTP STARTTLS command is
14120 received. See chapter &<<CHAPACL>>& for further details.
14121
14122 .option acl_smtp_vrfy main string&!! unset
14123 .cindex "VRFY" "ACL for"
14124 This option defines the ACL that is run when an SMTP VRFY command is
14125 received. See chapter &<<CHAPACL>>& for further details.
14126
14127 .option add_environment main "string list" empty
14128 .cindex "environment" "set values"
14129 This option allows to set individual environment variables that the
14130 currently linked libraries and programs in child processes use.
14131 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14132
14133 .option admin_groups main "string list&!!" unset
14134 .cindex "admin user"
14135 This option is expanded just once, at the start of Exim's processing. If the
14136 current group or any of the supplementary groups of an Exim caller is in this
14137 colon-separated list, the caller has admin privileges. If all your system
14138 programmers are in a specific group, for example, you can give them all Exim
14139 admin privileges by putting that group in &%admin_groups%&. However, this does
14140 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14141 To permit this, you have to add individuals to the Exim group.
14142
14143 .option allow_domain_literals main boolean false
14144 .cindex "domain literal"
14145 If this option is set, the RFC 2822 domain literal format is permitted in
14146 email addresses. The option is not set by default, because the domain literal
14147 format is not normally required these days, and few people know about it. It
14148 has, however, been exploited by mail abusers.
14149
14150 Unfortunately, it seems that some DNS black list maintainers are using this
14151 format to report black listing to postmasters. If you want to accept messages
14152 addressed to your hosts by IP address, you need to set
14153 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14154 domains (defined in the named domain list &%local_domains%& in the default
14155 configuration). This &"magic string"& matches the domain literal form of all
14156 the local host's IP addresses.
14157
14158
14159 .option allow_mx_to_ip main boolean false
14160 .cindex "MX record" "pointing to IP address"
14161 It appears that more and more DNS zone administrators are breaking the rules
14162 and putting domain names that look like IP addresses on the right hand side of
14163 MX records. Exim follows the rules and rejects this, giving an error message
14164 that explains the misconfiguration. However, some other MTAs support this
14165 practice, so to avoid &"Why can't Exim do this?"& complaints,
14166 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14167 recommended, except when you have no other choice.
14168
14169 .option allow_utf8_domains main boolean false
14170 .cindex "domain" "UTF-8 characters in"
14171 .cindex "UTF-8" "in domain name"
14172 Lots of discussion is going on about internationalized domain names. One
14173 camp is strongly in favour of just using UTF-8 characters, and it seems
14174 that at least two other MTAs permit this. This option allows Exim users to
14175 experiment if they wish.
14176
14177 If it is set true, Exim's domain parsing function allows valid
14178 UTF-8 multicharacters to appear in domain name components, in addition to
14179 letters, digits, and hyphens. However, just setting this option is not
14180 enough; if you want to look up these domain names in the DNS, you must also
14181 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14182 suitable setting is:
14183 .code
14184 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14185   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14186 .endd
14187 Alternatively, you can just disable this feature by setting
14188 .code
14189 dns_check_names_pattern =
14190 .endd
14191 That is, set the option to an empty string so that no check is done.
14192
14193
14194 .option auth_advertise_hosts main "host list&!!" *
14195 .cindex "authentication" "advertising"
14196 .cindex "AUTH" "advertising"
14197 If any server authentication mechanisms are configured, Exim advertises them in
14198 response to an EHLO command only if the calling host matches this list.
14199 Otherwise, Exim does not advertise AUTH.
14200 Exim does not accept AUTH commands from clients to which it has not
14201 advertised the availability of AUTH. The advertising of individual
14202 authentication mechanisms can be controlled by the use of the
14203 &%server_advertise_condition%& generic authenticator option on the individual
14204 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14205
14206 Certain mail clients (for example, Netscape) require the user to provide a name
14207 and password for authentication if AUTH is advertised, even though it may
14208 not be needed (the host may accept messages from hosts on its local LAN without
14209 authentication, for example). The &%auth_advertise_hosts%& option can be used
14210 to make these clients more friendly by excluding them from the set of hosts to
14211 which Exim advertises AUTH.
14212
14213 .cindex "AUTH" "advertising when encrypted"
14214 If you want to advertise the availability of AUTH only when the connection
14215 is encrypted using TLS, you can make use of the fact that the value of this
14216 option is expanded, with a setting like this:
14217 .code
14218 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14219 .endd
14220 .vindex "&$tls_in_cipher$&"
14221 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14222 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14223 expansion is *, which matches all hosts.
14224
14225
14226 .option auto_thaw main time 0s
14227 .cindex "thawing messages"
14228 .cindex "unfreezing messages"
14229 If this option is set to a time greater than zero, a queue runner will try a
14230 new delivery attempt on any frozen message, other than a bounce message, if
14231 this much time has passed since it was frozen. This may result in the message
14232 being re-frozen if nothing has changed since the last attempt. It is a way of
14233 saying &"keep on trying, even though there are big problems"&.
14234
14235 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14236 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14237 thought to be very useful any more, and its use should probably be avoided.
14238
14239
14240 .option av_scanner main string "see below"
14241 This option is available if Exim is built with the content-scanning extension.
14242 It specifies which anti-virus scanner to use. The default value is:
14243 .code
14244 sophie:/var/run/sophie
14245 .endd
14246 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14247 before use. See section &<<SECTscanvirus>>& for further details.
14248
14249
14250 .option bi_command main string unset
14251 .oindex "&%-bi%&"
14252 This option supplies the name of a command that is run when Exim is called with
14253 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14254 just the command name, it is not a complete command line. If an argument is
14255 required, it must come from the &%-oA%& command line option.
14256
14257
14258 .option bounce_message_file main string unset
14259 .cindex "bounce message" "customizing"
14260 .cindex "customizing" "bounce message"
14261 This option defines a template file containing paragraphs of text to be used
14262 for constructing bounce messages.  Details of the file's contents are given in
14263 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14264
14265
14266 .option bounce_message_text main string unset
14267 When this option is set, its contents are included in the default bounce
14268 message immediately after &"This message was created automatically by mail
14269 delivery software."& It is not used if &%bounce_message_file%& is set.
14270
14271 .option bounce_return_body main boolean true
14272 .cindex "bounce message" "including body"
14273 This option controls whether the body of an incoming message is included in a
14274 bounce message when &%bounce_return_message%& is true. The default setting
14275 causes the entire message, both header and body, to be returned (subject to the
14276 value of &%bounce_return_size_limit%&). If this option is false, only the
14277 message header is included. In the case of a non-SMTP message containing an
14278 error that is detected during reception, only those header lines preceding the
14279 point at which the error was detected are returned.
14280 .cindex "bounce message" "including original"
14281
14282 .option bounce_return_linesize_limit main integer 998
14283 .cindex "size" "of bounce lines, limit"
14284 .cindex "bounce message" "line length limit"
14285 .cindex "limit" "bounce message line length"
14286 This option sets a limit in bytes on the line length of messages
14287 that are returned to senders due to delivery problems,
14288 when &%bounce_return_message%& is true.
14289 The default value corresponds to RFC limits.
14290 If the message being returned has lines longer than this value it is
14291 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14292
14293 The option also applies to bounces returned when an error is detected
14294 during reception of a message.
14295 In this case lines from the original are truncated.
14296
14297 The option does not apply to messages generated by an &(autoreply)& transport.
14298
14299
14300 .option bounce_return_message main boolean true
14301 If this option is set false, none of the original message is included in
14302 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14303 &%bounce_return_body%&.
14304
14305
14306 .option bounce_return_size_limit main integer 100K
14307 .cindex "size" "of bounce, limit"
14308 .cindex "bounce message" "size limit"
14309 .cindex "limit" "bounce message size"
14310 This option sets a limit in bytes on the size of messages that are returned to
14311 senders as part of bounce messages when &%bounce_return_message%& is true. The
14312 limit should be less than the value of the global &%message_size_limit%& and of
14313 any &%message_size_limit%& settings on transports, to allow for the bounce text
14314 that Exim generates. If this option is set to zero there is no limit.
14315
14316 When the body of any message that is to be included in a bounce message is
14317 greater than the limit, it is truncated, and a comment pointing this out is
14318 added at the top. The actual cutoff may be greater than the value given, owing
14319 to the use of buffering for transferring the message in chunks (typically 8K in
14320 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14321 messages.
14322
14323 .option bounce_sender_authentication main string unset
14324 .cindex "bounce message" "sender authentication"
14325 .cindex "authentication" "bounce message"
14326 .cindex "AUTH" "on bounce message"
14327 This option provides an authenticated sender address that is sent with any
14328 bounce messages generated by Exim that are sent over an authenticated SMTP
14329 connection. A typical setting might be:
14330 .code
14331 bounce_sender_authentication = mailer-daemon@my.domain.example
14332 .endd
14333 which would cause bounce messages to be sent using the SMTP command:
14334 .code
14335 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14336 .endd
14337 The value of &%bounce_sender_authentication%& must always be a complete email
14338 address.
14339
14340 .option callout_domain_negative_expire main time 3h
14341 .cindex "caching" "callout timeouts"
14342 .cindex "callout" "caching timeouts"
14343 This option specifies the expiry time for negative callout cache data for a
14344 domain. See section &<<SECTcallver>>& for details of callout verification, and
14345 section &<<SECTcallvercache>>& for details of the caching.
14346
14347
14348 .option callout_domain_positive_expire main time 7d
14349 This option specifies the expiry time for positive callout cache data for a
14350 domain. See section &<<SECTcallver>>& for details of callout verification, and
14351 section &<<SECTcallvercache>>& for details of the caching.
14352
14353
14354 .option callout_negative_expire main time 2h
14355 This option specifies the expiry time for negative callout cache data for an
14356 address. See section &<<SECTcallver>>& for details of callout verification, and
14357 section &<<SECTcallvercache>>& for details of the caching.
14358
14359
14360 .option callout_positive_expire main time 24h
14361 This option specifies the expiry time for positive callout cache data for an
14362 address. See section &<<SECTcallver>>& for details of callout verification, and
14363 section &<<SECTcallvercache>>& for details of the caching.
14364
14365
14366 .option callout_random_local_part main string&!! "see below"
14367 This option defines the &"random"& local part that can be used as part of
14368 callout verification. The default value is
14369 .code
14370 $primary_hostname-$tod_epoch-testing
14371 .endd
14372 See section &<<CALLaddparcall>>& for details of how this value is used.
14373
14374
14375 .new
14376 .option check_log_inodes main integer 100
14377 .wen
14378 See &%check_spool_space%& below.
14379
14380
14381 .new
14382 .option check_log_space main integer 10M
14383 .wen
14384 See &%check_spool_space%& below.
14385
14386 .oindex "&%check_rfc2047_length%&"
14387 .cindex "RFC 2047" "disabling length check"
14388 .option check_rfc2047_length main boolean true
14389 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14390 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14391 word; strings to be encoded that exceed this length are supposed to use
14392 multiple encoded words. By default, Exim does not recognize encoded words that
14393 exceed the maximum length. However, it seems that some software, in violation
14394 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14395 set false, Exim recognizes encoded words of any length.
14396
14397
14398 .new
14399 .option check_spool_inodes main integer 100
14400 .wen
14401 See &%check_spool_space%& below.
14402
14403
14404 .new
14405 .option check_spool_space main integer 10M
14406 .wen
14407 .cindex "checking disk space"
14408 .cindex "disk space, checking"
14409 .cindex "spool directory" "checking space"
14410 The four &%check_...%& options allow for checking of disk resources before a
14411 message is accepted.
14412
14413 .vindex "&$log_inodes$&"
14414 .vindex "&$log_space$&"
14415 .vindex "&$spool_inodes$&"
14416 .vindex "&$spool_space$&"
14417 When any of these options are nonzero, they apply to all incoming messages. If you
14418 want to apply different checks to different kinds of message, you can do so by
14419 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14420 &$spool_space$& in an ACL with appropriate additional conditions.
14421
14422
14423 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14424 either value is greater than zero, for example:
14425 .code
14426 check_spool_space = 100M
14427 check_spool_inodes = 100
14428 .endd
14429 The spool partition is the one that contains the directory defined by
14430 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14431 transit.
14432
14433 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14434 files are written if either is greater than zero. These should be set only if
14435 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14436
14437 If there is less space or fewer inodes than requested, Exim refuses to accept
14438 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14439 error response to the MAIL command. If ESMTP is in use and there was a
14440 SIZE parameter on the MAIL command, its value is added to the
14441 &%check_spool_space%& value, and the check is performed even if
14442 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14443
14444 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14445 number of kilobytes (though specified in bytes).
14446 If a non-multiple of 1024 is specified, it is rounded up.
14447
14448 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14449 failure a message is written to stderr and Exim exits with a non-zero code, as
14450 it obviously cannot send an error message of any kind.
14451
14452 .new
14453 There is a slight performance penalty for these checks.
14454 Versions of Exim preceding 4.88 had these disabled by default;
14455 high-rate installations confident they will never run out of resources
14456 may wish to deliberately disable them.
14457 .wen
14458
14459 .new
14460 .option chunking_advertise_hosts main "host list&!!" *
14461 .cindex CHUNKING advertisement
14462 .cindex "RFC 3030" "CHUNKING"
14463 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14464 these hosts.
14465 Hosts may use the BDAT command as an alternate to DATA.
14466 .wen
14467
14468 .option daemon_smtp_ports main string &`smtp`&
14469 .cindex "port" "for daemon"
14470 .cindex "TCP/IP" "setting listening ports"
14471 This option specifies one or more default SMTP ports on which the Exim daemon
14472 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14473 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14474
14475 .option daemon_startup_retries main integer 9
14476 .cindex "daemon startup, retrying"
14477 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14478 the daemon at startup when it cannot immediately bind a listening socket
14479 (typically because the socket is already in use): &%daemon_startup_retries%&
14480 defines the number of retries after the first failure, and
14481 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14482
14483 .option daemon_startup_sleep main time 30s
14484 See &%daemon_startup_retries%&.
14485
14486 .option delay_warning main "time list" 24h
14487 .cindex "warning of delay"
14488 .cindex "delay warning, specifying"
14489 .cindex "queue" "delay warning"
14490 When a message is delayed, Exim sends a warning message to the sender at
14491 intervals specified by this option. The data is a colon-separated list of times
14492 after which to send warning messages. If the value of the option is an empty
14493 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14494 message has been on the queue for longer than the last time, the last interval
14495 between the times is used to compute subsequent warning times. For example,
14496 with
14497 .code
14498 delay_warning = 4h:8h:24h
14499 .endd
14500 the first message is sent after 4 hours, the second after 8 hours, and
14501 the third one after 24 hours. After that, messages are sent every 16 hours,
14502 because that is the interval between the last two times on the list. If you set
14503 just one time, it specifies the repeat interval. For example, with:
14504 .code
14505 delay_warning = 6h
14506 .endd
14507 messages are repeated every six hours. To stop warnings after a given time, set
14508 a very large time at the end of the list. For example:
14509 .code
14510 delay_warning = 2h:12h:99d
14511 .endd
14512 Note that the option is only evaluated at the time a delivery attempt fails,
14513 which depends on retry and queue-runner configuration.
14514 Typically retries will be configured more frequently than warning messages.
14515
14516 .option delay_warning_condition main string&!! "see below"
14517 .vindex "&$domain$&"
14518 The string is expanded at the time a warning message might be sent. If all the
14519 deferred addresses have the same domain, it is set in &$domain$& during the
14520 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14521 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14522 &"false"& (the comparison being done caselessly) then the warning message is
14523 not sent. The default is:
14524 .code
14525 delay_warning_condition = ${if or {\
14526   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14527   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14528   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14529   } {no}{yes}}
14530 .endd
14531 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14532 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14533 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14534 &"auto-replied"& in an &'Auto-Submitted:'& header.
14535
14536 .option deliver_drop_privilege main boolean false
14537 .cindex "unprivileged delivery"
14538 .cindex "delivery" "unprivileged"
14539 If this option is set true, Exim drops its root privilege at the start of a
14540 delivery process, and runs as the Exim user throughout. This severely restricts
14541 the kinds of local delivery that are possible, but is viable in certain types
14542 of configuration. There is a discussion about the use of root privilege in
14543 chapter &<<CHAPsecurity>>&.
14544
14545 .option deliver_queue_load_max main fixed-point unset
14546 .cindex "load average"
14547 .cindex "queue runner" "abandoning"
14548 When this option is set, a queue run is abandoned if the system load average
14549 becomes greater than the value of the option. The option has no effect on
14550 ancient operating systems on which Exim cannot determine the load average.
14551 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14552
14553
14554 .option delivery_date_remove main boolean true
14555 .cindex "&'Delivery-date:'& header line"
14556 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14557 message when it is delivered, in exactly the same way as &'Return-path:'& is
14558 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14559 should not be present in incoming messages, and this option causes them to be
14560 removed at the time the message is received, to avoid any problems that might
14561 occur when a delivered message is subsequently sent on to some other recipient.
14562
14563 .option disable_fsync main boolean false
14564 .cindex "&[fsync()]&, disabling"
14565 This option is available only if Exim was built with the compile-time option
14566 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14567 a runtime configuration generates an &"unknown option"& error. You should not
14568 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14569 really, really, really understand what you are doing. &'No pre-compiled
14570 distributions of Exim should ever make this option available.'&
14571
14572 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14573 updated files' data to be written to disc before continuing. Unexpected events
14574 such as crashes and power outages may cause data to be lost or scrambled.
14575 Here be Dragons. &*Beware.*&
14576
14577
14578 .option disable_ipv6 main boolean false
14579 .cindex "IPv6" "disabling"
14580 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14581 activities take place. AAAA records are never looked up, and any IPv6 addresses
14582 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14583 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14584 to handle IPv6 literal addresses.
14585
14586
14587 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14588 .cindex DKIM "controlling calls to the ACL"
14589 This option gives a list of DKIM domains for which the DKIM ACL is run.
14590 It is expanded after the message is received; by default it runs
14591 the ACL once for each signature in the message.
14592 See chapter &<<CHAPdkim>>&.
14593
14594
14595 .option dns_again_means_nonexist main "domain list&!!" unset
14596 .cindex "DNS" "&""try again""& response; overriding"
14597 DNS lookups give a &"try again"& response for the DNS errors
14598 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14599 keep trying to deliver a message, or to give repeated temporary errors to
14600 incoming mail. Sometimes the effect is caused by a badly set up name server and
14601 may persist for a long time. If a domain which exhibits this problem matches
14602 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14603 This option should be used with care. You can make it apply to reverse lookups
14604 by a setting such as this:
14605 .code
14606 dns_again_means_nonexist = *.in-addr.arpa
14607 .endd
14608 This option applies to all DNS lookups that Exim does. It also applies when the
14609 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14610 since these are most likely to be caused by DNS lookup problems. The
14611 &(dnslookup)& router has some options of its own for controlling what happens
14612 when lookups for MX or SRV records give temporary errors. These more specific
14613 options are applied after this global option.
14614
14615 .option dns_check_names_pattern main string "see below"
14616 .cindex "DNS" "pre-check of name syntax"
14617 When this option is set to a non-empty string, it causes Exim to check domain
14618 names for characters that are not allowed in host names before handing them to
14619 the DNS resolver, because some resolvers give temporary errors for names that
14620 contain unusual characters. If a domain name contains any unwanted characters,
14621 a &"not found"& result is forced, and the resolver is not called. The check is
14622 done by matching the domain name against a regular expression, which is the
14623 value of this option. The default pattern is
14624 .code
14625 dns_check_names_pattern = \
14626   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14627 .endd
14628 which permits only letters, digits, slashes, and hyphens in components, but
14629 they must start and end with a letter or digit. Slashes are not, in fact,
14630 permitted in host names, but they are found in certain NS records (which can be
14631 accessed in Exim by using a &%dnsdb%& lookup). If you set
14632 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14633 empty string.
14634
14635 .option dns_csa_search_limit main integer 5
14636 This option controls the depth of parental searching for CSA SRV records in the
14637 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14638
14639 .option dns_csa_use_reverse main boolean true
14640 This option controls whether or not an IP address, given as a CSA domain, is
14641 reversed and looked up in the reverse DNS, as described in more detail in
14642 section &<<SECTverifyCSA>>&.
14643
14644
14645 .option dns_dnssec_ok main integer -1
14646 .cindex "DNS" "resolver options"
14647 .cindex "DNS" "DNSSEC"
14648 If this option is set to a non-negative number then Exim will initialise the
14649 DNS resolver library to either use or not use DNSSEC, overriding the system
14650 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14651
14652 If the resolver library does not support DNSSEC then this option has no effect.
14653
14654
14655 .option dns_ipv4_lookup main "domain list&!!" unset
14656 .cindex "IPv6" "DNS lookup for AAAA records"
14657 .cindex "DNS" "IPv6 lookup for AAAA records"
14658 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14659 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14660 (A records) when trying to find IP addresses for hosts, unless the host's
14661 domain matches this list.
14662
14663 This is a fudge to help with name servers that give big delays or otherwise do
14664 not work for the AAAA record type. In due course, when the world's name
14665 servers have all been upgraded, there should be no need for this option.
14666
14667
14668 .option dns_retrans main time 0s
14669 .cindex "DNS" "resolver options"
14670 .cindex timeout "dns lookup"
14671 .cindex "DNS" timeout
14672 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14673 retransmission and retry parameters for DNS lookups. Values of zero (the
14674 defaults) leave the system default settings unchanged. The first value is the
14675 time between retries, and the second is the number of retries. It isn't
14676 totally clear exactly how these settings affect the total time a DNS lookup may
14677 take. I haven't found any documentation about timeouts on DNS lookups; these
14678 parameter values are available in the external resolver interface structure,
14679 but nowhere does it seem to describe how they are used or what you might want
14680 to set in them.
14681 See also the &%slow_lookup_log%& option.
14682
14683
14684 .option dns_retry main integer 0
14685 See &%dns_retrans%& above.
14686
14687
14688 .option dns_trust_aa main "domain list&!!" unset
14689 .cindex "DNS" "resolver options"
14690 .cindex "DNS" "DNSSEC"
14691 If this option is set then lookup results marked with the AA bit
14692 (Authoritative Answer) are trusted the same way as if they were
14693 DNSSEC-verified. The authority section's name of the answer must
14694 match with this expanded domain list.
14695
14696 Use this option only if you talk directly to a resolver that is
14697 authoritative for some zones and does not set the AD (Authentic Data)
14698 bit in the answer. Some DNS servers may have an configuration option to
14699 mark the answers from their own zones as verified (they set the AD bit).
14700 Others do not have this option. It is considered as poor practice using
14701 a resolver that is an authoritative server for some zones.
14702
14703 Use this option only if you really have to (e.g. if you want
14704 to use DANE for remote delivery to a server that is listed in the DNS
14705 zones that your resolver is authoritative for).
14706
14707 If the DNS answer packet has the AA bit set and contains resource record
14708 in the answer section, the name of the first NS record appearing in the
14709 authority section is compared against the list. If the answer packet is
14710 authoritative but the answer section is empty, the name of the first SOA
14711 record in the authoritative section is used instead.
14712
14713 .cindex "DNS" "resolver options"
14714 .option dns_use_edns0 main integer -1
14715 .cindex "DNS" "resolver options"
14716 .cindex "DNS" "EDNS0"
14717 .cindex "DNS" "OpenBSD
14718 If this option is set to a non-negative number then Exim will initialise the
14719 DNS resolver library to either use or not use EDNS0 extensions, overriding
14720 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14721 on.
14722
14723 If the resolver library does not support EDNS0 then this option has no effect.
14724
14725 .new
14726 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14727 means that DNSSEC will not work with Exim on that platform either, unless Exim
14728 is linked against an alternative DNS client library.
14729 .wen
14730
14731
14732 .option drop_cr main boolean false
14733 This is an obsolete option that is now a no-op. It used to affect the way Exim
14734 handled CR and LF characters in incoming messages. What happens now is
14735 described in section &<<SECTlineendings>>&.
14736
14737 .option dsn_advertise_hosts main "host list&!!" unset
14738 .cindex "bounce messages" "success"
14739 .cindex "DSN" "success"
14740 .cindex "Delivery Status Notification" "success"
14741 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14742 and accepted from, these hosts.
14743 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14744 and RET and ORCPT options on MAIL FROM commands.
14745 A NOTIFY=SUCCESS option requests success-DSN messages.
14746 A NOTIFY= option with no argument requests that no delay or failure DSNs
14747 are sent.
14748
14749 .option dsn_from main "string&!!" "see below"
14750 .cindex "&'From:'& header line" "in bounces"
14751 .cindex "bounce messages" "&'From:'& line, specifying"
14752 This option can be used to vary the contents of &'From:'& header lines in
14753 bounces and other automatically generated messages (&"Delivery Status
14754 Notifications"& &-- hence the name of the option). The default setting is:
14755 .code
14756 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14757 .endd
14758 The value is expanded every time it is needed. If the expansion fails, a
14759 panic is logged, and the default value is used.
14760
14761 .option envelope_to_remove main boolean true
14762 .cindex "&'Envelope-to:'& header line"
14763 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14764 message when it is delivered, in exactly the same way as &'Return-path:'& is
14765 handled. &'Envelope-to:'& records the original recipient address from the
14766 message's envelope that caused the delivery to happen. Such headers should not
14767 be present in incoming messages, and this option causes them to be removed at
14768 the time the message is received, to avoid any problems that might occur when a
14769 delivered message is subsequently sent on to some other recipient.
14770
14771
14772 .option errors_copy main "string list&!!" unset
14773 .cindex "bounce message" "copy to other address"
14774 .cindex "copy of bounce message"
14775 Setting this option causes Exim to send bcc copies of bounce messages that it
14776 generates to other addresses. &*Note*&: This does not apply to bounce messages
14777 coming from elsewhere. The value of the option is a colon-separated list of
14778 items. Each item consists of a pattern, terminated by white space, followed by
14779 a comma-separated list of email addresses. If a pattern contains spaces, it
14780 must be enclosed in double quotes.
14781
14782 Each pattern is processed in the same way as a single item in an address list
14783 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14784 the bounce message, the message is copied to the addresses on the list. The
14785 items are scanned in order, and once a matching one is found, no further items
14786 are examined. For example:
14787 .code
14788 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14789               rqps@mydomain   hostmaster@mydomain.example,\
14790                               postmaster@mydomain.example
14791 .endd
14792 .vindex "&$domain$&"
14793 .vindex "&$local_part$&"
14794 The address list is expanded before use. The expansion variables &$local_part$&
14795 and &$domain$& are set from the original recipient of the error message, and if
14796 there was any wildcard matching in the pattern, the expansion
14797 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14798 variables &$0$&, &$1$&, etc. are set in the normal way.
14799
14800
14801 .option errors_reply_to main string unset
14802 .cindex "bounce message" "&'Reply-to:'& in"
14803 By default, Exim's bounce and delivery warning messages contain the header line
14804 .display
14805 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14806 .endd
14807 .oindex &%quota_warn_message%&
14808 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14809 A warning message that is generated by the &%quota_warn_message%& option in an
14810 &(appendfile)& transport may contain its own &'From:'& header line that
14811 overrides the default.
14812
14813 Experience shows that people reply to bounce messages. If the
14814 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14815 and warning messages. For example:
14816 .code
14817 errors_reply_to = postmaster@my.domain.example
14818 .endd
14819 The value of the option is not expanded. It must specify a valid RFC 2822
14820 address. However, if a warning message that is generated by the
14821 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14822 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14823 not used.
14824
14825
14826 .option event_action main string&!! unset
14827 .cindex events
14828 This option declares a string to be expanded for Exim's events mechanism.
14829 For details see chapter &<<CHAPevents>>&.
14830
14831
14832 .option exim_group main string "compile-time configured"
14833 .cindex "gid (group id)" "Exim's own"
14834 .cindex "Exim group"
14835 This option changes the gid under which Exim runs when it gives up root
14836 privilege. The default value is compiled into the binary. The value of this
14837 option is used only when &%exim_user%& is also set. Unless it consists entirely
14838 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14839 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14840 security issues.
14841
14842
14843 .option exim_path main string "see below"
14844 .cindex "Exim binary, path name"
14845 This option specifies the path name of the Exim binary, which is used when Exim
14846 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14847 the directory configured at compile time by the BIN_DIRECTORY setting. It
14848 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14849 other place.
14850 &*Warning*&: Do not use a macro to define the value of this option, because
14851 you will break those Exim utilities that scan the configuration file to find
14852 where the binary is. (They then use the &%-bP%& option to extract option
14853 settings such as the value of &%spool_directory%&.)
14854
14855
14856 .option exim_user main string "compile-time configured"
14857 .cindex "uid (user id)" "Exim's own"
14858 .cindex "Exim user"
14859 This option changes the uid under which Exim runs when it gives up root
14860 privilege. The default value is compiled into the binary. Ownership of the run
14861 time configuration file and the use of the &%-C%& and &%-D%& command line
14862 options is checked against the values in the binary, not what is set here.
14863
14864 Unless it consists entirely of digits, the string is looked up using
14865 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14866 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14867 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14868
14869
14870 .option extra_local_interfaces main "string list" unset
14871 This option defines network interfaces that are to be considered local when
14872 routing, but which are not used for listening by the daemon. See section
14873 &<<SECTreclocipadd>>& for details.
14874
14875
14876 . Allow this long option name to split; give it unsplit as a fifth argument
14877 . for the automatic .oindex that is generated by .option.
14878
14879 .option "extract_addresses_remove_arguments" main boolean true &&&
14880          extract_addresses_remove_arguments
14881 .oindex "&%-t%&"
14882 .cindex "command line" "addresses with &%-t%&"
14883 .cindex "Sendmail compatibility" "&%-t%& option"
14884 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14885 are present on the command line when the &%-t%& option is used to build an
14886 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14887 line addresses are removed from the recipients list. This is also how Smail
14888 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14889 command line addresses are added to those obtained from the header lines. When
14890 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14891 argument headers. If it is set false, Exim adds rather than removes argument
14892 addresses.
14893
14894
14895 .option finduser_retries main integer 0
14896 .cindex "NIS, retrying user lookups"
14897 On systems running NIS or other schemes in which user and group information is
14898 distributed from a remote system, there can be times when &[getpwnam()]& and
14899 related functions fail, even when given valid data, because things time out.
14900 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14901 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14902 many extra times to find a user or a group, waiting for one second between
14903 retries.
14904
14905 .cindex "&_/etc/passwd_&" "multiple reading of"
14906 You should not set this option greater than zero if your user information is in
14907 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14908 search the file multiple times for non-existent users, and also cause delay.
14909
14910
14911
14912 .option freeze_tell main "string list, comma separated" unset
14913 .cindex "freezing messages" "sending a message when freezing"
14914 On encountering certain errors, or when configured to do so in a system filter,
14915 ACL, or special router, Exim freezes a message. This means that no further
14916 delivery attempts take place until an administrator thaws the message, or the
14917 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14918 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14919 warning message whenever it freezes something, unless the message it is
14920 freezing is a locally-generated bounce message. (Without this exception there
14921 is the possibility of looping.) The warning message is sent to the addresses
14922 supplied as the comma-separated value of this option. If several of the
14923 message's addresses cause freezing, only a single message is sent. If the
14924 freezing was automatic, the reason(s) for freezing can be found in the message
14925 log. If you configure freezing in a filter or ACL, you must arrange for any
14926 logging that you require.
14927
14928
14929 .option gecos_name main string&!! unset
14930 .cindex "HP-UX"
14931 .cindex "&""gecos""& field, parsing"
14932 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14933 password file to hold other information in addition to users' real names. Exim
14934 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14935 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14936 of the field are used unchanged, except that, if an ampersand is encountered,
14937 it is replaced by the user's login name with the first character forced to
14938 upper case, since this is a convention that is observed on many systems.
14939
14940 When these options are set, &%gecos_pattern%& is treated as a regular
14941 expression that is to be applied to the field (again with && replaced by the
14942 login name), and if it matches, &%gecos_name%& is expanded and used as the
14943 user's name.
14944
14945 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14946 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14947 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14948 name terminates at the first comma, the following can be used:
14949 .code
14950 gecos_pattern = ([^,]*)
14951 gecos_name = $1
14952 .endd
14953
14954 .option gecos_pattern main string unset
14955 See &%gecos_name%& above.
14956
14957
14958 .option gnutls_compat_mode main boolean unset
14959 This option controls whether GnuTLS is used in compatibility mode in an Exim
14960 server. This reduces security slightly, but improves interworking with older
14961 implementations of TLS.
14962
14963
14964 option gnutls_allow_auto_pkcs11 main boolean unset
14965 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14966 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14967
14968 See
14969 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14970 for documentation.
14971
14972
14973
14974 .option headers_charset main string "see below"
14975 This option sets a default character set for translating from encoded MIME
14976 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14977 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14978 ultimate default is ISO-8859-1. For more details see the description of header
14979 insertions in section &<<SECTexpansionitems>>&.
14980
14981
14982
14983 .option header_maxsize main integer "see below"
14984 .cindex "header section" "maximum size of"
14985 .cindex "limit" "size of message header section"
14986 This option controls the overall maximum size of a message's header
14987 section. The default is the value of HEADER_MAXSIZE in
14988 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14989 sections are rejected.
14990
14991
14992 .option header_line_maxsize main integer 0
14993 .cindex "header lines" "maximum size of"
14994 .cindex "limit" "size of one header line"
14995 This option limits the length of any individual header line in a message, after
14996 all the continuations have been joined together. Messages with individual
14997 header lines that are longer than the limit are rejected. The default value of
14998 zero means &"no limit"&.
14999
15000
15001
15002
15003 .option helo_accept_junk_hosts main "host list&!!" unset
15004 .cindex "HELO" "accepting junk data"
15005 .cindex "EHLO" "accepting junk data"
15006 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15007 mail, and gives an error response for invalid data. Unfortunately, there are
15008 some SMTP clients that send syntactic junk. They can be accommodated by setting
15009 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15010 if you want to do semantic checking.
15011 See also &%helo_allow_chars%& for a way of extending the permitted character
15012 set.
15013
15014
15015 .option helo_allow_chars main string unset
15016 .cindex "HELO" "underscores in"
15017 .cindex "EHLO" "underscores in"
15018 .cindex "underscore in EHLO/HELO"
15019 This option can be set to a string of rogue characters that are permitted in
15020 all EHLO and HELO names in addition to the standard letters, digits,
15021 hyphens, and dots. If you really must allow underscores, you can set
15022 .code
15023 helo_allow_chars = _
15024 .endd
15025 Note that the value is one string, not a list.
15026
15027
15028 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15029 .cindex "HELO" "forcing reverse lookup"
15030 .cindex "EHLO" "forcing reverse lookup"
15031 If the domain given by a client in a HELO or EHLO command matches this
15032 list, a reverse lookup is done in order to establish the host's true name. The
15033 default forces a lookup if the client host gives the server's name or any of
15034 its IP addresses (in brackets), something that broken clients have been seen to
15035 do.
15036
15037
15038 .option helo_try_verify_hosts main "host list&!!" unset
15039 .cindex "HELO verifying" "optional"
15040 .cindex "EHLO" "verifying, optional"
15041 By default, Exim just checks the syntax of HELO and EHLO commands (see
15042 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15043 to do more extensive checking of the data supplied by these commands. The ACL
15044 condition &`verify = helo`& is provided to make this possible.
15045 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15046 to force the check to occur. From release 4.53 onwards, this is no longer
15047 necessary. If the check has not been done before &`verify = helo`& is
15048 encountered, it is done at that time. Consequently, this option is obsolete.
15049 Its specification is retained here for backwards compatibility.
15050
15051 When an EHLO or HELO command is received, if the calling host matches
15052 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15053 EHLO command either:
15054
15055 .ilist
15056 is an IP literal matching the calling address of the host, or
15057 .next
15058 .cindex "DNS" "reverse lookup"
15059 .cindex "reverse DNS lookup"
15060 matches the host name that Exim obtains by doing a reverse lookup of the
15061 calling host address, or
15062 .next
15063 when looked up in DNS yields the calling host address.
15064 .endlist
15065
15066 However, the EHLO or HELO command is not rejected if any of the checks
15067 fail. Processing continues, but the result of the check is remembered, and can
15068 be detected later in an ACL by the &`verify = helo`& condition.
15069
15070 If DNS was used for successful verification, the variable
15071 .cindex "DNS" "DNSSEC"
15072 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15073
15074 .option helo_verify_hosts main "host list&!!" unset
15075 .cindex "HELO verifying" "mandatory"
15076 .cindex "EHLO" "verifying, mandatory"
15077 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15078 backwards compatibility. For hosts that match this option, Exim checks the host
15079 name given in the HELO or EHLO in the same way as for
15080 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15081 rejected with a 550 error, and entries are written to the main and reject logs.
15082 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15083 error.
15084
15085 .option hold_domains main "domain list&!!" unset
15086 .cindex "domain" "delaying delivery"
15087 .cindex "delivery" "delaying certain domains"
15088 This option allows mail for particular domains to be held on the queue
15089 manually. The option is overridden if a message delivery is forced with the
15090 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15091 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15092 item in &%hold_domains%&, no routing or delivery for that address is done, and
15093 it is deferred every time the message is looked at.
15094
15095 This option is intended as a temporary operational measure for delaying the
15096 delivery of mail while some problem is being sorted out, or some new
15097 configuration tested. If you just want to delay the processing of some
15098 domains until a queue run occurs, you should use &%queue_domains%& or
15099 &%queue_smtp_domains%&, not &%hold_domains%&.
15100
15101 A setting of &%hold_domains%& does not override Exim's code for removing
15102 messages from the queue if they have been there longer than the longest retry
15103 time in any retry rule. If you want to hold messages for longer than the normal
15104 retry times, insert a dummy retry rule with a long retry time.
15105
15106
15107 .option host_lookup main "host list&!!" unset
15108 .cindex "host name" "lookup, forcing"
15109 Exim does not look up the name of a calling host from its IP address unless it
15110 is required to compare against some host list, or the host matches
15111 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15112 option (which normally contains IP addresses rather than host names). The
15113 default configuration file contains
15114 .code
15115 host_lookup = *
15116 .endd
15117 which causes a lookup to happen for all hosts. If the expense of these lookups
15118 is felt to be too great, the setting can be changed or removed.
15119
15120 After a successful reverse lookup, Exim does a forward lookup on the name it
15121 has obtained, to verify that it yields the IP address that it started with. If
15122 this check fails, Exim behaves as if the name lookup failed.
15123
15124 .vindex "&$host_lookup_failed$&"
15125 .vindex "&$sender_host_name$&"
15126 After any kind of failure, the host name (in &$sender_host_name$&) remains
15127 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15128 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15129 &`verify = reverse_host_lookup`& in ACLs.
15130
15131
15132 .option host_lookup_order main "string list" &`bydns:byaddr`&
15133 This option specifies the order of different lookup methods when Exim is trying
15134 to find a host name from an IP address. The default is to do a DNS lookup
15135 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15136 if that fails. You can change the order of these lookups, or omit one entirely,
15137 if you want.
15138
15139 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15140 multiple PTR records in the DNS and the IP address is not listed in
15141 &_/etc/hosts_&. Different operating systems give different results in this
15142 case. That is why the default tries a DNS lookup first.
15143
15144
15145
15146 .option host_reject_connection main "host list&!!" unset
15147 .cindex "host" "rejecting connections from"
15148 If this option is set, incoming SMTP calls from the hosts listed are rejected
15149 as soon as the connection is made.
15150 This option is obsolete, and retained only for backward compatibility, because
15151 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15152 connections immediately.
15153
15154 The ability to give an immediate rejection (either by this option or using an
15155 ACL) is provided for use in unusual cases. Many hosts will just try again,
15156 sometimes without much delay. Normally, it is better to use an ACL to reject
15157 incoming messages at a later stage, such as after RCPT commands. See
15158 chapter &<<CHAPACL>>&.
15159
15160
15161 .option hosts_connection_nolog main "host list&!!" unset
15162 .cindex "host" "not logging connections from"
15163 This option defines a list of hosts for which connection logging does not
15164 happen, even though the &%smtp_connection%& log selector is set. For example,
15165 you might want not to log SMTP connections from local processes, or from
15166 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15167 the daemon; you should therefore strive to restrict its value to a short inline
15168 list of IP addresses and networks. To disable logging SMTP connections from
15169 local processes, you must create a host list with an empty item. For example:
15170 .code
15171 hosts_connection_nolog = :
15172 .endd
15173 If the &%smtp_connection%& log selector is not set, this option has no effect.
15174
15175
15176
15177 .option hosts_proxy main "host list&!!" unset
15178 .cindex proxy "proxy protocol"
15179 This option enables use of Proxy Protocol proxies for incoming
15180 connections.  For details see section &<<SECTproxyInbound>>&.
15181
15182
15183 .option hosts_treat_as_local main "domain list&!!" unset
15184 .cindex "local host" "domains treated as"
15185 .cindex "host" "treated as local"
15186 If this option is set, any host names that match the domain list are treated as
15187 if they were the local host when Exim is scanning host lists obtained from MX
15188 records
15189 or other sources. Note that the value of this option is a domain list, not a
15190 host list, because it is always used to check host names, not IP addresses.
15191
15192 This option also applies when Exim is matching the special items
15193 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15194 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15195 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15196 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15197 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15198 interfaces and recognizing the local host.
15199
15200
15201 .option ibase_servers main "string list" unset
15202 .cindex "InterBase" "server list"
15203 This option provides a list of InterBase servers and associated connection data,
15204 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15205 The option is available only if Exim has been built with InterBase support.
15206
15207
15208
15209 .option ignore_bounce_errors_after main time 10w
15210 .cindex "bounce message" "discarding"
15211 .cindex "discarding bounce message"
15212 This option affects the processing of bounce messages that cannot be delivered,
15213 that is, those that suffer a permanent delivery failure. (Bounce messages that
15214 suffer temporary delivery failures are of course retried in the usual way.)
15215
15216 After a permanent delivery failure, bounce messages are frozen,
15217 because there is no sender to whom they can be returned. When a frozen bounce
15218 message has been on the queue for more than the given time, it is unfrozen at
15219 the next queue run, and a further delivery is attempted. If delivery fails
15220 again, the bounce message is discarded. This makes it possible to keep failed
15221 bounce messages around for a shorter time than the normal maximum retry time
15222 for frozen messages. For example,
15223 .code
15224 ignore_bounce_errors_after = 12h
15225 .endd
15226 retries failed bounce message deliveries after 12 hours, discarding any further
15227 failures. If the value of this option is set to a zero time period, bounce
15228 failures are discarded immediately. Setting a very long time (as in the default
15229 value) has the effect of disabling this option. For ways of automatically
15230 dealing with other kinds of frozen message, see &%auto_thaw%& and
15231 &%timeout_frozen_after%&.
15232
15233
15234 .option ignore_fromline_hosts main "host list&!!" unset
15235 .cindex "&""From""& line"
15236 .cindex "UUCP" "&""From""& line"
15237 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15238 the headers of a message. By default this is treated as the start of the
15239 message's body, which means that any following headers are not recognized as
15240 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15241 match those hosts that insist on sending it. If the sender is actually a local
15242 process rather than a remote host, and is using &%-bs%& to inject the messages,
15243 &%ignore_fromline_local%& must be set to achieve this effect.
15244
15245
15246 .option ignore_fromline_local main boolean false
15247 See &%ignore_fromline_hosts%& above.
15248
15249 .option keep_environment main "string list" unset
15250 .cindex "environment" "values from"
15251 This option contains a string list of environment variables to keep.
15252 You have to trust these variables or you have to be sure that
15253 these variables do not impose any security risk. Keep in mind that
15254 during the startup phase Exim is running with an effective UID 0 in most
15255 installations. As the default value is an empty list, the default
15256 environment for using libraries, running embedded Perl code, or running
15257 external binaries is empty, and does not not even contain PATH or HOME.
15258
15259 Actually the list is interpreted as a list of patterns
15260 (&<<SECTlistexpand>>&), except that it is not expanded first.
15261
15262 WARNING: Macro substitution is still done first, so having a macro
15263 FOO and having FOO_HOME in your &%keep_environment%& option may have
15264 unexpected results. You may work around this using a regular expression
15265 that does not match the macro name: ^[F]OO_HOME$.
15266
15267 Current versions of Exim issue a warning during startup if you do not mention
15268 &%keep_environment%& in your runtime configuration file and if your
15269 current environment is not empty. Future versions may not issue that warning
15270 anymore.
15271
15272 See the &%add_environment%& main config option for a way to set
15273 environment variables to a fixed value.  The environment for &(pipe)&
15274 transports is handled separately, see section &<<SECTpipeenv>>& for
15275 details.
15276
15277
15278 .option keep_malformed main time 4d
15279 This option specifies the length of time to keep messages whose spool files
15280 have been corrupted in some way. This should, of course, never happen. At the
15281 next attempt to deliver such a message, it gets removed. The incident is
15282 logged.
15283
15284
15285 .option ldap_ca_cert_dir main string unset
15286 .cindex "LDAP", "TLS CA certificate directory"
15287 .cindex certificate "directory for LDAP"
15288 This option indicates which directory contains CA certificates for verifying
15289 a TLS certificate presented by an LDAP server.
15290 While Exim does not provide a default value, your SSL library may.
15291 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15292 and constrained to be a directory.
15293
15294
15295 .option ldap_ca_cert_file main string unset
15296 .cindex "LDAP", "TLS CA certificate file"
15297 .cindex certificate "file for LDAP"
15298 This option indicates which file contains CA certificates for verifying
15299 a TLS certificate presented by an LDAP server.
15300 While Exim does not provide a default value, your SSL library may.
15301 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15302 and constrained to be a file.
15303
15304
15305 .option ldap_cert_file main string unset
15306 .cindex "LDAP" "TLS client certificate file"
15307 .cindex certificate "file for LDAP"
15308 This option indicates which file contains an TLS client certificate which
15309 Exim should present to the LDAP server during TLS negotiation.
15310 Should be used together with &%ldap_cert_key%&.
15311
15312
15313 .option ldap_cert_key main string unset
15314 .cindex "LDAP" "TLS client key file"
15315 .cindex certificate "key for LDAP"
15316 This option indicates which file contains the secret/private key to use
15317 to prove identity to the LDAP server during TLS negotiation.
15318 Should be used together with &%ldap_cert_file%&, which contains the
15319 identity to be proven.
15320
15321
15322 .option ldap_cipher_suite main string unset
15323 .cindex "LDAP" "TLS cipher suite"
15324 This controls the TLS cipher-suite negotiation during TLS negotiation with
15325 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15326 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15327
15328
15329 .option ldap_default_servers main "string list" unset
15330 .cindex "LDAP" "default servers"
15331 This option provides a list of LDAP servers which are tried in turn when an
15332 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15333 details of LDAP queries. This option is available only when Exim has been built
15334 with LDAP support.
15335
15336
15337 .option ldap_require_cert main string unset.
15338 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15339 This should be one of the values "hard", "demand", "allow", "try" or "never".
15340 A value other than one of these is interpreted as "never".
15341 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15342 Although Exim does not set a default, the LDAP library probably defaults
15343 to hard/demand.
15344
15345
15346 .option ldap_start_tls main boolean false
15347 .cindex "LDAP" "whether or not to negotiate TLS"
15348 If set, Exim will attempt to negotiate TLS with the LDAP server when
15349 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15350 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15351 of SSL-on-connect.
15352 In the event of failure to negotiate TLS, the action taken is controlled
15353 by &%ldap_require_cert%&.
15354 .new
15355 This option is ignored for &`ldapi`& connections.
15356 .wen
15357
15358
15359 .option ldap_version main integer unset
15360 .cindex "LDAP" "protocol version, forcing"
15361 This option can be used to force Exim to set a specific protocol version for
15362 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15363 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15364 the LDAP headers; otherwise it is 2. This option is available only when Exim
15365 has been built with LDAP support.
15366
15367
15368
15369 .option local_from_check main boolean true
15370 .cindex "&'Sender:'& header line" "disabling addition of"
15371 .cindex "&'From:'& header line" "disabling checking of"
15372 When a message is submitted locally (that is, not over a TCP/IP connection) by
15373 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15374 checks that the &'From:'& header line matches the login of the calling user and
15375 the domain specified by &%qualify_domain%&.
15376
15377 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15378 locally submitted message is automatically qualified by Exim, unless the
15379 &%-bnq%& command line option is used.
15380
15381 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15382 on the local part. If the &'From:'& header line does not match, Exim adds a
15383 &'Sender:'& header with an address constructed from the calling user's login
15384 and the default qualify domain.
15385
15386 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15387 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15388 &'Sender:'& header lines supplied by untrusted users, you must also set
15389 &%local_sender_retain%& to be true.
15390
15391 .cindex "envelope sender"
15392 These options affect only the header lines in the message. The envelope sender
15393 is still forced to be the login id at the qualify domain unless
15394 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15395
15396 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15397 request similar header line checking. See section &<<SECTthesenhea>>&, which
15398 has more details about &'Sender:'& processing.
15399
15400
15401
15402
15403 .option local_from_prefix main string unset
15404 When Exim checks the &'From:'& header line of locally submitted messages for
15405 matching the login id (see &%local_from_check%& above), it can be configured to
15406 ignore certain prefixes and suffixes in the local part of the address. This is
15407 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15408 appropriate lists, in the same form as the &%local_part_prefix%& and
15409 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15410 example, if
15411 .code
15412 local_from_prefix = *-
15413 .endd
15414 is set, a &'From:'& line containing
15415 .code
15416 From: anything-user@your.domain.example
15417 .endd
15418 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15419 matches the actual sender address that is constructed from the login name and
15420 qualify domain.
15421
15422
15423 .option local_from_suffix main string unset
15424 See &%local_from_prefix%& above.
15425
15426
15427 .option local_interfaces main "string list" "see below"
15428 This option controls which network interfaces are used by the daemon for
15429 listening; they are also used to identify the local host when routing. Chapter
15430 &<<CHAPinterfaces>>& contains a full description of this option and the related
15431 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15432 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15433 &%local_interfaces%& is
15434 .code
15435 local_interfaces = 0.0.0.0
15436 .endd
15437 when Exim is built without IPv6 support; otherwise it is
15438 .code
15439 local_interfaces = <; ::0 ; 0.0.0.0
15440 .endd
15441
15442 .option local_scan_timeout main time 5m
15443 .cindex "timeout" "for &[local_scan()]& function"
15444 .cindex "&[local_scan()]& function" "timeout"
15445 This timeout applies to the &[local_scan()]& function (see chapter
15446 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15447 the incoming message is rejected with a temporary error if it is an SMTP
15448 message. For a non-SMTP message, the message is dropped and Exim ends with a
15449 non-zero code. The incident is logged on the main and reject logs.
15450
15451
15452
15453 .option local_sender_retain main boolean false
15454 .cindex "&'Sender:'& header line" "retaining from local submission"
15455 When a message is submitted locally (that is, not over a TCP/IP connection) by
15456 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15457 do not want this to happen, you must set &%local_sender_retain%&, and you must
15458 also set &%local_from_check%& to be false (Exim will complain if you do not).
15459 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15460 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15461
15462
15463
15464
15465 .option localhost_number main string&!! unset
15466 .cindex "host" "locally unique number for"
15467 .cindex "message ids" "with multiple hosts"
15468 .vindex "&$localhost_number$&"
15469 Exim's message ids are normally unique only within the local host. If
15470 uniqueness among a set of hosts is required, each host must set a different
15471 value for the &%localhost_number%& option. The string is expanded immediately
15472 after reading the configuration file (so that a number can be computed from the
15473 host name, for example) and the result of the expansion must be a number in the
15474 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15475 systems). This is available in subsequent string expansions via the variable
15476 &$localhost_number$&. When &%localhost_number is set%&, the final two
15477 characters of the message id, instead of just being a fractional part of the
15478 time, are computed from the time and the local host number as described in
15479 section &<<SECTmessiden>>&.
15480
15481
15482
15483 .option log_file_path main "string list&!!" "set at compile time"
15484 .cindex "log" "file path for"
15485 This option sets the path which is used to determine the names of Exim's log
15486 files, or indicates that logging is to be to syslog, or both. It is expanded
15487 when Exim is entered, so it can, for example, contain a reference to the host
15488 name. If no specific path is set for the log files at compile or run time,
15489 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15490 they are written in a sub-directory called &_log_& in Exim's spool directory.
15491 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15492 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15493 used. If this string is fixed at your installation (contains no expansion
15494 variables) it is recommended that you do not set this option in the
15495 configuration file, but instead supply the path using LOG_FILE_PATH in
15496 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15497 early on &-- in particular, failure to read the configuration file.
15498
15499
15500 .option log_selector main string unset
15501 .cindex "log" "selectors"
15502 This option can be used to reduce or increase the number of things that Exim
15503 writes to its log files. Its argument is made up of names preceded by plus or
15504 minus characters. For example:
15505 .code
15506 log_selector = +arguments -retry_defer
15507 .endd
15508 A list of possible names and what they control is given in the chapter on
15509 logging, in section &<<SECTlogselector>>&.
15510
15511
15512 .option log_timezone main boolean false
15513 .cindex "log" "timezone for entries"
15514 .vindex "&$tod_log$&"
15515 .vindex "&$tod_zone$&"
15516 By default, the timestamps on log lines are in local time without the
15517 timezone. This means that if your timezone changes twice a year, the timestamps
15518 in log lines are ambiguous for an hour when the clocks go back. One way of
15519 avoiding this problem is to set the timezone to UTC. An alternative is to set
15520 &%log_timezone%& true. This turns on the addition of the timezone offset to
15521 timestamps in log lines. Turning on this option can add quite a lot to the size
15522 of log files because each line is extended by 6 characters. Note that the
15523 &$tod_log$& variable contains the log timestamp without the zone, but there is
15524 another variable called &$tod_zone$& that contains just the timezone offset.
15525
15526
15527 .option lookup_open_max main integer 25
15528 .cindex "too many open files"
15529 .cindex "open files, too many"
15530 .cindex "file" "too many open"
15531 .cindex "lookup" "maximum open files"
15532 .cindex "limit" "open files for lookups"
15533 This option limits the number of simultaneously open files for single-key
15534 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15535 Exim normally keeps these files open during routing, because often the same
15536 file is required several times. If the limit is reached, Exim closes the least
15537 recently used file. Note that if you are using the &'ndbm'& library, it
15538 actually opens two files for each logical DBM database, though it still counts
15539 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15540 open files"& errors with NDBM, you need to reduce the value of
15541 &%lookup_open_max%&.
15542
15543
15544 .option max_username_length main integer 0
15545 .cindex "length of login name"
15546 .cindex "user name" "maximum length"
15547 .cindex "limit" "user name length"
15548 Some operating systems are broken in that they truncate long arguments to
15549 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15550 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15551 an argument that is longer behaves as if &[getpwnam()]& failed.
15552
15553
15554 .option message_body_newlines main bool false
15555 .cindex "message body" "newlines in variables"
15556 .cindex "newline" "in message body variables"
15557 .vindex "&$message_body$&"
15558 .vindex "&$message_body_end$&"
15559 By default, newlines in the message body are replaced by spaces when setting
15560 the &$message_body$& and &$message_body_end$& expansion variables. If this
15561 option is set true, this no longer happens.
15562
15563
15564 .option message_body_visible main integer 500
15565 .cindex "body of message" "visible size"
15566 .cindex "message body" "visible size"
15567 .vindex "&$message_body$&"
15568 .vindex "&$message_body_end$&"
15569 This option specifies how much of a message's body is to be included in the
15570 &$message_body$& and &$message_body_end$& expansion variables.
15571
15572
15573 .option message_id_header_domain main string&!! unset
15574 .cindex "&'Message-ID:'& header line"
15575 If this option is set, the string is expanded and used as the right hand side
15576 (domain) of the &'Message-ID:'& header that Exim creates if a
15577 locally-originated incoming message does not have one. &"Locally-originated"&
15578 means &"not received over TCP/IP."&
15579 Otherwise, the primary host name is used.
15580 Only letters, digits, dot and hyphen are accepted; any other characters are
15581 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15582 empty string, the option is ignored.
15583
15584
15585 .option message_id_header_text main string&!! unset
15586 If this variable is set, the string is expanded and used to augment the text of
15587 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15588 message does not have one. The text of this header is required by RFC 2822 to
15589 take the form of an address. By default, Exim uses its internal message id as
15590 the local part, and the primary host name as the domain. If this option is set,
15591 it is expanded, and provided the expansion is not forced to fail, and does not
15592 yield an empty string, the result is inserted into the header immediately
15593 before the @, separated from the internal message id by a dot. Any characters
15594 that are illegal in an address are automatically converted into hyphens. This
15595 means that variables such as &$tod_log$& can be used, because the spaces and
15596 colons will become hyphens.
15597
15598
15599 .option message_logs main boolean true
15600 .cindex "message logs" "disabling"
15601 .cindex "log" "message log; disabling"
15602 If this option is turned off, per-message log files are not created in the
15603 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15604 Exim, by reducing the number of files involved in handling a message from a
15605 minimum of four (header spool file, body spool file, delivery journal, and
15606 per-message log) to three. The other major I/O activity is Exim's main log,
15607 which is not affected by this option.
15608
15609
15610 .option message_size_limit main string&!! 50M
15611 .cindex "message" "size limit"
15612 .cindex "limit" "message size"
15613 .cindex "size" "of message, limit"
15614 This option limits the maximum size of message that Exim will process. The
15615 value is expanded for each incoming connection so, for example, it can be made
15616 to depend on the IP address of the remote host for messages arriving via
15617 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15618 optionally followed by K or M.
15619
15620 &*Note*&: This limit cannot be made to depend on a message's sender or any
15621 other properties of an individual message, because it has to be advertised in
15622 the server's response to EHLO. String expansion failure causes a temporary
15623 error. A value of zero means no limit, but its use is not recommended. See also
15624 &%bounce_return_size_limit%&.
15625
15626 Incoming SMTP messages are failed with a 552 error if the limit is
15627 exceeded; locally-generated messages either get a stderr message or a delivery
15628 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15629 an oversized message is logged in both the main and the reject logs. See also
15630 the generic transport option &%message_size_limit%&, which limits the size of
15631 message that an individual transport can process.
15632
15633 If you use a virus-scanner and set this option to to a value larger than the
15634 maximum size that your virus-scanner is configured to support, you may get
15635 failures triggered by large mails.  The right size to configure for the
15636 virus-scanner depends upon what data is passed and the options in use but it's
15637 probably safest to just set it to a little larger than this value.  E.g., with a
15638 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15639 some problems may result.
15640
15641 A value of 0 will disable size limit checking; Exim will still advertise the
15642 SIZE extension in an EHLO response, but without a limit, so as to permit
15643 SMTP clients to still indicate the message size along with the MAIL verb.
15644
15645
15646 .option move_frozen_messages main boolean false
15647 .cindex "frozen messages" "moving"
15648 This option, which is available only if Exim has been built with the setting
15649 .code
15650 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15651 .endd
15652 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15653 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15654 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15655 standard utilities for handling such moved messages, and they do not show up in
15656 lists generated by &%-bp%& or by the Exim monitor.
15657
15658
15659 .option mua_wrapper main boolean false
15660 Setting this option true causes Exim to run in a very restrictive mode in which
15661 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15662 contains a full description of this facility.
15663
15664
15665
15666 .option mysql_servers main "string list" unset
15667 .cindex "MySQL" "server list"
15668 This option provides a list of MySQL servers and associated connection data, to
15669 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15670 option is available only if Exim has been built with MySQL support.
15671
15672
15673 .option never_users main "string list&!!" unset
15674 This option is expanded just once, at the start of Exim's processing. Local
15675 message deliveries are normally run in processes that are setuid to the
15676 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15677 It is usually desirable to prevent any deliveries from running as root, as a
15678 safety precaution.
15679
15680 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15681 list of users that must not be used for local deliveries. This list is fixed in
15682 the binary and cannot be overridden by the configuration file. By default, it
15683 contains just the single user name &"root"&. The &%never_users%& runtime option
15684 can be used to add more users to the fixed list.
15685
15686 If a message is to be delivered as one of the users on the fixed list or the
15687 &%never_users%& list, an error occurs, and delivery is deferred. A common
15688 example is
15689 .code
15690 never_users = root:daemon:bin
15691 .endd
15692 Including root is redundant if it is also on the fixed list, but it does no
15693 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15694 transport driver.
15695
15696
15697 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15698 .cindex "OpenSSL "compatibility options"
15699 This option allows an administrator to adjust the SSL options applied
15700 by OpenSSL to connections.  It is given as a space-separated list of items,
15701 each one to be +added or -subtracted from the current value.
15702
15703 This option is only available if Exim is built against OpenSSL.  The values
15704 available for this option vary according to the age of your OpenSSL install.
15705 The &"all"& value controls a subset of flags which are available, typically
15706 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15707 list the values known on your system and Exim should support all the
15708 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15709 names lose the leading &"SSL_OP_"& and are lower-cased.
15710
15711 Note that adjusting the options can have severe impact upon the security of
15712 SSL as used by Exim.  It is possible to disable safety checks and shoot
15713 yourself in the foot in various unpleasant ways.  This option should not be
15714 adjusted lightly.  An unrecognised item will be detected at startup, by
15715 invoking Exim with the &%-bV%& flag.
15716
15717 The option affects Exim operating both as a server and as a client.
15718
15719 Historical note: prior to release 4.80, Exim defaulted this value to
15720 "+dont_insert_empty_fragments", which may still be needed for compatibility
15721 with some clients, but which lowers security by increasing exposure to
15722 some now infamous attacks.
15723
15724 Examples:
15725 .code
15726 # Make both old MS and old Eudora happy:
15727 openssl_options = -all +microsoft_big_sslv3_buffer \
15728                        +dont_insert_empty_fragments
15729
15730 # Disable older protocol versions:
15731 openssl_options = +no_sslv2 +no_sslv3
15732 .endd
15733
15734 Possible options may include:
15735 .ilist
15736 &`all`&
15737 .next
15738 &`allow_unsafe_legacy_renegotiation`&
15739 .next
15740 &`cipher_server_preference`&
15741 .next
15742 &`dont_insert_empty_fragments`&
15743 .next
15744 &`ephemeral_rsa`&
15745 .next
15746 &`legacy_server_connect`&
15747 .next
15748 &`microsoft_big_sslv3_buffer`&
15749 .next
15750 &`microsoft_sess_id_bug`&
15751 .next
15752 &`msie_sslv2_rsa_padding`&
15753 .next
15754 &`netscape_challenge_bug`&
15755 .next
15756 &`netscape_reuse_cipher_change_bug`&
15757 .next
15758 &`no_compression`&
15759 .next
15760 &`no_session_resumption_on_renegotiation`&
15761 .next
15762 &`no_sslv2`&
15763 .next
15764 &`no_sslv3`&
15765 .next
15766 &`no_ticket`&
15767 .next
15768 &`no_tlsv1`&
15769 .next
15770 &`no_tlsv1_1`&
15771 .next
15772 &`no_tlsv1_2`&
15773 .next
15774 &`safari_ecdhe_ecdsa_bug`&
15775 .next
15776 &`single_dh_use`&
15777 .next
15778 &`single_ecdh_use`&
15779 .next
15780 &`ssleay_080_client_dh_bug`&
15781 .next
15782 &`sslref2_reuse_cert_type_bug`&
15783 .next
15784 &`tls_block_padding_bug`&
15785 .next
15786 &`tls_d5_bug`&
15787 .next
15788 &`tls_rollback_bug`&
15789 .endlist
15790
15791 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15792 all clients connecting using the MacOS SecureTransport TLS facility prior
15793 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15794 to negotiate TLS then this option value might help, provided that your OpenSSL
15795 release is new enough to contain this work-around.  This may be a situation
15796 where you have to upgrade OpenSSL to get buggy clients working.
15797
15798
15799 .option oracle_servers main "string list" unset
15800 .cindex "Oracle" "server list"
15801 This option provides a list of Oracle servers and associated connection data,
15802 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15803 The option is available only if Exim has been built with Oracle support.
15804
15805
15806 .option percent_hack_domains main "domain list&!!" unset
15807 .cindex "&""percent hack""&"
15808 .cindex "source routing" "in email address"
15809 .cindex "address" "source-routed"
15810 The &"percent hack"& is the convention whereby a local part containing a
15811 percent sign is re-interpreted as a new email address, with the percent
15812 replaced by @. This is sometimes called &"source routing"&, though that term is
15813 also applied to RFC 2822 addresses that begin with an @ character. If this
15814 option is set, Exim implements the percent facility for those domains listed,
15815 but no others. This happens before an incoming SMTP address is tested against
15816 an ACL.
15817
15818 &*Warning*&: The &"percent hack"& has often been abused by people who are
15819 trying to get round relaying restrictions. For this reason, it is best avoided
15820 if at all possible. Unfortunately, a number of less security-conscious MTAs
15821 implement it unconditionally. If you are running Exim on a gateway host, and
15822 routing mail through to internal MTAs without processing the local parts, it is
15823 a good idea to reject recipient addresses with percent characters in their
15824 local parts. Exim's default configuration does this.
15825
15826
15827 .option perl_at_start main boolean false
15828 .cindex "Perl"
15829 This option is available only when Exim is built with an embedded Perl
15830 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15831
15832
15833 .option perl_startup main string unset
15834 .cindex "Perl"
15835 This option is available only when Exim is built with an embedded Perl
15836 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15837
15838 .option perl_startup main boolean false
15839 .cindex "Perl"
15840 This Option enables the taint mode of the embedded Perl interpreter.
15841
15842
15843 .option pgsql_servers main "string list" unset
15844 .cindex "PostgreSQL lookup type" "server list"
15845 This option provides a list of PostgreSQL servers and associated connection
15846 data, to be used in conjunction with &(pgsql)& lookups (see section
15847 &<<SECID72>>&). The option is available only if Exim has been built with
15848 PostgreSQL support.
15849
15850
15851 .option pid_file_path main string&!! "set at compile time"
15852 .cindex "daemon" "pid file path"
15853 .cindex "pid file, path for"
15854 This option sets the name of the file to which the Exim daemon writes its
15855 process id. The string is expanded, so it can contain, for example, references
15856 to the host name:
15857 .code
15858 pid_file_path = /var/log/$primary_hostname/exim.pid
15859 .endd
15860 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15861 spool directory.
15862 The value set by the option can be overridden by the &%-oP%& command line
15863 option. A pid file is not written if a &"non-standard"& daemon is run by means
15864 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15865
15866
15867 .option pipelining_advertise_hosts main "host list&!!" *
15868 .cindex "PIPELINING" "suppressing advertising"
15869 This option can be used to suppress the advertisement of the SMTP
15870 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15871 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15872 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15873 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15874 that clients will use it; &"out of order"& commands that are &"expected"& do
15875 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15876
15877
15878 .option prdr_enable main boolean false
15879 .cindex "PRDR" "enabling on server"
15880 This option can be used to enable the Per-Recipient Data Response extension
15881 to SMTP, defined by Eric Hall.
15882 If the option is set, PRDR is advertised by Exim when operating as a server.
15883 If the client requests PRDR, and more than one recipient, for a message
15884 an additional ACL is called for each recipient after the message content
15885 is received.  See section &<<SECTPRDRACL>>&.
15886
15887 .option preserve_message_logs main boolean false
15888 .cindex "message logs" "preserving"
15889 If this option is set, message log files are not deleted when messages are
15890 completed. Instead, they are moved to a sub-directory of the spool directory
15891 called &_msglog.OLD_&, where they remain available for statistical or debugging
15892 purposes. This is a dangerous option to set on systems with any appreciable
15893 volume of mail. Use with care!
15894
15895
15896 .option primary_hostname main string "see below"
15897 .cindex "name" "of local host"
15898 .cindex "host" "name of local"
15899 .cindex "local host" "name of"
15900 .vindex "&$primary_hostname$&"
15901 This specifies the name of the current host. It is used in the default EHLO or
15902 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15903 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15904 The value is also used by default in some SMTP response messages from an Exim
15905 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15906
15907 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15908 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15909 contains only one component, Exim passes it to &[gethostbyname()]& (or
15910 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15911 version. The variable &$primary_hostname$& contains the host name, whether set
15912 explicitly by this option, or defaulted.
15913
15914
15915 .option print_topbitchars main boolean false
15916 .cindex "printing characters"
15917 .cindex "8-bit characters"
15918 By default, Exim considers only those characters whose codes lie in the range
15919 32&--126 to be printing characters. In a number of circumstances (for example,
15920 when writing log entries) non-printing characters are converted into escape
15921 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15922 is set, code values of 128 and above are also considered to be printing
15923 characters.
15924
15925 This option also affects the header syntax checks performed by the
15926 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15927 the user's full name when constructing From: and Sender: addresses (as
15928 described in section &<<SECTconstr>>&). Setting this option can cause
15929 Exim to generate eight bit message headers that do not conform to the
15930 standards.
15931
15932
15933 .option process_log_path main string unset
15934 .cindex "process log path"
15935 .cindex "log" "process log"
15936 .cindex "&'exiwhat'&"
15937 This option sets the name of the file to which an Exim process writes its
15938 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15939 utility script. If this option is unset, the file called &_exim-process.info_&
15940 in Exim's spool directory is used. The ability to specify the name explicitly
15941 can be useful in environments where two different Exims are running, using
15942 different spool directories.
15943
15944
15945 .option prod_requires_admin main boolean true
15946 .oindex "&%-M%&"
15947 .oindex "&%-R%&"
15948 .oindex "&%-q%&"
15949 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15950 admin user unless &%prod_requires_admin%& is set false. See also
15951 &%queue_list_requires_admin%&.
15952
15953
15954 .option qualify_domain main string "see below"
15955 .cindex "domain" "for qualifying addresses"
15956 .cindex "address" "qualification"
15957 This option specifies the domain name that is added to any envelope sender
15958 addresses that do not have a domain qualification. It also applies to
15959 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15960 are accepted by default only for locally-generated messages. Qualification is
15961 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15962 locally-generated messages, unless the &%-bnq%& command line option is used.
15963
15964 Messages from external sources must always contain fully qualified addresses,
15965 unless the sending host matches &%sender_unqualified_hosts%& or
15966 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15967 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15968 necessary. Internally, Exim always works with fully qualified envelope
15969 addresses. If &%qualify_domain%& is not set, it defaults to the
15970 &%primary_hostname%& value.
15971
15972
15973 .option qualify_recipient main string "see below"
15974 This option allows you to specify a different domain for qualifying recipient
15975 addresses to the one that is used for senders. See &%qualify_domain%& above.
15976
15977
15978
15979 .option queue_domains main "domain list&!!" unset
15980 .cindex "domain" "specifying non-immediate delivery"
15981 .cindex "queueing incoming messages"
15982 .cindex "message" "queueing certain domains"
15983 This option lists domains for which immediate delivery is not required.
15984 A delivery process is started whenever a message is received, but only those
15985 domains that do not match are processed. All other deliveries wait until the
15986 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15987
15988
15989 .option queue_list_requires_admin main boolean true
15990 .oindex "&%-bp%&"
15991 The &%-bp%& command-line option, which lists the messages that are on the
15992 queue, requires the caller to be an admin user unless
15993 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15994
15995
15996 .option queue_only main boolean false
15997 .cindex "queueing incoming messages"
15998 .cindex "message" "queueing unconditionally"
15999 If &%queue_only%& is set, a delivery process is not automatically started
16000 whenever a message is received. Instead, the message waits on the queue for the
16001 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16002 delivered immediately when certain conditions (such as heavy load) occur.
16003
16004 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16005 and &%-odi%& command line options override &%queue_only%& unless
16006 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16007 &%queue_only_load%&, and &%smtp_accept_queue%&.
16008
16009
16010 .option queue_only_file main string unset
16011 .cindex "queueing incoming messages"
16012 .cindex "message" "queueing by file existence"
16013 This option can be set to a colon-separated list of absolute path names, each
16014 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16015 it tests for the existence of each listed path using a call to &[stat()]&. For
16016 each path that exists, the corresponding queueing option is set.
16017 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16018 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16019 .code
16020 queue_only_file = smtp/some/file
16021 .endd
16022 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16023 &_/some/file_& exists.
16024
16025
16026 .option queue_only_load main fixed-point unset
16027 .cindex "load average"
16028 .cindex "queueing incoming messages"
16029 .cindex "message" "queueing by load"
16030 If the system load average is higher than this value, incoming messages from
16031 all sources are queued, and no automatic deliveries are started. If this
16032 happens during local or remote SMTP input, all subsequent messages received on
16033 the same SMTP connection are queued by default, whatever happens to the load in
16034 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16035 false.
16036
16037 Deliveries will subsequently be performed by queue runner processes. This
16038 option has no effect on ancient operating systems on which Exim cannot
16039 determine the load average. See also &%deliver_queue_load_max%& and
16040 &%smtp_load_reserve%&.
16041
16042
16043 .option queue_only_load_latch main boolean true
16044 .cindex "load average" "re-evaluating per message"
16045 When this option is true (the default), once one message has been queued
16046 because the load average is higher than the value set by &%queue_only_load%&,
16047 all subsequent messages received on the same SMTP connection are also queued.
16048 This is a deliberate choice; even though the load average may fall below the
16049 threshold, it doesn't seem right to deliver later messages on the same
16050 connection when not delivering earlier ones. However, there are special
16051 circumstances such as very long-lived connections from scanning appliances
16052 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16053 should be set false. This causes the value of the load average to be
16054 re-evaluated for each message.
16055
16056
16057 .option queue_only_override main boolean true
16058 .cindex "queueing incoming messages"
16059 When this option is true, the &%-od%&&'x'& command line options override the
16060 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16061 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16062 to override; they are accepted, but ignored.
16063
16064
16065 .option queue_run_in_order main boolean false
16066 .cindex "queue runner" "processing messages in order"
16067 If this option is set, queue runs happen in order of message arrival instead of
16068 in an arbitrary order. For this to happen, a complete list of the entire queue
16069 must be set up before the deliveries start. When the queue is all held in a
16070 single directory (the default), a single list is created for both the ordered
16071 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16072 single list is not created when &%queue_run_in_order%& is false. In this case,
16073 the sub-directories are processed one at a time (in a random order), and this
16074 avoids setting up one huge list for the whole queue. Thus, setting
16075 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16076 when the queue is large, because of the extra work in setting up the single,
16077 large list. In most situations, &%queue_run_in_order%& should not be set.
16078
16079
16080
16081 .option queue_run_max main integer&!! 5
16082 .cindex "queue runner" "maximum number of"
16083 This controls the maximum number of queue runner processes that an Exim daemon
16084 can run simultaneously. This does not mean that it starts them all at once,
16085 but rather that if the maximum number are still running when the time comes to
16086 start another one, it refrains from starting another one. This can happen with
16087 very large queues and/or very sluggish deliveries. This option does not,
16088 however, interlock with other processes, so additional queue runners can be
16089 started by other means, or by killing and restarting the daemon.
16090
16091 Setting this option to zero does not suppress queue runs; rather, it disables
16092 the limit, allowing any number of simultaneous queue runner processes to be
16093 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16094 the daemon's command line.
16095
16096 .new
16097 .cindex queues named
16098 .cindex "named queues"
16099 To set limits for different named queues use
16100 an expansion depending on the &$queue_name$& variable.
16101 .wen
16102
16103 .option queue_smtp_domains main "domain list&!!" unset
16104 .cindex "queueing incoming messages"
16105 .cindex "message" "queueing remote deliveries"
16106 When this option is set, a delivery process is started whenever a message is
16107 received, routing is performed, and local deliveries take place.
16108 However, if any SMTP deliveries are required for domains that match
16109 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16110 message waits on the queue for the next queue run. Since routing of the message
16111 has taken place, Exim knows to which remote hosts it must be delivered, and so
16112 when the queue run happens, multiple messages for the same host are delivered
16113 over a single SMTP connection. The &%-odqs%& command line option causes all
16114 SMTP deliveries to be queued in this way, and is equivalent to setting
16115 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16116 &%queue_domains%&.
16117
16118
16119 .option receive_timeout main time 0s
16120 .cindex "timeout" "for non-SMTP input"
16121 This option sets the timeout for accepting a non-SMTP message, that is, the
16122 maximum time that Exim waits when reading a message on the standard input. If
16123 the value is zero, it will wait for ever. This setting is overridden by the
16124 &%-or%& command line option. The timeout for incoming SMTP messages is
16125 controlled by &%smtp_receive_timeout%&.
16126
16127 .option received_header_text main string&!! "see below"
16128 .cindex "customizing" "&'Received:'& header"
16129 .cindex "&'Received:'& header line" "customizing"
16130 This string defines the contents of the &'Received:'& message header that is
16131 added to each message, except for the timestamp, which is automatically added
16132 on at the end (preceded by a semicolon). The string is expanded each time it is
16133 used. If the expansion yields an empty string, no &'Received:'& header line is
16134 added to the message. Otherwise, the string should start with the text
16135 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16136 header lines. The default setting is:
16137
16138 .code
16139 received_header_text = Received: \
16140   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16141   {${if def:sender_ident \
16142   {from ${quote_local_part:$sender_ident} }}\
16143   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16144   by $primary_hostname \
16145   ${if def:received_protocol {with $received_protocol}} \
16146   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16147   (Exim $version_number)\n\t\
16148   ${if def:sender_address \
16149   {(envelope-from <$sender_address>)\n\t}}\
16150   id $message_exim_id\
16151   ${if def:received_for {\n\tfor $received_for}}
16152 .endd
16153
16154 The reference to the TLS cipher is omitted when Exim is built without TLS
16155 support. The use of conditional expansions ensures that this works for both
16156 locally generated messages and messages received from remote hosts, giving
16157 header lines such as the following:
16158 .code
16159 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16160 by marley.carol.example with esmtp (Exim 4.00)
16161 (envelope-from <bob@carol.example>)
16162 id 16IOWa-00019l-00
16163 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16164 Received: by scrooge.carol.example with local (Exim 4.00)
16165 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16166 .endd
16167 Until the body of the message has been received, the timestamp is the time when
16168 the message started to be received. Once the body has arrived, and all policy
16169 checks have taken place, the timestamp is updated to the time at which the
16170 message was accepted.
16171
16172
16173 .option received_headers_max main integer 30
16174 .cindex "loop" "prevention"
16175 .cindex "mail loop prevention"
16176 .cindex "&'Received:'& header line" "counting"
16177 When a message is to be delivered, the number of &'Received:'& headers is
16178 counted, and if it is greater than this parameter, a mail loop is assumed to
16179 have occurred, the delivery is abandoned, and an error message is generated.
16180 This applies to both local and remote deliveries.
16181
16182
16183 .option recipient_unqualified_hosts main "host list&!!" unset
16184 .cindex "unqualified addresses"
16185 .cindex "host" "unqualified addresses from"
16186 This option lists those hosts from which Exim is prepared to accept unqualified
16187 recipient addresses in message envelopes. The addresses are made fully
16188 qualified by the addition of the &%qualify_recipient%& value. This option also
16189 affects message header lines. Exim does not reject unqualified recipient
16190 addresses in headers, but it qualifies them only if the message came from a
16191 host that matches &%recipient_unqualified_hosts%&,
16192 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16193 option was not set.
16194
16195
16196 .option recipients_max main integer 0
16197 .cindex "limit" "number of recipients"
16198 .cindex "recipient" "maximum number"
16199 If this option is set greater than zero, it specifies the maximum number of
16200 original recipients for any message. Additional recipients that are generated
16201 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16202 all recipients over the limit; earlier recipients are delivered as normal.
16203 Non-SMTP messages with too many recipients are failed, and no deliveries are
16204 done.
16205
16206 .cindex "RCPT" "maximum number of incoming"
16207 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16208 RCPT commands in a single message.
16209
16210
16211 .option recipients_max_reject main boolean false
16212 If this option is set true, Exim rejects SMTP messages containing too many
16213 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16214 error to the eventual DATA command. Otherwise (the default) it gives a 452
16215 error to the surplus RCPT commands and accepts the message on behalf of the
16216 initial set of recipients. The remote server should then re-send the message
16217 for the remaining recipients at a later time.
16218
16219
16220 .option remote_max_parallel main integer 2
16221 .cindex "delivery" "parallelism for remote"
16222 This option controls parallel delivery of one message to a number of remote
16223 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16224 does all the remote deliveries for a message one by one. Otherwise, if a single
16225 message has to be delivered to more than one remote host, or if several copies
16226 have to be sent to the same remote host, up to &%remote_max_parallel%&
16227 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16228 deliveries are required, the maximum number of processes are started, and as
16229 each one finishes, another is begun. The order of starting processes is the
16230 same as if sequential delivery were being done, and can be controlled by the
16231 &%remote_sort_domains%& option. If parallel delivery takes place while running
16232 with debugging turned on, the debugging output from each delivery process is
16233 tagged with its process id.
16234
16235 This option controls only the maximum number of parallel deliveries for one
16236 message in one Exim delivery process. Because Exim has no central queue
16237 manager, there is no way of controlling the total number of simultaneous
16238 deliveries if the configuration allows a delivery attempt as soon as a message
16239 is received.
16240
16241 .cindex "number of deliveries"
16242 .cindex "delivery" "maximum number of"
16243 If you want to control the total number of deliveries on the system, you
16244 need to set the &%queue_only%& option. This ensures that all incoming messages
16245 are added to the queue without starting a delivery process. Then set up an Exim
16246 daemon to start queue runner processes at appropriate intervals (probably
16247 fairly often, for example, every minute), and limit the total number of queue
16248 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16249 delivers only one message at a time, the maximum number of deliveries that can
16250 then take place at once is &%queue_run_max%& multiplied by
16251 &%remote_max_parallel%&.
16252
16253 If it is purely remote deliveries you want to control, use
16254 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16255 doing the SMTP routing before queueing, so that several messages for the same
16256 host will eventually get delivered down the same connection.
16257
16258
16259 .option remote_sort_domains main "domain list&!!" unset
16260 .cindex "sorting remote deliveries"
16261 .cindex "delivery" "sorting remote"
16262 When there are a number of remote deliveries for a message, they are sorted by
16263 domain into the order given by this list. For example,
16264 .code
16265 remote_sort_domains = *.cam.ac.uk:*.uk
16266 .endd
16267 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16268 then to those in the &%uk%& domain, then to any others.
16269
16270
16271 .option retry_data_expire main time 7d
16272 .cindex "hints database" "data expiry"
16273 This option sets a &"use before"& time on retry information in Exim's hints
16274 database. Any older retry data is ignored. This means that, for example, once a
16275 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16276 past failures.
16277
16278
16279 .option retry_interval_max main time 24h
16280 .cindex "retry" "limit on interval"
16281 .cindex "limit" "on retry interval"
16282 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16283 intervals between delivery attempts for messages that cannot be delivered
16284 straight away. This option sets an overall limit to the length of time between
16285 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16286 the default value.
16287
16288
16289 .option return_path_remove main boolean true
16290 .cindex "&'Return-path:'& header line" "removing"
16291 RFC 2821, section 4.4, states that an SMTP server must insert a
16292 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16293 The &'Return-path:'& header preserves the sender address as received in the
16294 MAIL command. This description implies that this header should not be present
16295 in an incoming message. If &%return_path_remove%& is true, any existing
16296 &'Return-path:'& headers are removed from messages at the time they are
16297 received. Exim's transports have options for adding &'Return-path:'& headers at
16298 the time of delivery. They are normally used only for final local deliveries.
16299
16300
16301 .option return_size_limit main integer 100K
16302 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16303
16304
16305 .option rfc1413_hosts main "host list&!!" @[]
16306 .cindex "RFC 1413"
16307 .cindex "host" "for RFC 1413 calls"
16308 RFC 1413 identification calls are made to any client host which matches
16309 an item in the list.
16310 The default value specifies just this host, being any local interface
16311 for the system.
16312
16313 .option rfc1413_query_timeout main time 0s
16314 .cindex "RFC 1413" "query timeout"
16315 .cindex "timeout" "for RFC 1413 call"
16316 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16317 no RFC 1413 calls are ever made.
16318
16319
16320 .option sender_unqualified_hosts main "host list&!!" unset
16321 .cindex "unqualified addresses"
16322 .cindex "host" "unqualified addresses from"
16323 This option lists those hosts from which Exim is prepared to accept unqualified
16324 sender addresses. The addresses are made fully qualified by the addition of
16325 &%qualify_domain%&. This option also affects message header lines. Exim does
16326 not reject unqualified addresses in headers that contain sender addresses, but
16327 it qualifies them only if the message came from a host that matches
16328 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16329 using TCP/IP), and the &%-bnq%& option was not set.
16330
16331 .option set_environment main "string list" empty
16332 .cindex "environment"
16333 This option allows to set individual environment variables that the
16334 currently linked libraries and programs in child processes use. The
16335 default list is empty,
16336
16337
16338 .option slow_lookup_log main integer 0
16339 .cindex "logging" "slow lookups"
16340 .cindex "dns" "logging slow lookups"
16341 This option controls logging of slow lookups.
16342 If the value is nonzero it is taken as a number of milliseconds
16343 and lookups taking longer than this are logged.
16344 Currently this applies only to DNS lookups.
16345
16346
16347
16348 .option smtp_accept_keepalive main boolean true
16349 .cindex "keepalive" "on incoming connection"
16350 This option controls the setting of the SO_KEEPALIVE option on incoming
16351 TCP/IP socket connections. When set, it causes the kernel to probe idle
16352 connections periodically, by sending packets with &"old"& sequence numbers. The
16353 other end of the connection should send an acknowledgment if the connection is
16354 still okay or a reset if the connection has been aborted. The reason for doing
16355 this is that it has the beneficial effect of freeing up certain types of
16356 connection that can get stuck when the remote host is disconnected without
16357 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16358 hours to detect unreachable hosts.
16359
16360
16361
16362 .option smtp_accept_max main integer 20
16363 .cindex "limit" "incoming SMTP connections"
16364 .cindex "SMTP" "incoming connection count"
16365 .cindex "inetd"
16366 This option specifies the maximum number of simultaneous incoming SMTP calls
16367 that Exim will accept. It applies only to the listening daemon; there is no
16368 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16369 value is set to zero, no limit is applied. However, it is required to be
16370 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16371 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16372
16373 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16374 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16375 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16376 and &%smtp_load_reserve%& are then checked before accepting the connection.
16377
16378
16379 .option smtp_accept_max_nonmail main integer 10
16380 .cindex "limit" "non-mail SMTP commands"
16381 .cindex "SMTP" "limiting non-mail commands"
16382 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16383 the connection if there are too many. This option defines &"too many"&. The
16384 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16385 client looping sending EHLO, for example. The check is applied only if the
16386 client host matches &%smtp_accept_max_nonmail_hosts%&.
16387
16388 When a new message is expected, one occurrence of RSET is not counted. This
16389 allows a client to send one RSET between messages (this is not necessary,
16390 but some clients do it). Exim also allows one uncounted occurrence of HELO
16391 or EHLO, and one occurrence of STARTTLS between messages. After
16392 starting up a TLS session, another EHLO is expected, and so it too is not
16393 counted. The first occurrence of AUTH in a connection, or immediately
16394 following STARTTLS is not counted. Otherwise, all commands other than
16395 MAIL, RCPT, DATA, and QUIT are counted.
16396
16397
16398 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16399 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16400 check by setting this option. The default value makes it apply to all hosts. By
16401 changing the value, you can exclude any badly-behaved hosts that you have to
16402 live with.
16403
16404
16405 . Allow this long option name to split; give it unsplit as a fifth argument
16406 . for the automatic .oindex that is generated by .option.
16407 . We insert " &~&~" which is both pretty nasty visually and results in
16408 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16409 . zero-width-space, which would be nicer visually and results in (at least)
16410 . html that Firefox will split on when it's forced to reflow (rather than
16411 . inserting a horizontal scrollbar).  However, the text is still not
16412 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16413 . the option name to split.
16414
16415 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16416          smtp_accept_max_per_connection
16417 .cindex "SMTP" "limiting incoming message count"
16418 .cindex "limit" "messages per SMTP connection"
16419 The value of this option limits the number of MAIL commands that Exim is
16420 prepared to accept over a single SMTP connection, whether or not each command
16421 results in the transfer of a message. After the limit is reached, a 421
16422 response is given to subsequent MAIL commands. This limit is a safety
16423 precaution against a client that goes mad (incidents of this type have been
16424 seen).
16425
16426
16427 .option smtp_accept_max_per_host main string&!! unset
16428 .cindex "limit" "SMTP connections from one host"
16429 .cindex "host" "limiting SMTP connections from"
16430 This option restricts the number of simultaneous IP connections from a single
16431 host (strictly, from a single IP address) to the Exim daemon. The option is
16432 expanded, to enable different limits to be applied to different hosts by
16433 reference to &$sender_host_address$&. Once the limit is reached, additional
16434 connection attempts from the same host are rejected with error code 421. This
16435 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16436 of zero imposes no limit. If this option is set greater than zero, it is
16437 required that &%smtp_accept_max%& be non-zero.
16438
16439 &*Warning*&: When setting this option you should not use any expansion
16440 constructions that take an appreciable amount of time. The expansion and test
16441 happen in the main daemon loop, in order to reject additional connections
16442 without forking additional processes (otherwise a denial-of-service attack
16443 could cause a vast number or processes to be created). While the daemon is
16444 doing this processing, it cannot accept any other incoming connections.
16445
16446
16447
16448 .option smtp_accept_queue main integer 0
16449 .cindex "SMTP" "incoming connection count"
16450 .cindex "queueing incoming messages"
16451 .cindex "message" "queueing by SMTP connection count"
16452 If the number of simultaneous incoming SMTP connections being handled via the
16453 listening daemon exceeds this value, messages received by SMTP are just placed
16454 on the queue; no delivery processes are started automatically. The count is
16455 fixed at the start of an SMTP connection. It cannot be updated in the
16456 subprocess that receives messages, and so the queueing or not queueing applies
16457 to all messages received in the same connection.
16458
16459 A value of zero implies no limit, and clearly any non-zero value is useful only
16460 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16461 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16462 various &%-od%&&'x'& command line options.
16463
16464
16465 . See the comment on smtp_accept_max_per_connection
16466
16467 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16468          smtp_accept_queue_per_connection
16469 .cindex "queueing incoming messages"
16470 .cindex "message" "queueing by message count"
16471 This option limits the number of delivery processes that Exim starts
16472 automatically when receiving messages via SMTP, whether via the daemon or by
16473 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16474 and the number of messages received in a single SMTP session exceeds this
16475 number, subsequent messages are placed on the queue, but no delivery processes
16476 are started. This helps to limit the number of Exim processes when a server
16477 restarts after downtime and there is a lot of mail waiting for it on other
16478 systems. On large systems, the default should probably be increased, and on
16479 dial-in client systems it should probably be set to zero (that is, disabled).
16480
16481
16482 .option smtp_accept_reserve main integer 0
16483 .cindex "SMTP" "incoming call count"
16484 .cindex "host" "reserved"
16485 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16486 number of SMTP connections that are reserved for connections from the hosts
16487 that are specified in &%smtp_reserve_hosts%&. The value set in
16488 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16489 restricted to this number of connections; the option specifies a minimum number
16490 of connection slots for them, not a maximum. It is a guarantee that this group
16491 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16492 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16493 individual host.
16494
16495 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16496 set to 5, once there are 45 active connections (from any hosts), new
16497 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16498 provided the other criteria for acceptance are met.
16499
16500
16501 .option smtp_active_hostname main string&!! unset
16502 .cindex "host" "name in SMTP responses"
16503 .cindex "SMTP" "host name in responses"
16504 .vindex "&$primary_hostname$&"
16505 This option is provided for multi-homed servers that want to masquerade as
16506 several different hosts. At the start of an incoming SMTP connection, its value
16507 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16508 responses. For example, it is used as domain name in the response to an
16509 incoming HELO or EHLO command.
16510
16511 .vindex "&$smtp_active_hostname$&"
16512 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16513 is saved with any messages that are received. It is therefore available for use
16514 in routers and transports when the message is later delivered.
16515
16516 If this option is unset, or if its expansion is forced to fail, or if the
16517 expansion results in an empty string, the value of &$primary_hostname$& is
16518 used. Other expansion failures cause a message to be written to the main and
16519 panic logs, and the SMTP command receives a temporary error. Typically, the
16520 value of &%smtp_active_hostname%& depends on the incoming interface address.
16521 For example:
16522 .code
16523 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16524   {cox.mydomain}{box.mydomain}}
16525 .endd
16526
16527 Although &$smtp_active_hostname$& is primarily concerned with incoming
16528 messages, it is also used as the default for HELO commands in callout
16529 verification if there is no remote transport from which to obtain a
16530 &%helo_data%& value.
16531
16532 .option smtp_banner main string&!! "see below"
16533 .cindex "SMTP" "welcome banner"
16534 .cindex "banner for SMTP"
16535 .cindex "welcome banner for SMTP"
16536 .cindex "customizing" "SMTP banner"
16537 This string, which is expanded every time it is used, is output as the initial
16538 positive response to an SMTP connection. The default setting is:
16539 .code
16540 smtp_banner = $smtp_active_hostname ESMTP Exim \
16541   $version_number $tod_full
16542 .endd
16543 Failure to expand the string causes a panic error. If you want to create a
16544 multiline response to the initial SMTP connection, use &"\n"& in the string at
16545 appropriate points, but not at the end. Note that the 220 code is not included
16546 in this string. Exim adds it automatically (several times in the case of a
16547 multiline response).
16548
16549
16550 .option smtp_check_spool_space main boolean true
16551 .cindex "checking disk space"
16552 .cindex "disk space, checking"
16553 .cindex "spool directory" "checking space"
16554 When this option is set, if an incoming SMTP session encounters the SIZE
16555 option on a MAIL command, it checks that there is enough space in the
16556 spool directory's partition to accept a message of that size, while still
16557 leaving free the amount specified by &%check_spool_space%& (even if that value
16558 is zero). If there isn't enough space, a temporary error code is returned.
16559
16560
16561 .option smtp_connect_backlog main integer 20
16562 .cindex "connection backlog"
16563 .cindex "SMTP" "connection backlog"
16564 .cindex "backlog of connections"
16565 This option specifies a maximum number of waiting SMTP connections. Exim passes
16566 this value to the TCP/IP system when it sets up its listener. Once this number
16567 of connections are waiting for the daemon's attention, subsequent connection
16568 attempts are refused at the TCP/IP level. At least, that is what the manuals
16569 say; in some circumstances such connection attempts have been observed to time
16570 out instead. For large systems it is probably a good idea to increase the
16571 value (to 50, say). It also gives some protection against denial-of-service
16572 attacks by SYN flooding.
16573
16574
16575 .option smtp_enforce_sync main boolean true
16576 .cindex "SMTP" "synchronization checking"
16577 .cindex "synchronization checking in SMTP"
16578 The SMTP protocol specification requires the client to wait for a response from
16579 the server at certain points in the dialogue. Without PIPELINING these
16580 synchronization points are after every command; with PIPELINING they are
16581 fewer, but they still exist.
16582
16583 Some spamming sites send out a complete set of SMTP commands without waiting
16584 for any response. Exim protects against this by rejecting a message if the
16585 client has sent further input when it should not have. The error response &"554
16586 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16587 for this error cannot be perfect because of transmission delays (unexpected
16588 input may be on its way but not yet received when Exim checks). However, it
16589 does detect many instances.
16590
16591 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16592 If you want to disable the check selectively (for example, only for certain
16593 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16594 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16595
16596
16597
16598 .option smtp_etrn_command main string&!! unset
16599 .cindex "ETRN" "command to be run"
16600 .vindex "&$domain$&"
16601 If this option is set, the given command is run whenever an SMTP ETRN
16602 command is received from a host that is permitted to issue such commands (see
16603 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16604 are independently expanded. The expansion variable &$domain$& is set to the
16605 argument of the ETRN command, and no syntax checking is done on it. For
16606 example:
16607 .code
16608 smtp_etrn_command = /etc/etrn_command $domain \
16609                     $sender_host_address
16610 .endd
16611 A new process is created to run the command, but Exim does not wait for it to
16612 complete. Consequently, its status cannot be checked. If the command cannot be
16613 run, a line is written to the panic log, but the ETRN caller still receives
16614 a 250 success response. Exim is normally running under its own uid when
16615 receiving SMTP, so it is not possible for it to change the uid before running
16616 the command.
16617
16618
16619 .option smtp_etrn_serialize main boolean true
16620 .cindex "ETRN" "serializing"
16621 When this option is set, it prevents the simultaneous execution of more than
16622 one identical command as a result of ETRN in an SMTP connection. See
16623 section &<<SECTETRN>>& for details.
16624
16625
16626 .option smtp_load_reserve main fixed-point unset
16627 .cindex "load average"
16628 If the system load average ever gets higher than this, incoming SMTP calls are
16629 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16630 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16631 the load is over the limit. The option has no effect on ancient operating
16632 systems on which Exim cannot determine the load average. See also
16633 &%deliver_queue_load_max%& and &%queue_only_load%&.
16634
16635
16636
16637 .option smtp_max_synprot_errors main integer 3
16638 .cindex "SMTP" "limiting syntax and protocol errors"
16639 .cindex "limit" "SMTP syntax and protocol errors"
16640 Exim rejects SMTP commands that contain syntax or protocol errors. In
16641 particular, a syntactically invalid email address, as in this command:
16642 .code
16643 RCPT TO:<abc xyz@a.b.c>
16644 .endd
16645 causes immediate rejection of the command, before any other tests are done.
16646 (The ACL cannot be run if there is no valid address to set up for it.) An
16647 example of a protocol error is receiving RCPT before MAIL. If there are
16648 too many syntax or protocol errors in one SMTP session, the connection is
16649 dropped. The limit is set by this option.
16650
16651 .cindex "PIPELINING" "expected errors"
16652 When the PIPELINING extension to SMTP is in use, some protocol errors are
16653 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16654 Exim assumes that PIPELINING will be used if it advertises it (see
16655 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16656 not count towards the limit.
16657
16658
16659
16660 .option smtp_max_unknown_commands main integer 3
16661 .cindex "SMTP" "limiting unknown commands"
16662 .cindex "limit" "unknown SMTP commands"
16663 If there are too many unrecognized commands in an incoming SMTP session, an
16664 Exim server drops the connection. This is a defence against some kinds of abuse
16665 that subvert web
16666 clients
16667 into making connections to SMTP ports; in these circumstances, a number of
16668 non-SMTP command lines are sent first.
16669
16670
16671
16672 .option smtp_ratelimit_hosts main "host list&!!" unset
16673 .cindex "SMTP" "rate limiting"
16674 .cindex "limit" "rate of message arrival"
16675 .cindex "RCPT" "rate limiting"
16676 Some sites find it helpful to be able to limit the rate at which certain hosts
16677 can send them messages, and the rate at which an individual message can specify
16678 recipients.
16679
16680 Exim has two rate-limiting facilities. This section describes the older
16681 facility, which can limit rates within a single connection. The newer
16682 &%ratelimit%& ACL condition can limit rates across all connections. See section
16683 &<<SECTratelimiting>>& for details of the newer facility.
16684
16685 When a host matches &%smtp_ratelimit_hosts%&, the values of
16686 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16687 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16688 respectively. Each option, if set, must contain a set of four comma-separated
16689 values:
16690
16691 .ilist
16692 A threshold, before which there is no rate limiting.
16693 .next
16694 An initial time delay. Unlike other times in Exim, numbers with decimal
16695 fractional parts are allowed here.
16696 .next
16697 A factor by which to increase the delay each time.
16698 .next
16699 A maximum value for the delay. This should normally be less than 5 minutes,
16700 because after that time, the client is liable to timeout the SMTP command.
16701 .endlist
16702
16703 For example, these settings have been used successfully at the site which
16704 first suggested this feature, for controlling mail from their customers:
16705 .code
16706 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16707 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16708 .endd
16709 The first setting specifies delays that are applied to MAIL commands after
16710 two have been received over a single connection. The initial delay is 0.5
16711 seconds, increasing by a factor of 1.05 each time. The second setting applies
16712 delays to RCPT commands when more than four occur in a single message.
16713
16714
16715 .option smtp_ratelimit_mail main string unset
16716 See &%smtp_ratelimit_hosts%& above.
16717
16718
16719 .option smtp_ratelimit_rcpt main string unset
16720 See &%smtp_ratelimit_hosts%& above.
16721
16722
16723 .option smtp_receive_timeout main time&!! 5m
16724 .cindex "timeout" "for SMTP input"
16725 .cindex "SMTP" "input timeout"
16726 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16727 input, including batch SMTP. If a line of input (either an SMTP command or a
16728 data line) is not received within this time, the SMTP connection is dropped and
16729 the message is abandoned.
16730 A line is written to the log containing one of the following messages:
16731 .code
16732 SMTP command timeout on connection from...
16733 SMTP data timeout on connection from...
16734 .endd
16735 The former means that Exim was expecting to read an SMTP command; the latter
16736 means that it was in the DATA phase, reading the contents of a message.
16737
16738 If the first character of the option is a &"$"& the option is
16739 expanded before use and may depend on
16740 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16741
16742
16743 .oindex "&%-os%&"
16744 The value set by this option can be overridden by the
16745 &%-os%& command-line option. A setting of zero time disables the timeout, but
16746 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16747 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16748 timeout is controlled by &%receive_timeout%& and &%-or%&.
16749
16750
16751 .option smtp_reserve_hosts main "host list&!!" unset
16752 This option defines hosts for which SMTP connections are reserved; see
16753 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16754
16755
16756 .option smtp_return_error_details main boolean false
16757 .cindex "SMTP" "details policy failures"
16758 .cindex "policy control" "rejection, returning details"
16759 In the default state, Exim uses bland messages such as
16760 &"Administrative prohibition"& when it rejects SMTP commands for policy
16761 reasons. Many sysadmins like this because it gives away little information
16762 to spammers. However, some other sysadmins who are applying strict checking
16763 policies want to give out much fuller information about failures. Setting
16764 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16765 example, instead of &"Administrative prohibition"&, it might give:
16766 .code
16767 550-Rejected after DATA: '>' missing at end of address:
16768 550 failing address in "From" header is: <user@dom.ain
16769 .endd
16770
16771
16772 .option smtputf8_advertise_hosts main "host list&!!" *
16773 .cindex "SMTPUTF8" "advertising"
16774 When Exim is built with support for internationalised mail names,
16775 the availability thereof is advertised in
16776 response to EHLO only to those client hosts that match this option. See
16777 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16778
16779
16780 .option spamd_address main string "see below"
16781 This option is available when Exim is compiled with the content-scanning
16782 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16783 The default value is
16784 .code
16785 127.0.0.1 783
16786 .endd
16787 See section &<<SECTscanspamass>>& for more details.
16788
16789
16790
16791 .option split_spool_directory main boolean false
16792 .cindex "multiple spool directories"
16793 .cindex "spool directory" "split"
16794 .cindex "directories, multiple"
16795 If this option is set, it causes Exim to split its input directory into 62
16796 subdirectories, each with a single alphanumeric character as its name. The
16797 sixth character of the message id is used to allocate messages to
16798 subdirectories; this is the least significant base-62 digit of the time of
16799 arrival of the message.
16800
16801 Splitting up the spool in this way may provide better performance on systems
16802 where there are long mail queues, by reducing the number of files in any one
16803 directory. The msglog directory is also split up in a similar way to the input
16804 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16805 are still placed in the single directory &_msglog.OLD_&.
16806
16807 It is not necessary to take any special action for existing messages when
16808 changing &%split_spool_directory%&. Exim notices messages that are in the
16809 &"wrong"& place, and continues to process them. If the option is turned off
16810 after a period of being on, the subdirectories will eventually empty and be
16811 automatically deleted.
16812
16813 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16814 changes. Instead of creating a list of all messages in the queue, and then
16815 trying to deliver each one in turn, it constructs a list of those in one
16816 sub-directory and tries to deliver them, before moving on to the next
16817 sub-directory. The sub-directories are processed in a random order. This
16818 spreads out the scanning of the input directories, and uses less memory. It is
16819 particularly beneficial when there are lots of messages on the queue. However,
16820 if &%queue_run_in_order%& is set, none of this new processing happens. The
16821 entire queue has to be scanned and sorted before any deliveries can start.
16822
16823
16824 .option spool_directory main string&!! "set at compile time"
16825 .cindex "spool directory" "path to"
16826 This defines the directory in which Exim keeps its spool, that is, the messages
16827 it is waiting to deliver. The default value is taken from the compile-time
16828 configuration setting, if there is one. If not, this option must be set. The
16829 string is expanded, so it can contain, for example, a reference to
16830 &$primary_hostname$&.
16831
16832 If the spool directory name is fixed on your installation, it is recommended
16833 that you set it at build time rather than from this option, particularly if the
16834 log files are being written to the spool directory (see &%log_file_path%&).
16835 Otherwise log files cannot be used for errors that are detected early on, such
16836 as failures in the configuration file.
16837
16838 By using this option to override the compiled-in path, it is possible to run
16839 tests of Exim without using the standard spool.
16840
16841 .option sqlite_lock_timeout main time 5s
16842 .cindex "sqlite lookup type" "lock timeout"
16843 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16844 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16845
16846 .option strict_acl_vars main boolean false
16847 .cindex "&ACL;" "variables, handling unset"
16848 This option controls what happens if a syntactically valid but undefined ACL
16849 variable is referenced. If it is false (the default), an empty string
16850 is substituted; if it is true, an error is generated. See section
16851 &<<SECTaclvariables>>& for details of ACL variables.
16852
16853 .option strip_excess_angle_brackets main boolean false
16854 .cindex "angle brackets, excess"
16855 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16856 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16857 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16858 passed on to another MTA, the excess angle brackets are not passed on. If this
16859 option is not set, multiple pairs of angle brackets cause a syntax error.
16860
16861
16862 .option strip_trailing_dot main boolean false
16863 .cindex "trailing dot on domain"
16864 .cindex "dot" "trailing on domain"
16865 If this option is set, a trailing dot at the end of a domain in an address is
16866 ignored. If this is in the envelope and the message is passed on to another
16867 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16868 domain causes a syntax error.
16869 However, addresses in header lines are checked only when an ACL requests header
16870 syntax checking.
16871
16872
16873 .option syslog_duplication main boolean true
16874 .cindex "syslog" "duplicate log lines; suppressing"
16875 When Exim is logging to syslog, it writes the log lines for its three
16876 separate logs at different syslog priorities so that they can in principle
16877 be separated on the logging hosts. Some installations do not require this
16878 separation, and in those cases, the duplication of certain log lines is a
16879 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16880 particular log line is written to syslog. For lines that normally go to
16881 both the main log and the reject log, the reject log version (possibly
16882 containing message header lines) is written, at LOG_NOTICE priority.
16883 Lines that normally go to both the main and the panic log are written at
16884 the LOG_ALERT priority.
16885
16886
16887 .option syslog_facility main string unset
16888 .cindex "syslog" "facility; setting"
16889 This option sets the syslog &"facility"& name, used when Exim is logging to
16890 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16891 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16892 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16893 details of Exim's logging.
16894
16895
16896 .option syslog_pid main boolean true
16897 .cindex "syslog" "pid"
16898 If &%syslog_pid%& is set false, the PID on Exim's log lines are
16899 omitted when these lines are sent to syslog. (Syslog normally prefixes
16900 the log lines with the PID of the logging process automatically.) You need
16901 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
16902 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
16903
16904
16905
16906 .option syslog_processname main string &`exim`&
16907 .cindex "syslog" "process name; setting"
16908 This option sets the syslog &"ident"& name, used when Exim is logging to
16909 syslog. The value must be no longer than 32 characters. See chapter
16910 &<<CHAPlog>>& for details of Exim's logging.
16911
16912
16913
16914 .option syslog_timestamp main boolean true
16915 .cindex "syslog" "timestamps"
16916 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16917 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16918 details of Exim's logging.
16919
16920
16921 .option system_filter main string&!! unset
16922 .cindex "filter" "system filter"
16923 .cindex "system filter" "specifying"
16924 .cindex "Sieve filter" "not available for system filter"
16925 This option specifies an Exim filter file that is applied to all messages at
16926 the start of each delivery attempt, before any routing is done. System filters
16927 must be Exim filters; they cannot be Sieve filters. If the system filter
16928 generates any deliveries to files or pipes, or any new mail messages, the
16929 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16930 which transports are to be used. Details of this facility are given in chapter
16931 &<<CHAPsystemfilter>>&.
16932 .new
16933 A forced expansion failure results in no filter operation.
16934 .wen
16935
16936
16937 .option system_filter_directory_transport main string&!! unset
16938 .vindex "&$address_file$&"
16939 This sets the name of the transport driver that is to be used when the
16940 &%save%& command in a system message filter specifies a path ending in &"/"&,
16941 implying delivery of each message into a separate file in some directory.
16942 During the delivery, the variable &$address_file$& contains the path name.
16943
16944
16945 .option system_filter_file_transport main string&!! unset
16946 .cindex "file" "transport for system filter"
16947 This sets the name of the transport driver that is to be used when the &%save%&
16948 command in a system message filter specifies a path not ending in &"/"&. During
16949 the delivery, the variable &$address_file$& contains the path name.
16950
16951 .option system_filter_group main string unset
16952 .cindex "gid (group id)" "system filter"
16953 This option is used only when &%system_filter_user%& is also set. It sets the
16954 gid under which the system filter is run, overriding any gid that is associated
16955 with the user. The value may be numerical or symbolic.
16956
16957 .option system_filter_pipe_transport main string&!! unset
16958 .cindex "&(pipe)& transport" "for system filter"
16959 .vindex "&$address_pipe$&"
16960 This specifies the transport driver that is to be used when a &%pipe%& command
16961 is used in a system filter. During the delivery, the variable &$address_pipe$&
16962 contains the pipe command.
16963
16964
16965 .option system_filter_reply_transport main string&!! unset
16966 .cindex "&(autoreply)& transport" "for system filter"
16967 This specifies the transport driver that is to be used when a &%mail%& command
16968 is used in a system filter.
16969
16970
16971 .option system_filter_user main string unset
16972 .cindex "uid (user id)" "system filter"
16973 If this option is set to root, the system filter is run in the main Exim
16974 delivery process, as root.  Otherwise, the system filter runs in a separate
16975 process, as the given user, defaulting to the Exim run-time user.
16976 Unless the string consists entirely of digits, it
16977 is looked up in the password data. Failure to find the named user causes a
16978 configuration error. The gid is either taken from the password data, or
16979 specified by &%system_filter_group%&. When the uid is specified numerically,
16980 &%system_filter_group%& is required to be set.
16981
16982 If the system filter generates any pipe, file, or reply deliveries, the uid
16983 under which the filter is run is used when transporting them, unless a
16984 transport option overrides.
16985
16986
16987 .option tcp_nodelay main boolean true
16988 .cindex "daemon" "TCP_NODELAY on sockets"
16989 .cindex "Nagle algorithm"
16990 .cindex "TCP_NODELAY on listening sockets"
16991 If this option is set false, it stops the Exim daemon setting the
16992 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16993 turns off the &"Nagle algorithm"&, which is a way of improving network
16994 performance in interactive (character-by-character) situations. Turning it off
16995 should improve Exim's performance a bit, so that is what happens by default.
16996 However, it appears that some broken clients cannot cope, and time out. Hence
16997 this option. It affects only those sockets that are set up for listening by the
16998 daemon. Sockets created by the smtp transport for delivering mail always set
16999 TCP_NODELAY.
17000
17001
17002 .option timeout_frozen_after main time 0s
17003 .cindex "frozen messages" "timing out"
17004 .cindex "timeout" "frozen messages"
17005 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17006 message of any kind that has been on the queue for longer than the given time
17007 is automatically cancelled at the next queue run. If the frozen message is a
17008 bounce message, it is just discarded; otherwise, a bounce is sent to the
17009 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17010 If you want to timeout frozen bounce messages earlier than other kinds of
17011 frozen message, see &%ignore_bounce_errors_after%&.
17012
17013 &*Note:*& the default value of zero means no timeouts; with this setting,
17014 frozen messages remain on the queue forever (except for any frozen bounce
17015 messages that are released by &%ignore_bounce_errors_after%&).
17016
17017
17018 .option timezone main string unset
17019 .cindex "timezone, setting"
17020 .cindex "environment" "values from"
17021 The value of &%timezone%& is used to set the environment variable TZ while
17022 running Exim (if it is different on entry). This ensures that all timestamps
17023 created by Exim are in the required timezone. If you want all your timestamps
17024 to be in UTC (aka GMT) you should set
17025 .code
17026 timezone = UTC
17027 .endd
17028 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17029 or, if that is not set, from the value of the TZ environment variable when Exim
17030 is built. If &%timezone%& is set to the empty string, either at build or run
17031 time, any existing TZ variable is removed from the environment when Exim
17032 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17033 unfortunately not all, operating systems.
17034
17035
17036 .option tls_advertise_hosts main "host list&!!" *
17037 .cindex "TLS" "advertising"
17038 .cindex "encryption" "on SMTP connection"
17039 .cindex "SMTP" "encrypted connection"
17040 When Exim is built with support for TLS encrypted connections, the availability
17041 of the STARTTLS command to set up an encrypted session is advertised in
17042 response to EHLO only to those client hosts that match this option. See
17043 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17044 Note that the default value requires that a certificate be supplied
17045 using the &%tls_certificate%& option.  If TLS support for incoming connections
17046 is not required the &%tls_advertise_hosts%& option should be set empty.
17047
17048
17049 .option tls_certificate main string&!! unset
17050 .cindex "TLS" "server certificate; location of"
17051 .cindex "certificate" "server, location of"
17052 The value of this option is expanded, and must then be the absolute path to a
17053 file which contains the server's certificates. The server's private key is also
17054 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17055 &<<CHAPTLS>>& for further details.
17056
17057 &*Note*&: The certificates defined by this option are used only when Exim is
17058 receiving incoming messages as a server. If you want to supply certificates for
17059 use when sending messages as a client, you must set the &%tls_certificate%&
17060 option in the relevant &(smtp)& transport.
17061
17062 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17063 if the OpenSSL build supports TLS extensions and the TLS client sends the
17064 Server Name Indication extension, then this option and others documented in
17065 &<<SECTtlssni>>& will be re-expanded.
17066
17067 .new
17068 If this option is unset or empty a fresh self-signed certificate will be
17069 generated for every connection.
17070 .wen
17071
17072 .option tls_crl main string&!! unset
17073 .cindex "TLS" "server certificate revocation list"
17074 .cindex "certificate" "revocation list for server"
17075 This option specifies a certificate revocation list. The expanded value must
17076 be the name of a file that contains a CRL in PEM format.
17077
17078 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17079
17080
17081 .option tls_dh_max_bits main integer 2236
17082 .cindex "TLS" "D-H bit count"
17083 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17084 the chosen TLS library.  That value might prove to be too high for
17085 interoperability.  This option provides a maximum clamp on the value
17086 suggested, trading off security for interoperability.
17087
17088 The value must be at least 1024.
17089
17090 The value 2236 was chosen because, at time of adding the option, it was the
17091 hard-coded maximum value supported by the NSS cryptographic library, as used
17092 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17093
17094 If you prefer more security and are willing to break some clients, raise this
17095 number.
17096
17097 Note that the value passed to GnuTLS for *generating* a new prime may be a
17098 little less than this figure, because GnuTLS is inexact and may produce a
17099 larger prime than requested.
17100
17101
17102 .option tls_dhparam main string&!! unset
17103 .cindex "TLS" "D-H parameters for server"
17104 The value of this option is expanded and indicates the source of DH parameters
17105 to be used by Exim.
17106
17107 .new
17108 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17109 local DH parameters*&, which has been supported across all versions of Exim.  The
17110 other specific constants available are a fallback so that even when
17111 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17112 .wen
17113
17114 If &%tls_dhparam%& is a filename starting with a &`/`&,
17115 then it names a file from which DH
17116 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17117 PKCS#3 representation of the DH prime.  If the file does not exist, for
17118 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17119 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17120 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17121 and treated as though the &%tls_dhparam%& were set to "none".
17122
17123 If this option expands to the string "none", then no DH parameters will be
17124 loaded by Exim.
17125
17126 If this option expands to the string "historic" and Exim is using GnuTLS, then
17127 Exim will attempt to load a file from inside the spool directory.  If the file
17128 does not exist, Exim will attempt to create it.
17129 See section &<<SECTgnutlsparam>>& for further details.
17130
17131 .new
17132 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17133 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17134
17135 In older versions of Exim the default was the 2048 bit prime described in section
17136 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17137 in IKE is assigned number 23.
17138
17139 Otherwise, the option must expand to the name used by Exim for any of a number
17140 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17141 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17142 the number used by IKE, or "default" which corresponds to
17143 &`exim.dev.20160529.3`&.
17144
17145 The available standard primes are:
17146 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17147 &`ike1`&, &`ike2`&, &`ike5`&,
17148 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17149 &`ike22`&, &`ike23`& and &`ike24`&.
17150
17151 The available additional primes are:
17152 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17153
17154 Some of these will be too small to be accepted by clients.
17155 Some may be too large to be accepted by clients.
17156 The open cryptographic community has suspicions about the integrity of some
17157 of the later IKE values, which led into RFC7919 providing new fixed constants
17158 (the "ffdhe" identifiers).
17159
17160 At this point, all of the "ike" values should be considered obsolete;
17161 they're still in Exim to avoid breaking unusual configurations, but are
17162 candidates for removal the next time we have backwards-incompatible changes.
17163 .wen
17164
17165 The TLS protocol does not negotiate an acceptable size for this; clients tend
17166 to hard-drop connections if what is offered by the server is unacceptable,
17167 whether too large or too small, and there's no provision for the client to
17168 tell the server what these constraints are.  Thus, as a server operator, you
17169 need to make an educated guess as to what is most likely to work for your
17170 userbase.
17171
17172 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17173 is most likely to maximise interoperability.  The upper bound comes from
17174 applications using the Mozilla Network Security Services (NSS) library, which
17175 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17176 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17177 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17178 acceptable bound from 1024 to 2048.
17179
17180
17181 .option tls_eccurve main string&!! &`auto`&
17182 .cindex TLS "EC cryptography"
17183 This option selects a EC curve for use by Exim.
17184
17185 After expansion it must contain a valid EC curve parameter, such as
17186 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17187 for valid selections.
17188
17189 For OpenSSL versions before (and not including) 1.0.2, the string
17190 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17191 &`auto`& tells the library to choose.
17192
17193 If the option expands to an empty string, no EC curves will be enabled.
17194
17195
17196 .option tls_ocsp_file main string&!! unset
17197 .cindex TLS "certificate status"
17198 .cindex TLS "OCSP proof file"
17199 This option
17200 must if set expand to the absolute path to a file which contains a current
17201 status proof for the server's certificate, as obtained from the
17202 Certificate Authority.
17203
17204 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17205
17206
17207 .option tls_on_connect_ports main "string list" unset
17208 .cindex SSMTP
17209 .cindex SMTPS
17210 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17211 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17212 set up without waiting for the client to issue a STARTTLS command. For
17213 further details, see section &<<SECTsupobssmt>>&.
17214
17215
17216
17217 .option tls_privatekey main string&!! unset
17218 .cindex "TLS" "server private key; location of"
17219 The value of this option is expanded, and must then be the absolute path to a
17220 file which contains the server's private key. If this option is unset, or if
17221 the expansion is forced to fail, or the result is an empty string, the private
17222 key is assumed to be in the same file as the server's certificates. See chapter
17223 &<<CHAPTLS>>& for further details.
17224
17225 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17226
17227
17228 .option tls_remember_esmtp main boolean false
17229 .cindex "TLS" "esmtp state; remembering"
17230 .cindex "TLS" "broken clients"
17231 If this option is set true, Exim violates the RFCs by remembering that it is in
17232 &"esmtp"& state after successfully negotiating a TLS session. This provides
17233 support for broken clients that fail to send a new EHLO after starting a
17234 TLS session.
17235
17236
17237 .option tls_require_ciphers main string&!! unset
17238 .cindex "TLS" "requiring specific ciphers"
17239 .cindex "cipher" "requiring specific"
17240 This option controls which ciphers can be used for incoming TLS connections.
17241 The &(smtp)& transport has an option of the same name for controlling outgoing
17242 connections. This option is expanded for each connection, so can be varied for
17243 different clients if required. The value of this option must be a list of
17244 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17245 in somewhat different ways. If GnuTLS is being used, the client controls the
17246 preference order of the available ciphers. Details are given in sections
17247 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17248
17249
17250 .option tls_try_verify_hosts main "host list&!!" unset
17251 .cindex "TLS" "client certificate verification"
17252 .cindex "certificate" "verification of client"
17253 See &%tls_verify_hosts%& below.
17254
17255
17256 .option tls_verify_certificates main string&!! system
17257 .cindex "TLS" "client certificate verification"
17258 .cindex "certificate" "verification of client"
17259 The value of this option is expanded, and must then be either the
17260 word "system"
17261 or the absolute path to
17262 a file or directory containing permitted certificates for clients that
17263 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17264
17265 The "system" value for the option will use a
17266 system default location compiled into the SSL library.
17267 This is not available for GnuTLS versions preceding 3.0.20,
17268 and will be taken as empty; an explicit location
17269 must be specified.
17270
17271 The use of a directory for the option value is not available for GnuTLS versions
17272 preceding 3.3.6 and a single file must be used.
17273
17274 With OpenSSL the certificates specified
17275 explicitly
17276 either by file or directory
17277 are added to those given by the system default location.
17278
17279 These certificates should be for the certificate authorities trusted, rather
17280 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17281 the value is a file then the certificates are sent by Exim as a server to
17282 connecting clients, defining the list of accepted certificate authorities.
17283 Thus the values defined should be considered public data.  To avoid this,
17284 use the explicit directory version.
17285
17286 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17287
17288 A forced expansion failure or setting to an empty string is equivalent to
17289 being unset.
17290
17291
17292 .option tls_verify_hosts main "host list&!!" unset
17293 .cindex "TLS" "client certificate verification"
17294 .cindex "certificate" "verification of client"
17295 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17296 certificates from clients. The expected certificates are defined by
17297 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17298 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17299 &%tls_verify_certificates%& is not set.
17300
17301 Any client that matches &%tls_verify_hosts%& is constrained by
17302 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17303 present one of the listed certificates. If it does not, the connection is
17304 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17305 the host to use TLS. It can still send SMTP commands through unencrypted
17306 connections. Forcing a client to use TLS has to be done separately using an
17307 ACL to reject inappropriate commands when the connection is not encrypted.
17308
17309 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17310 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17311 certificate and checks it against &%tls_verify_certificates%&, but does not
17312 abort the connection if there is no certificate or if it does not match. This
17313 state can be detected in an ACL, which makes it possible to implement policies
17314 such as &"accept for relay only if a verified certificate has been received,
17315 but accept for local delivery if encrypted, even without a verified
17316 certificate"&.
17317
17318 Client hosts that match neither of these lists are not asked to present
17319 certificates.
17320
17321
17322 .option trusted_groups main "string list&!!" unset
17323 .cindex "trusted groups"
17324 .cindex "groups" "trusted"
17325 This option is expanded just once, at the start of Exim's processing. If this
17326 option is set, any process that is running in one of the listed groups, or
17327 which has one of them as a supplementary group, is trusted. The groups can be
17328 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17329 details of what trusted callers are permitted to do. If neither
17330 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17331 are trusted.
17332
17333 .option trusted_users main "string list&!!" unset
17334 .cindex "trusted users"
17335 .cindex "user" "trusted"
17336 This option is expanded just once, at the start of Exim's processing. If this
17337 option is set, any process that is running as one of the listed users is
17338 trusted. The users can be specified numerically or by name. See section
17339 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17340 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17341 Exim user are trusted.
17342
17343 .option unknown_login main string&!! unset
17344 .cindex "uid (user id)" "unknown caller"
17345 .vindex "&$caller_uid$&"
17346 This is a specialized feature for use in unusual configurations. By default, if
17347 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17348 gives up. The &%unknown_login%& option can be used to set a login name to be
17349 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17350 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17351 is used for the user's real name (gecos field), unless this has been set by the
17352 &%-F%& option.
17353
17354 .option unknown_username main string unset
17355 See &%unknown_login%&.
17356
17357 .option untrusted_set_sender main "address list&!!" unset
17358 .cindex "trusted users"
17359 .cindex "sender" "setting by untrusted user"
17360 .cindex "untrusted user setting sender"
17361 .cindex "user" "untrusted setting sender"
17362 .cindex "envelope sender"
17363 When an untrusted user submits a message to Exim using the standard input, Exim
17364 normally creates an envelope sender address from the user's login and the
17365 default qualification domain. Data from the &%-f%& option (for setting envelope
17366 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17367 is used) is ignored.
17368
17369 However, untrusted users are permitted to set an empty envelope sender address,
17370 to declare that a message should never generate any bounces. For example:
17371 .code
17372 exim -f '<>' user@domain.example
17373 .endd
17374 .vindex "&$sender_ident$&"
17375 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17376 other envelope sender addresses in a controlled way. When it is set, untrusted
17377 users are allowed to set envelope sender addresses that match any of the
17378 patterns in the list. Like all address lists, the string is expanded. The
17379 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17380 users to setting senders that start with their login ids
17381 followed by a hyphen
17382 by a setting like this:
17383 .code
17384 untrusted_set_sender = ^$sender_ident-
17385 .endd
17386 If you want to allow untrusted users to set envelope sender addresses without
17387 restriction, you can use
17388 .code
17389 untrusted_set_sender = *
17390 .endd
17391 The &%untrusted_set_sender%& option applies to all forms of local input, but
17392 only to the setting of the envelope sender. It does not permit untrusted users
17393 to use the other options which trusted user can use to override message
17394 parameters. Furthermore, it does not stop Exim from removing an existing
17395 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17396 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17397 overriding these actions. The handling of the &'Sender:'& header is also
17398 described in section &<<SECTthesenhea>>&.
17399
17400 The log line for a message's arrival shows the envelope sender following
17401 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17402 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17403 envelope sender address, the user's login is shown in parentheses after the
17404 sender address.
17405
17406
17407 .option uucp_from_pattern main string "see below"
17408 .cindex "&""From""& line"
17409 .cindex "UUCP" "&""From""& line"
17410 Some applications that pass messages to an MTA via a command line interface use
17411 an initial line starting with &"From&~"& to pass the envelope sender. In
17412 particular, this is used by UUCP software. Exim recognizes such a line by means
17413 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17414 matches, the sender address is constructed by expanding the contents of
17415 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17416 default pattern recognizes lines in the following two forms:
17417 .code
17418 From ph10 Fri Jan  5 12:35 GMT 1996
17419 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17420 .endd
17421 The pattern can be seen by running
17422 .code
17423 exim -bP uucp_from_pattern
17424 .endd
17425 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17426 year in the second case. The first word after &"From&~"& is matched in the
17427 regular expression by a parenthesized subpattern. The default value for
17428 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17429 (&"ph10"& in the example above) as the message's sender. See also
17430 &%ignore_fromline_hosts%&.
17431
17432
17433 .option uucp_from_sender main string&!! &`$1`&
17434 See &%uucp_from_pattern%& above.
17435
17436
17437 .option warn_message_file main string unset
17438 .cindex "warning of delay" "customizing the message"
17439 .cindex "customizing" "warning message"
17440 This option defines a template file containing paragraphs of text to be used
17441 for constructing the warning message which is sent by Exim when a message has
17442 been on the queue for a specified amount of time, as specified by
17443 &%delay_warning%&. Details of the file's contents are given in chapter
17444 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17445
17446
17447 .option write_rejectlog main boolean true
17448 .cindex "reject log" "disabling"
17449 If this option is set false, Exim no longer writes anything to the reject log.
17450 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17451 .ecindex IIDconfima
17452 .ecindex IIDmaiconf
17453
17454
17455
17456
17457 . ////////////////////////////////////////////////////////////////////////////
17458 . ////////////////////////////////////////////////////////////////////////////
17459
17460 .chapter "Generic options for routers" "CHAProutergeneric"
17461 .scindex IIDgenoprou1 "options" "generic; for routers"
17462 .scindex IIDgenoprou2 "generic options" "router"
17463 This chapter describes the generic options that apply to all routers.
17464 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17465
17466 For a general description of how a router operates, see sections
17467 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17468 which the preconditions are tested. The order of expansion of the options that
17469 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17470 &%headers_remove%&, &%transport%&.
17471
17472
17473
17474 .option address_data routers string&!! unset
17475 .cindex "router" "data attached to address"
17476 The string is expanded just before the router is run, that is, after all the
17477 precondition tests have succeeded. If the expansion is forced to fail, the
17478 router declines, the value of &%address_data%& remains unchanged, and the
17479 &%more%& option controls what happens next. Other expansion failures cause
17480 delivery of the address to be deferred.
17481
17482 .vindex "&$address_data$&"
17483 When the expansion succeeds, the value is retained with the address, and can be
17484 accessed using the variable &$address_data$& in the current router, subsequent
17485 routers, and the eventual transport.
17486
17487 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17488 that runs a user's filter file, the contents of &$address_data$& are accessible
17489 in the filter. This is not normally a problem, because such data is usually
17490 either not confidential or it &"belongs"& to the current user, but if you do
17491 put confidential data into &$address_data$& you need to remember this point.
17492
17493 Even if the router declines or passes, the value of &$address_data$& remains
17494 with the address, though it can be changed by another &%address_data%& setting
17495 on a subsequent router. If a router generates child addresses, the value of
17496 &$address_data$& propagates to them. This also applies to the special kind of
17497 &"child"& that is generated by a router with the &%unseen%& option.
17498
17499 The idea of &%address_data%& is that you can use it to look up a lot of data
17500 for the address once, and then pick out parts of the data later. For example,
17501 you could use a single LDAP lookup to return a string of the form
17502 .code
17503 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17504 .endd
17505 In the transport you could pick out the mailbox by a setting such as
17506 .code
17507 file = ${extract{mailbox}{$address_data}}
17508 .endd
17509 This makes the configuration file less messy, and also reduces the number of
17510 lookups (though Exim does cache lookups).
17511
17512 .vindex "&$sender_address_data$&"
17513 .vindex "&$address_data$&"
17514 The &%address_data%& facility is also useful as a means of passing information
17515 from one router to another, and from a router to a transport. In addition, if
17516 &$address_data$& is set by a router when verifying a recipient address from an
17517 ACL, it remains available for use in the rest of the ACL statement. After
17518 verifying a sender, the value is transferred to &$sender_address_data$&.
17519
17520
17521
17522 .option address_test routers&!? boolean true
17523 .oindex "&%-bt%&"
17524 .cindex "router" "skipping when address testing"
17525 If this option is set false, the router is skipped when routing is being tested
17526 by means of the &%-bt%& command line option. This can be a convenience when
17527 your first router sends messages to an external scanner, because it saves you
17528 having to set the &"already scanned"& indicator when testing real address
17529 routing.
17530
17531
17532
17533 .option cannot_route_message routers string&!! unset
17534 .cindex "router" "customizing &""cannot route""& message"
17535 .cindex "customizing" "&""cannot route""& message"
17536 This option specifies a text message that is used when an address cannot be
17537 routed because Exim has run out of routers. The default message is
17538 &"Unrouteable address"&. This option is useful only on routers that have
17539 &%more%& set false, or on the very last router in a configuration, because the
17540 value that is used is taken from the last router that is considered. This
17541 includes a router that is skipped because its preconditions are not met, as
17542 well as a router that declines. For example, using the default configuration,
17543 you could put:
17544 .code
17545 cannot_route_message = Remote domain not found in DNS
17546 .endd
17547 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17548 and
17549 .code
17550 cannot_route_message = Unknown local user
17551 .endd
17552 on the final router that checks for local users. If string expansion fails for
17553 this option, the default message is used. Unless the expansion failure was
17554 explicitly forced, a message about the failure is written to the main and panic
17555 logs, in addition to the normal message about the routing failure.
17556
17557
17558 .option caseful_local_part routers boolean false
17559 .cindex "case of local parts"
17560 .cindex "router" "case of local parts"
17561 By default, routers handle the local parts of addresses in a case-insensitive
17562 manner, though the actual case is preserved for transmission with the message.
17563 If you want the case of letters to be significant in a router, you must set
17564 this option true. For individual router options that contain address or local
17565 part lists (for example, &%local_parts%&), case-sensitive matching can be
17566 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17567 more details.
17568
17569 .vindex "&$local_part$&"
17570 .vindex "&$original_local_part$&"
17571 .vindex "&$parent_local_part$&"
17572 The value of the &$local_part$& variable is forced to lower case while a
17573 router is running unless &%caseful_local_part%& is set. When a router assigns
17574 an address to a transport, the value of &$local_part$& when the transport runs
17575 is the same as it was in the router. Similarly, when a router generates child
17576 addresses by aliasing or forwarding, the values of &$original_local_part$&
17577 and &$parent_local_part$& are those that were used by the redirecting router.
17578
17579 This option applies to the processing of an address by a router. When a
17580 recipient address is being processed in an ACL, there is a separate &%control%&
17581 modifier that can be used to specify case-sensitive processing within the ACL
17582 (see section &<<SECTcontrols>>&).
17583
17584
17585
17586 .option check_local_user routers&!? boolean false
17587 .cindex "local user, checking in router"
17588 .cindex "router" "checking for local user"
17589 .cindex "&_/etc/passwd_&"
17590 .vindex "&$home$&"
17591 When this option is true, Exim checks that the local part of the recipient
17592 address (with affixes removed if relevant) is the name of an account on the
17593 local system. The check is done by calling the &[getpwnam()]& function rather
17594 than trying to read &_/etc/passwd_& directly. This means that other methods of
17595 holding password data (such as NIS) are supported. If the local part is a local
17596 user, &$home$& is set from the password data, and can be tested in other
17597 preconditions that are evaluated after this one (the order of evaluation is
17598 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17599 overridden by &%router_home_directory%&. If the local part is not a local user,
17600 the router is skipped.
17601
17602 If you want to check that the local part is either the name of a local user
17603 or matches something else, you cannot combine &%check_local_user%& with a
17604 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17605 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17606 setting to achieve this. For example:
17607 .code
17608 local_parts = passwd;$local_part : lsearch;/etc/other/users
17609 .endd
17610 Note, however, that the side effects of &%check_local_user%& (such as setting
17611 up a home directory) do not occur when a &(passwd)& lookup is used in a
17612 &%local_parts%& (or any other) precondition.
17613
17614
17615
17616 .option condition routers&!? string&!! unset
17617 .cindex "router" "customized precondition"
17618 This option specifies a general precondition test that has to succeed for the
17619 router to be called. The &%condition%& option is the last precondition to be
17620 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17621 result is a forced failure, or an empty string, or one of the strings &"0"& or
17622 &"no"& or &"false"& (checked without regard to the case of the letters), the
17623 router is skipped, and the address is offered to the next one.
17624
17625 If the result is any other value, the router is run (as this is the last
17626 precondition to be evaluated, all the other preconditions must be true).
17627
17628 This option is unusual in that multiple &%condition%& options may be present.
17629 All &%condition%& options must succeed.
17630
17631 The &%condition%& option provides a means of applying custom conditions to the
17632 running of routers. Note that in the case of a simple conditional expansion,
17633 the default expansion values are exactly what is wanted. For example:
17634 .code
17635 condition = ${if >{$message_age}{600}}
17636 .endd
17637 Because of the default behaviour of the string expansion, this is equivalent to
17638 .code
17639 condition = ${if >{$message_age}{600}{true}{}}
17640 .endd
17641
17642 A multiple condition example, which succeeds:
17643 .code
17644 condition = ${if >{$message_age}{600}}
17645 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17646 condition = foobar
17647 .endd
17648
17649 If the expansion fails (other than forced failure) delivery is deferred. Some
17650 of the other precondition options are common special cases that could in fact
17651 be specified using &%condition%&.
17652
17653 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17654 are far older, and use one set of semantics.  ACLs are newer and when
17655 they were created, the ACL &%condition%& process was given far stricter
17656 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17657 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17658 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17659 Router rules processing behavior.
17660
17661 This is best illustrated in an example:
17662 .code
17663 # If used in an ACL condition will fail with a syntax error, but
17664 # in a router condition any extra characters are treated as a string
17665
17666 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17667 true {yes} {no}}
17668
17669 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17670  {yes} {no}}
17671 .endd
17672 In each example above, the &%if%& statement actually ends after
17673 &"{google.com}}"&.  Since no true or false braces were defined, the
17674 default &%if%& behavior is to return a boolean true or a null answer
17675 (which evaluates to false). The rest of the line is then treated as a
17676 string. So the first example resulted in the boolean answer &"true"&
17677 with the string &" {yes} {no}}"& appended to it. The second example
17678 resulted in the null output (indicating false) with the string
17679 &" {yes} {no}}"& appended to it.
17680
17681 In fact you can put excess forward braces in too.  In the router
17682 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17683 mean something, like after a &"$"& or when required as part of a
17684 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17685 string characters.
17686
17687 Thus, in a Router, the above expansion strings will both always evaluate
17688 true, as the result of expansion is a non-empty string which doesn't
17689 match an explicit false value.  This can be tricky to debug.  By
17690 contrast, in an ACL either of those strings will always result in an
17691 expansion error because the result doesn't look sufficiently boolean.
17692
17693
17694 .option debug_print routers string&!! unset
17695 .cindex "testing" "variables in drivers"
17696 If this option is set and debugging is enabled (see the &%-d%& command line
17697 option) or in address-testing mode (see the &%-bt%& command line option),
17698 the string is expanded and included in the debugging output.
17699 If expansion of the string fails, the error message is written to the debugging
17700 output, and Exim carries on processing.
17701 This option is provided to help with checking out the values of variables and
17702 so on when debugging router configurations. For example, if a &%condition%&
17703 option appears not to be working, &%debug_print%& can be used to output the
17704 variables it references. The output happens after checks for &%domains%&,
17705 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17706 are tested. A newline is added to the text if it does not end with one.
17707 The variable &$router_name$& contains the name of the router.
17708
17709
17710
17711 .option disable_logging routers boolean false
17712 If this option is set true, nothing is logged for any routing errors
17713 or for any deliveries caused by this router. You should not set this option
17714 unless you really, really know what you are doing. See also the generic
17715 transport option of the same name.
17716
17717 .option dnssec_request_domains routers "domain list&!!" unset
17718 .cindex "MX record" "security"
17719 .cindex "DNSSEC" "MX lookup"
17720 .cindex "security" "MX lookup"
17721 .cindex "DNS" "DNSSEC"
17722 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17723 the dnssec request bit set.
17724 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17725
17726 .option dnssec_require_domains routers "domain list&!!" unset
17727 .cindex "MX record" "security"
17728 .cindex "DNSSEC" "MX lookup"
17729 .cindex "security" "MX lookup"
17730 .cindex "DNS" "DNSSEC"
17731 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17732 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17733 (AD bit) set will be ignored and logged as a host-lookup failure.
17734 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17735
17736
17737 .option domains routers&!? "domain list&!!" unset
17738 .cindex "router" "restricting to specific domains"
17739 .vindex "&$domain_data$&"
17740 If this option is set, the router is skipped unless the current domain matches
17741 the list. If the match is achieved by means of a file lookup, the data that the
17742 lookup returned for the domain is placed in &$domain_data$& for use in string
17743 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17744 a list of the order in which preconditions are evaluated.
17745
17746
17747
17748 .option driver routers string unset
17749 This option must always be set. It specifies which of the available routers is
17750 to be used.
17751
17752
17753 .option dsn_lasthop routers boolean false
17754 .cindex "DSN" "success"
17755 .cindex "Delivery Status Notification" "success"
17756 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17757 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17758 instead send a success DSN as if the next hop does not support DSN.
17759 Not effective on redirect routers.
17760
17761
17762
17763 .option errors_to routers string&!! unset
17764 .cindex "envelope sender"
17765 .cindex "router" "changing address for errors"
17766 If a router successfully handles an address, it may assign the address to a
17767 transport for delivery or it may generate child addresses. In both cases, if
17768 there is a delivery problem during later processing, the resulting bounce
17769 message is sent to the address that results from expanding this string,
17770 provided that the address verifies successfully. The &%errors_to%& option is
17771 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17772
17773 The &%errors_to%& setting associated with an address can be overridden if it
17774 subsequently passes through other routers that have their own &%errors_to%&
17775 settings, or if the message is delivered by a transport with a &%return_path%&
17776 setting.
17777
17778 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17779 the expansion fails to verify, the errors address associated with the incoming
17780 address is used. At top level, this is the envelope sender. A non-forced
17781 expansion failure causes delivery to be deferred.
17782
17783 If an address for which &%errors_to%& has been set ends up being delivered over
17784 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17785 any bounces that are generated by other MTAs on the delivery route are also
17786 sent there. You can set &%errors_to%& to the empty string by either of these
17787 settings:
17788 .code
17789 errors_to =
17790 errors_to = ""
17791 .endd
17792 An expansion item that yields an empty string has the same effect. If you do
17793 this, a locally detected delivery error for addresses processed by this router
17794 no longer gives rise to a bounce message; the error is discarded. If the
17795 address is delivered to a remote host, the return path is set to &`<>`&, unless
17796 overridden by the &%return_path%& option on the transport.
17797
17798 .vindex "&$address_data$&"
17799 If for some reason you want to discard local errors, but use a non-empty
17800 MAIL command for remote delivery, you can preserve the original return
17801 path in &$address_data$& in the router, and reinstate it in the transport by
17802 setting &%return_path%&.
17803
17804 The most common use of &%errors_to%& is to direct mailing list bounces to the
17805 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17806 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17807
17808
17809
17810 .option expn routers&!? boolean true
17811 .cindex "address" "testing"
17812 .cindex "testing" "addresses"
17813 .cindex "EXPN" "router skipping"
17814 .cindex "router" "skipping for EXPN"
17815 If this option is turned off, the router is skipped when testing an address
17816 as a result of processing an SMTP EXPN command. You might, for example,
17817 want to turn it off on a router for users' &_.forward_& files, while leaving it
17818 on for the system alias file.
17819 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17820 are evaluated.
17821
17822 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17823 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17824 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17825
17826
17827
17828 .option fail_verify routers boolean false
17829 .cindex "router" "forcing verification failure"
17830 Setting this option has the effect of setting both &%fail_verify_sender%& and
17831 &%fail_verify_recipient%& to the same value.
17832
17833
17834
17835 .option fail_verify_recipient routers boolean false
17836 If this option is true and an address is accepted by this router when
17837 verifying a recipient, verification fails.
17838
17839
17840
17841 .option fail_verify_sender routers boolean false
17842 If this option is true and an address is accepted by this router when
17843 verifying a sender, verification fails.
17844
17845
17846
17847 .option fallback_hosts routers "string list" unset
17848 .cindex "router" "fallback hosts"
17849 .cindex "fallback" "hosts specified on router"
17850 String expansion is not applied to this option. The argument must be a
17851 colon-separated list of host names or IP addresses. The list separator can be
17852 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17853 each name or address. In fact, the format of each item is exactly the same as
17854 defined for the list of hosts in a &(manualroute)& router (see section
17855 &<<SECTformatonehostitem>>&).
17856
17857 If a router queues an address for a remote transport, this host list is
17858 associated with the address, and used instead of the transport's fallback host
17859 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17860 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17861 transport for further details.
17862
17863
17864 .option group routers string&!! "see below"
17865 .cindex "gid (group id)" "local delivery"
17866 .cindex "local transports" "uid and gid"
17867 .cindex "transport" "local"
17868 .cindex "router" "setting group"
17869 When a router queues an address for a transport, and the transport does not
17870 specify a group, the group given here is used when running the delivery
17871 process.
17872 The group may be specified numerically or by name. If expansion fails, the
17873 error is logged and delivery is deferred.
17874 The default is unset, unless &%check_local_user%& is set, when the default
17875 is taken from the password information. See also &%initgroups%& and &%user%&
17876 and the discussion in chapter &<<CHAPenvironment>>&.
17877
17878
17879
17880 .option headers_add routers list&!! unset
17881 .cindex "header lines" "adding"
17882 .cindex "router" "adding header lines"
17883 This option specifies a list of text headers,
17884 newline-separated (by default, changeable in the usual way),
17885 that is associated with any addresses that are accepted by the router.
17886 Each item is separately expanded, at routing time.  However, this
17887 option has no effect when an address is just being verified. The way in which
17888 the text is used to add header lines at transport time is described in section
17889 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17890 message is in the process of being transported. This means that references to
17891 header lines in string expansions in the transport's configuration do not
17892 &"see"& the added header lines.
17893
17894 The &%headers_add%& option is expanded after &%errors_to%&, but before
17895 &%headers_remove%& and &%transport%&. If an item is empty, or if
17896 an item expansion is forced to fail, the item has no effect. Other expansion
17897 failures are treated as configuration errors.
17898
17899 Unlike most options, &%headers_add%& can be specified multiple times
17900 for a router; all listed headers are added.
17901
17902 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17903 router that has the &%one_time%& option set.
17904
17905 .cindex "duplicate addresses"
17906 .oindex "&%unseen%&"
17907 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17908 additions are deleted when the address is passed on to subsequent routers.
17909 For a &%redirect%& router, if a generated address is the same as the incoming
17910 address, this can lead to duplicate addresses with different header
17911 modifications. Exim does not do duplicate deliveries (except, in certain
17912 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17913 which of the duplicates is discarded, so this ambiguous situation should be
17914 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17915
17916
17917
17918 .option headers_remove routers list&!! unset
17919 .cindex "header lines" "removing"
17920 .cindex "router" "removing header lines"
17921 This option specifies a list of text headers,
17922 colon-separated (by default, changeable in the usual way),
17923 that is associated with any addresses that are accepted by the router.
17924 Each item is separately expanded, at routing time.  However, this
17925 option has no effect when an address is just being verified. The way in which
17926 the text is used to remove header lines at transport time is described in
17927 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17928 the message is in the process of being transported. This means that references
17929 to header lines in string expansions in the transport's configuration still
17930 &"see"& the original header lines.
17931
17932 The &%headers_remove%& option is expanded after &%errors_to%& and
17933 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17934 the item has no effect. Other expansion failures are treated as configuration
17935 errors.
17936
17937 Unlike most options, &%headers_remove%& can be specified multiple times
17938 for a router; all listed headers are removed.
17939
17940 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17941 router that has the &%one_time%& option set.
17942
17943 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17944 removal requests are deleted when the address is passed on to subsequent
17945 routers, and this can lead to problems with duplicates -- see the similar
17946 warning for &%headers_add%& above.
17947
17948 &*Warning 3*&: Because of the separate expansion of the list items,
17949 items that contain a list separator must have it doubled.
17950 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17951
17952
17953
17954 .option ignore_target_hosts routers "host list&!!" unset
17955 .cindex "IP address" "discarding"
17956 .cindex "router" "discarding IP addresses"
17957 Although this option is a host list, it should normally contain IP address
17958 entries rather than names. If any host that is looked up by the router has an
17959 IP address that matches an item in this list, Exim behaves as if that IP
17960 address did not exist. This option allows you to cope with rogue DNS entries
17961 like
17962 .code
17963 remote.domain.example.  A  127.0.0.1
17964 .endd
17965 by setting
17966 .code
17967 ignore_target_hosts = 127.0.0.1
17968 .endd
17969 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17970 discarded in this way, the router declines. In a conventional configuration, an
17971 attempt to mail to such a domain would normally provoke the &"unrouteable
17972 domain"& error, and an attempt to verify an address in the domain would fail.
17973 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17974 router declines if presented with one of the listed addresses.
17975
17976 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17977 means of the first or the second of the following settings, respectively:
17978 .code
17979 ignore_target_hosts = 0.0.0.0/0
17980 ignore_target_hosts = <; 0::0/0
17981 .endd
17982 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17983 in the second line matches all IPv6 addresses.
17984
17985 This option may also be useful for ignoring link-local and site-local IPv6
17986 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17987 is expanded before use as a list, it is possible to make it dependent on the
17988 domain that is being routed.
17989
17990 .vindex "&$host_address$&"
17991 During its expansion, &$host_address$& is set to the IP address that is being
17992 checked.
17993
17994 .option initgroups routers boolean false
17995 .cindex "additional groups"
17996 .cindex "groups" "additional"
17997 .cindex "local transports" "uid and gid"
17998 .cindex "transport" "local"
17999 If the router queues an address for a transport, and this option is true, and
18000 the uid supplied by the router is not overridden by the transport, the
18001 &[initgroups()]& function is called when running the transport to ensure that
18002 any additional groups associated with the uid are set up. See also &%group%&
18003 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18004
18005
18006
18007 .option local_part_prefix routers&!? "string list" unset
18008 .cindex "router" "prefix for local part"
18009 .cindex "prefix" "for local part, used in router"
18010 If this option is set, the router is skipped unless the local part starts with
18011 one of the given strings, or &%local_part_prefix_optional%& is true. See
18012 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18013 evaluated.
18014
18015 The list is scanned from left to right, and the first prefix that matches is
18016 used. A limited form of wildcard is available; if the prefix begins with an
18017 asterisk, it matches the longest possible sequence of arbitrary characters at
18018 the start of the local part. An asterisk should therefore always be followed by
18019 some character that does not occur in normal local parts.
18020 .cindex "multiple mailboxes"
18021 .cindex "mailbox" "multiple"
18022 Wildcarding can be used to set up multiple user mailboxes, as described in
18023 section &<<SECTmulbox>>&.
18024
18025 .vindex "&$local_part$&"
18026 .vindex "&$local_part_prefix$&"
18027 During the testing of the &%local_parts%& option, and while the router is
18028 running, the prefix is removed from the local part, and is available in the
18029 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18030 the router accepts the address, this remains true during subsequent delivery by
18031 a transport. In particular, the local part that is transmitted in the RCPT
18032 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18033 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18034 the relevant transport.
18035
18036 When an address is being verified, &%local_part_prefix%& affects only the
18037 behaviour of the router. If the callout feature of verification is in use, this
18038 means that the full address, including the prefix, will be used during the
18039 callout.
18040
18041 The prefix facility is commonly used to handle local parts of the form
18042 &%owner-something%&. Another common use is to support local parts of the form
18043 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18044 to tell a user their forwarding is broken &-- by placing a router like this one
18045 immediately before the router that handles &_.forward_& files:
18046 .code
18047 real_localuser:
18048   driver = accept
18049   local_part_prefix = real-
18050   check_local_user
18051   transport = local_delivery
18052 .endd
18053 For security, it would probably be a good idea to restrict the use of this
18054 router to locally-generated messages, using a condition such as this:
18055 .code
18056   condition = ${if match {$sender_host_address}\
18057                          {\N^(|127\.0\.0\.1)$\N}}
18058 .endd
18059
18060 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18061 both conditions must be met if not optional. Care must be taken if wildcards
18062 are used in both a prefix and a suffix on the same router. Different
18063 separator characters must be used to avoid ambiguity.
18064
18065
18066 .option local_part_prefix_optional routers boolean false
18067 See &%local_part_prefix%& above.
18068
18069
18070
18071 .option local_part_suffix routers&!? "string list" unset
18072 .cindex "router" "suffix for local part"
18073 .cindex "suffix for local part" "used in router"
18074 This option operates in the same way as &%local_part_prefix%&, except that the
18075 local part must end (rather than start) with the given string, the
18076 &%local_part_suffix_optional%& option determines whether the suffix is
18077 mandatory, and the wildcard * character, if present, must be the last
18078 character of the suffix. This option facility is commonly used to handle local
18079 parts of the form &%something-request%& and multiple user mailboxes of the form
18080 &%username-foo%&.
18081
18082
18083 .option local_part_suffix_optional routers boolean false
18084 See &%local_part_suffix%& above.
18085
18086
18087
18088 .option local_parts routers&!? "local part list&!!" unset
18089 .cindex "router" "restricting to specific local parts"
18090 .cindex "local part" "checking in router"
18091 The router is run only if the local part of the address matches the list.
18092 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18093 are evaluated, and
18094 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18095 string is expanded, it is possible to make it depend on the domain, for
18096 example:
18097 .code
18098 local_parts = dbm;/usr/local/specials/$domain
18099 .endd
18100 .vindex "&$local_part_data$&"
18101 If the match is achieved by a lookup, the data that the lookup returned
18102 for the local part is placed in the variable &$local_part_data$& for use in
18103 expansions of the router's private options. You might use this option, for
18104 example, if you have a large number of local virtual domains, and you want to
18105 send all postmaster mail to the same place without having to set up an alias in
18106 each virtual domain:
18107 .code
18108 postmaster:
18109   driver = redirect
18110   local_parts = postmaster
18111   data = postmaster@real.domain.example
18112 .endd
18113
18114
18115 .option log_as_local routers boolean "see below"
18116 .cindex "log" "delivery line"
18117 .cindex "delivery" "log line format"
18118 Exim has two logging styles for delivery, the idea being to make local
18119 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18120 recipient address is given just as the local part, without a domain. The use of
18121 this style is controlled by this option. It defaults to true for the &(accept)&
18122 router, and false for all the others. This option applies only when a
18123 router assigns an address to a transport. It has no effect on routers that
18124 redirect addresses.
18125
18126
18127
18128 .option more routers boolean&!! true
18129 The result of string expansion for this option must be a valid boolean value,
18130 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18131 result causes an error, and delivery is deferred. If the expansion is forced to
18132 fail, the default value for the option (true) is used. Other failures cause
18133 delivery to be deferred.
18134
18135 If this option is set false, and the router declines to handle the address, no
18136 further routers are tried, routing fails, and the address is bounced.
18137 .oindex "&%self%&"
18138 However, if the router explicitly passes an address to the following router by
18139 means of the setting
18140 .code
18141 self = pass
18142 .endd
18143 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18144 does not affect the behaviour if one of the precondition tests fails. In that
18145 case, the address is always passed to the next router.
18146
18147 Note that &%address_data%& is not considered to be a precondition. If its
18148 expansion is forced to fail, the router declines, and the value of &%more%&
18149 controls what happens next.
18150
18151
18152 .option pass_on_timeout routers boolean false
18153 .cindex "timeout" "of router"
18154 .cindex "router" "timeout"
18155 If a router times out during a host lookup, it normally causes deferral of the
18156 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18157 router, overriding &%no_more%&. This may be helpful for systems that are
18158 intermittently connected to the Internet, or those that want to pass to a smart
18159 host any messages that cannot immediately be delivered.
18160
18161 There are occasional other temporary errors that can occur while doing DNS
18162 lookups. They are treated in the same way as a timeout, and this option
18163 applies to all of them.
18164
18165
18166
18167 .option pass_router routers string unset
18168 .cindex "router" "go to after &""pass""&"
18169 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18170 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18171 routing to continue, and overriding a false setting of &%more%&. When one of
18172 these routers returns &"pass"&, the address is normally handed on to the next
18173 router in sequence. This can be changed by setting &%pass_router%& to the name
18174 of another router. However (unlike &%redirect_router%&) the named router must
18175 be below the current router, to avoid loops. Note that this option applies only
18176 to the special case of &"pass"&. It does not apply when a router returns
18177 &"decline"& because it cannot handle an address.
18178
18179
18180
18181 .option redirect_router routers string unset
18182 .cindex "router" "start at after redirection"
18183 Sometimes an administrator knows that it is pointless to reprocess addresses
18184 generated from alias or forward files with the same router again. For
18185 example, if an alias file translates real names into login ids there is no
18186 point searching the alias file a second time, especially if it is a large file.
18187
18188 The &%redirect_router%& option can be set to the name of any router instance.
18189 It causes the routing of any generated addresses to start at the named router
18190 instead of at the first router. This option has no effect if the router in
18191 which it is set does not generate new addresses.
18192
18193
18194
18195 .option require_files routers&!? "string list&!!" unset
18196 .cindex "file" "requiring for router"
18197 .cindex "router" "requiring file existence"
18198 This option provides a general mechanism for predicating the running of a
18199 router on the existence or non-existence of certain files or directories.
18200 Before running a router, as one of its precondition tests, Exim works its way
18201 through the &%require_files%& list, expanding each item separately.
18202
18203 Because the list is split before expansion, any colons in expansion items must
18204 be doubled, or the facility for using a different list separator must be used.
18205 If any expansion is forced to fail, the item is ignored. Other expansion
18206 failures cause routing of the address to be deferred.
18207
18208 If any expanded string is empty, it is ignored. Otherwise, except as described
18209 below, each string must be a fully qualified file path, optionally preceded by
18210 &"!"&. The paths are passed to the &[stat()]& function to test for the
18211 existence of the files or directories. The router is skipped if any paths not
18212 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18213
18214 .cindex "NFS"
18215 If &[stat()]& cannot determine whether a file exists or not, delivery of
18216 the message is deferred. This can happen when NFS-mounted filesystems are
18217 unavailable.
18218
18219 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18220 options, so you cannot use it to check for the existence of a file in which to
18221 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18222 full list of the order in which preconditions are evaluated.) However, as
18223 these options are all expanded, you can use the &%exists%& expansion condition
18224 to make such tests. The &%require_files%& option is intended for checking files
18225 that the router may be going to use internally, or which are needed by a
18226 transport (for example &_.procmailrc_&).
18227
18228 During delivery, the &[stat()]& function is run as root, but there is a
18229 facility for some checking of the accessibility of a file by another user.
18230 This is not a proper permissions check, but just a &"rough"& check that
18231 operates as follows:
18232
18233 If an item in a &%require_files%& list does not contain any forward slash
18234 characters, it is taken to be the user (and optional group, separated by a
18235 comma) to be checked for subsequent files in the list. If no group is specified
18236 but the user is specified symbolically, the gid associated with the uid is
18237 used. For example:
18238 .code
18239 require_files = mail:/some/file
18240 require_files = $local_part:$home/.procmailrc
18241 .endd
18242 If a user or group name in a &%require_files%& list does not exist, the
18243 &%require_files%& condition fails.
18244
18245 Exim performs the check by scanning along the components of the file path, and
18246 checking the access for the given uid and gid. It checks for &"x"& access on
18247 directories, and &"r"& access on the final file. Note that this means that file
18248 access control lists, if the operating system has them, are ignored.
18249
18250 &*Warning 1*&: When the router is being run to verify addresses for an
18251 incoming SMTP message, Exim is not running as root, but under its own uid. This
18252 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18253 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18254 user is not permitted to read one of the directories on the file's path.
18255
18256 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18257 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18258 without root access. In this case, if a check for access by a particular user
18259 is requested, Exim creates a subprocess that runs as that user, and tries the
18260 check again in that process.
18261
18262 The default action for handling an unresolved EACCES is to consider it to
18263 be caused by a configuration error, and routing is deferred because the
18264 existence or non-existence of the file cannot be determined. However, in some
18265 circumstances it may be desirable to treat this condition as if the file did
18266 not exist. If the file name (or the exclamation mark that precedes the file
18267 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18268 as if the file did not exist. For example:
18269 .code
18270 require_files = +/some/file
18271 .endd
18272 If the router is not an essential part of verification (for example, it
18273 handles users' &_.forward_& files), another solution is to set the &%verify%&
18274 option false so that the router is skipped when verifying.
18275
18276
18277
18278 .option retry_use_local_part routers boolean "see below"
18279 .cindex "hints database" "retry keys"
18280 .cindex "local part" "in retry keys"
18281 When a delivery suffers a temporary routing failure, a retry record is created
18282 in Exim's hints database. For addresses whose routing depends only on the
18283 domain, the key for the retry record should not involve the local part, but for
18284 other addresses, both the domain and the local part should be included.
18285 Usually, remote routing is of the former kind, and local routing is of the
18286 latter kind.
18287
18288 This option controls whether the local part is used to form the key for retry
18289 hints for addresses that suffer temporary errors while being handled by this
18290 router. The default value is true for any router that has &%check_local_user%&
18291 set, and false otherwise. Note that this option does not apply to hints keys
18292 for transport delays; they are controlled by a generic transport option of the
18293 same name.
18294
18295 The setting of &%retry_use_local_part%& applies only to the router on which it
18296 appears. If the router generates child addresses, they are routed
18297 independently; this setting does not become attached to them.
18298
18299
18300
18301 .option router_home_directory routers string&!! unset
18302 .cindex "router" "home directory for"
18303 .cindex "home directory" "for router"
18304 .vindex "&$home$&"
18305 This option sets a home directory for use while the router is running. (Compare
18306 &%transport_home_directory%&, which sets a home directory for later
18307 transporting.) In particular, if used on a &(redirect)& router, this option
18308 sets a value for &$home$& while a filter is running. The value is expanded;
18309 forced expansion failure causes the option to be ignored &-- other failures
18310 cause the router to defer.
18311
18312 Expansion of &%router_home_directory%& happens immediately after the
18313 &%check_local_user%& test (if configured), before any further expansions take
18314 place.
18315 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18316 are evaluated.)
18317 While the router is running, &%router_home_directory%& overrides the value of
18318 &$home$& that came from &%check_local_user%&.
18319
18320 When a router accepts an address and assigns it to a local transport (including
18321 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18322 delivery), the home directory setting for the transport is taken from the first
18323 of these values that is set:
18324
18325 .ilist
18326 The &%home_directory%& option on the transport;
18327 .next
18328 The &%transport_home_directory%& option on the router;
18329 .next
18330 The password data if &%check_local_user%& is set on the router;
18331 .next
18332 The &%router_home_directory%& option on the router.
18333 .endlist
18334
18335 In other words, &%router_home_directory%& overrides the password data for the
18336 router, but not for the transport.
18337
18338
18339
18340 .option self routers string freeze
18341 .cindex "MX record" "pointing to local host"
18342 .cindex "local host" "MX pointing to"
18343 This option applies to those routers that use a recipient address to find a
18344 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18345 and &(manualroute)& routers.
18346 Certain configurations of the &(queryprogram)& router can also specify a list
18347 of remote hosts.
18348 Usually such routers are configured to send the message to a remote host via an
18349 &(smtp)& transport. The &%self%& option specifies what happens when the first
18350 host on the list turns out to be the local host.
18351 The way in which Exim checks for the local host is described in section
18352 &<<SECTreclocipadd>>&.
18353
18354 Normally this situation indicates either an error in Exim's configuration (for
18355 example, the router should be configured not to process this domain), or an
18356 error in the DNS (for example, the MX should not point to this host). For this
18357 reason, the default action is to log the incident, defer the address, and
18358 freeze the message. The following alternatives are provided for use in special
18359 cases:
18360
18361 .vlist
18362 .vitem &%defer%&
18363 Delivery of the message is tried again later, but the message is not frozen.
18364
18365 .vitem "&%reroute%&: <&'domain'&>"
18366 The domain is changed to the given domain, and the address is passed back to
18367 be reprocessed by the routers. No rewriting of headers takes place. This
18368 behaviour is essentially a redirection.
18369
18370 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18371 The domain is changed to the given domain, and the address is passed back to be
18372 reprocessed by the routers. Any headers that contain the original domain are
18373 rewritten.
18374
18375 .vitem &%pass%&
18376 .oindex "&%more%&"
18377 .vindex "&$self_hostname$&"
18378 The router passes the address to the next router, or to the router named in the
18379 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18380 subsequent routing and delivery, the variable &$self_hostname$& contains the
18381 name of the local host that the router encountered. This can be used to
18382 distinguish between different cases for hosts with multiple names. The
18383 combination
18384 .code
18385 self = pass
18386 no_more
18387 .endd
18388 ensures that only those addresses that routed to the local host are passed on.
18389 Without &%no_more%&, addresses that were declined for other reasons would also
18390 be passed to the next router.
18391
18392 .vitem &%fail%&
18393 Delivery fails and an error report is generated.
18394
18395 .vitem &%send%&
18396 .cindex "local host" "sending to"
18397 The anomaly is ignored and the address is queued for the transport. This
18398 setting should be used with extreme caution. For an &(smtp)& transport, it
18399 makes sense only in cases where the program that is listening on the SMTP port
18400 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18401 different configuration file that handles the domain in another way.
18402 .endlist
18403
18404
18405
18406 .option senders routers&!? "address list&!!" unset
18407 .cindex "router" "checking senders"
18408 If this option is set, the router is skipped unless the message's sender
18409 address matches something on the list.
18410 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18411 are evaluated.
18412
18413 There are issues concerning verification when the running of routers is
18414 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18415 setting, it sets the sender to the null string. When using the &%-bt%& option
18416 to check a configuration file, it is necessary also to use the &%-f%& option to
18417 set an appropriate sender. For incoming mail, the sender is unset when
18418 verifying the sender, but is available when verifying any recipients. If the
18419 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18420 matters.
18421
18422
18423 .option translate_ip_address routers string&!! unset
18424 .cindex "IP address" "translating"
18425 .cindex "packet radio"
18426 .cindex "router" "IP address translation"
18427 There exist some rare networking situations (for example, packet radio) where
18428 it is helpful to be able to translate IP addresses generated by normal routing
18429 mechanisms into other IP addresses, thus performing a kind of manual IP
18430 routing. This should be done only if the normal IP routing of the TCP/IP stack
18431 is inadequate or broken. Because this is an extremely uncommon requirement, the
18432 code to support this option is not included in the Exim binary unless
18433 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18434
18435 .vindex "&$host_address$&"
18436 The &%translate_ip_address%& string is expanded for every IP address generated
18437 by the router, with the generated address set in &$host_address$&. If the
18438 expansion is forced to fail, no action is taken.
18439 For any other expansion error, delivery of the message is deferred.
18440 If the result of the expansion is an IP address, that replaces the original
18441 address; otherwise the result is assumed to be a host name &-- this is looked
18442 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18443 produce one or more replacement IP addresses. For example, to subvert all IP
18444 addresses in some specific networks, this could be added to a router:
18445 .code
18446 translate_ip_address = \
18447   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18448     {$value}fail}}
18449 .endd
18450 The file would contain lines like
18451 .code
18452 10.2.3.128/26    some.host
18453 10.8.4.34/26     10.44.8.15
18454 .endd
18455 You should not make use of this facility unless you really understand what you
18456 are doing.
18457
18458
18459
18460 .option transport routers string&!! unset
18461 This option specifies the transport to be used when a router accepts an address
18462 and sets it up for delivery. A transport is never needed if a router is used
18463 only for verification. The value of the option is expanded at routing time,
18464 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18465 and result must be the name of one of the configured transports. If it is not,
18466 delivery is deferred.
18467
18468 The &%transport%& option is not used by the &(redirect)& router, but it does
18469 have some private options that set up transports for pipe and file deliveries
18470 (see chapter &<<CHAPredirect>>&).
18471
18472
18473
18474 .option transport_current_directory routers string&!! unset
18475 .cindex "current directory for local transport"
18476 This option associates a current directory with any address that is routed
18477 to a local transport. This can happen either because a transport is
18478 explicitly configured for the router, or because it generates a delivery to a
18479 file or a pipe. During the delivery process (that is, at transport time), this
18480 option string is expanded and is set as the current directory, unless
18481 overridden by a setting on the transport.
18482 If the expansion fails for any reason, including forced failure, an error is
18483 logged, and delivery is deferred.
18484 See chapter &<<CHAPenvironment>>& for details of the local delivery
18485 environment.
18486
18487
18488
18489
18490 .option transport_home_directory routers string&!! "see below"
18491 .cindex "home directory" "for local transport"
18492 This option associates a home directory with any address that is routed to a
18493 local transport. This can happen either because a transport is explicitly
18494 configured for the router, or because it generates a delivery to a file or a
18495 pipe. During the delivery process (that is, at transport time), the option
18496 string is expanded and is set as the home directory, unless overridden by a
18497 setting of &%home_directory%& on the transport.
18498 If the expansion fails for any reason, including forced failure, an error is
18499 logged, and delivery is deferred.
18500
18501 If the transport does not specify a home directory, and
18502 &%transport_home_directory%& is not set for the router, the home directory for
18503 the transport is taken from the password data if &%check_local_user%& is set for
18504 the router. Otherwise it is taken from &%router_home_directory%& if that option
18505 is set; if not, no home directory is set for the transport.
18506
18507 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18508 environment.
18509
18510
18511
18512
18513 .option unseen routers boolean&!! false
18514 .cindex "router" "carrying on after success"
18515 The result of string expansion for this option must be a valid boolean value,
18516 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18517 result causes an error, and delivery is deferred. If the expansion is forced to
18518 fail, the default value for the option (false) is used. Other failures cause
18519 delivery to be deferred.
18520
18521 When this option is set true, routing does not cease if the router accepts the
18522 address. Instead, a copy of the incoming address is passed to the next router,
18523 overriding a false setting of &%more%&. There is little point in setting
18524 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18525 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18526 sometimes true and sometimes false).
18527
18528 .cindex "copy of message (&%unseen%& option)"
18529 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18530 qualifier in filter files. It can be used to cause copies of messages to be
18531 delivered to some other destination, while also carrying out a normal delivery.
18532 In effect, the current address is made into a &"parent"& that has two children
18533 &-- one that is delivered as specified by this router, and a clone that goes on
18534 to be routed further. For this reason, &%unseen%& may not be combined with the
18535 &%one_time%& option in a &(redirect)& router.
18536
18537 &*Warning*&: Header lines added to the address (or specified for removal) by
18538 this router or by previous routers affect the &"unseen"& copy of the message
18539 only. The clone that continues to be processed by further routers starts with
18540 no added headers and none specified for removal. For a &%redirect%& router, if
18541 a generated address is the same as the incoming address, this can lead to
18542 duplicate addresses with different header modifications. Exim does not do
18543 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18544 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18545 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18546 &%redirect%& router may be of help.
18547
18548 Unlike the handling of header modifications, any data that was set by the
18549 &%address_data%& option in the current or previous routers &'is'& passed on to
18550 subsequent routers.
18551
18552
18553 .option user routers string&!! "see below"
18554 .cindex "uid (user id)" "local delivery"
18555 .cindex "local transports" "uid and gid"
18556 .cindex "transport" "local"
18557 .cindex "router" "user for filter processing"
18558 .cindex "filter" "user for processing"
18559 When a router queues an address for a transport, and the transport does not
18560 specify a user, the user given here is used when running the delivery process.
18561 The user may be specified numerically or by name. If expansion fails, the
18562 error is logged and delivery is deferred.
18563 This user is also used by the &(redirect)& router when running a filter file.
18564 The default is unset, except when &%check_local_user%& is set. In this case,
18565 the default is taken from the password information. If the user is specified as
18566 a name, and &%group%& is not set, the group associated with the user is used.
18567 See also &%initgroups%& and &%group%& and the discussion in chapter
18568 &<<CHAPenvironment>>&.
18569
18570
18571
18572 .option verify routers&!? boolean true
18573 Setting this option has the effect of setting &%verify_sender%& and
18574 &%verify_recipient%& to the same value.
18575
18576
18577 .option verify_only routers&!? boolean false
18578 .cindex "EXPN" "with &%verify_only%&"
18579 .oindex "&%-bv%&"
18580 .cindex "router" "used only when verifying"
18581 If this option is set, the router is used only when verifying an address,
18582 delivering in cutthrough mode or
18583 testing with the &%-bv%& option, not when actually doing a delivery, testing
18584 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18585 restricted to verifying only senders or recipients by means of
18586 &%verify_sender%& and &%verify_recipient%&.
18587
18588 &*Warning*&: When the router is being run to verify addresses for an incoming
18589 SMTP message, Exim is not running as root, but under its own uid. If the router
18590 accesses any files, you need to make sure that they are accessible to the Exim
18591 user or group.
18592
18593
18594 .option verify_recipient routers&!? boolean true
18595 If this option is false, the router is skipped when verifying recipient
18596 addresses,
18597 delivering in cutthrough mode
18598 or testing recipient verification using &%-bv%&.
18599 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18600 are evaluated.
18601 See also the &$verify_mode$& variable.
18602
18603
18604 .option verify_sender routers&!? boolean true
18605 If this option is false, the router is skipped when verifying sender addresses
18606 or testing sender verification using &%-bvs%&.
18607 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18608 are evaluated.
18609 See also the &$verify_mode$& variable.
18610 .ecindex IIDgenoprou1
18611 .ecindex IIDgenoprou2
18612
18613
18614
18615
18616
18617
18618 . ////////////////////////////////////////////////////////////////////////////
18619 . ////////////////////////////////////////////////////////////////////////////
18620
18621 .chapter "The accept router" "CHID4"
18622 .cindex "&(accept)& router"
18623 .cindex "routers" "&(accept)&"
18624 The &(accept)& router has no private options of its own. Unless it is being
18625 used purely for verification (see &%verify_only%&) a transport is required to
18626 be defined by the generic &%transport%& option. If the preconditions that are
18627 specified by generic options are met, the router accepts the address and queues
18628 it for the given transport. The most common use of this router is for setting
18629 up deliveries to local mailboxes. For example:
18630 .code
18631 localusers:
18632   driver = accept
18633   domains = mydomain.example
18634   check_local_user
18635   transport = local_delivery
18636 .endd
18637 The &%domains%& condition in this example checks the domain of the address, and
18638 &%check_local_user%& checks that the local part is the login of a local user.
18639 When both preconditions are met, the &(accept)& router runs, and queues the
18640 address for the &(local_delivery)& transport.
18641
18642
18643
18644
18645
18646
18647 . ////////////////////////////////////////////////////////////////////////////
18648 . ////////////////////////////////////////////////////////////////////////////
18649
18650 .chapter "The dnslookup router" "CHAPdnslookup"
18651 .scindex IIDdnsrou1 "&(dnslookup)& router"
18652 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18653 The &(dnslookup)& router looks up the hosts that handle mail for the
18654 recipient's domain in the DNS. A transport must always be set for this router,
18655 unless &%verify_only%& is set.
18656
18657 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18658 SRV records. If none are found, or if SRV support is not configured,
18659 MX records are looked up. If no MX records exist, address records are sought.
18660 However, &%mx_domains%& can be set to disable the direct use of address
18661 records.
18662
18663 MX records of equal priority are sorted by Exim into a random order. Exim then
18664 looks for address records for the host names obtained from MX or SRV records.
18665 When a host has more than one IP address, they are sorted into a random order,
18666 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18667 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18668 generic option, the router declines.
18669
18670 Unless they have the highest priority (lowest MX value), MX records that point
18671 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18672 are discarded, together with any other MX records of equal or lower priority.
18673
18674 .cindex "MX record" "pointing to local host"
18675 .cindex "local host" "MX pointing to"
18676 .oindex "&%self%&" "in &(dnslookup)& router"
18677 If the host pointed to by the highest priority MX record, or looked up as an
18678 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18679 happens is controlled by the generic &%self%& option.
18680
18681
18682 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18683 There have been problems with DNS servers when SRV records are looked up.
18684 Some misbehaving servers return a DNS error or timeout when a non-existent
18685 SRV record is sought. Similar problems have in the past been reported for
18686 MX records. The global &%dns_again_means_nonexist%& option can help with this
18687 problem, but it is heavy-handed because it is a global option.
18688
18689 For this reason, there are two options, &%srv_fail_domains%& and
18690 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18691 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18692 an attempt to look up an SRV or MX record causes one of these results, and the
18693 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18694 such record"&. In the case of an SRV lookup, this means that the router
18695 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18696 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18697 case routing fails.
18698
18699
18700 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18701 .cindex "&(dnslookup)& router" "declines"
18702 There are a few cases where a &(dnslookup)& router will decline to accept
18703 an address; if such a router is expected to handle "all remaining non-local
18704 domains", then it is important to set &%no_more%&.
18705
18706 The router will defer rather than decline if the domain
18707 is found in the &%fail_defer_domains%& router option.
18708
18709 Reasons for a &(dnslookup)& router to decline currently include:
18710 .ilist
18711 The domain does not exist in DNS
18712 .next
18713 The domain exists but the MX record's host part is just "."; this is a common
18714 convention (borrowed from SRV) used to indicate that there is no such service
18715 for this domain and to not fall back to trying A/AAAA records.
18716 .next
18717 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18718 .next
18719 MX record points to a non-existent host.
18720 .next
18721 MX record points to an IP address and the main section option
18722 &%allow_mx_to_ip%& is not set.
18723 .next
18724 MX records exist and point to valid hosts, but all hosts resolve only to
18725 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18726 .next
18727 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18728 &%dns_check_names_pattern%& for handling one variant of this)
18729 .next
18730 &%check_secondary_mx%& is set on this router but the local host can
18731 not be found in the MX records (see below)
18732 .endlist
18733
18734
18735
18736
18737 .section "Private options for dnslookup" "SECID118"
18738 .cindex "options" "&(dnslookup)& router"
18739 The private options for the &(dnslookup)& router are as follows:
18740
18741 .option check_secondary_mx dnslookup boolean false
18742 .cindex "MX record" "checking for secondary"
18743 If this option is set, the router declines unless the local host is found in
18744 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18745 process domains for which the local host is a secondary mail exchanger
18746 differently to other domains. The way in which Exim decides whether a host is
18747 the local host is described in section &<<SECTreclocipadd>>&.
18748
18749
18750 .option check_srv dnslookup string&!! unset
18751 .cindex "SRV record" "enabling use of"
18752 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18753 addition to MX and address records. The support is disabled by default. To
18754 enable SRV support, set the &%check_srv%& option to the name of the service
18755 required. For example,
18756 .code
18757 check_srv = smtp
18758 .endd
18759 looks for SRV records that refer to the normal smtp service. The option is
18760 expanded, so the service name can vary from message to message or address
18761 to address. This might be helpful if SRV records are being used for a
18762 submission service. If the expansion is forced to fail, the &%check_srv%&
18763 option is ignored, and the router proceeds to look for MX records in the
18764 normal way.
18765
18766 When the expansion succeeds, the router searches first for SRV records for
18767 the given service (it assumes TCP protocol). A single SRV record with a
18768 host name that consists of just a single dot indicates &"no such service for
18769 this domain"&; if this is encountered, the router declines. If other kinds of
18770 SRV record are found, they are used to construct a host list for delivery
18771 according to the rules of RFC 2782. MX records are not sought in this case.
18772
18773 When no SRV records are found, MX records (and address records) are sought in
18774 the traditional way. In other words, SRV records take precedence over MX
18775 records, just as MX records take precedence over address records. Note that
18776 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18777 defined it. It is apparently believed that MX records are sufficient for email
18778 and that SRV records should not be used for this purpose. However, SRV records
18779 have an additional &"weight"& feature which some people might find useful when
18780 trying to split an SMTP load between hosts of different power.
18781
18782 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18783 when there is a DNS lookup error.
18784
18785
18786
18787
18788 .option fail_defer_domains dnslookup "domain list&!!" unset
18789 .cindex "MX record" "not found"
18790 DNS lookups for domains matching &%fail_defer_domains%&
18791 which find no matching record will cause the router to defer
18792 rather than the default behaviour of decline.
18793 This maybe be useful for queueing messages for a newly created
18794 domain while the DNS configuration is not ready.
18795 However, it will result in any message with mistyped domains
18796 also being queued.
18797
18798
18799 .option mx_domains dnslookup "domain list&!!" unset
18800 .cindex "MX record" "required to exist"
18801 .cindex "SRV record" "required to exist"
18802 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18803 record in order to be recognized. (The name of this option could be improved.)
18804 For example, if all the mail hosts in &'fict.example'& are known to have MX
18805 records, except for those in &'discworld.fict.example'&, you could use this
18806 setting:
18807 .code
18808 mx_domains = ! *.discworld.fict.example : *.fict.example
18809 .endd
18810 This specifies that messages addressed to a domain that matches the list but
18811 has no MX record should be bounced immediately instead of being routed using
18812 the address record.
18813
18814
18815 .option mx_fail_domains dnslookup "domain list&!!" unset
18816 If the DNS lookup for MX records for one of the domains in this list causes a
18817 DNS lookup error, Exim behaves as if no MX records were found. See section
18818 &<<SECTprowitdnsloo>>& for more discussion.
18819
18820
18821
18822
18823 .option qualify_single dnslookup boolean true
18824 .cindex "DNS" "resolver options"
18825 .cindex "DNS" "qualifying single-component names"
18826 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18827 lookups. Typically, but not standardly, this causes the resolver to qualify
18828 single-component names with the default domain. For example, on a machine
18829 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18830 &'thesaurus.ref.example'& inside the resolver. For details of what your
18831 resolver actually does, consult your man pages for &'resolver'& and
18832 &'resolv.conf'&.
18833
18834
18835
18836 .option rewrite_headers dnslookup boolean true
18837 .cindex "rewriting" "header lines"
18838 .cindex "header lines" "rewriting"
18839 If the domain name in the address that is being processed is not fully
18840 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18841 an address is specified as &'dormouse@teaparty'&, the domain might be
18842 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18843 occur as a result of setting the &%widen_domains%& option. If
18844 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18845 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18846 header lines of the message are rewritten with the full domain name.
18847
18848 This option should be turned off only when it is known that no message is
18849 ever going to be sent outside an environment where the abbreviation makes
18850 sense.
18851
18852 When an MX record is looked up in the DNS and matches a wildcard record, name
18853 servers normally return a record containing the name that has been looked up,
18854 making it impossible to detect whether a wildcard was present or not. However,
18855 some name servers have recently been seen to return the wildcard entry. If the
18856 name returned by a DNS lookup begins with an asterisk, it is not used for
18857 header rewriting.
18858
18859
18860 .option same_domain_copy_routing dnslookup boolean false
18861 .cindex "address" "copying routing"
18862 Addresses with the same domain are normally routed by the &(dnslookup)& router
18863 to the same list of hosts. However, this cannot be presumed, because the router
18864 options and preconditions may refer to the local part of the address. By
18865 default, therefore, Exim routes each address in a message independently. DNS
18866 servers run caches, so repeated DNS lookups are not normally expensive, and in
18867 any case, personal messages rarely have more than a few recipients.
18868
18869 If you are running mailing lists with large numbers of subscribers at the same
18870 domain, and you are using a &(dnslookup)& router which is independent of the
18871 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18872 lookups for identical domains in one message. In this case, when &(dnslookup)&
18873 routes an address to a remote transport, any other unrouted addresses in the
18874 message that have the same domain are automatically given the same routing
18875 without processing them independently,
18876 provided the following conditions are met:
18877
18878 .ilist
18879 No router that processed the address specified &%headers_add%& or
18880 &%headers_remove%&.
18881 .next
18882 The router did not change the address in any way, for example, by &"widening"&
18883 the domain.
18884 .endlist
18885
18886
18887
18888
18889 .option search_parents dnslookup boolean false
18890 .cindex "DNS" "resolver options"
18891 When this option is true, the resolver option RES_DNSRCH is set for DNS
18892 lookups. This is different from the &%qualify_single%& option in that it
18893 applies to domains containing dots. Typically, but not standardly, it causes
18894 the resolver to search for the name in the current domain and in parent
18895 domains. For example, on a machine in the &'fict.example'& domain, if looking
18896 up &'teaparty.wonderland'& failed, the resolver would try
18897 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18898 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18899
18900 Setting this option true can cause problems in domains that have a wildcard MX
18901 record, because any domain that does not have its own MX record matches the
18902 local wildcard.
18903
18904
18905
18906 .option srv_fail_domains dnslookup "domain list&!!" unset
18907 If the DNS lookup for SRV records for one of the domains in this list causes a
18908 DNS lookup error, Exim behaves as if no SRV records were found. See section
18909 &<<SECTprowitdnsloo>>& for more discussion.
18910
18911
18912
18913
18914 .option widen_domains dnslookup "string list" unset
18915 .cindex "domain" "partial; widening"
18916 If a DNS lookup fails and this option is set, each of its strings in turn is
18917 added onto the end of the domain, and the lookup is tried again. For example,
18918 if
18919 .code
18920 widen_domains = fict.example:ref.example
18921 .endd
18922 is set and a lookup of &'klingon.dictionary'& fails,
18923 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18924 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18925 and &%search_parents%& options can cause some widening to be undertaken inside
18926 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18927 when verifying, unless &%rewrite_headers%& is false (not the default).
18928
18929
18930 .section "Effect of qualify_single and search_parents" "SECID119"
18931 When a domain from an envelope recipient is changed by the resolver as a result
18932 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18933 corresponding address in the message's header lines unless &%rewrite_headers%&
18934 is set false. Exim then re-routes the address, using the full domain.
18935
18936 These two options affect only the DNS lookup that takes place inside the router
18937 for the domain of the address that is being routed. They do not affect lookups
18938 such as that implied by
18939 .code
18940 domains = @mx_any
18941 .endd
18942 that may happen while processing a router precondition before the router is
18943 entered. No widening ever takes place for these lookups.
18944 .ecindex IIDdnsrou1
18945 .ecindex IIDdnsrou2
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955 . ////////////////////////////////////////////////////////////////////////////
18956 . ////////////////////////////////////////////////////////////////////////////
18957
18958 .chapter "The ipliteral router" "CHID5"
18959 .cindex "&(ipliteral)& router"
18960 .cindex "domain literal" "routing"
18961 .cindex "routers" "&(ipliteral)&"
18962 This router has no private options. Unless it is being used purely for
18963 verification (see &%verify_only%&) a transport is required to be defined by the
18964 generic &%transport%& option. The router accepts the address if its domain part
18965 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18966 router handles the address
18967 .code
18968 root@[192.168.1.1]
18969 .endd
18970 by setting up delivery to the host with that IP address. IPv4 domain literals
18971 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18972 are similar, but the address is preceded by &`ipv6:`&. For example:
18973 .code
18974 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18975 .endd
18976 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18977 grounds that sooner or later somebody will try it.
18978
18979 .oindex "&%self%&" "in &(ipliteral)& router"
18980 If the IP address matches something in &%ignore_target_hosts%&, the router
18981 declines. If an IP literal turns out to refer to the local host, the generic
18982 &%self%& option determines what happens.
18983
18984 The RFCs require support for domain literals; however, their use is
18985 controversial in today's Internet. If you want to use this router, you must
18986 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18987 Exim will not recognize the domain literal syntax in addresses.
18988
18989
18990
18991 . ////////////////////////////////////////////////////////////////////////////
18992 . ////////////////////////////////////////////////////////////////////////////
18993
18994 .chapter "The iplookup router" "CHID6"
18995 .cindex "&(iplookup)& router"
18996 .cindex "routers" "&(iplookup)&"
18997 The &(iplookup)& router was written to fulfil a specific requirement in
18998 Cambridge University (which in fact no longer exists). For this reason, it is
18999 not included in the binary of Exim by default. If you want to include it, you
19000 must set
19001 .code
19002 ROUTER_IPLOOKUP=yes
19003 .endd
19004 in your &_Local/Makefile_& configuration file.
19005
19006 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19007 connection to one or more specific hosts. The host can then return the same or
19008 a different address &-- in effect rewriting the recipient address in the
19009 message's envelope. The new address is then passed on to subsequent routers. If
19010 this process fails, the address can be passed on to other routers, or delivery
19011 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19012 must not be specified for it.
19013
19014 .cindex "options" "&(iplookup)& router"
19015 .option hosts iplookup string unset
19016 This option must be supplied. Its value is a colon-separated list of host
19017 names. The hosts are looked up using &[gethostbyname()]&
19018 (or &[getipnodebyname()]& when available)
19019 and are tried in order until one responds to the query. If none respond, what
19020 happens is controlled by &%optional%&.
19021
19022
19023 .option optional iplookup boolean false
19024 If &%optional%& is true, if no response is obtained from any host, the address
19025 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19026 delivery to the address is deferred.
19027
19028
19029 .option port iplookup integer 0
19030 .cindex "port" "&(iplookup)& router"
19031 This option must be supplied. It specifies the port number for the TCP or UDP
19032 call.
19033
19034
19035 .option protocol iplookup string udp
19036 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19037 protocols is to be used.
19038
19039
19040 .option query iplookup string&!! "see below"
19041 This defines the content of the query that is sent to the remote hosts. The
19042 default value is:
19043 .code
19044 $local_part@$domain $local_part@$domain
19045 .endd
19046 The repetition serves as a way of checking that a response is to the correct
19047 query in the default case (see &%response_pattern%& below).
19048
19049
19050 .option reroute iplookup string&!! unset
19051 If this option is not set, the rerouted address is precisely the byte string
19052 returned by the remote host, up to the first white space, if any. If set, the
19053 string is expanded to form the rerouted address. It can include parts matched
19054 in the response by &%response_pattern%& by means of numeric variables such as
19055 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19056 whether or not a pattern is in use. In all cases, the rerouted address must end
19057 up in the form &'local_part@domain'&.
19058
19059
19060 .option response_pattern iplookup string unset
19061 This option can be set to a regular expression that is applied to the string
19062 returned from the remote host. If the pattern does not match the response, the
19063 router declines. If &%response_pattern%& is not set, no checking of the
19064 response is done, unless the query was defaulted, in which case there is a
19065 check that the text returned after the first white space is the original
19066 address. This checks that the answer that has been received is in response to
19067 the correct question. For example, if the response is just a new domain, the
19068 following could be used:
19069 .code
19070 response_pattern = ^([^@]+)$
19071 reroute = $local_part@$1
19072 .endd
19073
19074 .option timeout iplookup time 5s
19075 This specifies the amount of time to wait for a response from the remote
19076 machine. The same timeout is used for the &[connect()]& function for a TCP
19077 call. It does not apply to UDP.
19078
19079
19080
19081
19082 . ////////////////////////////////////////////////////////////////////////////
19083 . ////////////////////////////////////////////////////////////////////////////
19084
19085 .chapter "The manualroute router" "CHID7"
19086 .scindex IIDmanrou1 "&(manualroute)& router"
19087 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19088 .cindex "domain" "manually routing"
19089 The &(manualroute)& router is so-called because it provides a way of manually
19090 routing an address according to its domain. It is mainly used when you want to
19091 route addresses to remote hosts according to your own rules, bypassing the
19092 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19093 route to local transports, a facility that may be useful if you want to save
19094 messages for dial-in hosts in local files.
19095
19096 The &(manualroute)& router compares a list of domain patterns with the domain
19097 it is trying to route. If there is no match, the router declines. Each pattern
19098 has associated with it a list of hosts and some other optional data, which may
19099 include a transport. The combination of a pattern and its data is called a
19100 &"routing rule"&. For patterns that do not have an associated transport, the
19101 generic &%transport%& option must specify a transport, unless the router is
19102 being used purely for verification (see &%verify_only%&).
19103
19104 .vindex "&$host$&"
19105 In the case of verification, matching the domain pattern is sufficient for the
19106 router to accept the address. When actually routing an address for delivery,
19107 an address that matches a domain pattern is queued for the associated
19108 transport. If the transport is not a local one, a host list must be associated
19109 with the pattern; IP addresses are looked up for the hosts, and these are
19110 passed to the transport along with the mail address. For local transports, a
19111 host list is optional. If it is present, it is passed in &$host$& as a single
19112 text string.
19113
19114 The list of routing rules can be provided as an inline string in
19115 &%route_list%&, or the data can be obtained by looking up the domain in a file
19116 or database by setting &%route_data%&. Only one of these settings may appear in
19117 any one instance of &(manualroute)&. The format of routing rules is described
19118 below, following the list of private options.
19119
19120
19121 .section "Private options for manualroute" "SECTprioptman"
19122
19123 .cindex "options" "&(manualroute)& router"
19124 The private options for the &(manualroute)& router are as follows:
19125
19126 .option host_all_ignored manualroute string defer
19127 See &%host_find_failed%&.
19128
19129 .option host_find_failed manualroute string freeze
19130 This option controls what happens when &(manualroute)& tries to find an IP
19131 address for a host, and the host does not exist. The option can be set to one
19132 of the following values:
19133 .code
19134 decline
19135 defer
19136 fail
19137 freeze
19138 ignore
19139 pass
19140 .endd
19141 The default (&"freeze"&) assumes that this state is a serious configuration
19142 error. The difference between &"pass"& and &"decline"& is that the former
19143 forces the address to be passed to the next router (or the router defined by
19144 &%pass_router%&),
19145 .oindex "&%more%&"
19146 overriding &%no_more%&, whereas the latter passes the address to the next
19147 router only if &%more%& is true.
19148
19149 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19150 cannot be found. If all the hosts in the list are ignored, the behaviour is
19151 controlled by the &%host_all_ignored%& option. This takes the same values
19152 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19153
19154 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19155 state; if a host lookup gets a temporary error, delivery is deferred unless the
19156 generic &%pass_on_timeout%& option is set.
19157
19158
19159 .option hosts_randomize manualroute boolean false
19160 .cindex "randomized host list"
19161 .cindex "host" "list of; randomized"
19162 If this option is set, the order of the items in a host list in a routing rule
19163 is randomized each time the list is used, unless an option in the routing rule
19164 overrides (see below). Randomizing the order of a host list can be used to do
19165 crude load sharing. However, if more than one mail address is routed by the
19166 same router to the same host list, the host lists are considered to be the same
19167 (even though they may be randomized into different orders) for the purpose of
19168 deciding whether to batch the deliveries into a single SMTP transaction.
19169
19170 When &%hosts_randomize%& is true, a host list may be split
19171 into groups whose order is separately randomized. This makes it possible to
19172 set up MX-like behaviour. The boundaries between groups are indicated by an
19173 item that is just &`+`& in the host list. For example:
19174 .code
19175 route_list = * host1:host2:host3:+:host4:host5
19176 .endd
19177 The order of the first three hosts and the order of the last two hosts is
19178 randomized for each use, but the first three always end up before the last two.
19179 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19180 randomized host list is passed to an &(smtp)& transport that also has
19181 &%hosts_randomize set%&, the list is not re-randomized.
19182
19183
19184 .option route_data manualroute string&!! unset
19185 If this option is set, it must expand to yield the data part of a routing rule.
19186 Typically, the expansion string includes a lookup based on the domain. For
19187 example:
19188 .code
19189 route_data = ${lookup{$domain}dbm{/etc/routes}}
19190 .endd
19191 If the expansion is forced to fail, or the result is an empty string, the
19192 router declines. Other kinds of expansion failure cause delivery to be
19193 deferred.
19194
19195
19196 .option route_list manualroute "string list" unset
19197 This string is a list of routing rules, in the form defined below. Note that,
19198 unlike most string lists, the items are separated by semicolons. This is so
19199 that they may contain colon-separated host lists.
19200
19201
19202 .option same_domain_copy_routing manualroute boolean false
19203 .cindex "address" "copying routing"
19204 Addresses with the same domain are normally routed by the &(manualroute)&
19205 router to the same list of hosts. However, this cannot be presumed, because the
19206 router options and preconditions may refer to the local part of the address. By
19207 default, therefore, Exim routes each address in a message independently. DNS
19208 servers run caches, so repeated DNS lookups are not normally expensive, and in
19209 any case, personal messages rarely have more than a few recipients.
19210
19211 If you are running mailing lists with large numbers of subscribers at the same
19212 domain, and you are using a &(manualroute)& router which is independent of the
19213 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19214 lookups for identical domains in one message. In this case, when
19215 &(manualroute)& routes an address to a remote transport, any other unrouted
19216 addresses in the message that have the same domain are automatically given the
19217 same routing without processing them independently. However, this is only done
19218 if &%headers_add%& and &%headers_remove%& are unset.
19219
19220
19221
19222
19223 .section "Routing rules in route_list" "SECID120"
19224 The value of &%route_list%& is a string consisting of a sequence of routing
19225 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19226 entered as two semicolons. Alternatively, the list separator can be changed as
19227 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19228 Empty rules are ignored. The format of each rule is
19229 .display
19230 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19231 .endd
19232 The following example contains two rules, each with a simple domain pattern and
19233 no options:
19234 .code
19235 route_list = \
19236   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19237   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19238 .endd
19239 The three parts of a rule are separated by white space. The pattern and the
19240 list of hosts can be enclosed in quotes if necessary, and if they are, the
19241 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19242 single domain pattern, which is the only mandatory item in the rule. The
19243 pattern is in the same format as one item in a domain list (see section
19244 &<<SECTdomainlist>>&),
19245 except that it may not be the name of an interpolated file.
19246 That is, it may be wildcarded, or a regular expression, or a file or database
19247 lookup (with semicolons doubled, because of the use of semicolon as a separator
19248 in a &%route_list%&).
19249
19250 The rules in &%route_list%& are searched in order until one of the patterns
19251 matches the domain that is being routed. The list of hosts and then options are
19252 then used as described below. If there is no match, the router declines. When
19253 &%route_list%& is set, &%route_data%& must not be set.
19254
19255
19256
19257 .section "Routing rules in route_data" "SECID121"
19258 The use of &%route_list%& is convenient when there are only a small number of
19259 routing rules. For larger numbers, it is easier to use a file or database to
19260 hold the routing information, and use the &%route_data%& option instead.
19261 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19262 Most commonly, &%route_data%& is set as a string that contains an
19263 expansion lookup. For example, suppose we place two routing rules in a file
19264 like this:
19265 .code
19266 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19267 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19268 .endd
19269 This data can be accessed by setting
19270 .code
19271 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19272 .endd
19273 Failure of the lookup results in an empty string, causing the router to
19274 decline. However, you do not have to use a lookup in &%route_data%&. The only
19275 requirement is that the result of expanding the string is a list of hosts,
19276 possibly followed by options, separated by white space. The list of hosts must
19277 be enclosed in quotes if it contains white space.
19278
19279
19280
19281
19282 .section "Format of the list of hosts" "SECID122"
19283 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19284 always separately expanded before use. If the expansion fails, the router
19285 declines. The result of the expansion must be a colon-separated list of names
19286 and/or IP addresses, optionally also including ports. The format of each item
19287 in the list is described in the next section. The list separator can be changed
19288 as described in section &<<SECTlistconstruct>>&.
19289
19290 If the list of hosts was obtained from a &%route_list%& item, the following
19291 variables are set during its expansion:
19292
19293 .ilist
19294 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19295 If the domain was matched against a regular expression, the numeric variables
19296 &$1$&, &$2$&, etc. may be set. For example:
19297 .code
19298 route_list = ^domain(\d+)   host-$1.text.example
19299 .endd
19300 .next
19301 &$0$& is always set to the entire domain.
19302 .next
19303 &$1$& is also set when partial matching is done in a file lookup.
19304
19305 .next
19306 .vindex "&$value$&"
19307 If the pattern that matched the domain was a lookup item, the data that was
19308 looked up is available in the expansion variable &$value$&. For example:
19309 .code
19310 route_list = lsearch;;/some/file.routes  $value
19311 .endd
19312 .endlist
19313
19314 Note the doubling of the semicolon in the pattern that is necessary because
19315 semicolon is the default route list separator.
19316
19317
19318
19319 .section "Format of one host item" "SECTformatonehostitem"
19320 Each item in the list of hosts is either a host name or an IP address,
19321 optionally with an attached port number. When no port is given, an IP address
19322 is not enclosed in brackets. When a port is specified, it overrides the port
19323 specification on the transport. The port is separated from the name or address
19324 by a colon. This leads to some complications:
19325
19326 .ilist
19327 Because colon is the default separator for the list of hosts, either
19328 the colon that specifies a port must be doubled, or the list separator must
19329 be changed. The following two examples have the same effect:
19330 .code
19331 route_list = * "host1.tld::1225 : host2.tld::1226"
19332 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19333 .endd
19334 .next
19335 When IPv6 addresses are involved, it gets worse, because they contain
19336 colons of their own. To make this case easier, it is permitted to
19337 enclose an IP address (either v4 or v6) in square brackets if a port
19338 number follows. For example:
19339 .code
19340 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19341 .endd
19342 .endlist
19343
19344 .section "How the list of hosts is used" "SECThostshowused"
19345 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19346 the hosts is tried, in the order specified, when carrying out the SMTP
19347 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19348 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19349 transport.
19350
19351 Hosts may be listed by name or by IP address. An unadorned name in the list of
19352 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19353 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19354 records in the DNS. For example:
19355 .code
19356 route_list = *  x.y.z:p.q.r/MX:e.f.g
19357 .endd
19358 If this feature is used with a port specifier, the port must come last. For
19359 example:
19360 .code
19361 route_list = *  dom1.tld/mx::1225
19362 .endd
19363 If the &%hosts_randomize%& option is set, the order of the items in the list is
19364 randomized before any lookups are done. Exim then scans the list; for any name
19365 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19366 be an interface on the local host and the item is not the first in the list,
19367 Exim discards it and any subsequent items. If it is the first item, what
19368 happens is controlled by the
19369 .oindex "&%self%&" "in &(manualroute)& router"
19370 &%self%& option of the router.
19371
19372 A name on the list that is followed by &`/MX`& is replaced with the list of
19373 hosts obtained by looking up MX records for the name. This is always a DNS
19374 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19375 below) are not relevant here. The order of these hosts is determined by the
19376 preference values in the MX records, according to the usual rules. Because
19377 randomizing happens before the MX lookup, it does not affect the order that is
19378 defined by MX preferences.
19379
19380 If the local host is present in the sublist obtained from MX records, but is
19381 not the most preferred host in that list, it and any equally or less
19382 preferred hosts are removed before the sublist is inserted into the main list.
19383
19384 If the local host is the most preferred host in the MX list, what happens
19385 depends on where in the original list of hosts the &`/MX`& item appears. If it
19386 is not the first item (that is, there are previous hosts in the main list),
19387 Exim discards this name and any subsequent items in the main list.
19388
19389 If the MX item is first in the list of hosts, and the local host is the
19390 most preferred host, what happens is controlled by the &%self%& option of the
19391 router.
19392
19393 DNS failures when lookup up the MX records are treated in the same way as DNS
19394 failures when looking up IP addresses: &%pass_on_timeout%& and
19395 &%host_find_failed%& are used when relevant.
19396
19397 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19398 whether obtained from an MX lookup or not.
19399
19400
19401
19402 .section "How the options are used" "SECThowoptused"
19403 The options are a sequence of words; in practice no more than three are ever
19404 present. One of the words can be the name of a transport; this overrides the
19405 &%transport%& option on the router for this particular routing rule only. The
19406 other words (if present) control randomization of the list of hosts on a
19407 per-rule basis, and how the IP addresses of the hosts are to be found when
19408 routing to a remote transport. These options are as follows:
19409
19410 .ilist
19411 &%randomize%&: randomize the order of the hosts in this list, overriding the
19412 setting of &%hosts_randomize%& for this routing rule only.
19413 .next
19414 &%no_randomize%&: do not randomize the order of the hosts in this list,
19415 overriding the setting of &%hosts_randomize%& for this routing rule only.
19416 .next
19417 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19418 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19419 also look in &_/etc/hosts_& or other sources of information.
19420 .next
19421 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19422 no address records are found. If there is a temporary DNS error (such as a
19423 timeout), delivery is deferred.
19424 .endlist
19425
19426 For example:
19427 .code
19428 route_list = domain1  host1:host2:host3  randomize bydns;\
19429              domain2  host4:host5
19430 .endd
19431 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19432 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19433 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19434 or &[gethostbyname()]&, and the result of the lookup is the result of that
19435 call.
19436
19437 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19438 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19439 instead of TRY_AGAIN. That is why the default action is to try a DNS
19440 lookup first. Only if that gives a definite &"no such host"& is the local
19441 function called.
19442
19443
19444
19445 If no IP address for a host can be found, what happens is controlled by the
19446 &%host_find_failed%& option.
19447
19448 .vindex "&$host$&"
19449 When an address is routed to a local transport, IP addresses are not looked up.
19450 The host list is passed to the transport in the &$host$& variable.
19451
19452
19453
19454 .section "Manualroute examples" "SECID123"
19455 In some of the examples that follow, the presence of the &%remote_smtp%&
19456 transport, as defined in the default configuration file, is assumed:
19457
19458 .ilist
19459 .cindex "smart host" "example router"
19460 The &(manualroute)& router can be used to forward all external mail to a
19461 &'smart host'&. If you have set up, in the main part of the configuration, a
19462 named domain list that contains your local domains, for example:
19463 .code
19464 domainlist local_domains = my.domain.example
19465 .endd
19466 You can arrange for all other domains to be routed to a smart host by making
19467 your first router something like this:
19468 .code
19469 smart_route:
19470   driver = manualroute
19471   domains = !+local_domains
19472   transport = remote_smtp
19473   route_list = * smarthost.ref.example
19474 .endd
19475 This causes all non-local addresses to be sent to the single host
19476 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19477 they are tried in order
19478 (but you can use &%hosts_randomize%& to vary the order each time).
19479 Another way of configuring the same thing is this:
19480 .code
19481 smart_route:
19482   driver = manualroute
19483   transport = remote_smtp
19484   route_list = !+local_domains  smarthost.ref.example
19485 .endd
19486 There is no difference in behaviour between these two routers as they stand.
19487 However, they behave differently if &%no_more%& is added to them. In the first
19488 example, the router is skipped if the domain does not match the &%domains%&
19489 precondition; the following router is always tried. If the router runs, it
19490 always matches the domain and so can never decline. Therefore, &%no_more%&
19491 would have no effect. In the second case, the router is never skipped; it
19492 always runs. However, if it doesn't match the domain, it declines. In this case
19493 &%no_more%& would prevent subsequent routers from running.
19494
19495 .next
19496 .cindex "mail hub example"
19497 A &'mail hub'& is a host which receives mail for a number of domains via MX
19498 records in the DNS and delivers it via its own private routing mechanism. Often
19499 the final destinations are behind a firewall, with the mail hub being the one
19500 machine that can connect to machines both inside and outside the firewall. The
19501 &(manualroute)& router is usually used on a mail hub to route incoming messages
19502 to the correct hosts. For a small number of domains, the routing can be inline,
19503 using the &%route_list%& option, but for a larger number a file or database
19504 lookup is easier to manage.
19505
19506 If the domain names are in fact the names of the machines to which the mail is
19507 to be sent by the mail hub, the configuration can be quite simple. For
19508 example:
19509 .code
19510 hub_route:
19511   driver = manualroute
19512   transport = remote_smtp
19513   route_list = *.rhodes.tvs.example  $domain
19514 .endd
19515 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19516 whose names are the same as the mail domains. A similar approach can be taken
19517 if the host name can be obtained from the domain name by a string manipulation
19518 that the expansion facilities can handle. Otherwise, a lookup based on the
19519 domain can be used to find the host:
19520 .code
19521 through_firewall:
19522   driver = manualroute
19523   transport = remote_smtp
19524   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19525 .endd
19526 The result of the lookup must be the name or IP address of the host (or
19527 hosts) to which the address is to be routed. If the lookup fails, the route
19528 data is empty, causing the router to decline. The address then passes to the
19529 next router.
19530
19531 .next
19532 .cindex "batched SMTP output example"
19533 .cindex "SMTP" "batched outgoing; example"
19534 You can use &(manualroute)& to deliver messages to pipes or files in batched
19535 SMTP format for onward transportation by some other means. This is one way of
19536 storing mail for a dial-up host when it is not connected. The route list entry
19537 can be as simple as a single domain name in a configuration like this:
19538 .code
19539 save_in_file:
19540   driver = manualroute
19541   transport = batchsmtp_appendfile
19542   route_list = saved.domain.example
19543 .endd
19544 though often a pattern is used to pick up more than one domain. If there are
19545 several domains or groups of domains with different transport requirements,
19546 different transports can be listed in the routing information:
19547 .code
19548 save_in_file:
19549   driver = manualroute
19550   route_list = \
19551     *.saved.domain1.example  $domain  batch_appendfile; \
19552     *.saved.domain2.example  \
19553       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19554       batch_pipe
19555 .endd
19556 .vindex "&$domain$&"
19557 .vindex "&$host$&"
19558 The first of these just passes the domain in the &$host$& variable, which
19559 doesn't achieve much (since it is also in &$domain$&), but the second does a
19560 file lookup to find a value to pass, causing the router to decline to handle
19561 the address if the lookup fails.
19562
19563 .next
19564 .cindex "UUCP" "example of router for"
19565 Routing mail directly to UUCP software is a specific case of the use of
19566 &(manualroute)& in a gateway to another mail environment. This is an example of
19567 one way it can be done:
19568 .code
19569 # Transport
19570 uucp:
19571   driver = pipe
19572   user = nobody
19573   command = /usr/local/bin/uux -r - \
19574     ${substr_-5:$host}!rmail ${local_part}
19575   return_fail_output = true
19576
19577 # Router
19578 uucphost:
19579   transport = uucp
19580   driver = manualroute
19581   route_data = \
19582     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19583 .endd
19584 The file &_/usr/local/exim/uucphosts_& contains entries like
19585 .code
19586 darksite.ethereal.example:           darksite.UUCP
19587 .endd
19588 It can be set up more simply without adding and removing &".UUCP"& but this way
19589 makes clear the distinction between the domain name
19590 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19591 .endlist
19592 .ecindex IIDmanrou1
19593 .ecindex IIDmanrou2
19594
19595
19596
19597
19598
19599
19600
19601
19602 . ////////////////////////////////////////////////////////////////////////////
19603 . ////////////////////////////////////////////////////////////////////////////
19604
19605 .chapter "The queryprogram router" "CHAPdriverlast"
19606 .scindex IIDquerou1 "&(queryprogram)& router"
19607 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19608 .cindex "routing" "by external program"
19609 The &(queryprogram)& router routes an address by running an external command
19610 and acting on its output. This is an expensive way to route, and is intended
19611 mainly for use in lightly-loaded systems, or for performing experiments.
19612 However, if it is possible to use the precondition options (&%domains%&,
19613 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19614 be used in special cases, even on a busy host. There are the following private
19615 options:
19616 .cindex "options" "&(queryprogram)& router"
19617
19618 .option command queryprogram string&!! unset
19619 This option must be set. It specifies the command that is to be run. The
19620 command is split up into a command name and arguments, and then each is
19621 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19622 &<<CHAPpipetransport>>&).
19623
19624
19625 .option command_group queryprogram string unset
19626 .cindex "gid (group id)" "in &(queryprogram)& router"
19627 This option specifies a gid to be set when running the command while routing an
19628 address for deliver. It must be set if &%command_user%& specifies a numerical
19629 uid. If it begins with a digit, it is interpreted as the numerical value of the
19630 gid. Otherwise it is looked up using &[getgrnam()]&.
19631
19632
19633 .option command_user queryprogram string unset
19634 .cindex "uid (user id)" "for &(queryprogram)&"
19635 This option must be set. It specifies the uid which is set when running the
19636 command while routing an address for delivery. If the value begins with a digit,
19637 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19638 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19639 not set, a value for the gid also.
19640
19641 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19642 root, which it does during a normal delivery in a conventional configuration.
19643 However, when an address is being verified during message reception, Exim is
19644 usually running as the Exim user, not as root. If the &(queryprogram)& router
19645 is called from a non-root process, Exim cannot change uid or gid before running
19646 the command. In this circumstance the command runs under the current uid and
19647 gid.
19648
19649
19650 .option current_directory queryprogram string /
19651 This option specifies an absolute path which is made the current directory
19652 before running the command.
19653
19654
19655 .option timeout queryprogram time 1h
19656 If the command does not complete within the timeout period, its process group
19657 is killed and the message is frozen. A value of zero time specifies no
19658 timeout.
19659
19660
19661 The standard output of the command is connected to a pipe, which is read when
19662 the command terminates. It should consist of a single line of output,
19663 containing up to five fields, separated by white space. The maximum length of
19664 the line is 1023 characters. Longer lines are silently truncated. The first
19665 field is one of the following words (case-insensitive):
19666
19667 .ilist
19668 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19669 below).
19670 .next
19671 &'Decline'&: the router declines; pass the address to the next router, unless
19672 &%no_more%& is set.
19673 .next
19674 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19675 subsequent text on the line is an error message. If the router is run as part
19676 of address verification during an incoming SMTP message, the message is
19677 included in the SMTP response.
19678 .next
19679 &'Defer'&: routing could not be completed at this time; try again later. Any
19680 subsequent text on the line is an error message which is logged. It is not
19681 included in any SMTP response.
19682 .next
19683 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19684 .next
19685 &'Pass'&: pass the address to the next router (or the router specified by
19686 &%pass_router%&), overriding &%no_more%&.
19687 .next
19688 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19689 new addresses, which are routed independently, starting with the first router,
19690 or the router specified by &%redirect_router%&, if set.
19691 .endlist
19692
19693 When the first word is &'accept'&, the remainder of the line consists of a
19694 number of keyed data values, as follows (split into two lines here, to fit on
19695 the page):
19696 .code
19697 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19698 LOOKUP=byname|bydns DATA=<text>
19699 .endd
19700 The data items can be given in any order, and all are optional. If no transport
19701 is included, the transport specified by the generic &%transport%& option is
19702 used. The list of hosts and the lookup type are needed only if the transport is
19703 an &(smtp)& transport that does not itself supply a list of hosts.
19704
19705 The format of the list of hosts is the same as for the &(manualroute)& router.
19706 As well as host names and IP addresses with optional port numbers, as described
19707 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19708 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19709 (see section &<<SECThostshowused>>&).
19710
19711 If the lookup type is not specified, Exim behaves as follows when trying to
19712 find an IP address for each host: First, a DNS lookup is done. If this yields
19713 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19714 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19715 result of the lookup is the result of that call.
19716
19717 .vindex "&$address_data$&"
19718 If the DATA field is set, its value is placed in the &$address_data$&
19719 variable. For example, this return line
19720 .code
19721 accept hosts=x1.y.example:x2.y.example data="rule1"
19722 .endd
19723 routes the address to the default transport, passing a list of two hosts. When
19724 the transport runs, the string &"rule1"& is in &$address_data$&.
19725 .ecindex IIDquerou1
19726 .ecindex IIDquerou2
19727
19728
19729
19730
19731 . ////////////////////////////////////////////////////////////////////////////
19732 . ////////////////////////////////////////////////////////////////////////////
19733
19734 .chapter "The redirect router" "CHAPredirect"
19735 .scindex IIDredrou1 "&(redirect)& router"
19736 .scindex IIDredrou2 "routers" "&(redirect)&"
19737 .cindex "alias file" "in a &(redirect)& router"
19738 .cindex "address redirection" "&(redirect)& router"
19739 The &(redirect)& router handles several kinds of address redirection. Its most
19740 common uses are for resolving local part aliases from a central alias file
19741 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19742 files, but it has many other potential uses. The incoming address can be
19743 redirected in several different ways:
19744
19745 .ilist
19746 It can be replaced by one or more new addresses which are themselves routed
19747 independently.
19748 .next
19749 It can be routed to be delivered to a given file or directory.
19750 .next
19751 It can be routed to be delivered to a specified pipe command.
19752 .next
19753 It can cause an automatic reply to be generated.
19754 .next
19755 It can be forced to fail, optionally with a custom error message.
19756 .next
19757 It can be temporarily deferred, optionally with a custom message.
19758 .next
19759 It can be discarded.
19760 .endlist
19761
19762 The generic &%transport%& option must not be set for &(redirect)& routers.
19763 However, there are some private options which define transports for delivery to
19764 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19765 &%pipe_transport%& and &%reply_transport%& descriptions below.
19766
19767 If success DSNs have been requested
19768 .cindex "DSN" "success"
19769 .cindex "Delivery Status Notification" "success"
19770 redirection triggers one and the DSN options are not passed any further.
19771
19772
19773
19774 .section "Redirection data" "SECID124"
19775 The router operates by interpreting a text string which it obtains either by
19776 expanding the contents of the &%data%& option, or by reading the entire
19777 contents of a file whose name is given in the &%file%& option. These two
19778 options are mutually exclusive. The first is commonly used for handling system
19779 aliases, in a configuration like this:
19780 .code
19781 system_aliases:
19782   driver = redirect
19783   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19784 .endd
19785 If the lookup fails, the expanded string in this example is empty. When the
19786 expansion of &%data%& results in an empty string, the router declines. A forced
19787 expansion failure also causes the router to decline; other expansion failures
19788 cause delivery to be deferred.
19789
19790 A configuration using &%file%& is commonly used for handling users'
19791 &_.forward_& files, like this:
19792 .code
19793 userforward:
19794   driver = redirect
19795   check_local_user
19796   file = $home/.forward
19797   no_verify
19798 .endd
19799 If the file does not exist, or causes no action to be taken (for example, it is
19800 empty or consists only of comments), the router declines. &*Warning*&: This
19801 is not the case when the file contains syntactically valid items that happen to
19802 yield empty addresses, for example, items containing only RFC 2822 address
19803 comments.
19804
19805
19806
19807 .section "Forward files and address verification" "SECID125"
19808 .cindex "address redirection" "while verifying"
19809 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19810 &_.forward_& files, as in the example above. There are two reasons for this:
19811
19812 .ilist
19813 When Exim is receiving an incoming SMTP message from a remote host, it is
19814 running under the Exim uid, not as root. Exim is unable to change uid to read
19815 the file as the user, and it may not be able to read it as the Exim user. So in
19816 practice the router may not be able to operate.
19817 .next
19818 However, even when the router can operate, the existence of a &_.forward_& file
19819 is unimportant when verifying an address. What should be checked is whether the
19820 local part is a valid user name or not. Cutting out the redirection processing
19821 saves some resources.
19822 .endlist
19823
19824
19825
19826
19827
19828
19829 .section "Interpreting redirection data" "SECID126"
19830 .cindex "Sieve filter" "specifying in redirection data"
19831 .cindex "filter" "specifying in redirection data"
19832 The contents of the data string, whether obtained from &%data%& or &%file%&,
19833 can be interpreted in two different ways:
19834
19835 .ilist
19836 If the &%allow_filter%& option is set true, and the data begins with the text
19837 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19838 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19839 respectively. Details of the syntax and semantics of filter files are described
19840 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19841 document is intended for use by end users.
19842 .next
19843 Otherwise, the data must be a comma-separated list of redirection items, as
19844 described in the next section.
19845 .endlist
19846
19847 When a message is redirected to a file (a &"mail folder"&), the file name given
19848 in a non-filter redirection list must always be an absolute path. A filter may
19849 generate a relative path &-- how this is handled depends on the transport's
19850 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19851 for the &(appendfile)& transport.
19852
19853
19854
19855 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19856 .cindex "address redirection" "non-filter list items"
19857 When the redirection data is not an Exim or Sieve filter, for example, if it
19858 comes from a conventional alias or forward file, it consists of a list of
19859 addresses, file names, pipe commands, or certain special items (see section
19860 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19861 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19862 depending on their default values. The items in the list are separated by
19863 commas or newlines.
19864 If a comma is required in an item, the entire item must be enclosed in double
19865 quotes.
19866
19867 Lines starting with a # character are comments, and are ignored, and # may
19868 also appear following a comma, in which case everything between the # and the
19869 next newline character is ignored.
19870
19871 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19872 double quotes are retained because some forms of mail address require their use
19873 (but never to enclose the entire address). In the following description,
19874 &"item"& refers to what remains after any surrounding double quotes have been
19875 removed.
19876
19877 .vindex "&$local_part$&"
19878 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19879 and the expansion contains a reference to &$local_part$&, you should make use
19880 of the &%quote_local_part%& expansion operator, in case the local part contains
19881 special characters. For example, to redirect all mail for the domain
19882 &'obsolete.example'&, retaining the existing local part, you could use this
19883 setting:
19884 .code
19885 data = ${quote_local_part:$local_part}@newdomain.example
19886 .endd
19887
19888
19889 .section "Redirecting to a local mailbox" "SECTredlocmai"
19890 .cindex "routing" "loops in"
19891 .cindex "loop" "while routing, avoidance of"
19892 .cindex "address redirection" "to local mailbox"
19893 A redirection item may safely be the same as the address currently under
19894 consideration. This does not cause a routing loop, because a router is
19895 automatically skipped if any ancestor of the address that is being processed
19896 is the same as the current address and was processed by the current router.
19897 Such an address is therefore passed to the following routers, so it is handled
19898 as if there were no redirection. When making this loop-avoidance test, the
19899 complete local part, including any prefix or suffix, is used.
19900
19901 .cindex "address redirection" "local part without domain"
19902 Specifying the same local part without a domain is a common usage in personal
19903 filter files when the user wants to have messages delivered to the local
19904 mailbox and also forwarded elsewhere. For example, the user whose login is
19905 &'cleo'& might have a &_.forward_& file containing this:
19906 .code
19907 cleo, cleopatra@egypt.example
19908 .endd
19909 .cindex "backslash in alias file"
19910 .cindex "alias file" "backslash in"
19911 For compatibility with other MTAs, such unqualified local parts may be
19912 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19913 it does make a difference if more than one domain is being handled
19914 synonymously.
19915
19916 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19917 2822 address that does not include a domain, the item is qualified using the
19918 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19919 addresses are qualified using the value in &%qualify_recipient%&, but you can
19920 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19921
19922 Care must be taken if there are alias names for local users.
19923 Consider an MTA handling a single local domain where the system alias file
19924 contains:
19925 .code
19926 Sam.Reman: spqr
19927 .endd
19928 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19929 messages in the local mailbox, and also forward copies elsewhere. He creates
19930 this forward file:
19931 .code
19932 Sam.Reman, spqr@reme.elsewhere.example
19933 .endd
19934 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19935 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19936 second time round, because it has previously routed it,
19937 and the following routers presumably cannot handle the alias. The forward file
19938 should really contain
19939 .code
19940 spqr, spqr@reme.elsewhere.example
19941 .endd
19942 but because this is such a common error, the &%check_ancestor%& option (see
19943 below) exists to provide a way to get round it. This is normally set on a
19944 &(redirect)& router that is handling users' &_.forward_& files.
19945
19946
19947
19948 .section "Special items in redirection lists" "SECTspecitredli"
19949 In addition to addresses, the following types of item may appear in redirection
19950 lists (that is, in non-filter redirection data):
19951
19952 .ilist
19953 .cindex "pipe" "in redirection list"
19954 .cindex "address redirection" "to pipe"
19955 An item is treated as a pipe command if it begins with &"|"& and does not parse
19956 as a valid RFC 2822 address that includes a domain. A transport for running the
19957 command must be specified by the &%pipe_transport%& option.
19958 Normally, either the router or the transport specifies a user and a group under
19959 which to run the delivery. The default is to use the Exim user and group.
19960
19961 Single or double quotes can be used for enclosing the individual arguments of
19962 the pipe command; no interpretation of escapes is done for single quotes. If
19963 the command contains a comma character, it is necessary to put the whole item
19964 in double quotes, for example:
19965 .code
19966 "|/some/command ready,steady,go"
19967 .endd
19968 since items in redirection lists are terminated by commas. Do not, however,
19969 quote just the command. An item such as
19970 .code
19971 |"/some/command ready,steady,go"
19972 .endd
19973 is interpreted as a pipe with a rather strange command name, and no arguments.
19974
19975 Note that the above example assumes that the text comes from a lookup source
19976 of some sort, so that the quotes are part of the data.  If composing a
19977 redirect router with a &%data%& option directly specifying this command, the
19978 quotes will be used by the configuration parser to define the extent of one
19979 string, but will not be passed down into the redirect router itself.  There
19980 are two main approaches to get around this: escape quotes to be part of the
19981 data itself, or avoid using this mechanism and instead create a custom
19982 transport with the &%command%& option set and reference that transport from
19983 an &%accept%& router.
19984
19985 .next
19986 .cindex "file" "in redirection list"
19987 .cindex "address redirection" "to file"
19988 An item is interpreted as a path name if it begins with &"/"& and does not
19989 parse as a valid RFC 2822 address that includes a domain. For example,
19990 .code
19991 /home/world/minbari
19992 .endd
19993 is treated as a file name, but
19994 .code
19995 /s=molari/o=babylon/@x400gate.way
19996 .endd
19997 is treated as an address. For a file name, a transport must be specified using
19998 the &%file_transport%& option. However, if the generated path name ends with a
19999 forward slash character, it is interpreted as a directory name rather than a
20000 file name, and &%directory_transport%& is used instead.
20001
20002 Normally, either the router or the transport specifies a user and a group under
20003 which to run the delivery. The default is to use the Exim user and group.
20004
20005 .cindex "&_/dev/null_&"
20006 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20007 bypassed at a high level, and the log entry shows &"**bypassed**"&
20008 instead of a transport name. In this case the user and group are not used.
20009
20010 .next
20011 .cindex "included address list"
20012 .cindex "address redirection" "included external list"
20013 If an item is of the form
20014 .code
20015 :include:<path name>
20016 .endd
20017 a list of further items is taken from the given file and included at that
20018 point. &*Note*&: Such a file can not be a filter file; it is just an
20019 out-of-line addition to the list. The items in the included list are separated
20020 by commas or newlines and are not subject to expansion. If this is the first
20021 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20022 the alias name. This example is incorrect:
20023 .code
20024 list1    :include:/opt/lists/list1
20025 .endd
20026 It must be given as
20027 .code
20028 list1:   :include:/opt/lists/list1
20029 .endd
20030 .next
20031 .cindex "address redirection" "to black hole"
20032 .cindex "delivery" "discard"
20033 .cindex "delivery" "blackhole"
20034 .cindex "black hole"
20035 .cindex "abandoning mail"
20036 Sometimes you want to throw away mail to a particular local part.  Making the
20037 &%data%& option expand to an empty string does not work, because that causes
20038 the router to decline. Instead, the alias item
20039 .code
20040 :blackhole:
20041 .endd
20042 can be used. It does what its name implies. No delivery is
20043 done, and no error message is generated. This has the same effect as specifying
20044 &_/dev/null_& as a destination, but it can be independently disabled.
20045
20046 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20047 delivery is done for the original local part, even if other redirection items
20048 are present. If you are generating a multi-item list (for example, by reading a
20049 database) and need the ability to provide a no-op item, you must use
20050 &_/dev/null_&.
20051
20052 .next
20053 .cindex "delivery" "forcing failure"
20054 .cindex "delivery" "forcing deferral"
20055 .cindex "failing delivery" "forcing"
20056 .cindex "deferred delivery, forcing"
20057 .cindex "customizing" "failure message"
20058 An attempt to deliver a particular address can be deferred or forced to fail by
20059 redirection items of the form
20060 .code
20061 :defer:
20062 :fail:
20063 .endd
20064 respectively. When a redirection list contains such an item, it applies
20065 to the entire redirection; any other items in the list are ignored. Any
20066 text following &':fail:'& or &':defer:'& is placed in the error text
20067 associated with the failure. For example, an alias file might contain:
20068 .code
20069 X.Employee:  :fail: Gone away, no forwarding address
20070 .endd
20071 In the case of an address that is being verified from an ACL or as the subject
20072 of a
20073 .cindex "VRFY" "error text, display of"
20074 VRFY command, the text is included in the SMTP error response by
20075 default.
20076 .cindex "EXPN" "error text, display of"
20077 The text is not included in the response to an EXPN command. In non-SMTP cases
20078 the text is included in the error message that Exim generates.
20079
20080 .cindex "SMTP" "error codes"
20081 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20082 &':fail:'&. However, if the message starts with three digits followed by a
20083 space, optionally followed by an extended code of the form &'n.n.n'&, also
20084 followed by a space, and the very first digit is the same as the default error
20085 code, the code from the message is used instead. If the very first digit is
20086 incorrect, a panic error is logged, and the default code is used. You can
20087 suppress the use of the supplied code in a redirect router by setting the
20088 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20089 ignored.
20090
20091 .vindex "&$acl_verify_message$&"
20092 In an ACL, an explicitly provided message overrides the default, but the
20093 default message is available in the variable &$acl_verify_message$& and can
20094 therefore be included in a custom message if this is desired.
20095
20096 Normally the error text is the rest of the redirection list &-- a comma does
20097 not terminate it &-- but a newline does act as a terminator. Newlines are not
20098 normally present in alias expansions. In &(lsearch)& lookups they are removed
20099 as part of the continuation process, but they may exist in other kinds of
20100 lookup and in &':include:'& files.
20101
20102 During routing for message delivery (as opposed to verification), a redirection
20103 containing &':fail:'& causes an immediate failure of the incoming address,
20104 whereas &':defer:'& causes the message to remain on the queue so that a
20105 subsequent delivery attempt can happen at a later time. If an address is
20106 deferred for too long, it will ultimately fail, because the normal retry
20107 rules still apply.
20108
20109 .next
20110 .cindex "alias file" "exception to default"
20111 Sometimes it is useful to use a single-key search type with a default (see
20112 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20113 for exceptions to the default. These can be handled by aliasing them to
20114 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20115 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20116 results in an empty redirection list has the same effect.
20117 .endlist
20118
20119
20120 .section "Duplicate addresses" "SECTdupaddr"
20121 .cindex "duplicate addresses"
20122 .cindex "address duplicate, discarding"
20123 .cindex "pipe" "duplicated"
20124 Exim removes duplicate addresses from the list to which it is delivering, so as
20125 to deliver just one copy to each address. This does not apply to deliveries
20126 routed to pipes by different immediate parent addresses, but an indirect
20127 aliasing scheme of the type
20128 .code
20129 pipe:       |/some/command $local_part
20130 localpart1: pipe
20131 localpart2: pipe
20132 .endd
20133 does not work with a message that is addressed to both local parts, because
20134 when the second is aliased to the intermediate local part &"pipe"& it gets
20135 discarded as being the same as a previously handled address. However, a scheme
20136 such as
20137 .code
20138 localpart1: |/some/command $local_part
20139 localpart2: |/some/command $local_part
20140 .endd
20141 does result in two different pipe deliveries, because the immediate parents of
20142 the pipes are distinct.
20143
20144
20145
20146 .section "Repeated redirection expansion" "SECID128"
20147 .cindex "repeated redirection expansion"
20148 .cindex "address redirection" "repeated for each delivery attempt"
20149 When a message cannot be delivered to all of its recipients immediately,
20150 leading to two or more delivery attempts, redirection expansion is carried out
20151 afresh each time for those addresses whose children were not all previously
20152 delivered. If redirection is being used as a mailing list, this can lead to new
20153 members of the list receiving copies of old messages. The &%one_time%& option
20154 can be used to avoid this.
20155
20156
20157 .section "Errors in redirection lists" "SECID129"
20158 .cindex "address redirection" "errors"
20159 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20160 error is skipped, and an entry is written to the main log. This may be useful
20161 for mailing lists that are automatically managed. Otherwise, if an error is
20162 detected while generating the list of new addresses, the original address is
20163 deferred. See also &%syntax_errors_to%&.
20164
20165
20166
20167 .section "Private options for the redirect router" "SECID130"
20168
20169 .cindex "options" "&(redirect)& router"
20170 The private options for the &(redirect)& router are as follows:
20171
20172
20173 .option allow_defer redirect boolean false
20174 Setting this option allows the use of &':defer:'& in non-filter redirection
20175 data, or the &%defer%& command in an Exim filter file.
20176
20177
20178 .option allow_fail redirect boolean false
20179 .cindex "failing delivery" "from filter"
20180 If this option is true, the &':fail:'& item can be used in a redirection list,
20181 and the &%fail%& command may be used in an Exim filter file.
20182
20183
20184 .option allow_filter redirect boolean false
20185 .cindex "filter" "enabling use of"
20186 .cindex "Sieve filter" "enabling use of"
20187 Setting this option allows Exim to interpret redirection data that starts with
20188 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20189 are some features of Exim filter files that some administrators may wish to
20190 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20191
20192 It is also possible to lock out Exim filters or Sieve filters while allowing
20193 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20194
20195
20196 The filter is run using the uid and gid set by the generic &%user%& and
20197 &%group%& options. These take their defaults from the password data if
20198 &%check_local_user%& is set, so in the normal case of users' personal filter
20199 files, the filter is run as the relevant user. When &%allow_filter%& is set
20200 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20201
20202
20203
20204 .option allow_freeze redirect boolean false
20205 .cindex "freezing messages" "allowing in filter"
20206 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20207 This command is more normally encountered in system filters, and is disabled by
20208 default for redirection filters because it isn't something you usually want to
20209 let ordinary users do.
20210
20211
20212
20213 .option check_ancestor redirect boolean false
20214 This option is concerned with handling generated addresses that are the same
20215 as some address in the list of redirection ancestors of the current address.
20216 Although it is turned off by default in the code, it is set in the default
20217 configuration file for handling users' &_.forward_& files. It is recommended
20218 for this use of the &(redirect)& router.
20219
20220 When &%check_ancestor%& is set, if a generated address (including the domain)
20221 is the same as any ancestor of the current address, it is replaced by a copy of
20222 the current address. This helps in the case where local part A is aliased to B,
20223 and B has a &_.forward_& file pointing back to A. For example, within a single
20224 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20225 &_&~jb/.forward_& contains:
20226 .code
20227 \Joe.Bloggs, <other item(s)>
20228 .endd
20229 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20230 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20231 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20232 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20233 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20234 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20235 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20236 original address. See also the &%repeat_use%& option below.
20237
20238
20239 .option check_group redirect boolean "see below"
20240 When the &%file%& option is used, the group owner of the file is checked only
20241 when this option is set. The permitted groups are those listed in the
20242 &%owngroups%& option, together with the user's default group if
20243 &%check_local_user%& is set. If the file has the wrong group, routing is
20244 deferred. The default setting for this option is true if &%check_local_user%&
20245 is set and the &%modemask%& option permits the group write bit, or if the
20246 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20247
20248
20249
20250 .option check_owner redirect boolean "see below"
20251 When the &%file%& option is used, the owner of the file is checked only when
20252 this option is set. If &%check_local_user%& is set, the local user is
20253 permitted; otherwise the owner must be one of those listed in the &%owners%&
20254 option. The default value for this option is true if &%check_local_user%& or
20255 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20256
20257
20258 .option data redirect string&!! unset
20259 This option is mutually exclusive with &%file%&. One or other of them must be
20260 set, but not both. The contents of &%data%& are expanded, and then used as the
20261 list of forwarding items, or as a set of filtering instructions. If the
20262 expansion is forced to fail, or the result is an empty string or a string that
20263 has no effect (consists entirely of comments), the router declines.
20264
20265 When filtering instructions are used, the string must begin with &"#Exim
20266 filter"&, and all comments in the string, including this initial one, must be
20267 terminated with newline characters. For example:
20268 .code
20269 data = #Exim filter\n\
20270        if $h_to: contains Exim then save $home/mail/exim endif
20271 .endd
20272 If you are reading the data from a database where newlines cannot be included,
20273 you can use the &${sg}$& expansion item to turn the escape string of your
20274 choice into a newline.
20275
20276
20277 .option directory_transport redirect string&!! unset
20278 A &(redirect)& router sets up a direct delivery to a directory when a path name
20279 ending with a slash is specified as a new &"address"&. The transport used is
20280 specified by this option, which, after expansion, must be the name of a
20281 configured transport. This should normally be an &(appendfile)& transport.
20282
20283
20284 .option file redirect string&!! unset
20285 This option specifies the name of a file that contains the redirection data. It
20286 is mutually exclusive with the &%data%& option. The string is expanded before
20287 use; if the expansion is forced to fail, the router declines. Other expansion
20288 failures cause delivery to be deferred. The result of a successful expansion
20289 must be an absolute path. The entire file is read and used as the redirection
20290 data. If the data is an empty string or a string that has no effect (consists
20291 entirely of comments), the router declines.
20292
20293 .cindex "NFS" "checking for file existence"
20294 If the attempt to open the file fails with a &"does not exist"& error, Exim
20295 runs a check on the containing directory,
20296 unless &%ignore_enotdir%& is true (see below).
20297 If the directory does not appear to exist, delivery is deferred. This can
20298 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20299 is a mount problem. If the containing directory does exist, but the file does
20300 not, the router declines.
20301
20302
20303 .option file_transport redirect string&!! unset
20304 .vindex "&$address_file$&"
20305 A &(redirect)& router sets up a direct delivery to a file when a path name not
20306 ending in a slash is specified as a new &"address"&. The transport used is
20307 specified by this option, which, after expansion, must be the name of a
20308 configured transport. This should normally be an &(appendfile)& transport. When
20309 it is running, the file name is in &$address_file$&.
20310
20311
20312 .option filter_prepend_home redirect boolean true
20313 When this option is true, if a &(save)& command in an Exim filter specifies a
20314 relative path, and &$home$& is defined, it is automatically prepended to the
20315 relative path. If this option is set false, this action does not happen. The
20316 relative path is then passed to the transport unmodified.
20317
20318
20319 .option forbid_blackhole redirect boolean false
20320 If this option is true, the &':blackhole:'& item may not appear in a
20321 redirection list.
20322
20323
20324 .option forbid_exim_filter redirect boolean false
20325 If this option is set true, only Sieve filters are permitted when
20326 &%allow_filter%& is true.
20327
20328
20329
20330
20331 .option forbid_file redirect boolean false
20332 .cindex "delivery" "to file; forbidding"
20333 .cindex "Sieve filter" "forbidding delivery to a file"
20334 .cindex "Sieve filter" "&""keep""& facility; disabling"
20335 If this option is true, this router may not generate a new address that
20336 specifies delivery to a local file or directory, either from a filter or from a
20337 conventional forward file. This option is forced to be true if &%one_time%& is
20338 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20339 locks out the Sieve's &"keep"& facility.
20340
20341
20342 .option forbid_filter_dlfunc redirect boolean false
20343 .cindex "filter" "locking out certain features"
20344 If this option is true, string expansions in Exim filters are not allowed to
20345 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20346 functions.
20347
20348 .option forbid_filter_existstest redirect boolean false
20349 .cindex "expansion" "statting a file"
20350 If this option is true, string expansions in Exim filters are not allowed to
20351 make use of the &%exists%& condition or the &%stat%& expansion item.
20352
20353 .option forbid_filter_logwrite redirect boolean false
20354 If this option is true, use of the logging facility in Exim filters is not
20355 permitted. Logging is in any case available only if the filter is being run
20356 under some unprivileged uid (which is normally the case for ordinary users'
20357 &_.forward_& files).
20358
20359
20360 .option forbid_filter_lookup redirect boolean false
20361 If this option is true, string expansions in Exim filter files are not allowed
20362 to make use of &%lookup%& items.
20363
20364
20365 .option forbid_filter_perl redirect boolean false
20366 This option has an effect only if Exim is built with embedded Perl support. If
20367 it is true, string expansions in Exim filter files are not allowed to make use
20368 of the embedded Perl support.
20369
20370
20371 .option forbid_filter_readfile redirect boolean false
20372 If this option is true, string expansions in Exim filter files are not allowed
20373 to make use of &%readfile%& items.
20374
20375
20376 .option forbid_filter_readsocket redirect boolean false
20377 If this option is true, string expansions in Exim filter files are not allowed
20378 to make use of &%readsocket%& items.
20379
20380
20381 .option forbid_filter_reply redirect boolean false
20382 If this option is true, this router may not generate an automatic reply
20383 message. Automatic replies can be generated only from Exim or Sieve filter
20384 files, not from traditional forward files. This option is forced to be true if
20385 &%one_time%& is set.
20386
20387
20388 .option forbid_filter_run redirect boolean false
20389 If this option is true, string expansions in Exim filter files are not allowed
20390 to make use of &%run%& items.
20391
20392
20393 .option forbid_include redirect boolean false
20394 If this option is true, items of the form
20395 .code
20396 :include:<path name>
20397 .endd
20398 are not permitted in non-filter redirection lists.
20399
20400
20401 .option forbid_pipe redirect boolean false
20402 .cindex "delivery" "to pipe; forbidding"
20403 If this option is true, this router may not generate a new address which
20404 specifies delivery to a pipe, either from an Exim filter or from a conventional
20405 forward file. This option is forced to be true if &%one_time%& is set.
20406
20407
20408 .option forbid_sieve_filter redirect boolean false
20409 If this option is set true, only Exim filters are permitted when
20410 &%allow_filter%& is true.
20411
20412
20413 .cindex "SMTP" "error codes"
20414 .option forbid_smtp_code redirect boolean false
20415 If this option is set true, any SMTP error codes that are present at the start
20416 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20417 the default codes (451 and 550, respectively) are always used.
20418
20419
20420
20421
20422 .option hide_child_in_errmsg redirect boolean false
20423 .cindex "bounce message" "redirection details; suppressing"
20424 If this option is true, it prevents Exim from quoting a child address if it
20425 generates a bounce or delay message for it. Instead it says &"an address
20426 generated from <&'the top level address'&>"&. Of course, this applies only to
20427 bounces generated locally. If a message is forwarded to another host, &'its'&
20428 bounce may well quote the generated address.
20429
20430
20431 .option ignore_eacces redirect boolean false
20432 .cindex "EACCES"
20433 If this option is set and an attempt to open a redirection file yields the
20434 EACCES error (permission denied), the &(redirect)& router behaves as if the
20435 file did not exist.
20436
20437
20438 .option ignore_enotdir redirect boolean false
20439 .cindex "ENOTDIR"
20440 If this option is set and an attempt to open a redirection file yields the
20441 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20442 router behaves as if the file did not exist.
20443
20444 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20445 router that has the &%file%& option set discovers that the file does not exist
20446 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20447 against unmounted NFS directories. If the parent can not be statted, delivery
20448 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20449 is set, because that option tells Exim to ignore &"something on the path is not
20450 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20451 that some operating systems give ENOENT where others give ENOTDIR.
20452
20453
20454
20455 .option include_directory redirect string unset
20456 If this option is set, the path names of any &':include:'& items in a
20457 redirection list must start with this directory.
20458
20459
20460 .option modemask redirect "octal integer" 022
20461 This specifies mode bits which must not be set for a file specified by the
20462 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20463
20464
20465 .option one_time redirect boolean false
20466 .cindex "one-time aliasing/forwarding expansion"
20467 .cindex "alias file" "one-time expansion"
20468 .cindex "forward file" "one-time expansion"
20469 .cindex "mailing lists" "one-time expansion"
20470 .cindex "address redirection" "one-time expansion"
20471 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20472 files each time it tries to deliver a message causes a problem when one or more
20473 of the generated addresses fails be delivered at the first attempt. The problem
20474 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20475 but of what happens when the redirection list changes during the time that the
20476 message is on Exim's queue. This is particularly true in the case of mailing
20477 lists, where new subscribers might receive copies of messages that were posted
20478 before they subscribed.
20479
20480 If &%one_time%& is set and any addresses generated by the router fail to
20481 deliver at the first attempt, the failing addresses are added to the message as
20482 &"top level"& addresses, and the parent address that generated them is marked
20483 &"delivered"&. Thus, redirection does not happen again at the next delivery
20484 attempt.
20485
20486 &*Warning 1*&: Any header line addition or removal that is specified by this
20487 router would be lost if delivery did not succeed at the first attempt. For this
20488 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20489 permitted when &%one_time%& is set.
20490
20491 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20492 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20493 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20494
20495 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20496 &%one_time%&.
20497
20498 The original top-level address is remembered with each of the generated
20499 addresses, and is output in any log messages. However, any intermediate parent
20500 addresses are not recorded. This makes a difference to the log only if
20501 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20502 typically be used for mailing lists, where there is normally just one level of
20503 expansion.
20504
20505
20506 .option owners redirect "string list" unset
20507 .cindex "ownership" "alias file"
20508 .cindex "ownership" "forward file"
20509 .cindex "alias file" "ownership"
20510 .cindex "forward file" "ownership"
20511 This specifies a list of permitted owners for the file specified by &%file%&.
20512 This list is in addition to the local user when &%check_local_user%& is set.
20513 See &%check_owner%& above.
20514
20515
20516 .option owngroups redirect "string list" unset
20517 This specifies a list of permitted groups for the file specified by &%file%&.
20518 The list is in addition to the local user's primary group when
20519 &%check_local_user%& is set. See &%check_group%& above.
20520
20521
20522 .option pipe_transport redirect string&!! unset
20523 .vindex "&$address_pipe$&"
20524 A &(redirect)& router sets up a direct delivery to a pipe when a string
20525 starting with a vertical bar character is specified as a new &"address"&. The
20526 transport used is specified by this option, which, after expansion, must be the
20527 name of a configured transport. This should normally be a &(pipe)& transport.
20528 When the transport is run, the pipe command is in &$address_pipe$&.
20529
20530
20531 .option qualify_domain redirect string&!! unset
20532 .vindex "&$qualify_recipient$&"
20533 If this option is set, and an unqualified address (one without a domain) is
20534 generated, and that address would normally be qualified by the global setting
20535 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20536 expanding this string. If the expansion fails, the router declines. If you want
20537 to revert to the default, you can have the expansion generate
20538 &$qualify_recipient$&.
20539
20540 This option applies to all unqualified addresses generated by Exim filters,
20541 but for traditional &_.forward_& files, it applies only to addresses that are
20542 not preceded by a backslash. Sieve filters cannot generate unqualified
20543 addresses.
20544
20545 .option qualify_preserve_domain redirect boolean false
20546 .cindex "domain" "in redirection; preserving"
20547 .cindex "preserving domain in redirection"
20548 .cindex "address redirection" "domain; preserving"
20549 If this option is set, the router's local &%qualify_domain%& option must not be
20550 set (a configuration error occurs if it is). If an unqualified address (one
20551 without a domain) is generated, it is qualified with the domain of the parent
20552 address (the immediately preceding ancestor) instead of the global
20553 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20554 this applies whether or not the address is preceded by a backslash.
20555
20556
20557 .option repeat_use redirect boolean true
20558 If this option is set false, the router is skipped for a child address that has
20559 any ancestor that was routed by this router. This test happens before any of
20560 the other preconditions are tested. Exim's default anti-looping rules skip
20561 only when the ancestor is the same as the current address. See also
20562 &%check_ancestor%& above and the generic &%redirect_router%& option.
20563
20564
20565 .option reply_transport redirect string&!! unset
20566 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20567 &%vacation%& command is used in a filter file. The transport used is specified
20568 by this option, which, after expansion, must be the name of a configured
20569 transport. This should normally be an &(autoreply)& transport. Other transports
20570 are unlikely to do anything sensible or useful.
20571
20572
20573 .option rewrite redirect boolean true
20574 .cindex "address redirection" "disabling rewriting"
20575 If this option is set false, addresses generated by the router are not
20576 subject to address rewriting. Otherwise, they are treated like new addresses
20577 and are rewritten according to the global rewriting rules.
20578
20579
20580 .option sieve_subaddress redirect string&!! unset
20581 The value of this option is passed to a Sieve filter to specify the
20582 :subaddress part of an address.
20583
20584 .option sieve_useraddress redirect string&!! unset
20585 The value of this option is passed to a Sieve filter to specify the :user part
20586 of an address. However, if it is unset, the entire original local part
20587 (including any prefix or suffix) is used for :user.
20588
20589
20590 .option sieve_vacation_directory redirect string&!! unset
20591 .cindex "Sieve filter" "vacation directory"
20592 To enable the &"vacation"& extension for Sieve filters, you must set
20593 &%sieve_vacation_directory%& to the directory where vacation databases are held
20594 (do not put anything else in that directory), and ensure that the
20595 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20596 needs their own directory; Exim will create it if necessary.
20597
20598
20599
20600 .option skip_syntax_errors redirect boolean false
20601 .cindex "forward file" "broken"
20602 .cindex "address redirection" "broken files"
20603 .cindex "alias file" "broken"
20604 .cindex "broken alias or forward files"
20605 .cindex "ignoring faulty addresses"
20606 .cindex "skipping faulty addresses"
20607 .cindex "error" "skipping bad syntax"
20608 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20609 non-filter redirection data are skipped, and each failing address is logged. If
20610 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20611 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20612 are expanded and placed at the head of the error message generated by
20613 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20614 be the same address as the generic &%errors_to%& option. The
20615 &%skip_syntax_errors%& option is often used when handling mailing lists.
20616
20617 If all the addresses in a redirection list are skipped because of syntax
20618 errors, the router declines to handle the original address, and it is passed to
20619 the following routers.
20620
20621 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20622 error in the filter causes filtering to be abandoned without any action being
20623 taken. The incident is logged, and the router declines to handle the address,
20624 so it is passed to the following routers.
20625
20626 .cindex "Sieve filter" "syntax errors in"
20627 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20628 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20629 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20630
20631 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20632 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20633 option, used with an address that does not get redirected, can be used to
20634 notify users of these errors, by means of a router like this:
20635 .code
20636 userforward:
20637   driver = redirect
20638   allow_filter
20639   check_local_user
20640   file = $home/.forward
20641   file_transport = address_file
20642   pipe_transport = address_pipe
20643   reply_transport = address_reply
20644   no_verify
20645   skip_syntax_errors
20646   syntax_errors_to = real-$local_part@$domain
20647   syntax_errors_text = \
20648    This is an automatically generated message. An error has\n\
20649    been found in your .forward file. Details of the error are\n\
20650    reported below. While this error persists, you will receive\n\
20651    a copy of this message for every message that is addressed\n\
20652    to you. If your .forward file is a filter file, or if it is\n\
20653    a non-filter file containing no valid forwarding addresses,\n\
20654    a copy of each incoming message will be put in your normal\n\
20655    mailbox. If a non-filter file contains at least one valid\n\
20656    forwarding address, forwarding to the valid addresses will\n\
20657    happen, and those will be the only deliveries that occur.
20658 .endd
20659 You also need a router to ensure that local addresses that are prefixed by
20660 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20661 put this immediately before the &(userforward)& router:
20662 .code
20663 real_localuser:
20664   driver = accept
20665   check_local_user
20666   local_part_prefix = real-
20667   transport = local_delivery
20668 .endd
20669 For security, it would probably be a good idea to restrict the use of this
20670 router to locally-generated messages, using a condition such as this:
20671 .code
20672   condition = ${if match {$sender_host_address}\
20673                          {\N^(|127\.0\.0\.1)$\N}}
20674 .endd
20675
20676
20677 .option syntax_errors_text redirect string&!! unset
20678 See &%skip_syntax_errors%& above.
20679
20680
20681 .option syntax_errors_to redirect string unset
20682 See &%skip_syntax_errors%& above.
20683 .ecindex IIDredrou1
20684 .ecindex IIDredrou2
20685
20686
20687
20688
20689
20690
20691 . ////////////////////////////////////////////////////////////////////////////
20692 . ////////////////////////////////////////////////////////////////////////////
20693
20694 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20695          "Environment for local transports"
20696 .scindex IIDenvlotra1 "local transports" "environment for"
20697 .scindex IIDenvlotra2 "environment" "local transports"
20698 .scindex IIDenvlotra3 "transport" "local; environment for"
20699 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20700 transport can be thought of as similar to a pipe.) Exim always runs transports
20701 in subprocesses, under specified uids and gids. Typical deliveries to local
20702 mailboxes run under the uid and gid of the local user.
20703
20704 Exim also sets a specific current directory while running the transport; for
20705 some transports a home directory setting is also relevant. The &(pipe)&
20706 transport is the only one that sets up environment variables; see section
20707 &<<SECTpipeenv>>& for details.
20708
20709 The values used for the uid, gid, and the directories may come from several
20710 different places. In many cases, the router that handles the address associates
20711 settings with that address as a result of its &%check_local_user%&, &%group%&,
20712 or &%user%& options. However, values may also be given in the transport's own
20713 configuration, and these override anything that comes from the router.
20714
20715
20716
20717 .section "Concurrent deliveries" "SECID131"
20718 .cindex "concurrent deliveries"
20719 .cindex "simultaneous deliveries"
20720 If two different messages for the same local recipient arrive more or less
20721 simultaneously, the two delivery processes are likely to run concurrently. When
20722 the &(appendfile)& transport is used to write to a file, Exim applies locking
20723 rules to stop concurrent processes from writing to the same file at the same
20724 time.
20725
20726 However, when you use a &(pipe)& transport, it is up to you to arrange any
20727 locking that is needed. Here is a silly example:
20728 .code
20729 my_transport:
20730   driver = pipe
20731   command = /bin/sh -c 'cat >>/some/file'
20732 .endd
20733 This is supposed to write the message at the end of the file. However, if two
20734 messages arrive at the same time, the file will be scrambled. You can use the
20735 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20736 file using the same algorithm that Exim itself uses.
20737
20738
20739
20740
20741 .section "Uids and gids" "SECTenvuidgid"
20742 .cindex "local transports" "uid and gid"
20743 .cindex "transport" "local; uid and gid"
20744 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20745 overrides any group that the router set in the address, even if &%user%& is not
20746 set for the transport. This makes it possible, for example, to run local mail
20747 delivery under the uid of the recipient (set by the router), but in a special
20748 group (set by the transport). For example:
20749 .code
20750 # Routers ...
20751 # User/group are set by check_local_user in this router
20752 local_users:
20753   driver = accept
20754   check_local_user
20755   transport = group_delivery
20756
20757 # Transports ...
20758 # This transport overrides the group
20759 group_delivery:
20760   driver = appendfile
20761   file = /var/spool/mail/$local_part
20762   group = mail
20763 .endd
20764 If &%user%& is set for a transport, its value overrides what is set in the
20765 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20766 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20767 set.
20768
20769 .oindex "&%initgroups%&"
20770 When the uid is taken from the transport's configuration, the &[initgroups()]&
20771 function is called for the groups associated with that uid if the
20772 &%initgroups%& option is set for the transport. When the uid is not specified
20773 by the transport, but is associated with the address by a router, the option
20774 for calling &[initgroups()]& is taken from the router configuration.
20775
20776 .cindex "&(pipe)& transport" "uid for"
20777 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20778 is set and &%user%& is not set, the uid of the process that called Exim to
20779 receive the message is used, and if &%group%& is not set, the corresponding
20780 original gid is also used.
20781
20782 This is the detailed preference order for obtaining a gid; the first of the
20783 following that is set is used:
20784
20785 .ilist
20786 A &%group%& setting of the transport;
20787 .next
20788 A &%group%& setting of the router;
20789 .next
20790 A gid associated with a user setting of the router, either as a result of
20791 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20792 .next
20793 The group associated with a non-numeric &%user%& setting of the transport;
20794 .next
20795 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20796 the uid is the creator's uid;
20797 .next
20798 The Exim gid if the Exim uid is being used as a default.
20799 .endlist
20800
20801 If, for example, the user is specified numerically on the router and there are
20802 no group settings, no gid is available. In this situation, an error occurs.
20803 This is different for the uid, for which there always is an ultimate default.
20804 The first of the following that is set is used:
20805
20806 .ilist
20807 A &%user%& setting of the transport;
20808 .next
20809 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20810 .next
20811 A &%user%& setting of the router;
20812 .next
20813 A &%check_local_user%& setting of the router;
20814 .next
20815 The Exim uid.
20816 .endlist
20817
20818 Of course, an error will still occur if the uid that is chosen is on the
20819 &%never_users%& list.
20820
20821
20822
20823
20824
20825 .section "Current and home directories" "SECID132"
20826 .cindex "current directory for local transport"
20827 .cindex "home directory" "for local transport"
20828 .cindex "transport" "local; home directory for"
20829 .cindex "transport" "local; current directory for"
20830 Routers may set current and home directories for local transports by means of
20831 the &%transport_current_directory%& and &%transport_home_directory%& options.
20832 However, if the transport's &%current_directory%& or &%home_directory%& options
20833 are set, they override the router's values. In detail, the home directory
20834 for a local transport is taken from the first of these values that is set:
20835
20836 .ilist
20837 The &%home_directory%& option on the transport;
20838 .next
20839 The &%transport_home_directory%& option on the router;
20840 .next
20841 The password data if &%check_local_user%& is set on the router;
20842 .next
20843 The &%router_home_directory%& option on the router.
20844 .endlist
20845
20846 The current directory is taken from the first of these values that is set:
20847
20848 .ilist
20849 The &%current_directory%& option on the transport;
20850 .next
20851 The &%transport_current_directory%& option on the router.
20852 .endlist
20853
20854
20855 If neither the router nor the transport sets a current directory, Exim uses the
20856 value of the home directory, if it is set. Otherwise it sets the current
20857 directory to &_/_& before running a local transport.
20858
20859
20860
20861 .section "Expansion variables derived from the address" "SECID133"
20862 .vindex "&$domain$&"
20863 .vindex "&$local_part$&"
20864 .vindex "&$original_domain$&"
20865 Normally a local delivery is handling a single address, and in that case the
20866 variables such as &$domain$& and &$local_part$& are set during local
20867 deliveries. However, in some circumstances more than one address may be handled
20868 at once (for example, while writing batch SMTP for onward transmission by some
20869 other means). In this case, the variables associated with the local part are
20870 never set, &$domain$& is set only if all the addresses have the same domain,
20871 and &$original_domain$& is never set.
20872 .ecindex IIDenvlotra1
20873 .ecindex IIDenvlotra2
20874 .ecindex IIDenvlotra3
20875
20876
20877
20878
20879
20880
20881
20882 . ////////////////////////////////////////////////////////////////////////////
20883 . ////////////////////////////////////////////////////////////////////////////
20884
20885 .chapter "Generic options for transports" "CHAPtransportgeneric"
20886 .scindex IIDgenoptra1 "generic options" "transport"
20887 .scindex IIDgenoptra2 "options" "generic; for transports"
20888 .scindex IIDgenoptra3 "transport" "generic options for"
20889 The following generic options apply to all transports:
20890
20891
20892 .option body_only transports boolean false
20893 .cindex "transport" "body only"
20894 .cindex "message" "transporting body only"
20895 .cindex "body of message" "transporting"
20896 If this option is set, the message's headers are not transported. It is
20897 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20898 or &(pipe)& transports, the settings of &%message_prefix%& and
20899 &%message_suffix%& should be checked, because this option does not
20900 automatically suppress them.
20901
20902
20903 .option current_directory transports string&!! unset
20904 .cindex "transport" "current directory for"
20905 This specifies the current directory that is to be set while running the
20906 transport, overriding any value that may have been set by the router.
20907 If the expansion fails for any reason, including forced failure, an error is
20908 logged, and delivery is deferred.
20909
20910
20911 .option disable_logging transports boolean false
20912 If this option is set true, nothing is logged for any
20913 deliveries by the transport or for any
20914 transport errors. You should not set this option unless you really, really know
20915 what you are doing.
20916
20917
20918 .option debug_print transports string&!! unset
20919 .cindex "testing" "variables in drivers"
20920 If this option is set and debugging is enabled (see the &%-d%& command line
20921 option), the string is expanded and included in the debugging output when the
20922 transport is run.
20923 If expansion of the string fails, the error message is written to the debugging
20924 output, and Exim carries on processing.
20925 This facility is provided to help with checking out the values of variables and
20926 so on when debugging driver configurations. For example, if a &%headers_add%&
20927 option is not working properly, &%debug_print%& could be used to output the
20928 variables it references. A newline is added to the text if it does not end with
20929 one.
20930 The variables &$transport_name$& and &$router_name$& contain the name of the
20931 transport and the router that called it.
20932
20933 .option delivery_date_add transports boolean false
20934 .cindex "&'Delivery-date:'& header line"
20935 If this option is true, a &'Delivery-date:'& header is added to the message.
20936 This gives the actual time the delivery was made. As this is not a standard
20937 header, Exim has a configuration option (&%delivery_date_remove%&) which
20938 requests its removal from incoming messages, so that delivered messages can
20939 safely be resent to other recipients.
20940
20941
20942 .option driver transports string unset
20943 This specifies which of the available transport drivers is to be used.
20944 There is no default, and this option must be set for every transport.
20945
20946
20947 .option envelope_to_add transports boolean false
20948 .cindex "&'Envelope-to:'& header line"
20949 If this option is true, an &'Envelope-to:'& header is added to the message.
20950 This gives the original address(es) in the incoming envelope that caused this
20951 delivery to happen. More than one address may be present if the transport is
20952 configured to handle several addresses at once, or if more than one original
20953 address was redirected to the same final address. As this is not a standard
20954 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20955 its removal from incoming messages, so that delivered messages can safely be
20956 resent to other recipients.
20957
20958
20959 .option event_action transports string&!! unset
20960 .cindex events
20961 This option declares a string to be expanded for Exim's events mechanism.
20962 For details see chapter &<<CHAPevents>>&.
20963
20964
20965 .option group transports string&!! "Exim group"
20966 .cindex "transport" "group; specifying"
20967 This option specifies a gid for running the transport process, overriding any
20968 value that the router supplies, and also overriding any value associated with
20969 &%user%& (see below).
20970
20971
20972 .option headers_add transports list&!! unset
20973 .cindex "header lines" "adding in transport"
20974 .cindex "transport" "header lines; adding"
20975 This option specifies a list of text headers,
20976 newline-separated (by default, changeable in the usual way),
20977 which are (separately) expanded and added to the header
20978 portion of a message as it is transported, as described in section
20979 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20980 routers. If the result of the expansion is an empty string, or if the expansion
20981 is forced to fail, no action is taken. Other expansion failures are treated as
20982 errors and cause the delivery to be deferred.
20983
20984 Unlike most options, &%headers_add%& can be specified multiple times
20985 for a transport; all listed headers are added.
20986
20987
20988 .option headers_only transports boolean false
20989 .cindex "transport" "header lines only"
20990 .cindex "message" "transporting headers only"
20991 .cindex "header lines" "transporting"
20992 If this option is set, the message's body is not transported. It is mutually
20993 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20994 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20995 checked, since this option does not automatically suppress them.
20996
20997
20998 .option headers_remove transports list&!! unset
20999 .cindex "header lines" "removing"
21000 .cindex "transport" "header lines; removing"
21001 This option specifies a list of header names,
21002 colon-separated (by default, changeable in the usual way);
21003 these headers are omitted from the message as it is transported, as described
21004 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21005 routers.
21006 Each list item is separately expanded.
21007 If the result of the expansion is an empty string, or if the expansion
21008 is forced to fail, no action is taken. Other expansion failures are treated as
21009 errors and cause the delivery to be deferred.
21010
21011 Unlike most options, &%headers_remove%& can be specified multiple times
21012 for a transport; all listed headers are removed.
21013
21014 &*Warning*&: Because of the separate expansion of the list items,
21015 items that contain a list separator must have it doubled.
21016 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21017
21018
21019
21020 .option headers_rewrite transports string unset
21021 .cindex "transport" "header lines; rewriting"
21022 .cindex "rewriting" "at transport time"
21023 This option allows addresses in header lines to be rewritten at transport time,
21024 that is, as the message is being copied to its destination. The contents of the
21025 option are a colon-separated list of rewriting rules. Each rule is in exactly
21026 the same form as one of the general rewriting rules that are applied when a
21027 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21028 example,
21029 .code
21030 headers_rewrite = a@b c@d f : \
21031                   x@y w@z
21032 .endd
21033 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21034 &'w@z'& in all address-bearing header lines. The rules are applied to the
21035 header lines just before they are written out at transport time, so they affect
21036 only those copies of the message that pass through the transport. However, only
21037 the message's original header lines, and any that were added by a system
21038 filter, are rewritten. If a router or transport adds header lines, they are not
21039 affected by this option. These rewriting rules are &'not'& applied to the
21040 envelope. You can change the return path using &%return_path%&, but you cannot
21041 change envelope recipients at this time.
21042
21043
21044 .option home_directory transports string&!! unset
21045 .cindex "transport" "home directory for"
21046 .vindex "&$home$&"
21047 This option specifies a home directory setting for a local transport,
21048 overriding any value that may be set by the router. The home directory is
21049 placed in &$home$& while expanding the transport's private options. It is also
21050 used as the current directory if no current directory is set by the
21051 &%current_directory%& option on the transport or the
21052 &%transport_current_directory%& option on the router. If the expansion fails
21053 for any reason, including forced failure, an error is logged, and delivery is
21054 deferred.
21055
21056
21057 .option initgroups transports boolean false
21058 .cindex "additional groups"
21059 .cindex "groups" "additional"
21060 .cindex "transport" "group; additional"
21061 If this option is true and the uid for the delivery process is provided by the
21062 transport, the &[initgroups()]& function is called when running the transport
21063 to ensure that any additional groups associated with the uid are set up.
21064
21065
21066 .option max_parallel transports integer&!! unset
21067 .cindex limit "transport parallelism"
21068 .cindex transport "parallel processes"
21069 .cindex transport "concurrency limit"
21070 .cindex "delivery" "parallelism for transport"
21071 If this option is set and expands to an integer greater than zero
21072 it limits the number of concurrent runs of the transport.
21073 The control does not apply to shadow transports.
21074
21075 .cindex "hints database" "transport concurrency control"
21076 Exim implements this control by means of a hints database in which a record is
21077 incremented whenever a transport process is being created. The record
21078 is decremented and possibly removed when the process terminates.
21079 Obviously there is scope for
21080 records to get left lying around if there is a system or program crash. To
21081 guard against this, Exim ignores any records that are more than six hours old.
21082
21083 If you use this option, you should also arrange to delete the
21084 relevant hints database whenever your system reboots. The names of the files
21085 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21086 may be one or two files, depending on the type of DBM in use. The same files
21087 are used for ETRN and smtp transport serialization.
21088
21089
21090 .option message_size_limit transports string&!! 0
21091 .cindex "limit" "message size per transport"
21092 .cindex "size" "of message, limit"
21093 .cindex "transport" "message size; limiting"
21094 This option controls the size of messages passed through the transport. It is
21095 expanded before use; the result of the expansion must be a sequence of decimal
21096 digits, optionally followed by K or M. If the expansion fails for any reason,
21097 including forced failure, or if the result is not of the required form,
21098 delivery is deferred. If the value is greater than zero and the size of a
21099 message exceeds this limit, the address is failed. If there is any chance that
21100 the resulting bounce message could be routed to the same transport, you should
21101 ensure that &%return_size_limit%& is less than the transport's
21102 &%message_size_limit%&, as otherwise the bounce message will fail to get
21103 delivered.
21104
21105
21106
21107 .option rcpt_include_affixes transports boolean false
21108 .cindex "prefix" "for local part, including in envelope"
21109 .cindex "suffix for local part" "including in envelope"
21110 .cindex "local part" "prefix"
21111 .cindex "local part" "suffix"
21112 When this option is false (the default), and an address that has had any
21113 affixes (prefixes or suffixes) removed from the local part is delivered by any
21114 form of SMTP or LMTP, the affixes are not included. For example, if a router
21115 that contains
21116 .code
21117 local_part_prefix = *-
21118 .endd
21119 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21120 is delivered with
21121 .code
21122 RCPT TO:<xyz@some.domain>
21123 .endd
21124 This is also the case when an ACL-time callout is being used to verify a
21125 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21126 whole local part is included in the RCPT command. This option applies to BSMTP
21127 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21128 &(lmtp)& and &(smtp)& transports.
21129
21130
21131 .option retry_use_local_part transports boolean "see below"
21132 .cindex "hints database" "retry keys"
21133 When a delivery suffers a temporary failure, a retry record is created
21134 in Exim's hints database. For remote deliveries, the key for the retry record
21135 is based on the name and/or IP address of the failing remote host. For local
21136 deliveries, the key is normally the entire address, including both the local
21137 part and the domain. This is suitable for most common cases of local delivery
21138 temporary failure &-- for example, exceeding a mailbox quota should delay only
21139 deliveries to that mailbox, not to the whole domain.
21140
21141 However, in some special cases you may want to treat a temporary local delivery
21142 as a failure associated with the domain, and not with a particular local part.
21143 (For example, if you are storing all mail for some domain in files.) You can do
21144 this by setting &%retry_use_local_part%& false.
21145
21146 For all the local transports, its default value is true. For remote transports,
21147 the default value is false for tidiness, but changing the value has no effect
21148 on a remote transport in the current implementation.
21149
21150
21151 .option return_path transports string&!! unset
21152 .cindex "envelope sender"
21153 .cindex "transport" "return path; changing"
21154 .cindex "return path" "changing in transport"
21155 If this option is set, the string is expanded at transport time and replaces
21156 the existing return path (envelope sender) value in the copy of the message
21157 that is being delivered. An empty return path is permitted. This feature is
21158 designed for remote deliveries, where the value of this option is used in the
21159 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21160 only effect is to change the address that is placed in the &'Return-path:'&
21161 header line, if one is added to the message (see the next option).
21162
21163 &*Note:*& A changed return path is not logged unless you add
21164 &%return_path_on_delivery%& to the log selector.
21165
21166 .vindex "&$return_path$&"
21167 The expansion can refer to the existing value via &$return_path$&. This is
21168 either the message's envelope sender, or an address set by the
21169 &%errors_to%& option on a router. If the expansion is forced to fail, no
21170 replacement occurs; if it fails for another reason, delivery is deferred. This
21171 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21172 section &<<SECTverp>>&.
21173
21174 &*Note*&: If a delivery error is detected locally, including the case when a
21175 remote server rejects a message at SMTP time, the bounce message is not sent to
21176 the value of this option. It is sent to the previously set errors address.
21177 This defaults to the incoming sender address, but can be changed by setting
21178 &%errors_to%& in a router.
21179
21180
21181
21182 .option return_path_add transports boolean false
21183 .cindex "&'Return-path:'& header line"
21184 If this option is true, a &'Return-path:'& header is added to the message.
21185 Although the return path is normally available in the prefix line of BSD
21186 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21187 have easy access to it.
21188
21189 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21190 the delivery SMTP server makes the final delivery"&. This implies that this
21191 header should not be present in incoming messages. Exim has a configuration
21192 option, &%return_path_remove%&, which requests removal of this header from
21193 incoming messages, so that delivered messages can safely be resent to other
21194 recipients.
21195
21196
21197 .option shadow_condition transports string&!! unset
21198 See &%shadow_transport%& below.
21199
21200
21201 .option shadow_transport transports string unset
21202 .cindex "shadow transport"
21203 .cindex "transport" "shadow"
21204 A local transport may set the &%shadow_transport%& option to the name of
21205 another local transport. Shadow remote transports are not supported.
21206
21207 Whenever a delivery to the main transport succeeds, and either
21208 &%shadow_condition%& is unset, or its expansion does not result in the empty
21209 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21210 passed to the shadow transport, with the same delivery address or addresses. If
21211 expansion fails, no action is taken except that non-forced expansion failures
21212 cause a log line to be written.
21213
21214 The result of the shadow transport is discarded and does not affect the
21215 subsequent processing of the message. Only a single level of shadowing is
21216 provided; the &%shadow_transport%& option is ignored on any transport when it
21217 is running as a shadow. Options concerned with output from pipes are also
21218 ignored. The log line for the successful delivery has an item added on the end,
21219 of the form
21220 .code
21221 ST=<shadow transport name>
21222 .endd
21223 If the shadow transport did not succeed, the error message is put in
21224 parentheses afterwards. Shadow transports can be used for a number of different
21225 purposes, including keeping more detailed log information than Exim normally
21226 provides, and implementing automatic acknowledgment policies based on message
21227 headers that some sites insist on.
21228
21229
21230 .option transport_filter transports string&!! unset
21231 .cindex "transport" "filter"
21232 .cindex "filter" "transport filter"
21233 This option sets up a filtering (in the Unix shell sense) process for messages
21234 at transport time. It should not be confused with mail filtering as set up by
21235 individual users or via a system filter.
21236 If unset, or expanding to an empty string, no filtering is done.
21237
21238 When the message is about to be written out, the command specified by
21239 &%transport_filter%& is started up in a separate, parallel process, and
21240 the entire message, including the header lines, is passed to it on its standard
21241 input (this in fact is done from a third process, to avoid deadlock). The
21242 command must be specified as an absolute path.
21243
21244 The lines of the message that are written to the transport filter are
21245 terminated by newline (&"\n"&). The message is passed to the filter before any
21246 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21247 lines beginning with a dot, and also before any processing implied by the
21248 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21249 &(pipe)& transports.
21250
21251 The standard error for the filter process is set to the same destination as its
21252 standard output; this is read and written to the message's ultimate
21253 destination. The process that writes the message to the filter, the
21254 filter itself, and the original process that reads the result and delivers it
21255 are all run in parallel, like a shell pipeline.
21256
21257 The filter can perform any transformations it likes, but of course should take
21258 care not to break RFC 2822 syntax. Exim does not check the result, except to
21259 test for a final newline when SMTP is in use. All messages transmitted over
21260 SMTP must end with a newline, so Exim supplies one if it is missing.
21261
21262 .cindex "content scanning" "per user"
21263 A transport filter can be used to provide content-scanning on a per-user basis
21264 at delivery time if the only required effect of the scan is to modify the
21265 message. For example, a content scan could insert a new header line containing
21266 a spam score. This could be interpreted by a filter in the user's MUA. It is
21267 not possible to discard a message at this stage.
21268
21269 .cindex "SMTP" "SIZE"
21270 A problem might arise if the filter increases the size of a message that is
21271 being sent down an SMTP connection. If the receiving SMTP server has indicated
21272 support for the SIZE parameter, Exim will have sent the size of the message
21273 at the start of the SMTP session. If what is actually sent is substantially
21274 more, the server might reject the message. This can be worked round by setting
21275 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21276 additions to the message, or to disable the use of SIZE altogether.
21277
21278 .vindex "&$pipe_addresses$&"
21279 The value of the &%transport_filter%& option is the command string for starting
21280 the filter, which is run directly from Exim, not under a shell. The string is
21281 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21282 Exim breaks it up into arguments and then expands each argument separately (see
21283 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21284 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21285 of arguments, one for each address that applies to this delivery. (This isn't
21286 an ideal name for this feature here, but as it was already implemented for the
21287 &(pipe)& transport, it seemed sensible not to change it.)
21288
21289 .vindex "&$host$&"
21290 .vindex "&$host_address$&"
21291 The expansion variables &$host$& and &$host_address$& are available when the
21292 transport is a remote one. They contain the name and IP address of the host to
21293 which the message is being sent. For example:
21294 .code
21295 transport_filter = /some/directory/transport-filter.pl \
21296   $host $host_address $sender_address $pipe_addresses
21297 .endd
21298
21299 Two problems arise if you want to use more complicated expansion items to
21300 generate transport filter commands, both of which due to the fact that the
21301 command is split up &'before'& expansion.
21302 .ilist
21303 If an expansion item contains white space, you must quote it, so that it is all
21304 part of the same command item. If the entire option setting is one such
21305 expansion item, you have to take care what kind of quoting you use. For
21306 example:
21307 .code
21308 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21309 .endd
21310 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21311 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21312 stripped by Exim when it read the option's value. When the value is used, if
21313 the single quotes were missing, the line would be split into two items,
21314 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21315 Exim tried to expand the first one.
21316 .next
21317 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21318 expansion cannot generate multiple arguments, or a command name followed by
21319 arguments. Consider this example:
21320 .code
21321 transport_filter = ${lookup{$host}lsearch{/a/file}\
21322                     {$value}{/bin/cat}}
21323 .endd
21324 The result of the lookup is interpreted as the name of the command, even
21325 if it contains white space. The simplest way round this is to use a shell:
21326 .code
21327 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21328                                {$value}{/bin/cat}}
21329 .endd
21330 .endlist
21331
21332 The filter process is run under the same uid and gid as the normal delivery.
21333 For remote deliveries this is the Exim uid/gid by default. The command should
21334 normally yield a zero return code. Transport filters are not supposed to fail.
21335 A non-zero code is taken to mean that the transport filter encountered some
21336 serious problem. Delivery of the message is deferred; the message remains on
21337 the queue and is tried again later. It is not possible to cause a message to be
21338 bounced from a transport filter.
21339
21340 If a transport filter is set on an autoreply transport, the original message is
21341 passed through the filter as it is being copied into the newly generated
21342 message, which happens if the &%return_message%& option is set.
21343
21344
21345 .option transport_filter_timeout transports time 5m
21346 .cindex "transport" "filter, timeout"
21347 When Exim is reading the output of a transport filter, it applies a timeout
21348 that can be set by this option. Exceeding the timeout is normally treated as a
21349 temporary delivery failure. However, if a transport filter is used with a
21350 &(pipe)& transport, a timeout in the transport filter is treated in the same
21351 way as a timeout in the pipe command itself. By default, a timeout is a hard
21352 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21353 becomes a temporary error.
21354
21355
21356 .option user transports string&!! "Exim user"
21357 .cindex "uid (user id)" "local delivery"
21358 .cindex "transport" "user, specifying"
21359 This option specifies the user under whose uid the delivery process is to be
21360 run, overriding any uid that may have been set by the router. If the user is
21361 given as a name, the uid is looked up from the password data, and the
21362 associated group is taken as the value of the gid to be used if the &%group%&
21363 option is not set.
21364
21365 For deliveries that use local transports, a user and group are normally
21366 specified explicitly or implicitly (for example, as a result of
21367 &%check_local_user%&) by the router or transport.
21368
21369 .cindex "hints database" "access by remote transport"
21370 For remote transports, you should leave this option unset unless you really are
21371 sure you know what you are doing. When a remote transport is running, it needs
21372 to be able to access Exim's hints databases, because each host may have its own
21373 retry data.
21374 .ecindex IIDgenoptra1
21375 .ecindex IIDgenoptra2
21376 .ecindex IIDgenoptra3
21377
21378
21379
21380
21381
21382
21383 . ////////////////////////////////////////////////////////////////////////////
21384 . ////////////////////////////////////////////////////////////////////////////
21385
21386 .chapter "Address batching in local transports" "CHAPbatching" &&&
21387          "Address batching"
21388 .cindex "transport" "local; address batching in"
21389 The only remote transport (&(smtp)&) is normally configured to handle more than
21390 one address at a time, so that when several addresses are routed to the same
21391 remote host, just one copy of the message is sent. Local transports, however,
21392 normally handle one address at a time. That is, a separate instance of the
21393 transport is run for each address that is routed to the transport. A separate
21394 copy of the message is delivered each time.
21395
21396 .cindex "batched local delivery"
21397 .oindex "&%batch_max%&"
21398 .oindex "&%batch_id%&"
21399 In special cases, it may be desirable to handle several addresses at once in a
21400 local transport, for example:
21401
21402 .ilist
21403 In an &(appendfile)& transport, when storing messages in files for later
21404 delivery by some other means, a single copy of the message with multiple
21405 recipients saves space.
21406 .next
21407 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21408 a single copy saves time, and is the normal way LMTP is expected to work.
21409 .next
21410 In a &(pipe)& transport, when passing the message
21411 to a scanner program or
21412 to some other delivery mechanism such as UUCP, multiple recipients may be
21413 acceptable.
21414 .endlist
21415
21416 These three local transports all have the same options for controlling multiple
21417 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21418 repeating the information for each transport, these options are described here.
21419
21420 The &%batch_max%& option specifies the maximum number of addresses that can be
21421 delivered together in a single run of the transport. Its default value is one
21422 (no batching). When more than one address is routed to a transport that has a
21423 &%batch_max%& value greater than one, the addresses are delivered in a batch
21424 (that is, in a single run of the transport with multiple recipients), subject
21425 to certain conditions:
21426
21427 .ilist
21428 .vindex "&$local_part$&"
21429 If any of the transport's options contain a reference to &$local_part$&, no
21430 batching is possible.
21431 .next
21432 .vindex "&$domain$&"
21433 If any of the transport's options contain a reference to &$domain$&, only
21434 addresses with the same domain are batched.
21435 .next
21436 .cindex "customizing" "batching condition"
21437 If &%batch_id%& is set, it is expanded for each address, and only those
21438 addresses with the same expanded value are batched. This allows you to specify
21439 customized batching conditions. Failure of the expansion for any reason,
21440 including forced failure, disables batching, but it does not stop the delivery
21441 from taking place.
21442 .next
21443 Batched addresses must also have the same errors address (where to send
21444 delivery errors), the same header additions and removals, the same user and
21445 group for the transport, and if a host list is present, the first host must
21446 be the same.
21447 .endlist
21448
21449 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21450 both when the file or pipe command is specified in the transport, and when it
21451 is specified by a &(redirect)& router, but all the batched addresses must of
21452 course be routed to the same file or pipe command. These two transports have an
21453 option called &%use_bsmtp%&, which causes them to deliver the message in
21454 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21455 &%check_string%& and &%escape_string%& options are forced to the values
21456 .code
21457 check_string = "."
21458 escape_string = ".."
21459 .endd
21460 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21461 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21462 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21463
21464 .cindex "&'Envelope-to:'& header line"
21465 If the generic &%envelope_to_add%& option is set for a batching transport, the
21466 &'Envelope-to:'& header that is added to the message contains all the addresses
21467 that are being processed together. If you are using a batching &(appendfile)&
21468 transport without &%use_bsmtp%&, the only way to preserve the recipient
21469 addresses is to set the &%envelope_to_add%& option.
21470
21471 .cindex "&(pipe)& transport" "with multiple addresses"
21472 .vindex "&$pipe_addresses$&"
21473 If you are using a &(pipe)& transport without BSMTP, and setting the
21474 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21475 the command. This is not a true variable; it is a bit of magic that causes each
21476 of the recipient addresses to be inserted into the command as a separate
21477 argument. This provides a way of accessing all the addresses that are being
21478 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21479 are specified by a &(redirect)& router.
21480
21481
21482
21483
21484 . ////////////////////////////////////////////////////////////////////////////
21485 . ////////////////////////////////////////////////////////////////////////////
21486
21487 .chapter "The appendfile transport" "CHAPappendfile"
21488 .scindex IIDapptra1 "&(appendfile)& transport"
21489 .scindex IIDapptra2 "transports" "&(appendfile)&"
21490 .cindex "directory creation"
21491 .cindex "creating directories"
21492 The &(appendfile)& transport delivers a message by appending it to an existing
21493 file, or by creating an entirely new file in a specified directory. Single
21494 files to which messages are appended can be in the traditional Unix mailbox
21495 format, or optionally in the MBX format supported by the Pine MUA and
21496 University of Washington IMAP daemon, &'inter alia'&. When each message is
21497 being delivered as a separate file, &"maildir"& format can optionally be used
21498 to give added protection against failures that happen part-way through the
21499 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21500 supported. For all file formats, Exim attempts to create as many levels of
21501 directory as necessary, provided that &%create_directory%& is set.
21502
21503 The code for the optional formats is not included in the Exim binary by
21504 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21505 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21506 included.
21507
21508 .cindex "quota" "system"
21509 Exim recognizes system quota errors, and generates an appropriate message. Exim
21510 also supports its own quota control within the transport, for use when the
21511 system facility is unavailable or cannot be used for some reason.
21512
21513 If there is an error while appending to a file (for example, quota exceeded or
21514 partition filled), Exim attempts to reset the file's length and last
21515 modification time back to what they were before. If there is an error while
21516 creating an entirely new file, the new file is removed.
21517
21518 Before appending to a file, a number of security checks are made, and the
21519 file is locked. A detailed description is given below, after the list of
21520 private options.
21521
21522 The &(appendfile)& transport is most commonly used for local deliveries to
21523 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21524 putting messages into files for remote delivery by some means other than Exim.
21525 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21526 option).
21527
21528
21529
21530 .section "The file and directory options" "SECTfildiropt"
21531 The &%file%& option specifies a single file, to which the message is appended;
21532 the &%directory%& option specifies a directory, in which a new file containing
21533 the message is created. Only one of these two options can be set, and for
21534 normal deliveries to mailboxes, one of them &'must'& be set.
21535
21536 .vindex "&$address_file$&"
21537 .vindex "&$local_part$&"
21538 However, &(appendfile)& is also used for delivering messages to files or
21539 directories whose names (or parts of names) are obtained from alias,
21540 forwarding, or filtering operations (for example, a &%save%& command in a
21541 user's Exim filter). When such a transport is running, &$local_part$& contains
21542 the local part that was aliased or forwarded, and &$address_file$& contains the
21543 name (or partial name) of the file or directory generated by the redirection
21544 operation. There are two cases:
21545
21546 .ilist
21547 If neither &%file%& nor &%directory%& is set, the redirection operation
21548 must specify an absolute path (one that begins with &`/`&). This is the most
21549 common case when users with local accounts use filtering to sort mail into
21550 different folders. See for example, the &(address_file)& transport in the
21551 default configuration. If the path ends with a slash, it is assumed to be the
21552 name of a directory. A delivery to a directory can also be forced by setting
21553 &%maildir_format%& or &%mailstore_format%&.
21554 .next
21555 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21556 used to determine the file or directory name for the delivery. Normally, the
21557 contents of &$address_file$& are used in some way in the string expansion.
21558 .endlist
21559
21560
21561 .cindex "Sieve filter" "configuring &(appendfile)&"
21562 .cindex "Sieve filter" "relative mailbox path handling"
21563 As an example of the second case, consider an environment where users do not
21564 have home directories. They may be permitted to use Exim filter commands of the
21565 form:
21566 .code
21567 save folder23
21568 .endd
21569 or Sieve filter commands of the form:
21570 .code
21571 require "fileinto";
21572 fileinto "folder23";
21573 .endd
21574 In this situation, the expansion of &%file%& or &%directory%& in the transport
21575 must transform the relative path into an appropriate absolute file name. In the
21576 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21577 is used as a result of a &"keep"& action in the filter. This example shows one
21578 way of handling this requirement:
21579 .code
21580 file = ${if eq{$address_file}{inbox} \
21581             {/var/mail/$local_part} \
21582             {${if eq{${substr_0_1:$address_file}}{/} \
21583                   {$address_file} \
21584                   {$home/mail/$address_file} \
21585             }} \
21586        }
21587 .endd
21588 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21589 location, absolute paths are used without change, and other folders are in the
21590 &_mail_& directory within the home directory.
21591
21592 &*Note 1*&: While processing an Exim filter, a relative path such as
21593 &_folder23_& is turned into an absolute path if a home directory is known to
21594 the router. In particular, this is the case if &%check_local_user%& is set. If
21595 you want to prevent this happening at routing time, you can set
21596 &%router_home_directory%& empty. This forces the router to pass the relative
21597 path to the transport.
21598
21599 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21600 the &%file%& or &%directory%& option is still used if it is set.
21601
21602
21603
21604
21605 .section "Private options for appendfile" "SECID134"
21606 .cindex "options" "&(appendfile)& transport"
21607
21608
21609
21610 .option allow_fifo appendfile boolean false
21611 .cindex "fifo (named pipe)"
21612 .cindex "named pipe (fifo)"
21613 .cindex "pipe" "named (fifo)"
21614 Setting this option permits delivery to named pipes (FIFOs) as well as to
21615 regular files. If no process is reading the named pipe at delivery time, the
21616 delivery is deferred.
21617
21618
21619 .option allow_symlink appendfile boolean false
21620 .cindex "symbolic link" "to mailbox"
21621 .cindex "mailbox" "symbolic link"
21622 By default, &(appendfile)& will not deliver if the path name for the file is
21623 that of a symbolic link. Setting this option relaxes that constraint, but there
21624 are security issues involved in the use of symbolic links. Be sure you know
21625 what you are doing if you set this. Details of exactly what this option affects
21626 are included in the discussion which follows this list of options.
21627
21628
21629 .option batch_id appendfile string&!! unset
21630 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21631 However, batching is automatically disabled for &(appendfile)& deliveries that
21632 happen as a result of forwarding or aliasing or other redirection directly to a
21633 file.
21634
21635
21636 .option batch_max appendfile integer 1
21637 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21638
21639
21640 .option check_group appendfile boolean false
21641 When this option is set, the group owner of the file defined by the &%file%&
21642 option is checked to see that it is the same as the group under which the
21643 delivery process is running. The default setting is false because the default
21644 file mode is 0600, which means that the group is irrelevant.
21645
21646
21647 .option check_owner appendfile boolean true
21648 When this option is set, the owner of the file defined by the &%file%& option
21649 is checked to ensure that it is the same as the user under which the delivery
21650 process is running.
21651
21652
21653 .option check_string appendfile string "see below"
21654 .cindex "&""From""& line"
21655 As &(appendfile)& writes the message, the start of each line is tested for
21656 matching &%check_string%&, and if it does, the initial matching characters are
21657 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21658 a literal string, not a regular expression, and the case of any letters it
21659 contains is significant.
21660
21661 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21662 are forced to &"."& and &".."& respectively, and any settings in the
21663 configuration are ignored. Otherwise, they default to &"From&~"& and
21664 &">From&~"& when the &%file%& option is set, and unset when any of the
21665 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21666
21667 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21668 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21669 &"From&~"& indicates the start of a new message. All four options need changing
21670 if another format is used. For example, to deliver to mailboxes in MMDF format:
21671 .cindex "MMDF format mailbox"
21672 .cindex "mailbox" "MMDF format"
21673 .code
21674 check_string = "\1\1\1\1\n"
21675 escape_string = "\1\1\1\1 \n"
21676 message_prefix = "\1\1\1\1\n"
21677 message_suffix = "\1\1\1\1\n"
21678 .endd
21679 .option create_directory appendfile boolean true
21680 .cindex "directory creation"
21681 When this option is true, Exim attempts to create any missing superior
21682 directories for the file that it is about to write. A created directory's mode
21683 is given by the &%directory_mode%& option.
21684
21685 The group ownership of a newly created directory is highly dependent on the
21686 operating system (and possibly the file system) that is being used. For
21687 example, in Solaris, if the parent directory has the setgid bit set, its group
21688 is propagated to the child; if not, the currently set group is used. However,
21689 in FreeBSD, the parent's group is always used.
21690
21691
21692
21693 .option create_file appendfile string anywhere
21694 This option constrains the location of files and directories that are created
21695 by this transport. It applies to files defined by the &%file%& option and
21696 directories defined by the &%directory%& option. In the case of maildir
21697 delivery, it applies to the top level directory, not the maildir directories
21698 beneath.
21699
21700 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21701 &"belowhome"&. In the second and third cases, a home directory must have been
21702 set for the transport. This option is not useful when an explicit file name is
21703 given for normal mailbox deliveries. It is intended for the case when file
21704 names are generated from users' &_.forward_& files. These are usually handled
21705 by an &(appendfile)& transport called &%address_file%&. See also
21706 &%file_must_exist%&.
21707
21708
21709 .option directory appendfile string&!! unset
21710 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21711 or &%directory%& must be set, unless the delivery is the direct result of a
21712 redirection (see section &<<SECTfildiropt>>&).
21713
21714 When &%directory%& is set, the string is expanded, and the message is delivered
21715 into a new file or files in or below the given directory, instead of being
21716 appended to a single mailbox file. A number of different formats are provided
21717 (see &%maildir_format%& and &%mailstore_format%&), and see section
21718 &<<SECTopdir>>& for further details of this form of delivery.
21719
21720
21721 .option directory_file appendfile string&!! "see below"
21722 .cindex "base62"
21723 .vindex "&$inode$&"
21724 When &%directory%& is set, but neither &%maildir_format%& nor
21725 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21726 whose name is obtained by expanding this string. The default value is:
21727 .code
21728 q${base62:$tod_epoch}-$inode
21729 .endd
21730 This generates a unique name from the current time, in base 62 form, and the
21731 inode of the file. The variable &$inode$& is available only when expanding this
21732 option.
21733
21734
21735 .option directory_mode appendfile "octal integer" 0700
21736 If &(appendfile)& creates any directories as a result of the
21737 &%create_directory%& option, their mode is specified by this option.
21738
21739
21740 .option escape_string appendfile string "see description"
21741 See &%check_string%& above.
21742
21743
21744 .option file appendfile string&!! unset
21745 This option is mutually exclusive with the &%directory%& option, but one of
21746 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21747 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21748 specifies a single file, to which the message is appended. One or more of
21749 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21750 &%file%&.
21751
21752 .cindex "NFS" "lock file"
21753 .cindex "locking files"
21754 .cindex "lock files"
21755 If you are using more than one host to deliver over NFS into the same
21756 mailboxes, you should always use lock files.
21757
21758 The string value is expanded for each delivery, and must yield an absolute
21759 path. The most common settings of this option are variations on one of these
21760 examples:
21761 .code
21762 file = /var/spool/mail/$local_part
21763 file = /home/$local_part/inbox
21764 file = $home/inbox
21765 .endd
21766 .cindex "&""sticky""& bit"
21767 In the first example, all deliveries are done into the same directory. If Exim
21768 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21769 create a file in the directory, so the &"sticky"& bit must be turned on for
21770 deliveries to be possible, or alternatively the &%group%& option can be used to
21771 run the delivery under a group id which has write access to the directory.
21772
21773
21774
21775 .option file_format appendfile string unset
21776 .cindex "file" "mailbox; checking existing format"
21777 This option requests the transport to check the format of an existing file
21778 before adding to it. The check consists of matching a specific string at the
21779 start of the file. The value of the option consists of an even number of
21780 colon-separated strings. The first of each pair is the test string, and the
21781 second is the name of a transport. If the transport associated with a matched
21782 string is not the current transport, control is passed over to the other
21783 transport. For example, suppose the standard &(local_delivery)& transport has
21784 this added to it:
21785 .code
21786 file_format = "From       : local_delivery :\
21787                \1\1\1\1\n : local_mmdf_delivery"
21788 .endd
21789 Mailboxes that begin with &"From"& are still handled by this transport, but if
21790 a mailbox begins with four binary ones followed by a newline, control is passed
21791 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21792 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21793 is assumed to match the current transport. If the start of a mailbox doesn't
21794 match any string, or if the transport named for a given string is not defined,
21795 delivery is deferred.
21796
21797
21798 .option file_must_exist appendfile boolean false
21799 If this option is true, the file specified by the &%file%& option must exist.
21800 A temporary error occurs if it does not, causing delivery to be deferred.
21801 If this option is false, the file is created if it does not exist.
21802
21803
21804 .option lock_fcntl_timeout appendfile time 0s
21805 .cindex "timeout" "mailbox locking"
21806 .cindex "mailbox" "locking, blocking and non-blocking"
21807 .cindex "locking files"
21808 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21809 when locking an open mailbox file. If the call fails, the delivery process
21810 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21811 Non-blocking calls are used so that the file is not kept open during the wait
21812 for the lock; the reason for this is to make it as safe as possible for
21813 deliveries over NFS in the case when processes might be accessing an NFS
21814 mailbox without using a lock file. This should not be done, but
21815 misunderstandings and hence misconfigurations are not unknown.
21816
21817 On a busy system, however, the performance of a non-blocking lock approach is
21818 not as good as using a blocking lock with a timeout. In this case, the waiting
21819 is done inside the system call, and Exim's delivery process acquires the lock
21820 and can proceed as soon as the previous lock holder releases it.
21821
21822 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21823 timeout, are used. There may still be some retrying: the maximum number of
21824 retries is
21825 .code
21826 (lock_retries * lock_interval) / lock_fcntl_timeout
21827 .endd
21828 rounded up to the next whole number. In other words, the total time during
21829 which &(appendfile)& is trying to get a lock is roughly the same, unless
21830 &%lock_fcntl_timeout%& is set very large.
21831
21832 You should consider setting this option if you are getting a lot of delayed
21833 local deliveries because of errors of the form
21834 .code
21835 failed to lock mailbox /some/file (fcntl)
21836 .endd
21837
21838 .option lock_flock_timeout appendfile time 0s
21839 This timeout applies to file locking when using &[flock()]& (see
21840 &%use_flock%&); the timeout operates in a similar manner to
21841 &%lock_fcntl_timeout%&.
21842
21843
21844 .option lock_interval appendfile time 3s
21845 This specifies the time to wait between attempts to lock the file. See below
21846 for details of locking.
21847
21848
21849 .option lock_retries appendfile integer 10
21850 This specifies the maximum number of attempts to lock the file. A value of zero
21851 is treated as 1. See below for details of locking.
21852
21853
21854 .option lockfile_mode appendfile "octal integer" 0600
21855 This specifies the mode of the created lock file, when a lock file is being
21856 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21857
21858
21859 .option lockfile_timeout appendfile time 30m
21860 .cindex "timeout" "mailbox locking"
21861 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21862 exists and is older than this value, it is assumed to have been left behind by
21863 accident, and Exim attempts to remove it.
21864
21865
21866 .option mailbox_filecount appendfile string&!! unset
21867 .cindex "mailbox" "specifying size of"
21868 .cindex "size" "of mailbox"
21869 If this option is set, it is expanded, and the result is taken as the current
21870 number of files in the mailbox. It must be a decimal number, optionally
21871 followed by K or M. This provides a way of obtaining this information from an
21872 external source that maintains the data.
21873
21874
21875 .option mailbox_size appendfile string&!! unset
21876 .cindex "mailbox" "specifying size of"
21877 .cindex "size" "of mailbox"
21878 If this option is set, it is expanded, and the result is taken as the current
21879 size the mailbox. It must be a decimal number, optionally followed by K or M.
21880 This provides a way of obtaining this information from an external source that
21881 maintains the data. This is likely to be helpful for maildir deliveries where
21882 it is computationally expensive to compute the size of a mailbox.
21883
21884
21885
21886 .option maildir_format appendfile boolean false
21887 .cindex "maildir format" "specifying"
21888 If this option is set with the &%directory%& option, the delivery is into a new
21889 file, in the &"maildir"& format that is used by other mail software. When the
21890 transport is activated directly from a &(redirect)& router (for example, the
21891 &(address_file)& transport in the default configuration), setting
21892 &%maildir_format%& causes the path received from the router to be treated as a
21893 directory, whether or not it ends with &`/`&. This option is available only if
21894 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21895 &<<SECTmaildirdelivery>>& below for further details.
21896
21897
21898 .option maildir_quota_directory_regex appendfile string "See below"
21899 .cindex "maildir format" "quota; directories included in"
21900 .cindex "quota" "maildir; directories included in"
21901 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21902 a regular expression for specifying directories, relative to the quota
21903 directory (see &%quota_directory%&), that should be included in the quota
21904 calculation. The default value is:
21905 .code
21906 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21907 .endd
21908 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21909 (directories whose names begin with a dot). If you want to exclude the
21910 &_Trash_&
21911 folder from the count (as some sites do), you need to change this setting to
21912 .code
21913 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21914 .endd
21915 This uses a negative lookahead in the regular expression to exclude the
21916 directory whose name is &_.Trash_&. When a directory is excluded from quota
21917 calculations, quota processing is bypassed for any messages that are delivered
21918 directly into that directory.
21919
21920
21921 .option maildir_retries appendfile integer 10
21922 This option specifies the number of times to retry when writing a file in
21923 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21924
21925
21926 .option maildir_tag appendfile string&!! unset
21927 This option applies only to deliveries in maildir format, and is described in
21928 section &<<SECTmaildirdelivery>>& below.
21929
21930
21931 .option maildir_use_size_file appendfile&!! boolean false
21932 .cindex "maildir format" "&_maildirsize_& file"
21933 The result of string expansion for this option must be a valid boolean value.
21934 If it is true, it enables support for &_maildirsize_& files. Exim
21935 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21936 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21937 value is zero. See &%maildir_quota_directory_regex%& above and section
21938 &<<SECTmaildirdelivery>>& below for further details.
21939
21940 .option maildirfolder_create_regex appendfile string unset
21941 .cindex "maildir format" "&_maildirfolder_& file"
21942 .cindex "&_maildirfolder_&, creating"
21943 The value of this option is a regular expression. If it is unset, it has no
21944 effect. Otherwise, before a maildir delivery takes place, the pattern is
21945 matched against the name of the maildir directory, that is, the directory
21946 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21947 delivery. If there is a match, Exim checks for the existence of a file called
21948 &_maildirfolder_& in the directory, and creates it if it does not exist.
21949 See section &<<SECTmaildirdelivery>>& for more details.
21950
21951
21952 .option mailstore_format appendfile boolean false
21953 .cindex "mailstore format" "specifying"
21954 If this option is set with the &%directory%& option, the delivery is into two
21955 new files in  &"mailstore"& format. The option is available only if
21956 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21957 below for further details.
21958
21959
21960 .option mailstore_prefix appendfile string&!! unset
21961 This option applies only to deliveries in mailstore format, and is described in
21962 section &<<SECTopdir>>& below.
21963
21964
21965 .option mailstore_suffix appendfile string&!! unset
21966 This option applies only to deliveries in mailstore format, and is described in
21967 section &<<SECTopdir>>& below.
21968
21969
21970 .option mbx_format appendfile boolean false
21971 .cindex "locking files"
21972 .cindex "file" "locking"
21973 .cindex "file" "MBX format"
21974 .cindex "MBX format, specifying"
21975 This option is available only if Exim has been compiled with SUPPORT_MBX
21976 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21977 the message is appended to the mailbox file in MBX format instead of
21978 traditional Unix format. This format is supported by Pine4 and its associated
21979 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21980
21981 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21982 automatically changed by the use of &%mbx_format%&. They should normally be set
21983 empty when using MBX format, so this option almost always appears in this
21984 combination:
21985 .code
21986 mbx_format = true
21987 message_prefix =
21988 message_suffix =
21989 .endd
21990 If none of the locking options are mentioned in the configuration,
21991 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21992 is possible to specify the other kinds of locking with &%mbx_format%&, but
21993 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21994 interworks with &'c-client'&, providing for shared access to the mailbox. It
21995 should not be used if any program that does not use this form of locking is
21996 going to access the mailbox, nor should it be used if the mailbox file is NFS
21997 mounted, because it works only when the mailbox is accessed from a single host.
21998
21999 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22000 the standard version of &'c-client'&, because as long as it has a mailbox open
22001 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22002 append messages to it.
22003
22004
22005 .option message_prefix appendfile string&!! "see below"
22006 .cindex "&""From""& line"
22007 The string specified here is expanded and output at the start of every message.
22008 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22009 in which case it is:
22010 .code
22011 message_prefix = "From ${if def:return_path{$return_path}\
22012   {MAILER-DAEMON}} $tod_bsdinbox\n"
22013 .endd
22014 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22015 &`\n`& to &`\r\n`& in &%message_prefix%&.
22016
22017 .option message_suffix appendfile string&!! "see below"
22018 The string specified here is expanded and output at the end of every message.
22019 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22020 in which case it is a single newline character. The suffix can be suppressed by
22021 setting
22022 .code
22023 message_suffix =
22024 .endd
22025 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22026 &`\n`& to &`\r\n`& in &%message_suffix%&.
22027
22028 .option mode appendfile "octal integer" 0600
22029 If the output file is created, it is given this mode. If it already exists and
22030 has wider permissions, they are reduced to this mode. If it has narrower
22031 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22032 if the delivery is the result of a &%save%& command in a filter file specifying
22033 a particular mode, the mode of the output file is always forced to take that
22034 value, and this option is ignored.
22035
22036
22037 .option mode_fail_narrower appendfile boolean true
22038 This option applies in the case when an existing mailbox file has a narrower
22039 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22040 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22041 continues with the delivery attempt, using the existing mode of the file.
22042
22043
22044 .option notify_comsat appendfile boolean false
22045 If this option is true, the &'comsat'& daemon is notified after every
22046 successful delivery to a user mailbox. This is the daemon that notifies logged
22047 on users about incoming mail.
22048
22049
22050 .option quota appendfile string&!! unset
22051 .cindex "quota" "imposed by Exim"
22052 This option imposes a limit on the size of the file to which Exim is appending,
22053 or to the total space used in the directory tree when the &%directory%& option
22054 is set. In the latter case, computation of the space used is expensive, because
22055 all the files in the directory (and any sub-directories) have to be
22056 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22057 &%maildir_use_size_file%& for ways to avoid this in environments where users
22058 have no shell access to their mailboxes).
22059
22060 As there is no interlock against two simultaneous deliveries into a
22061 multi-file mailbox, it is possible for the quota to be overrun in this case.
22062 For single-file mailboxes, of course, an interlock is a necessity.
22063
22064 A file's size is taken as its &'used'& value. Because of blocking effects, this
22065 may be a lot less than the actual amount of disk space allocated to the file.
22066 If the sizes of a number of files are being added up, the rounding effect can
22067 become quite noticeable, especially on systems that have large block sizes.
22068 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22069 the obvious value which users understand most easily.
22070
22071 The value of the option is expanded, and must then be a numerical value
22072 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22073 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
22074 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22075 be handled.
22076
22077 &*Note*&: A value of zero is interpreted as &"no quota"&.
22078
22079 The expansion happens while Exim is running as root, before it changes uid for
22080 the delivery. This means that files that are inaccessible to the end user can
22081 be used to hold quota values that are looked up in the expansion. When delivery
22082 fails because this quota is exceeded, the handling of the error is as for
22083 system quota failures.
22084
22085 By default, Exim's quota checking mimics system quotas, and restricts the
22086 mailbox to the specified maximum size, though the value is not accurate to the
22087 last byte, owing to separator lines and additional headers that may get added
22088 during message delivery. When a mailbox is nearly full, large messages may get
22089 refused even though small ones are accepted, because the size of the current
22090 message is added to the quota when the check is made. This behaviour can be
22091 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22092 for exceeding the quota does not include the current message. Thus, deliveries
22093 continue until the quota has been exceeded; thereafter, no further messages are
22094 delivered. See also &%quota_warn_threshold%&.
22095
22096
22097 .option quota_directory appendfile string&!! unset
22098 This option defines the directory to check for quota purposes when delivering
22099 into individual files. The default is the delivery directory, or, if a file
22100 called &_maildirfolder_& exists in a maildir directory, the parent of the
22101 delivery directory.
22102
22103
22104 .option quota_filecount appendfile string&!! 0
22105 This option applies when the &%directory%& option is set. It limits the total
22106 number of files in the directory (compare the inode limit in system quotas). It
22107 can only be used if &%quota%& is also set. The value is expanded; an expansion
22108 failure causes delivery to be deferred. A value of zero is interpreted as
22109 &"no quota"&.
22110
22111
22112 .option quota_is_inclusive appendfile boolean true
22113 See &%quota%& above.
22114
22115
22116 .option quota_size_regex appendfile string unset
22117 This option applies when one of the delivery modes that writes a separate file
22118 for each message is being used. When Exim wants to find the size of one of
22119 these files in order to test the quota, it first checks &%quota_size_regex%&.
22120 If this is set to a regular expression that matches the file name, and it
22121 captures one string, that string is interpreted as a representation of the
22122 file's size. The value of &%quota_size_regex%& is not expanded.
22123
22124 This feature is useful only when users have no shell access to their mailboxes
22125 &-- otherwise they could defeat the quota simply by renaming the files. This
22126 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22127 the file length to the file name. For example:
22128 .code
22129 maildir_tag = ,S=$message_size
22130 quota_size_regex = ,S=(\d+)
22131 .endd
22132 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22133 number of lines in the message.
22134
22135 The regular expression should not assume that the length is at the end of the
22136 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22137 sometimes add other information onto the ends of message file names.
22138
22139 Section &<<SECID136>>& contains further information.
22140
22141
22142 .option quota_warn_message appendfile string&!! "see below"
22143 See below for the use of this option. If it is not set when
22144 &%quota_warn_threshold%& is set, it defaults to
22145 .code
22146 quota_warn_message = "\
22147   To: $local_part@$domain\n\
22148   Subject: Your mailbox\n\n\
22149   This message is automatically created \
22150   by mail delivery software.\n\n\
22151   The size of your mailbox has exceeded \
22152   a warning threshold that is\n\
22153   set by the system administrator.\n"
22154 .endd
22155
22156
22157 .option quota_warn_threshold appendfile string&!! 0
22158 .cindex "quota" "warning threshold"
22159 .cindex "mailbox" "size warning"
22160 .cindex "size" "of mailbox"
22161 This option is expanded in the same way as &%quota%& (see above). If the
22162 resulting value is greater than zero, and delivery of the message causes the
22163 size of the file or total space in the directory tree to cross the given
22164 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22165 may be specified as a percentage of it by following the value with a percent
22166 sign. For example:
22167 .code
22168 quota = 10M
22169 quota_warn_threshold = 75%
22170 .endd
22171 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22172 percent sign is ignored.
22173
22174 The warning message itself is specified by the &%quota_warn_message%& option,
22175 and it must start with a &'To:'& header line containing the recipient(s) of the
22176 warning message. These do not necessarily have to include the recipient(s) of
22177 the original message. A &'Subject:'& line should also normally be supplied. You
22178 can include any other header lines that you want. If you do not include a
22179 &'From:'& line, the default is:
22180 .code
22181 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22182 .endd
22183 .oindex &%errors_reply_to%&
22184 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22185 option.
22186
22187 The &%quota%& option does not have to be set in order to use this option; they
22188 are independent of one another except when the threshold is specified as a
22189 percentage.
22190
22191
22192 .option use_bsmtp appendfile boolean false
22193 .cindex "envelope sender"
22194 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22195 format, with the envelope sender and recipient(s) included as SMTP commands. If
22196 you want to include a leading HELO command with such messages, you can do
22197 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22198 for details of batch SMTP.
22199
22200
22201 .option use_crlf appendfile boolean false
22202 .cindex "carriage return"
22203 .cindex "linefeed"
22204 This option causes lines to be terminated with the two-character CRLF sequence
22205 (carriage return, linefeed) instead of just a linefeed character. In the case
22206 of batched SMTP, the byte sequence written to the file is then an exact image
22207 of what would be sent down a real SMTP connection.
22208
22209 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22210 (which are used to supply the traditional &"From&~"& and blank line separators
22211 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22212 carriage return characters if these are needed. In cases where these options
22213 have non-empty defaults, the values end with a single linefeed, so they must be
22214 changed to end with &`\r\n`& if &%use_crlf%& is set.
22215
22216
22217 .option use_fcntl_lock appendfile boolean "see below"
22218 This option controls the use of the &[fcntl()]& function to lock a file for
22219 exclusive use when a message is being appended. It is set by default unless
22220 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22221 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22222 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22223
22224
22225 .option use_flock_lock appendfile boolean false
22226 This option is provided to support the use of &[flock()]& for file locking, for
22227 the few situations where it is needed. Most modern operating systems support
22228 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22229 each other. Exim uses &[fcntl()]& locking by default.
22230
22231 This option is required only if you are using an operating system where
22232 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22233 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22234 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22235
22236 .cindex "Solaris" "&[flock()]& support"
22237 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22238 have it (and some, I think, provide a not quite right version built on top of
22239 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22240 the ability to use it, and any attempt to do so will cause a configuration
22241 error.
22242
22243 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22244 is just being mapped onto &[fcntl()]& by the OS).
22245
22246
22247 .option use_lockfile appendfile boolean "see below"
22248 If this option is turned off, Exim does not attempt to create a lock file when
22249 appending to a mailbox file. In this situation, the only locking is by
22250 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22251 sure that every MUA that is ever going to look at your users' mailboxes uses
22252 &[fcntl()]& rather than a lock file, and even then only when you are not
22253 delivering over NFS from more than one host.
22254
22255 .cindex "NFS" "lock file"
22256 In order to append to an NFS file safely from more than one host, it is
22257 necessary to take out a lock &'before'& opening the file, and the lock file
22258 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22259 file corruption.
22260
22261 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22262 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22263 except when &%mbx_format%& is set.
22264
22265
22266 .option use_mbx_lock appendfile boolean "see below"
22267 This option is available only if Exim has been compiled with SUPPORT_MBX
22268 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22269 locking rules be used. It is set by default if &%mbx_format%& is set and none
22270 of the locking options are mentioned in the configuration. The locking rules
22271 are the same as are used by the &'c-client'& library that underlies Pine and
22272 the IMAP4 and POP daemons that come with it (see the discussion below). The
22273 rules allow for shared access to the mailbox. However, this kind of locking
22274 does not work when the mailbox is NFS mounted.
22275
22276 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22277 &%use_flock_lock%& to control what kind of locking is used in implementing the
22278 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22279 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22280
22281
22282
22283
22284 .section "Operational details for appending" "SECTopappend"
22285 .cindex "appending to a file"
22286 .cindex "file" "appending"
22287 Before appending to a file, the following preparations are made:
22288
22289 .ilist
22290 If the name of the file is &_/dev/null_&, no action is taken, and a success
22291 return is given.
22292
22293 .next
22294 .cindex "directory creation"
22295 If any directories on the file's path are missing, Exim creates them if the
22296 &%create_directory%& option is set. A created directory's mode is given by the
22297 &%directory_mode%& option.
22298
22299 .next
22300 If &%file_format%& is set, the format of an existing file is checked. If this
22301 indicates that a different transport should be used, control is passed to that
22302 transport.
22303
22304 .next
22305 .cindex "file" "locking"
22306 .cindex "locking files"
22307 .cindex "NFS" "lock file"
22308 If &%use_lockfile%& is set, a lock file is built in a way that will work
22309 reliably over NFS, as follows:
22310
22311 .olist
22312 Create a &"hitching post"& file whose name is that of the lock file with the
22313 current time, primary host name, and process id added, by opening for writing
22314 as a new file. If this fails with an access error, delivery is deferred.
22315 .next
22316 Close the hitching post file, and hard link it to the lock file name.
22317 .next
22318 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22319 Unlink the hitching post name.
22320 .next
22321 Otherwise, use &[stat()]& to get information about the hitching post file, and
22322 then unlink hitching post name. If the number of links is exactly two, creation
22323 of the lock file succeeded but something (for example, an NFS server crash and
22324 restart) caused this fact not to be communicated to the &[link()]& call.
22325 .next
22326 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22327 up to &%lock_retries%& times. However, since any program that writes to a
22328 mailbox should complete its task very quickly, it is reasonable to time out old
22329 lock files that are normally the result of user agent and system crashes. If an
22330 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22331 it before trying again.
22332 .endlist olist
22333
22334 .next
22335 A call is made to &[lstat()]& to discover whether the main file exists, and if
22336 so, what its characteristics are. If &[lstat()]& fails for any reason other
22337 than non-existence, delivery is deferred.
22338
22339 .next
22340 .cindex "symbolic link" "to mailbox"
22341 .cindex "mailbox" "symbolic link"
22342 If the file does exist and is a symbolic link, delivery is deferred, unless the
22343 &%allow_symlink%& option is set, in which case the ownership of the link is
22344 checked, and then &[stat()]& is called to find out about the real file, which
22345 is then subjected to the checks below. The check on the top-level link
22346 ownership prevents one user creating a link for another's mailbox in a sticky
22347 directory, though allowing symbolic links in this case is definitely not a good
22348 idea. If there is a chain of symbolic links, the intermediate ones are not
22349 checked.
22350
22351 .next
22352 If the file already exists but is not a regular file, or if the file's owner
22353 and group (if the group is being checked &-- see &%check_group%& above) are
22354 different from the user and group under which the delivery is running,
22355 delivery is deferred.
22356
22357 .next
22358 If the file's permissions are more generous than specified, they are reduced.
22359 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22360 is set false, in which case the delivery is tried using the existing
22361 permissions.
22362
22363 .next
22364 The file's inode number is saved, and the file is then opened for appending.
22365 If this fails because the file has vanished, &(appendfile)& behaves as if it
22366 hadn't existed (see below). For any other failures, delivery is deferred.
22367
22368 .next
22369 If the file is opened successfully, check that the inode number hasn't
22370 changed, that it is still a regular file, and that the owner and permissions
22371 have not changed. If anything is wrong, defer delivery and freeze the message.
22372
22373 .next
22374 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22375 option is set. Otherwise, check that the file is being created in a permitted
22376 directory if the &%create_file%& option is set (deferring on failure), and then
22377 open for writing as a new file, with the O_EXCL and O_CREAT options,
22378 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22379 set). In this case, which can happen if the link points to a non-existent file,
22380 the file is opened for writing using O_CREAT but not O_EXCL, because
22381 that prevents link following.
22382
22383 .next
22384 .cindex "loop" "while file testing"
22385 If opening fails because the file exists, obey the tests given above for
22386 existing files. However, to avoid looping in a situation where the file is
22387 being continuously created and destroyed, the exists/not-exists loop is broken
22388 after 10 repetitions, and the message is then frozen.
22389
22390 .next
22391 If opening fails with any other error, defer delivery.
22392
22393 .next
22394 .cindex "file" "locking"
22395 .cindex "locking files"
22396 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22397 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22398 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22399 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22400 file, and an exclusive lock on the file whose name is
22401 .code
22402 /tmp/.<device-number>.<inode-number>
22403 .endd
22404 using the device and inode numbers of the open mailbox file, in accordance with
22405 the MBX locking rules. This file is created with a mode that is specified by
22406 the &%lockfile_mode%& option.
22407
22408 If Exim fails to lock the file, there are two possible courses of action,
22409 depending on the value of the locking timeout. This is obtained from
22410 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22411
22412 If the timeout value is zero, the file is closed, Exim waits for
22413 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22414 to lock it again. This happens up to &%lock_retries%& times, after which the
22415 delivery is deferred.
22416
22417 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22418 &[flock()]& are used (with the given timeout), so there has already been some
22419 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22420 immediately. It retries up to
22421 .code
22422 (lock_retries * lock_interval) / <timeout>
22423 .endd
22424 times (rounded up).
22425 .endlist
22426
22427 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22428 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22429
22430
22431 .section "Operational details for delivery to a new file" "SECTopdir"
22432 .cindex "delivery" "to single file"
22433 .cindex "&""From""& line"
22434 When the &%directory%& option is set instead of &%file%&, each message is
22435 delivered into a newly-created file or set of files. When &(appendfile)& is
22436 activated directly from a &(redirect)& router, neither &%file%& nor
22437 &%directory%& is normally set, because the path for delivery is supplied by the
22438 router. (See for example, the &(address_file)& transport in the default
22439 configuration.) In this case, delivery is to a new file if either the path name
22440 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22441
22442 No locking is required while writing the message to a new file, so the various
22443 locking options of the transport are ignored. The &"From"& line that by default
22444 separates messages in a single file is not normally needed, nor is the escaping
22445 of message lines that start with &"From"&, and there is no need to ensure a
22446 newline at the end of each message. Consequently, the default values for
22447 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22448 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22449
22450 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22451 the files in the delivery directory by default. However, you can specify a
22452 different directory by setting &%quota_directory%&. Also, for maildir
22453 deliveries (see below) the &_maildirfolder_& convention is honoured.
22454
22455
22456 .cindex "maildir format"
22457 .cindex "mailstore format"
22458 There are three different ways in which delivery to individual files can be
22459 done, controlled by the settings of the &%maildir_format%& and
22460 &%mailstore_format%& options. Note that code to support maildir or mailstore
22461 formats is not included in the binary unless SUPPORT_MAILDIR or
22462 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22463
22464 .cindex "directory creation"
22465 In all three cases an attempt is made to create the directory and any necessary
22466 sub-directories if they do not exist, provided that the &%create_directory%&
22467 option is set (the default). The location of a created directory can be
22468 constrained by setting &%create_file%&. A created directory's mode is given by
22469 the &%directory_mode%& option. If creation fails, or if the
22470 &%create_directory%& option is not set when creation is required, delivery is
22471 deferred.
22472
22473
22474
22475 .section "Maildir delivery" "SECTmaildirdelivery"
22476 .cindex "maildir format" "description of"
22477 If the &%maildir_format%& option is true, Exim delivers each message by writing
22478 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22479 directory that is defined by the &%directory%& option (the &"delivery
22480 directory"&). If the delivery is successful, the file is renamed into the
22481 &_new_& subdirectory.
22482
22483 In the file name, <&'stime'&> is the current time of day in seconds, and
22484 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22485 Exim checks that the time-of-day clock has moved on by at least one microsecond
22486 before terminating the delivery process. This guarantees uniqueness for the
22487 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22488 opening it. If any response other than ENOENT (does not exist) is given,
22489 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22490
22491 Before Exim carries out a maildir delivery, it ensures that subdirectories
22492 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22493 do not exist, Exim tries to create them and any superior directories in their
22494 path, subject to the &%create_directory%& and &%create_file%& options. If the
22495 &%maildirfolder_create_regex%& option is set, and the regular expression it
22496 contains matches the delivery directory, Exim also ensures that a file called
22497 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22498 &_maildirfolder_& file cannot be created, delivery is deferred.
22499
22500 These features make it possible to use Exim to create all the necessary files
22501 and directories in a maildir mailbox, including subdirectories for maildir++
22502 folders. Consider this example:
22503 .code
22504 maildir_format = true
22505 directory = /var/mail/$local_part\
22506            ${if eq{$local_part_suffix}{}{}\
22507            {/.${substr_1:$local_part_suffix}}}
22508 maildirfolder_create_regex = /\.[^/]+$
22509 .endd
22510 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22511 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22512 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22513 not match this name, so Exim will not look for or create the file
22514 &_/var/mail/pimbo/maildirfolder_&, though it will create
22515 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22516
22517 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22518 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22519 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22520 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22521 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22522
22523 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22524 not inadvertently match the toplevel maildir directory, because a
22525 &_maildirfolder_& file at top level would completely break quota calculations.
22526
22527 .cindex "quota" "in maildir delivery"
22528 .cindex "maildir++"
22529 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22530 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22531 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22532 Exim assumes the directory is a maildir++ folder directory, which is one level
22533 down from the user's top level mailbox directory. This causes it to start at
22534 the parent directory instead of the current directory when calculating the
22535 amount of space used.
22536
22537 One problem with delivering into a multi-file mailbox is that it is
22538 computationally expensive to compute the size of the mailbox for quota
22539 checking. Various approaches have been taken to reduce the amount of work
22540 needed. The next two sections describe two of them. A third alternative is to
22541 use some external process for maintaining the size data, and use the expansion
22542 of the &%mailbox_size%& option as a way of importing it into Exim.
22543
22544
22545
22546
22547 .section "Using tags to record message sizes" "SECID135"
22548 If &%maildir_tag%& is set, the string is expanded for each delivery.
22549 When the maildir file is renamed into the &_new_& sub-directory, the
22550 tag is added to its name. However, if adding the tag takes the length of the
22551 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22552 the tag is dropped and the maildir file is created with no tag.
22553
22554
22555 .vindex "&$message_size$&"
22556 Tags can be used to encode the size of files in their names; see
22557 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22558 happens after the message has been written. The value of the &$message_size$&
22559 variable is set to the number of bytes actually written. If the expansion is
22560 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22561 be deferred. The expanded tag may contain any printing characters except &"/"&.
22562 Non-printing characters in the string are ignored; if the resulting string is
22563 empty, it is ignored. If it starts with an alphanumeric character, a leading
22564 colon is inserted; this default has not proven to be the path that popular
22565 maildir implementations have chosen (but changing it in Exim would break
22566 backwards compatibility).
22567
22568 For one common implementation, you might set:
22569 .code
22570 maildir_tag = ,S=${message_size}
22571 .endd
22572 but you should check the documentation of the other software to be sure.
22573
22574 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22575 as this allows Exim to extract the size from your tag, instead of having to
22576 &[stat()]& each message file.
22577
22578
22579 .section "Using a maildirsize file" "SECID136"
22580 .cindex "quota" "in maildir delivery"
22581 .cindex "maildir format" "&_maildirsize_& file"
22582 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22583 storing quota and message size information in a file called &_maildirsize_&
22584 within the toplevel maildir directory. If this file does not exist, Exim
22585 creates it, setting the quota from the &%quota%& option of the transport. If
22586 the maildir directory itself does not exist, it is created before any attempt
22587 to write a &_maildirsize_& file.
22588
22589 The &_maildirsize_& file is used to hold information about the sizes of
22590 messages in the maildir, thus speeding up quota calculations. The quota value
22591 in the file is just a cache; if the quota is changed in the transport, the new
22592 value overrides the cached value when the next message is delivered. The cache
22593 is maintained for the benefit of other programs that access the maildir and
22594 need to know the quota.
22595
22596 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22597 file is maintained (with a zero quota setting), but no quota is imposed.
22598
22599 A regular expression is available for controlling which directories in the
22600 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22601 See the description of the &%maildir_quota_directory_regex%& option above for
22602 details.
22603
22604
22605 .section "Mailstore delivery" "SECID137"
22606 .cindex "mailstore format" "description of"
22607 If the &%mailstore_format%& option is true, each message is written as two
22608 files in the given directory. A unique base name is constructed from the
22609 message id and the current delivery process, and the files that are written use
22610 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22611 contains the message's envelope, and the &_.msg_& file contains the message
22612 itself. The base name is placed in the variable &$mailstore_basename$&.
22613
22614 During delivery, the envelope is first written to a file with the suffix
22615 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22616 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22617 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22618 file before accessing either of them. An alternative approach is to wait for
22619 the absence of a &_.tmp_& file.
22620
22621 The envelope file starts with any text defined by the &%mailstore_prefix%&
22622 option, expanded and terminated by a newline if there isn't one. Then follows
22623 the sender address on one line, then all the recipient addresses, one per line.
22624 There can be more than one recipient only if the &%batch_max%& option is set
22625 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22626 appended to the file, followed by a newline if it does not end with one.
22627
22628 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22629 failure, it is ignored. Other expansion errors are treated as serious
22630 configuration errors, and delivery is deferred. The variable
22631 &$mailstore_basename$& is available for use during these expansions.
22632
22633
22634 .section "Non-special new file delivery" "SECID138"
22635 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22636 file is created directly in the named directory. For example, when delivering
22637 messages into files in batched SMTP format for later delivery to some host (see
22638 section &<<SECTbatchSMTP>>&), a setting such as
22639 .code
22640 directory = /var/bsmtp/$host
22641 .endd
22642 might be used. A message is written to a file with a temporary name, which is
22643 then renamed when the delivery is complete. The final name is obtained by
22644 expanding the contents of the &%directory_file%& option.
22645 .ecindex IIDapptra1
22646 .ecindex IIDapptra2
22647
22648
22649
22650
22651
22652
22653 . ////////////////////////////////////////////////////////////////////////////
22654 . ////////////////////////////////////////////////////////////////////////////
22655
22656 .chapter "The autoreply transport" "CHID8"
22657 .scindex IIDauttra1 "transports" "&(autoreply)&"
22658 .scindex IIDauttra2 "&(autoreply)& transport"
22659 The &(autoreply)& transport is not a true transport in that it does not cause
22660 the message to be transmitted. Instead, it generates a new mail message as an
22661 automatic reply to the incoming message. &'References:'& and
22662 &'Auto-Submitted:'& header lines are included. These are constructed according
22663 to the rules in RFCs 2822 and 3834, respectively.
22664
22665 If the router that passes the message to this transport does not have the
22666 &%unseen%& option set, the original message (for the current recipient) is not
22667 delivered anywhere. However, when the &%unseen%& option is set on the router
22668 that passes the message to this transport, routing of the address continues, so
22669 another router can set up a normal message delivery.
22670
22671
22672 The &(autoreply)& transport is usually run as the result of mail filtering, a
22673 &"vacation"& message being the standard example. However, it can also be run
22674 directly from a router like any other transport. To reduce the possibility of
22675 message cascades, messages created by the &(autoreply)& transport always have
22676 empty envelope sender addresses, like bounce messages.
22677
22678 The parameters of the message to be sent can be specified in the configuration
22679 by options described below. However, these are used only when the address
22680 passed to the transport does not contain its own reply information. When the
22681 transport is run as a consequence of a
22682 &%mail%&
22683 or &%vacation%& command in a filter file, the parameters of the message are
22684 supplied by the filter, and passed with the address. The transport's options
22685 that define the message are then ignored (so they are not usually set in this
22686 case). The message is specified entirely by the filter or by the transport; it
22687 is never built from a mixture of options. However, the &%file_optional%&,
22688 &%mode%&, and &%return_message%& options apply in all cases.
22689
22690 &(Autoreply)& is implemented as a local transport. When used as a result of a
22691 command in a user's filter file, &(autoreply)& normally runs under the uid and
22692 gid of the user, and with appropriate current and home directories (see chapter
22693 &<<CHAPenvironment>>&).
22694
22695 There is a subtle difference between routing a message to a &(pipe)& transport
22696 that generates some text to be returned to the sender, and routing it to an
22697 &(autoreply)& transport. This difference is noticeable only if more than one
22698 address from the same message is so handled. In the case of a pipe, the
22699 separate outputs from the different addresses are gathered up and returned to
22700 the sender in a single message, whereas if &(autoreply)& is used, a separate
22701 message is generated for each address that is passed to it.
22702
22703 Non-printing characters are not permitted in the header lines generated for the
22704 message that &(autoreply)& creates, with the exception of newlines that are
22705 immediately followed by white space. If any non-printing characters are found,
22706 the transport defers.
22707 Whether characters with the top bit set count as printing characters or not is
22708 controlled by the &%print_topbitchars%& global option.
22709
22710 If any of the generic options for manipulating headers (for example,
22711 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22712 of the original message that is included in the generated message when
22713 &%return_message%& is set. They do not apply to the generated message itself.
22714
22715 .vindex "&$sender_address$&"
22716 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22717 the message, indicating that there were no recipients, it does not treat this
22718 as an error. This means that autoreplies sent to &$sender_address$& when this
22719 is empty (because the incoming message is a bounce message) do not cause
22720 problems. They are just discarded.
22721
22722
22723
22724 .section "Private options for autoreply" "SECID139"
22725 .cindex "options" "&(autoreply)& transport"
22726
22727 .option bcc autoreply string&!! unset
22728 This specifies the addresses that are to receive &"blind carbon copies"& of the
22729 message when the message is specified by the transport.
22730
22731
22732 .option cc autoreply string&!! unset
22733 This specifies recipients of the message and the contents of the &'Cc:'& header
22734 when the message is specified by the transport.
22735
22736
22737 .option file autoreply string&!! unset
22738 The contents of the file are sent as the body of the message when the message
22739 is specified by the transport. If both &%file%& and &%text%& are set, the text
22740 string comes first.
22741
22742
22743 .option file_expand autoreply boolean false
22744 If this is set, the contents of the file named by the &%file%& option are
22745 subjected to string expansion as they are added to the message.
22746
22747
22748 .option file_optional autoreply boolean false
22749 If this option is true, no error is generated if the file named by the &%file%&
22750 option or passed with the address does not exist or cannot be read.
22751
22752
22753 .option from autoreply string&!! unset
22754 This specifies the contents of the &'From:'& header when the message is
22755 specified by the transport.
22756
22757
22758 .option headers autoreply string&!! unset
22759 This specifies additional RFC 2822 headers that are to be added to the message
22760 when the message is specified by the transport. Several can be given by using
22761 &"\n"& to separate them. There is no check on the format.
22762
22763
22764 .option log autoreply string&!! unset
22765 This option names a file in which a record of every message sent is logged when
22766 the message is specified by the transport.
22767
22768
22769 .option mode autoreply "octal integer" 0600
22770 If either the log file or the &"once"& file has to be created, this mode is
22771 used.
22772
22773
22774 .option never_mail autoreply "address list&!!" unset
22775 If any run of the transport creates a message with a recipient that matches any
22776 item in the list, that recipient is quietly discarded. If all recipients are
22777 discarded, no message is created. This applies both when the recipients are
22778 generated by a filter and when they are specified in the transport.
22779
22780
22781
22782 .option once autoreply string&!! unset
22783 This option names a file or DBM database in which a record of each &'To:'&
22784 recipient is kept when the message is specified by the transport. &*Note*&:
22785 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22786
22787 If &%once%& is unset, or is set to an empty string, the message is always sent.
22788 By default, if &%once%& is set to a non-empty file name, the message
22789 is not sent if a potential recipient is already listed in the database.
22790 However, if the &%once_repeat%& option specifies a time greater than zero, the
22791 message is sent if that much time has elapsed since a message was last sent to
22792 this recipient. A setting of zero time for &%once_repeat%& (the default)
22793 prevents a message from being sent a second time &-- in this case, zero means
22794 infinity.
22795
22796 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22797 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22798 greater than zero, it changes the way Exim implements the &%once%& option.
22799 Instead of using a DBM file to record every recipient it sends to, it uses a
22800 regular file, whose size will never get larger than the given value.
22801
22802 In the file, Exim keeps a linear list of recipient addresses and the times at
22803 which they were sent messages. If the file is full when a new address needs to
22804 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22805 means that a given recipient may receive multiple messages, but at
22806 unpredictable intervals that depend on the rate of turnover of addresses in the
22807 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22808
22809
22810 .option once_file_size autoreply integer 0
22811 See &%once%& above.
22812
22813
22814 .option once_repeat autoreply time&!! 0s
22815 See &%once%& above.
22816 After expansion, the value of this option must be a valid time value.
22817
22818
22819 .option reply_to autoreply string&!! unset
22820 This specifies the contents of the &'Reply-To:'& header when the message is
22821 specified by the transport.
22822
22823
22824 .option return_message autoreply boolean false
22825 If this is set, a copy of the original message is returned with the new
22826 message, subject to the maximum size set in the &%return_size_limit%& global
22827 configuration option.
22828
22829
22830 .option subject autoreply string&!! unset
22831 This specifies the contents of the &'Subject:'& header when the message is
22832 specified by the transport. It is tempting to quote the original subject in
22833 automatic responses. For example:
22834 .code
22835 subject = Re: $h_subject:
22836 .endd
22837 There is a danger in doing this, however. It may allow a third party to
22838 subscribe your users to an opt-in mailing list, provided that the list accepts
22839 bounce messages as subscription confirmations. Well-managed lists require a
22840 non-bounce message to confirm a subscription, so the danger is relatively
22841 small.
22842
22843
22844
22845 .option text autoreply string&!! unset
22846 This specifies a single string to be used as the body of the message when the
22847 message is specified by the transport. If both &%text%& and &%file%& are set,
22848 the text comes first.
22849
22850
22851 .option to autoreply string&!! unset
22852 This specifies recipients of the message and the contents of the &'To:'& header
22853 when the message is specified by the transport.
22854 .ecindex IIDauttra1
22855 .ecindex IIDauttra2
22856
22857
22858
22859
22860 . ////////////////////////////////////////////////////////////////////////////
22861 . ////////////////////////////////////////////////////////////////////////////
22862
22863 .chapter "The lmtp transport" "CHAPLMTP"
22864 .cindex "transports" "&(lmtp)&"
22865 .cindex "&(lmtp)& transport"
22866 .cindex "LMTP" "over a pipe"
22867 .cindex "LMTP" "over a socket"
22868 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22869 specified command
22870 or by interacting with a Unix domain socket.
22871 This transport is something of a cross between the &(pipe)& and &(smtp)&
22872 transports. Exim also has support for using LMTP over TCP/IP; this is
22873 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22874 to be of minority interest, the default build-time configure in &_src/EDITME_&
22875 has it commented out. You need to ensure that
22876 .code
22877 TRANSPORT_LMTP=yes
22878 .endd
22879 .cindex "options" "&(lmtp)& transport"
22880 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22881 included in the Exim binary. The private options of the &(lmtp)& transport are
22882 as follows:
22883
22884 .option batch_id lmtp string&!! unset
22885 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22886
22887
22888 .option batch_max lmtp integer 1
22889 This limits the number of addresses that can be handled in a single delivery.
22890 Most LMTP servers can handle several addresses at once, so it is normally a
22891 good idea to increase this value. See the description of local delivery
22892 batching in chapter &<<CHAPbatching>>&.
22893
22894
22895 .option command lmtp string&!! unset
22896 This option must be set if &%socket%& is not set. The string is a command which
22897 is run in a separate process. It is split up into a command name and list of
22898 arguments, each of which is separately expanded (so expansion cannot change the
22899 number of arguments). The command is run directly, not via a shell. The message
22900 is passed to the new process using the standard input and output to operate the
22901 LMTP protocol.
22902
22903 .option ignore_quota lmtp boolean false
22904 .cindex "LMTP" "ignoring quota errors"
22905 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22906 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22907 in its response to the LHLO command.
22908
22909 .option socket lmtp string&!! unset
22910 This option must be set if &%command%& is not set. The result of expansion must
22911 be the name of a Unix domain socket. The transport connects to the socket and
22912 delivers the message to it using the LMTP protocol.
22913
22914
22915 .option timeout lmtp time 5m
22916 The transport is aborted if the created process or Unix domain socket does not
22917 respond to LMTP commands or message input within this timeout. Delivery
22918 is deferred, and will be tried again later. Here is an example of a typical
22919 LMTP transport:
22920 .code
22921 lmtp:
22922   driver = lmtp
22923   command = /some/local/lmtp/delivery/program
22924   batch_max = 20
22925   user = exim
22926 .endd
22927 This delivers up to 20 addresses at a time, in a mixture of domains if
22928 necessary, running as the user &'exim'&.
22929
22930
22931
22932 . ////////////////////////////////////////////////////////////////////////////
22933 . ////////////////////////////////////////////////////////////////////////////
22934
22935 .chapter "The pipe transport" "CHAPpipetransport"
22936 .scindex IIDpiptra1 "transports" "&(pipe)&"
22937 .scindex IIDpiptra2 "&(pipe)& transport"
22938 The &(pipe)& transport is used to deliver messages via a pipe to a command
22939 running in another process. One example is the use of &(pipe)& as a
22940 pseudo-remote transport for passing messages to some other delivery mechanism
22941 (such as UUCP). Another is the use by individual users to automatically process
22942 their incoming messages. The &(pipe)& transport can be used in one of the
22943 following ways:
22944
22945 .ilist
22946 .vindex "&$local_part$&"
22947 A router routes one address to a transport in the normal way, and the
22948 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22949 contains the local part of the address (as usual), and the command that is run
22950 is specified by the &%command%& option on the transport.
22951 .next
22952 .vindex "&$pipe_addresses$&"
22953 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22954 transport can handle more than one address in a single run. In this case, when
22955 more than one address is routed to the transport, &$local_part$& is not set
22956 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22957 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22958 that are routed to the transport.
22959 .next
22960 .vindex "&$address_pipe$&"
22961 A router redirects an address directly to a pipe command (for example, from an
22962 alias or forward file). In this case, &$address_pipe$& contains the text of the
22963 pipe command, and the &%command%& option on the transport is ignored unless
22964 &%force_command%& is set. If only one address is being transported
22965 (&%batch_max%& is not greater than one, or only one address was redirected to
22966 this pipe command), &$local_part$& contains the local part that was redirected.
22967 .endlist
22968
22969
22970 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22971 deliver messages over pipes using the LMTP interactive protocol. This is
22972 implemented by the &(lmtp)& transport.
22973
22974 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22975 &_.forward_& file, the command runs under the uid and gid of that user. In
22976 other cases, the uid and gid have to be specified explicitly, either on the
22977 transport or on the router that handles the address. Current and &"home"&
22978 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22979 details of the local delivery environment and chapter &<<CHAPbatching>>&
22980 for a discussion of local delivery batching.
22981
22982
22983 .section "Concurrent delivery" "SECID140"
22984 If two messages arrive at almost the same time, and both are routed to a pipe
22985 delivery, the two pipe transports may be run concurrently. You must ensure that
22986 any pipe commands you set up are robust against this happening. If the commands
22987 write to a file, the &%exim_lock%& utility might be of use.
22988 Alternatively the &%max_parallel%& option could be used with a value
22989 of "1" to enforce serialization.
22990
22991
22992
22993
22994 .section "Returned status and data" "SECID141"
22995 .cindex "&(pipe)& transport" "returned data"
22996 If the command exits with a non-zero return code, the delivery is deemed to
22997 have failed, unless either the &%ignore_status%& option is set (in which case
22998 the return code is treated as zero), or the return code is one of those listed
22999 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23000 later"&. In this case, delivery is deferred. Details of a permanent failure are
23001 logged, but are not included in the bounce message, which merely contains
23002 &"local delivery failed"&.
23003
23004 If the command exits on a signal and the &%freeze_signal%& option is set then
23005 the message will be frozen in the queue. If that option is not set, a bounce
23006 will be sent as normal.
23007
23008 If the return code is greater than 128 and the command being run is a shell
23009 script, it normally means that the script was terminated by a signal whose
23010 value is the return code minus 128. The &%freeze_signal%& option does not
23011 apply in this case.
23012
23013 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23014 return code is set to 127. This is the value that a shell returns if it is
23015 asked to run a non-existent command. The wording for the log line suggests that
23016 a non-existent command may be the problem.
23017
23018 The &%return_output%& option can affect the result of a pipe delivery. If it is
23019 set and the command produces any output on its standard output or standard
23020 error streams, the command is considered to have failed, even if it gave a zero
23021 return code or if &%ignore_status%& is set. The output from the command is
23022 included as part of the bounce message. The &%return_fail_output%& option is
23023 similar, except that output is returned only when the command exits with a
23024 failure return code, that is, a value other than zero or a code that matches
23025 &%temp_errors%&.
23026
23027
23028
23029 .section "How the command is run" "SECThowcommandrun"
23030 .cindex "&(pipe)& transport" "path for command"
23031 The command line is (by default) broken down into a command name and arguments
23032 by the &(pipe)& transport itself. The &%allow_commands%& and
23033 &%restrict_to_path%& options can be used to restrict the commands that may be
23034 run.
23035
23036 .cindex "quoting" "in pipe command"
23037 Unquoted arguments are delimited by white space. If an argument appears in
23038 double quotes, backslash is interpreted as an escape character in the usual
23039 way. If an argument appears in single quotes, no escaping is done.
23040
23041 String expansion is applied to the command line except when it comes from a
23042 traditional &_.forward_& file (commands from a filter file are expanded). The
23043 expansion is applied to each argument in turn rather than to the whole line.
23044 For this reason, any string expansion item that contains white space must be
23045 quoted so as to be contained within a single argument. A setting such as
23046 .code
23047 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23048 .endd
23049 will not work, because the expansion item gets split between several
23050 arguments. You have to write
23051 .code
23052 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23053 .endd
23054 to ensure that it is all in one argument. The expansion is done in this way,
23055 argument by argument, so that the number of arguments cannot be changed as a
23056 result of expansion, and quotes or backslashes in inserted variables do not
23057 interact with external quoting. However, this leads to problems if you want to
23058 generate multiple arguments (or the command name plus arguments) from a single
23059 expansion. In this situation, the simplest solution is to use a shell. For
23060 example:
23061 .code
23062 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23063 .endd
23064
23065 .cindex "transport" "filter"
23066 .cindex "filter" "transport filter"
23067 .vindex "&$pipe_addresses$&"
23068 Special handling takes place when an argument consists of precisely the text
23069 &`$pipe_addresses`&. This is not a general expansion variable; the only
23070 place this string is recognized is when it appears as an argument for a pipe or
23071 transport filter command. It causes each address that is being handled to be
23072 inserted in the argument list at that point &'as a separate argument'&. This
23073 avoids any problems with spaces or shell metacharacters, and is of use when a
23074 &(pipe)& transport is handling groups of addresses in a batch.
23075
23076 If &%force_command%& is enabled on the transport, Special handling takes place
23077 for an argument that consists of precisely the text &`$address_pipe`&.  It
23078 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23079 argument is inserted in the argument list at that point
23080 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23081 the only item in the argument; in fact, if it were then &%force_command%&
23082 should behave as a no-op.  Rather, it should be used to adjust the command
23083 run while preserving the argument vector separation.
23084
23085 After splitting up into arguments and expansion, the resulting command is run
23086 in a subprocess directly from the transport, &'not'& under a shell. The
23087 message that is being delivered is supplied on the standard input, and the
23088 standard output and standard error are both connected to a single pipe that is
23089 read by Exim. The &%max_output%& option controls how much output the command
23090 may produce, and the &%return_output%& and &%return_fail_output%& options
23091 control what is done with it.
23092
23093 Not running the command under a shell (by default) lessens the security risks
23094 in cases when a command from a user's filter file is built out of data that was
23095 taken from an incoming message. If a shell is required, it can of course be
23096 explicitly specified as the command to be run. However, there are circumstances
23097 where existing commands (for example, in &_.forward_& files) expect to be run
23098 under a shell and cannot easily be modified. To allow for these cases, there is
23099 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23100 works. Instead of breaking up the command line as just described, it expands it
23101 as a single string and passes the result to &_/bin/sh_&. The
23102 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23103 with &%use_shell%&, and the whole mechanism is inherently less secure.
23104
23105
23106
23107 .section "Environment variables" "SECTpipeenv"
23108 .cindex "&(pipe)& transport" "environment for command"
23109 .cindex "environment" "&(pipe)& transport"
23110 The environment variables listed below are set up when the command is invoked.
23111 This list is a compromise for maximum compatibility with other MTAs. Note that
23112 the &%environment%& option can be used to add additional variables to this
23113 environment. The environment for the &(pipe)& transport is not subject
23114 to the &%add_environment%& and &%keep_environment%& main config options.
23115 .display
23116 &`DOMAIN            `&   the domain of the address
23117 &`HOME              `&   the home directory, if set
23118 &`HOST              `&   the host name when called from a router (see below)
23119 &`LOCAL_PART        `&   see below
23120 &`LOCAL_PART_PREFIX `&   see below
23121 &`LOCAL_PART_SUFFIX `&   see below
23122 &`LOGNAME           `&   see below
23123 &`MESSAGE_ID        `&   Exim's local ID for the message
23124 &`PATH              `&   as specified by the &%path%& option below
23125 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23126 &`RECIPIENT         `&   the complete recipient address
23127 &`SENDER            `&   the sender of the message (empty if a bounce)
23128 &`SHELL             `&   &`/bin/sh`&
23129 &`TZ                `&   the value of the &%timezone%& option, if set
23130 &`USER              `&   see below
23131 .endd
23132 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23133 router, LOCAL_PART is set to the local part of the address. When it is
23134 called as a result of a forward or alias expansion, LOCAL_PART is set to
23135 the local part of the address that was expanded. In both cases, any affixes are
23136 removed from the local part, and made available in LOCAL_PART_PREFIX and
23137 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23138 same value as LOCAL_PART for compatibility with other MTAs.
23139
23140 .cindex "HOST"
23141 HOST is set only when a &(pipe)& transport is called from a router that
23142 associates hosts with an address, typically when using &(pipe)& as a
23143 pseudo-remote transport. HOST is set to the first host name specified by
23144 the router.
23145
23146 .cindex "HOME"
23147 If the transport's generic &%home_directory%& option is set, its value is used
23148 for the HOME environment variable. Otherwise, a home directory may be set
23149 by the router's &%transport_home_directory%& option, which defaults to the
23150 user's home directory if &%check_local_user%& is set.
23151
23152
23153 .section "Private options for pipe" "SECID142"
23154 .cindex "options" "&(pipe)& transport"
23155
23156
23157
23158 .option allow_commands pipe "string list&!!" unset
23159 .cindex "&(pipe)& transport" "permitted commands"
23160 The string is expanded, and is then interpreted as a colon-separated list of
23161 permitted commands. If &%restrict_to_path%& is not set, the only commands
23162 permitted are those in the &%allow_commands%& list. They need not be absolute
23163 paths; the &%path%& option is still used for relative paths. If
23164 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23165 in the &%allow_commands%& list, or a name without any slashes that is found on
23166 the path. In other words, if neither &%allow_commands%& nor
23167 &%restrict_to_path%& is set, there is no restriction on the command, but
23168 otherwise only commands that are permitted by one or the other are allowed. For
23169 example, if
23170 .code
23171 allow_commands = /usr/bin/vacation
23172 .endd
23173 and &%restrict_to_path%& is not set, the only permitted command is
23174 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23175 &%use_shell%& is set.
23176
23177
23178 .option batch_id pipe string&!! unset
23179 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23180
23181
23182 .option batch_max pipe integer 1
23183 This limits the number of addresses that can be handled in a single delivery.
23184 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23185
23186
23187 .option check_string pipe string unset
23188 As &(pipe)& writes the message, the start of each line is tested for matching
23189 &%check_string%&, and if it does, the initial matching characters are replaced
23190 by the contents of &%escape_string%&, provided both are set. The value of
23191 &%check_string%& is a literal string, not a regular expression, and the case of
23192 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23193 of &%check_string%& and &%escape_string%& are forced to values that implement
23194 the SMTP escaping protocol. Any settings made in the configuration file are
23195 ignored.
23196
23197
23198 .option command pipe string&!! unset
23199 This option need not be set when &(pipe)& is being used to deliver to pipes
23200 obtained directly from address redirections. In other cases, the option must be
23201 set, to provide a command to be run. It need not yield an absolute path (see
23202 the &%path%& option below). The command is split up into separate arguments by
23203 Exim, and each argument is separately expanded, as described in section
23204 &<<SECThowcommandrun>>& above.
23205
23206
23207 .option environment pipe string&!! unset
23208 .cindex "&(pipe)& transport" "environment for command"
23209 .cindex "environment" "&(pipe)& transport"
23210 This option is used to add additional variables to the environment in which the
23211 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23212 a string which is expanded, and then interpreted as a colon-separated list of
23213 environment settings of the form <&'name'&>=<&'value'&>.
23214
23215
23216 .option escape_string pipe string unset
23217 See &%check_string%& above.
23218
23219
23220 .option freeze_exec_fail pipe boolean false
23221 .cindex "exec failure"
23222 .cindex "failure of exec"
23223 .cindex "&(pipe)& transport" "failure of exec"
23224 Failure to exec the command in a pipe transport is by default treated like
23225 any other failure while running the command. However, if &%freeze_exec_fail%&
23226 is set, failure to exec is treated specially, and causes the message to be
23227 frozen, whatever the setting of &%ignore_status%&.
23228
23229
23230 .option freeze_signal pipe boolean false
23231 .cindex "signal exit"
23232 .cindex "&(pipe)& transport", "signal exit"
23233 Normally if the process run by a command in a pipe transport exits on a signal,
23234 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23235 frozen in Exim's queue instead.
23236
23237
23238 .option force_command pipe boolean false
23239 .cindex "force command"
23240 .cindex "&(pipe)& transport", "force command"
23241 Normally when a router redirects an address directly to a pipe command
23242 the &%command%& option on the transport is ignored.  If &%force_command%&
23243 is set, the &%command%& option will used. This is especially
23244 useful for forcing a wrapper or additional argument to be added to the
23245 command. For example:
23246 .code
23247 command = /usr/bin/remote_exec myhost -- $address_pipe
23248 force_command
23249 .endd
23250
23251 Note that &$address_pipe$& is handled specially in &%command%& when
23252 &%force_command%& is set, expanding out to the original argument vector as
23253 separate items, similarly to a Unix shell &`"$@"`& construct.
23254
23255
23256 .option ignore_status pipe boolean false
23257 If this option is true, the status returned by the subprocess that is set up to
23258 run the command is ignored, and Exim behaves as if zero had been returned.
23259 Otherwise, a non-zero status or termination by signal causes an error return
23260 from the transport unless the status value is one of those listed in
23261 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23262
23263 &*Note*&: This option does not apply to timeouts, which do not return a status.
23264 See the &%timeout_defer%& option for how timeouts are handled.
23265
23266
23267 .option log_defer_output pipe boolean false
23268 .cindex "&(pipe)& transport" "logging output"
23269 If this option is set, and the status returned by the command is
23270 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23271 and any output was produced on stdout or stderr, the first line of it is
23272 written to the main log.
23273
23274
23275 .option log_fail_output pipe boolean false
23276 If this option is set, and the command returns any output on stdout or
23277 stderr, and also ends with a return code that is neither zero nor one of
23278 the return codes listed in &%temp_errors%& (that is, the delivery
23279 failed), the first line of output is written to the main log. This
23280 option and &%log_output%& are mutually exclusive.  Only one of them may
23281 be set.
23282
23283
23284 .option log_output pipe boolean false
23285 If this option is set and the command returns any output on stdout or
23286 stderr, the first line of output is written to the main log, whatever
23287 the return code. This option and &%log_fail_output%& are mutually
23288 exclusive. Only one of them may be set.
23289
23290
23291 .option max_output pipe integer 20K
23292 This specifies the maximum amount of output that the command may produce on its
23293 standard output and standard error file combined. If the limit is exceeded, the
23294 process running the command is killed. This is intended as a safety measure to
23295 catch runaway processes. The limit is applied independently of the settings of
23296 the options that control what is done with such output (for example,
23297 &%return_output%&). Because of buffering effects, the amount of output may
23298 exceed the limit by a small amount before Exim notices.
23299
23300
23301 .option message_prefix pipe string&!! "see below"
23302 The string specified here is expanded and output at the start of every message.
23303 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23304 .code
23305 message_prefix = \
23306   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23307   ${tod_bsdinbox}\n
23308 .endd
23309 .cindex "Cyrus"
23310 .cindex "&%tmail%&"
23311 .cindex "&""From""& line"
23312 This is required by the commonly used &_/usr/bin/vacation_& program.
23313 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23314 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23315 setting
23316 .code
23317 message_prefix =
23318 .endd
23319 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23320 &`\n`& to &`\r\n`& in &%message_prefix%&.
23321
23322
23323 .option message_suffix pipe string&!! "see below"
23324 The string specified here is expanded and output at the end of every message.
23325 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23326 The suffix can be suppressed by setting
23327 .code
23328 message_suffix =
23329 .endd
23330 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23331 &`\n`& to &`\r\n`& in &%message_suffix%&.
23332
23333
23334 .option path pipe string&!! "/bin:/usr/bin"
23335 .new
23336 This option is expanded and
23337 .wen
23338 specifies the string that is set up in the PATH environment
23339 variable of the subprocess.
23340 If the &%command%& option does not yield an absolute path name, the command is
23341 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23342 apply to a command specified as a transport filter.
23343
23344
23345 .option permit_coredump pipe boolean false
23346 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23347 a core-dump of a pipe command, enable this command.  This enables core-dumps
23348 during delivery and affects both the Exim binary and the pipe command run.
23349 It is recommended that this option remain off unless and until you have a need
23350 for it and that this only be enabled when needed, as the risk of excessive
23351 resource consumption can be quite high.  Note also that Exim is typically
23352 installed as a setuid binary and most operating systems will inhibit coredumps
23353 of these by default, so further OS-specific action may be required.
23354
23355
23356 .option pipe_as_creator pipe boolean false
23357 .cindex "uid (user id)" "local delivery"
23358 If the generic &%user%& option is not set and this option is true, the delivery
23359 process is run under the uid that was in force when Exim was originally called
23360 to accept the message. If the group id is not otherwise set (via the generic
23361 &%group%& option), the gid that was in force when Exim was originally called to
23362 accept the message is used.
23363
23364
23365 .option restrict_to_path pipe boolean false
23366 When this option is set, any command name not listed in &%allow_commands%& must
23367 contain no slashes. The command is searched for only in the directories listed
23368 in the &%path%& option. This option is intended for use in the case when a pipe
23369 command has been generated from a user's &_.forward_& file. This is usually
23370 handled by a &(pipe)& transport called &%address_pipe%&.
23371
23372
23373 .option return_fail_output pipe boolean false
23374 If this option is true, and the command produced any output and ended with a
23375 return code other than zero or one of the codes listed in &%temp_errors%& (that
23376 is, the delivery failed), the output is returned in the bounce message.
23377 However, if the message has a null sender (that is, it is itself a bounce
23378 message), output from the command is discarded. This option and
23379 &%return_output%& are mutually exclusive. Only one of them may be set.
23380
23381
23382
23383 .option return_output pipe boolean false
23384 If this option is true, and the command produced any output, the delivery is
23385 deemed to have failed whatever the return code from the command, and the output
23386 is returned in the bounce message. Otherwise, the output is just discarded.
23387 However, if the message has a null sender (that is, it is a bounce message),
23388 output from the command is always discarded, whatever the setting of this
23389 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23390 of them may be set.
23391
23392
23393
23394 .option temp_errors pipe "string list" "see below"
23395 .cindex "&(pipe)& transport" "temporary failure"
23396 This option contains either a colon-separated list of numbers, or a single
23397 asterisk. If &%ignore_status%& is false
23398 and &%return_output%& is not set,
23399 and the command exits with a non-zero return code, the failure is treated as
23400 temporary and the delivery is deferred if the return code matches one of the
23401 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23402 codes are treated as permanent errors. The default setting contains the codes
23403 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23404 compiled on a system that does not define these macros, it assumes values of 75
23405 and 73, respectively.
23406
23407
23408 .option timeout pipe time 1h
23409 If the command fails to complete within this time, it is killed. This normally
23410 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23411 specifies no timeout. In order to ensure that any subprocesses created by the
23412 command are also killed, Exim makes the initial process a process group leader,
23413 and kills the whole process group on a timeout. However, this can be defeated
23414 if one of the processes starts a new process group.
23415
23416 .option timeout_defer pipe boolean false
23417 A timeout in a &(pipe)& transport, either in the command that the transport
23418 runs, or in a transport filter that is associated with it, is by default
23419 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23420 is set true, both kinds of timeout become temporary errors, causing the
23421 delivery to be deferred.
23422
23423 .option umask pipe "octal integer" 022
23424 This specifies the umask setting for the subprocess that runs the command.
23425
23426
23427 .option use_bsmtp pipe boolean false
23428 .cindex "envelope sender"
23429 If this option is set true, the &(pipe)& transport writes messages in &"batch
23430 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23431 commands. If you want to include a leading HELO command with such messages,
23432 you can do so by setting the &%message_prefix%& option. See section
23433 &<<SECTbatchSMTP>>& for details of batch SMTP.
23434
23435 .option use_classresources pipe boolean false
23436 .cindex "class resources (BSD)"
23437 This option is available only when Exim is running on FreeBSD, NetBSD, or
23438 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23439 resource limits when a &(pipe)& transport is run to perform a delivery. The
23440 limits for the uid under which the pipe is to run are obtained from the login
23441 class database.
23442
23443
23444 .option use_crlf pipe boolean false
23445 .cindex "carriage return"
23446 .cindex "linefeed"
23447 This option causes lines to be terminated with the two-character CRLF sequence
23448 (carriage return, linefeed) instead of just a linefeed character. In the case
23449 of batched SMTP, the byte sequence written to the pipe is then an exact image
23450 of what would be sent down a real SMTP connection.
23451
23452 The contents of the &%message_prefix%& and &%message_suffix%& options are
23453 written verbatim, so must contain their own carriage return characters if these
23454 are needed. When &%use_bsmtp%& is not set, the default values for both
23455 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23456 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23457
23458
23459 .option use_shell pipe boolean false
23460 .vindex "&$pipe_addresses$&"
23461 If this option is set, it causes the command to be passed to &_/bin/sh_&
23462 instead of being run directly from the transport, as described in section
23463 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23464 where the command is expected to be run under a shell and cannot easily be
23465 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23466 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23467 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23468 its &%-c%& option.
23469
23470
23471
23472 .section "Using an external local delivery agent" "SECID143"
23473 .cindex "local delivery" "using an external agent"
23474 .cindex "&'procmail'&"
23475 .cindex "external local delivery"
23476 .cindex "delivery" "&'procmail'&"
23477 .cindex "delivery" "by external agent"
23478 The &(pipe)& transport can be used to pass all messages that require local
23479 delivery to a separate local delivery agent such as &%procmail%&. When doing
23480 this, care must be taken to ensure that the pipe is run under an appropriate
23481 uid and gid. In some configurations one wants this to be a uid that is trusted
23482 by the delivery agent to supply the correct sender of the message. It may be
23483 necessary to recompile or reconfigure the delivery agent so that it trusts an
23484 appropriate user. The following is an example transport and router
23485 configuration for &%procmail%&:
23486 .code
23487 # transport
23488 procmail_pipe:
23489   driver = pipe
23490   command = /usr/local/bin/procmail -d $local_part
23491   return_path_add
23492   delivery_date_add
23493   envelope_to_add
23494   check_string = "From "
23495   escape_string = ">From "
23496   umask = 077
23497   user = $local_part
23498   group = mail
23499
23500 # router
23501 procmail:
23502   driver = accept
23503   check_local_user
23504   transport = procmail_pipe
23505 .endd
23506 In this example, the pipe is run as the local user, but with the group set to
23507 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23508 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23509 user to supply a correct sender address. If you do not specify either a
23510 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23511 home directory is the user's home directory by default.
23512
23513 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23514 .code
23515 IFS=" "
23516 .endd
23517 as shown in some &%procmail%& documentation, because Exim does not by default
23518 use a shell to run pipe commands.
23519
23520 .cindex "Cyrus"
23521 The next example shows a transport and a router for a system where local
23522 deliveries are handled by the Cyrus IMAP server.
23523 .code
23524 # transport
23525 local_delivery_cyrus:
23526   driver = pipe
23527   command = /usr/cyrus/bin/deliver \
23528             -m ${substr_1:$local_part_suffix} -- $local_part
23529   user = cyrus
23530   group = mail
23531   return_output
23532   log_output
23533   message_prefix =
23534   message_suffix =
23535
23536 # router
23537 local_user_cyrus:
23538   driver = accept
23539   check_local_user
23540   local_part_suffix = .*
23541   transport = local_delivery_cyrus
23542 .endd
23543 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23544 &%return_output%& to cause any text written by Cyrus to be returned to the
23545 sender.
23546 .ecindex IIDpiptra1
23547 .ecindex IIDpiptra2
23548
23549
23550 . ////////////////////////////////////////////////////////////////////////////
23551 . ////////////////////////////////////////////////////////////////////////////
23552
23553 .chapter "The smtp transport" "CHAPsmtptrans"
23554 .scindex IIDsmttra1 "transports" "&(smtp)&"
23555 .scindex IIDsmttra2 "&(smtp)& transport"
23556 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23557 or LMTP protocol. The list of hosts to try can either be taken from the address
23558 that is being processed (having been set up by the router), or specified
23559 explicitly for the transport. Timeout and retry processing (see chapter
23560 &<<CHAPretry>>&) is applied to each IP address independently.
23561
23562
23563 .section "Multiple messages on a single connection" "SECID144"
23564 The sending of multiple messages over a single TCP/IP connection can arise in
23565 two ways:
23566
23567 .ilist
23568 If a message contains more than &%max_rcpt%& (see below) addresses that are
23569 routed to the same host, more than one copy of the message has to be sent to
23570 that host. In this situation, multiple copies may be sent in a single run of
23571 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23572 does when it has too many addresses to send in one message also depends on the
23573 value of the global &%remote_max_parallel%& option. Details are given in
23574 section &<<SECToutSMTPTCP>>&.)
23575 .next
23576 .cindex "hints database" "remembering routing"
23577 When a message has been successfully delivered over a TCP/IP connection, Exim
23578 looks in its hints database to see if there are any other messages awaiting a
23579 connection to the same host. If there are, a new delivery process is started
23580 for one of them, and the current TCP/IP connection is passed on to it. The new
23581 process may in turn send multiple copies and possibly create yet another
23582 process.
23583 .endlist
23584
23585
23586 For each copy sent over the same TCP/IP connection, a sequence counter is
23587 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23588 no further messages are sent over that connection.
23589
23590
23591
23592 .section "Use of the $host and $host_address variables" "SECID145"
23593 .vindex "&$host$&"
23594 .vindex "&$host_address$&"
23595 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23596 &$host_address$& are the name and IP address of the first host on the host list
23597 passed by the router. However, when the transport is about to connect to a
23598 specific host, and while it is connected to that host, &$host$& and
23599 &$host_address$& are set to the values for that host. These are the values
23600 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23601 &%serialize_hosts%&, and the various TLS options are expanded.
23602
23603
23604 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23605 .vindex &$tls_bits$&
23606 .vindex &$tls_cipher$&
23607 .vindex &$tls_peerdn$&
23608 .vindex &$tls_sni$&
23609 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23610 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23611 are the values that were set when the message was received.
23612 These are the values that are used for options that are expanded before any
23613 SMTP connections are made. Just before each connection is made, these four
23614 variables are emptied. If TLS is subsequently started, they are set to the
23615 appropriate values for the outgoing connection, and these are the values that
23616 are in force when any authenticators are run and when the
23617 &%authenticated_sender%& option is expanded.
23618
23619 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23620 and will be removed in a future release.
23621
23622
23623 .section "Private options for smtp" "SECID146"
23624 .cindex "options" "&(smtp)& transport"
23625 The private options of the &(smtp)& transport are as follows:
23626
23627
23628 .option address_retry_include_sender smtp boolean true
23629 .cindex "4&'xx'& responses" "retrying after"
23630 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23631 is the combination of sender and recipient that is delayed in subsequent queue
23632 runs until the retry time is reached. You can delay the recipient without
23633 reference to the sender (which is what earlier versions of Exim did), by
23634 setting &%address_retry_include_sender%& false. However, this can lead to
23635 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23636
23637 .option allow_localhost smtp boolean false
23638 .cindex "local host" "sending to"
23639 .cindex "fallback" "hosts specified on transport"
23640 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23641 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23642 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23643 the delivery anyway. This should be used only in special cases when the
23644 configuration ensures that no looping will result (for example, a differently
23645 configured Exim is listening on the port to which the message is sent).
23646
23647
23648 .option authenticated_sender smtp string&!! unset
23649 .cindex "Cyrus"
23650 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23651 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23652 overriding any existing authenticated sender value. If the string expansion is
23653 forced to fail, the option is ignored. Other expansion failures cause delivery
23654 to be deferred. If the result of expansion is an empty string, that is also
23655 ignored.
23656
23657 The expansion happens after the outgoing connection has been made and TLS
23658 started, if required. This means that the &$host$&, &$host_address$&,
23659 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23660 particular connection.
23661
23662 If the SMTP session is not authenticated, the expansion of
23663 &%authenticated_sender%& still happens (and can cause the delivery to be
23664 deferred if it fails), but no AUTH= item is added to MAIL commands
23665 unless &%authenticated_sender_force%& is true.
23666
23667 This option allows you to use the &(smtp)& transport in LMTP mode to
23668 deliver mail to Cyrus IMAP and provide the proper local part as the
23669 &"authenticated sender"&, via a setting such as:
23670 .code
23671 authenticated_sender = $local_part
23672 .endd
23673 This removes the need for IMAP subfolders to be assigned special ACLs to
23674 allow direct delivery to those subfolders.
23675
23676 Because of expected uses such as that just described for Cyrus (when no
23677 domain is involved), there is no checking on the syntax of the provided
23678 value.
23679
23680
23681 .option authenticated_sender_force smtp boolean false
23682 If this option is set true, the &%authenticated_sender%& option's value
23683 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23684 authenticated as a client.
23685
23686
23687 .option command_timeout smtp time 5m
23688 This sets a timeout for receiving a response to an SMTP command that has been
23689 sent out. It is also used when waiting for the initial banner line from the
23690 remote host. Its value must not be zero.
23691
23692
23693 .option connect_timeout smtp time 5m
23694 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23695 to a remote host. A setting of zero allows the system timeout (typically
23696 several minutes) to act. To have any effect, the value of this option must be
23697 less than the system timeout. However, it has been observed that on some
23698 systems there is no system timeout, which is why the default value for this
23699 option is 5 minutes, a value recommended by RFC 1123.
23700
23701
23702 .option connection_max_messages smtp integer 500
23703 .cindex "SMTP" "passed connection"
23704 .cindex "SMTP" "multiple deliveries"
23705 .cindex "multiple SMTP deliveries"
23706 This controls the maximum number of separate message deliveries that are sent
23707 over a single TCP/IP connection. If the value is zero, there is no limit.
23708 For testing purposes, this value can be overridden by the &%-oB%& command line
23709 option.
23710
23711
23712 .option data_timeout smtp time 5m
23713 This sets a timeout for the transmission of each block in the data portion of
23714 the message. As a result, the overall timeout for a message depends on the size
23715 of the message. Its value must not be zero. See also &%final_timeout%&.
23716
23717
23718 .option dkim_domain smtp string&!! unset
23719 .option dkim_selector smtp string&!! unset
23720 .option dkim_private_key smtp string&!! unset
23721 .option dkim_canon smtp string&!! unset
23722 .option dkim_strict smtp string&!! unset
23723 .option dkim_sign_headers smtp string&!! unset
23724 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
23725
23726
23727 .option delay_after_cutoff smtp boolean true
23728 This option controls what happens when all remote IP addresses for a given
23729 domain have been inaccessible for so long that they have passed their retry
23730 cutoff times.
23731
23732 In the default state, if the next retry time has not been reached for any of
23733 them, the address is bounced without trying any deliveries. In other words,
23734 Exim delays retrying an IP address after the final cutoff time until a new
23735 retry time is reached, and can therefore bounce an address without ever trying
23736 a delivery, when machines have been down for a long time. Some people are
23737 unhappy at this prospect, so...
23738
23739 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23740 addresses are past their final cutoff time, Exim tries to deliver to those
23741 IP addresses that have not been tried since the message arrived. If there are
23742 none, of if they all fail, the address is bounced. In other words, it does not
23743 delay when a new message arrives, but immediately tries those expired IP
23744 addresses that haven't been tried since the message arrived. If there is a
23745 continuous stream of messages for the dead hosts, unsetting
23746 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23747 to them.
23748
23749
23750 .option dns_qualify_single smtp boolean true
23751 If the &%hosts%& or &%fallback_hosts%& option is being used,
23752 and the &%gethostbyname%& option is false,
23753 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23754 in chapter &<<CHAPdnslookup>>& for more details.
23755
23756
23757 .option dns_search_parents smtp boolean false
23758 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23759 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23760 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23761 details.
23762
23763
23764 .option dnssec_request_domains smtp "domain list&!!" unset
23765 .cindex "MX record" "security"
23766 .cindex "DNSSEC" "MX lookup"
23767 .cindex "security" "MX lookup"
23768 .cindex "DNS" "DNSSEC"
23769 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23770 the dnssec request bit set.
23771 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23772
23773
23774
23775 .option dnssec_require_domains smtp "domain list&!!" unset
23776 .cindex "MX record" "security"
23777 .cindex "DNSSEC" "MX lookup"
23778 .cindex "security" "MX lookup"
23779 .cindex "DNS" "DNSSEC"
23780 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23781 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23782 (AD bit) set will be ignored and logged as a host-lookup failure.
23783 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23784
23785
23786
23787 .option dscp smtp string&!! unset
23788 .cindex "DCSP" "outbound"
23789 This option causes the DSCP value associated with a socket to be set to one
23790 of a number of fixed strings or to numeric value.
23791 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23792 Common values include &`throughput`&, &`mincost`&, and on newer systems
23793 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23794
23795 The outbound packets from Exim will be marked with this value in the header
23796 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23797 that these values will have any effect, not be stripped by networking
23798 equipment, or do much of anything without cooperation with your Network
23799 Engineer and those of all network operators between the source and destination.
23800
23801
23802 .option fallback_hosts smtp "string list" unset
23803 .cindex "fallback" "hosts specified on transport"
23804 String expansion is not applied to this option. The argument must be a
23805 colon-separated list of host names or IP addresses, optionally also including
23806 port numbers, though the separator can be changed, as described in section
23807 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23808 item in a &%route_list%& setting for the &(manualroute)& router, as described
23809 in section &<<SECTformatonehostitem>>&.
23810
23811 Fallback hosts can also be specified on routers, which associate them with the
23812 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23813 &%fallback_hosts%& specified on the transport is used only if the address does
23814 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23815 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23816 However, &%hosts_randomize%& does apply to fallback host lists.
23817
23818 If Exim is unable to deliver to any of the hosts for a particular address, and
23819 the errors are not permanent rejections, the address is put on a separate
23820 transport queue with its host list replaced by the fallback hosts, unless the
23821 address was routed via MX records and the current host was in the original MX
23822 list. In that situation, the fallback host list is not used.
23823
23824 Once normal deliveries are complete, the fallback queue is delivered by
23825 re-running the same transports with the new host lists. If several failing
23826 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23827 copy of the message is sent.
23828
23829 The resolution of the host names on the fallback list is controlled by the
23830 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23831 both to cases when the host list comes with the address and when it is taken
23832 from &%hosts%&. This option provides a &"use a smart host only if delivery
23833 fails"& facility.
23834
23835
23836 .option final_timeout smtp time 10m
23837 This is the timeout that applies while waiting for the response to the final
23838 line containing just &"."& that terminates a message. Its value must not be
23839 zero.
23840
23841 .option gethostbyname smtp boolean false
23842 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23843 being used, names are looked up using &[gethostbyname()]&
23844 (or &[getipnodebyname()]& when available)
23845 instead of using the DNS. Of course, that function may in fact use the DNS, but
23846 it may also consult other sources of information such as &_/etc/hosts_&.
23847
23848 .option gnutls_compat_mode smtp boolean unset
23849 This option controls whether GnuTLS is used in compatibility mode in an Exim
23850 server. This reduces security slightly, but improves interworking with older
23851 implementations of TLS.
23852
23853 .option helo_data smtp string&!! "see below"
23854 .cindex "HELO" "argument, setting"
23855 .cindex "EHLO" "argument, setting"
23856 .cindex "LHLO argument setting"
23857 The value of this option is expanded after a connection to a another host has
23858 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23859 command that starts the outgoing SMTP or LMTP session. The default value of the
23860 option is:
23861 .code
23862 $primary_hostname
23863 .endd
23864 During the expansion, the variables &$host$& and &$host_address$& are set to
23865 the identity of the remote host, and the variables &$sending_ip_address$& and
23866 &$sending_port$& are set to the local IP address and port number that are being
23867 used. These variables can be used to generate different values for different
23868 servers or different local IP addresses. For example, if you want the string
23869 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23870 interface address, you could use this:
23871 .code
23872 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23873   {$primary_hostname}}
23874 .endd
23875 The use of &%helo_data%& applies both to sending messages and when doing
23876 callouts.
23877
23878 .option hosts smtp "string list&!!" unset
23879 Hosts are associated with an address by a router such as &(dnslookup)&, which
23880 finds the hosts by looking up the address domain in the DNS, or by
23881 &(manualroute)&, which has lists of hosts in its configuration. However,
23882 email addresses can be passed to the &(smtp)& transport by any router, and not
23883 all of them can provide an associated list of hosts.
23884
23885 The &%hosts%& option specifies a list of hosts to be used if the address being
23886 processed does not have any hosts associated with it. The hosts specified by
23887 &%hosts%& are also used, whether or not the address has its own hosts, if
23888 &%hosts_override%& is set.
23889
23890 The string is first expanded, before being interpreted as a colon-separated
23891 list of host names or IP addresses, possibly including port numbers. The
23892 separator may be changed to something other than colon, as described in section
23893 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23894 item in a &%route_list%& setting for the &(manualroute)& router, as described
23895 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23896 of the &(manualroute)& router is not available here.
23897
23898 If the expansion fails, delivery is deferred. Unless the failure was caused by
23899 the inability to complete a lookup, the error is logged to the panic log as
23900 well as the main log. Host names are looked up either by searching directly for
23901 address records in the DNS or by calling &[gethostbyname()]& (or
23902 &[getipnodebyname()]& when available), depending on the setting of the
23903 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23904 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23905 address are used.
23906
23907 During delivery, the hosts are tried in order, subject to their retry status,
23908 unless &%hosts_randomize%& is set.
23909
23910
23911 .option hosts_avoid_esmtp smtp "host list&!!" unset
23912 .cindex "ESMTP, avoiding use of"
23913 .cindex "HELO" "forcing use of"
23914 .cindex "EHLO" "avoiding use of"
23915 .cindex "PIPELINING" "avoiding the use of"
23916 This option is for use with broken hosts that announce ESMTP facilities (for
23917 example, PIPELINING) and then fail to implement them properly. When a host
23918 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23919 start of the SMTP session. This means that it cannot use any of the ESMTP
23920 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23921
23922
23923 .option hosts_avoid_pipelining smtp "host list&!!" unset
23924 .cindex "PIPELINING" "avoiding the use of"
23925 Exim will not use the SMTP PIPELINING extension when delivering to any host
23926 that matches this list, even if the server host advertises PIPELINING support.
23927
23928
23929 .option hosts_avoid_tls smtp "host list&!!" unset
23930 .cindex "TLS" "avoiding for certain hosts"
23931 Exim will not try to start a TLS session when delivering to any host that
23932 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23933
23934 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23935 .cindex "TLS" "avoiding for certain hosts"
23936 Exim will not try to start a TLS session for a verify callout,
23937 or when delivering in cutthrough mode,
23938 to any host that matches this list.
23939
23940
23941 .option hosts_max_try smtp integer 5
23942 .cindex "host" "maximum number to try"
23943 .cindex "limit" "number of hosts tried"
23944 .cindex "limit" "number of MX tried"
23945 .cindex "MX record" "maximum tried"
23946 This option limits the number of IP addresses that are tried for any one
23947 delivery in cases where there are temporary delivery errors. Section
23948 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23949
23950
23951 .option hosts_max_try_hardlimit smtp integer 50
23952 This is an additional check on the maximum number of IP addresses that Exim
23953 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23954 why it exists.
23955
23956
23957
23958 .option hosts_nopass_tls smtp "host list&!!" unset
23959 .cindex "TLS" "passing connection"
23960 .cindex "multiple SMTP deliveries"
23961 .cindex "TLS" "multiple message deliveries"
23962 For any host that matches this list, a connection on which a TLS session has
23963 been started will not be passed to a new delivery process for sending another
23964 message on the same connection. See section &<<SECTmulmessam>>& for an
23965 explanation of when this might be needed.
23966
23967
23968 .option hosts_override smtp boolean false
23969 If this option is set and the &%hosts%& option is also set, any hosts that are
23970 attached to the address are ignored, and instead the hosts specified by the
23971 &%hosts%& option are always used. This option does not apply to
23972 &%fallback_hosts%&.
23973
23974
23975 .option hosts_randomize smtp boolean false
23976 .cindex "randomized host list"
23977 .cindex "host" "list of; randomized"
23978 .cindex "fallback" "randomized hosts"
23979 If this option is set, and either the list of hosts is taken from the
23980 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23981 were not obtained from MX records (this includes fallback hosts from the
23982 router), and were not randomized by the router, the order of trying the hosts
23983 is randomized each time the transport runs. Randomizing the order of a host
23984 list can be used to do crude load sharing.
23985
23986 When &%hosts_randomize%& is true, a host list may be split into groups whose
23987 order is separately randomized. This makes it possible to set up MX-like
23988 behaviour. The boundaries between groups are indicated by an item that is just
23989 &`+`& in the host list. For example:
23990 .code
23991 hosts = host1:host2:host3:+:host4:host5
23992 .endd
23993 The order of the first three hosts and the order of the last two hosts is
23994 randomized for each use, but the first three always end up before the last two.
23995 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23996
23997 .option hosts_require_auth smtp "host list&!!" unset
23998 .cindex "authentication" "required by client"
23999 This option provides a list of servers for which authentication must succeed
24000 before Exim will try to transfer a message. If authentication fails for
24001 servers which are not in this list, Exim tries to send unauthenticated. If
24002 authentication fails for one of these servers, delivery is deferred. This
24003 temporary error is detectable in the retry rules, so it can be turned into a
24004 hard failure if required. See also &%hosts_try_auth%&, and chapter
24005 &<<CHAPSMTPAUTH>>& for details of authentication.
24006
24007
24008 .option hosts_request_ocsp smtp "host list&!!" *
24009 .cindex "TLS" "requiring for certain servers"
24010 Exim will request a Certificate Status on a
24011 TLS session for any host that matches this list.
24012 &%tls_verify_certificates%& should also be set for the transport.
24013
24014 .option hosts_require_ocsp smtp "host list&!!" unset
24015 .cindex "TLS" "requiring for certain servers"
24016 Exim will request, and check for a valid Certificate Status being given, on a
24017 TLS session for any host that matches this list.
24018 &%tls_verify_certificates%& should also be set for the transport.
24019
24020 .option hosts_require_tls smtp "host list&!!" unset
24021 .cindex "TLS" "requiring for certain servers"
24022 Exim will insist on using a TLS session when delivering to any host that
24023 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24024 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24025 incoming messages, use an appropriate ACL.
24026
24027 .option hosts_try_auth smtp "host list&!!" unset
24028 .cindex "authentication" "optional in client"
24029 This option provides a list of servers to which, provided they announce
24030 authentication support, Exim will attempt to authenticate as a client when it
24031 connects. If authentication fails, Exim will try to transfer the message
24032 unauthenticated. See also &%hosts_require_auth%&, and chapter
24033 &<<CHAPSMTPAUTH>>& for details of authentication.
24034
24035 .new
24036 .option hosts_try_chunking smtp "host list&!!" *
24037 .cindex CHUNKING "enabling, in client"
24038 .cindex BDAT "SMTP command"
24039 .cindex "RFC 3030" "CHUNKING"
24040 This option provides a list of servers to which, provided they announce
24041 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24042 BDAT will not be used in conjunction with a transport filter.
24043 .wen
24044
24045 .new
24046 .option hosts_try_fastopen smtp "host list!!" unset
24047 .cindex "fast open, TCP" "enabling, in client"
24048 .cindex "TCP Fast Open" "enabling, in client"
24049 .cindex "RFC 7413" "TCP Fast Open"
24050 This option provides a list of servers to which, provided
24051 the facility is supported by this system, Exim will attempt to
24052 perform a TCP Fast Open.
24053 No data is sent on the SYN segment but, if the remote server also
24054 supports the facility, it can send its SMTP banner immediately after
24055 the SYN,ACK segment.  This can save up to one round-trip time.
24056
24057 The facility is only active for previously-contacted servers,
24058 as the initiator must present a cookie in the SYN segment.
24059
24060 On (at least some) current Linux distributions the facility must be enabled
24061 in the kernel by the sysadmin before the support is usable.
24062 .wen
24063
24064 .option hosts_try_prdr smtp "host list&!!" *
24065 .cindex "PRDR" "enabling, optional in client"
24066 This option provides a list of servers to which, provided they announce
24067 PRDR support, Exim will attempt to negotiate PRDR
24068 for multi-recipient messages.
24069 The option can usually be left as default.
24070
24071 .option interface smtp "string list&!!" unset
24072 .cindex "bind IP address"
24073 .cindex "IP address" "binding"
24074 .vindex "&$host$&"
24075 .vindex "&$host_address$&"
24076 This option specifies which interface to bind to when making an outgoing SMTP
24077 call. The value is an IP address, not an interface name such as
24078 &`eth0`&. Do not confuse this with the interface address that was used when a
24079 message was received, which is in &$received_ip_address$&, formerly known as
24080 &$interface_address$&. The name was changed to minimize confusion with the
24081 outgoing interface address. There is no variable that contains an outgoing
24082 interface address because, unless it is set by this option, its value is
24083 unknown.
24084
24085 During the expansion of the &%interface%& option the variables &$host$& and
24086 &$host_address$& refer to the host to which a connection is about to be made
24087 during the expansion of the string. Forced expansion failure, or an empty
24088 string result causes the option to be ignored. Otherwise, after expansion, the
24089 string must be a list of IP addresses, colon-separated by default, but the
24090 separator can be changed in the usual way. For example:
24091 .code
24092 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24093 .endd
24094 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24095 connection. If none of them are the correct type, the option is ignored. If
24096 &%interface%& is not set, or is ignored, the system's IP functions choose which
24097 interface to use if the host has more than one.
24098
24099
24100 .option keepalive smtp boolean true
24101 .cindex "keepalive" "on outgoing connection"
24102 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24103 connections. When set, it causes the kernel to probe idle connections
24104 periodically, by sending packets with &"old"& sequence numbers. The other end
24105 of the connection should send a acknowledgment if the connection is still okay
24106 or a reset if the connection has been aborted. The reason for doing this is
24107 that it has the beneficial effect of freeing up certain types of connection
24108 that can get stuck when the remote host is disconnected without tidying up the
24109 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24110 unreachable hosts.
24111
24112
24113 .option lmtp_ignore_quota smtp boolean false
24114 .cindex "LMTP" "ignoring quota errors"
24115 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24116 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24117 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24118
24119 .option max_rcpt smtp integer 100
24120 .cindex "RCPT" "maximum number of outgoing"
24121 This option limits the number of RCPT commands that are sent in a single
24122 SMTP message transaction. Each set of addresses is treated independently, and
24123 so can cause parallel connections to the same host if &%remote_max_parallel%&
24124 permits this.
24125
24126
24127 .option multi_domain smtp boolean&!! true
24128 .vindex "&$domain$&"
24129 When this option is set, the &(smtp)& transport can handle a number of
24130 addresses containing a mixture of different domains provided they all resolve
24131 to the same list of hosts. Turning the option off restricts the transport to
24132 handling only one domain at a time. This is useful if you want to use
24133 &$domain$& in an expansion for the transport, because it is set only when there
24134 is a single domain involved in a remote delivery.
24135
24136 It is expanded per-address and can depend on any of
24137 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24138 &$host$&, &$host_address$& and &$host_port$&.
24139
24140 .option port smtp string&!! "see below"
24141 .cindex "port" "sending TCP/IP"
24142 .cindex "TCP/IP" "setting outgoing port"
24143 This option specifies the TCP/IP port on the server to which Exim connects.
24144 &*Note:*& Do not confuse this with the port that was used when a message was
24145 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24146 The name was changed to minimize confusion with the outgoing port. There is no
24147 variable that contains an outgoing port.
24148
24149 If the value of this option begins with a digit it is taken as a port number;
24150 otherwise it is looked up using &[getservbyname()]&. The default value is
24151 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24152 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24153 is deferred.
24154
24155
24156
24157 .option protocol smtp string smtp
24158 .cindex "LMTP" "over TCP/IP"
24159 .cindex "ssmtp protocol" "outbound"
24160 .cindex "TLS" "SSL-on-connect outbound"
24161 .vindex "&$port$&"
24162 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24163 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24164 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24165 deliveries into closed message stores. Exim also has support for running LMTP
24166 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24167
24168 If this option is set to &"smtps"&, the default value for the &%port%& option
24169 changes to &"smtps"&, and the transport initiates TLS immediately after
24170 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24171 The Internet standards bodies strongly discourage use of this mode.
24172
24173
24174 .option retry_include_ip_address smtp boolean&!! true
24175 Exim normally includes both the host name and the IP address in the key it
24176 constructs for indexing retry data after a temporary delivery failure. This
24177 means that when one of several IP addresses for a host is failing, it gets
24178 tried periodically (controlled by the retry rules), but use of the other IP
24179 addresses is not affected.
24180
24181 However, in some dialup environments hosts are assigned a different IP address
24182 each time they connect. In this situation the use of the IP address as part of
24183 the retry key leads to undesirable behaviour. Setting this option false causes
24184 Exim to use only the host name.
24185 Since it is expanded it can be made to depend on the host or domain.
24186
24187
24188 .option serialize_hosts smtp "host list&!!" unset
24189 .cindex "serializing connections"
24190 .cindex "host" "serializing connections"
24191 Because Exim operates in a distributed manner, if several messages for the same
24192 host arrive at around the same time, more than one simultaneous connection to
24193 the remote host can occur. This is not usually a problem except when there is a
24194 slow link between the hosts. In that situation it may be helpful to restrict
24195 Exim to one connection at a time. This can be done by setting
24196 &%serialize_hosts%& to match the relevant hosts.
24197
24198 .cindex "hints database" "serializing deliveries to a host"
24199 Exim implements serialization by means of a hints database in which a record is
24200 written whenever a process connects to one of the restricted hosts. The record
24201 is deleted when the connection is completed. Obviously there is scope for
24202 records to get left lying around if there is a system or program crash. To
24203 guard against this, Exim ignores any records that are more than six hours old.
24204
24205 If you set up this kind of serialization, you should also arrange to delete the
24206 relevant hints database whenever your system reboots. The names of the files
24207 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24208 may be one or two files, depending on the type of DBM in use. The same files
24209 are used for ETRN serialization.
24210
24211 See also the &%max_parallel%& generic transport option.
24212
24213
24214 .option size_addition smtp integer 1024
24215 .cindex "SMTP" "SIZE"
24216 .cindex "message" "size issue for transport filter"
24217 .cindex "size" "of message"
24218 .cindex "transport" "filter"
24219 .cindex "filter" "transport filter"
24220 If a remote SMTP server indicates that it supports the SIZE option of the
24221 MAIL command, Exim uses this to pass over the message size at the start of
24222 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24223 sends, to allow for headers and other text that may be added during delivery by
24224 configuration options or in a transport filter. It may be necessary to increase
24225 this if a lot of text is added to messages.
24226
24227 Alternatively, if the value of &%size_addition%& is set negative, it disables
24228 the use of the SIZE option altogether.
24229
24230
24231 .option socks_proxy smtp string&!! unset
24232 .cindex proxy SOCKS
24233 This option enables use of SOCKS proxies for connections made by the
24234 transport.  For details see section &<<SECTproxySOCKS>>&.
24235
24236
24237 .option tls_certificate smtp string&!! unset
24238 .cindex "TLS" "client certificate, location of"
24239 .cindex "certificate" "client, location of"
24240 .vindex "&$host$&"
24241 .vindex "&$host_address$&"
24242 The value of this option must be the absolute path to a file which contains the
24243 client's certificate, for possible use when sending a message over an encrypted
24244 connection. The values of &$host$& and &$host_address$& are set to the name and
24245 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24246 details of TLS.
24247
24248 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24249 certificate when sending messages as a client. The global option of the same
24250 name specifies the certificate for Exim as a server; it is not automatically
24251 assumed that the same certificate should be used when Exim is operating as a
24252 client.
24253
24254
24255 .option tls_crl smtp string&!! unset
24256 .cindex "TLS" "client certificate revocation list"
24257 .cindex "certificate" "revocation list for client"
24258 This option specifies a certificate revocation list. The expanded value must
24259 be the name of a file that contains a CRL in PEM format.
24260
24261
24262 .option tls_dh_min_bits smtp integer 1024
24263 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24264 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24265 key agreement is negotiated, the server will provide a large prime number
24266 for use.  This option establishes the minimum acceptable size of that number.
24267 If the parameter offered by the server is too small, then the TLS handshake
24268 will fail.
24269
24270 Only supported when using GnuTLS.
24271
24272
24273 .option tls_privatekey smtp string&!! unset
24274 .cindex "TLS" "client private key, location of"
24275 .vindex "&$host$&"
24276 .vindex "&$host_address$&"
24277 The value of this option must be the absolute path to a file which contains the
24278 client's private key. This is used when sending a message over an encrypted
24279 connection using a client certificate. The values of &$host$& and
24280 &$host_address$& are set to the name and address of the server during the
24281 expansion. If this option is unset, or the expansion is forced to fail, or the
24282 result is an empty string, the private key is assumed to be in the same file as
24283 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24284
24285
24286 .option tls_require_ciphers smtp string&!! unset
24287 .cindex "TLS" "requiring specific ciphers"
24288 .cindex "cipher" "requiring specific"
24289 .vindex "&$host$&"
24290 .vindex "&$host_address$&"
24291 The value of this option must be a list of permitted cipher suites, for use
24292 when setting up an outgoing encrypted connection. (There is a global option of
24293 the same name for controlling incoming connections.) The values of &$host$& and
24294 &$host_address$& are set to the name and address of the server during the
24295 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24296 is used in different ways by OpenSSL and GnuTLS (see sections
24297 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24298 ciphers is a preference order.
24299
24300
24301
24302 .option tls_sni smtp string&!! unset
24303 .cindex "TLS" "Server Name Indication"
24304 .vindex "&$tls_sni$&"
24305 If this option is set then it sets the $tls_out_sni variable and causes any
24306 TLS session to pass this value as the Server Name Indication extension to
24307 the remote side, which can be used by the remote side to select an appropriate
24308 certificate and private key for the session.
24309
24310 See &<<SECTtlssni>>& for more information.
24311
24312 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24313 TLS extensions.
24314
24315
24316
24317
24318 .option tls_tempfail_tryclear smtp boolean true
24319 .cindex "4&'xx'& responses" "to STARTTLS"
24320 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24321 setting up a TLS session, this option determines whether or not Exim should try
24322 to deliver the message unencrypted. If it is set false, delivery to the
24323 current host is deferred; if there are other hosts, they are tried. If this
24324 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24325 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24326 TLS negotiation fails, Exim closes the current connection (because it is in an
24327 unknown state), opens a new one to the same host, and then tries the delivery
24328 in clear.
24329
24330
24331 .option tls_try_verify_hosts smtp "host list&!!" *
24332 .cindex "TLS" "server certificate verification"
24333 .cindex "certificate" "verification of server"
24334 This option gives a list of hosts for which, on encrypted connections,
24335 certificate verification will be tried but need not succeed.
24336 The &%tls_verify_certificates%& option must also be set.
24337 Note that unless the host is in this list
24338 TLS connections will be denied to hosts using self-signed certificates
24339 when &%tls_verify_certificates%& is matched.
24340 The &$tls_out_certificate_verified$& variable is set when
24341 certificate verification succeeds.
24342
24343
24344 .option tls_verify_cert_hostnames smtp "host list&!!" *
24345 .cindex "TLS" "server certificate hostname verification"
24346 .cindex "certificate" "verification of server"
24347 This option give a list of hosts for which,
24348 while verifying the server certificate,
24349 checks will be included on the host name
24350 (note that this will generally be the result of a DNS MX lookup)
24351 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24352 limited to being the initial component of a 3-or-more component FQDN.
24353
24354 There is no equivalent checking on client certificates.
24355
24356
24357 .option tls_verify_certificates smtp string&!! system
24358 .cindex "TLS" "server certificate verification"
24359 .cindex "certificate" "verification of server"
24360 .vindex "&$host$&"
24361 .vindex "&$host_address$&"
24362 The value of this option must be either the
24363 word "system"
24364 or the absolute path to
24365 a file or directory containing permitted certificates for servers,
24366 for use when setting up an encrypted connection.
24367
24368 The "system" value for the option will use a location compiled into the SSL library.
24369 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24370 is taken as empty and an explicit location
24371 must be specified.
24372
24373 The use of a directory for the option value is not available for GnuTLS versions
24374 preceding 3.3.6 and a single file must be used.
24375
24376 With OpenSSL the certificates specified
24377 explicitly
24378 either by file or directory
24379 are added to those given by the system default location.
24380
24381 The values of &$host$& and
24382 &$host_address$& are set to the name and address of the server during the
24383 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24384
24385 For back-compatibility,
24386 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24387 (a single-colon empty list counts as being set)
24388 and certificate verification fails the TLS connection is closed.
24389
24390
24391 .option tls_verify_hosts smtp "host list&!!" unset
24392 .cindex "TLS" "server certificate verification"
24393 .cindex "certificate" "verification of server"
24394 This option gives a list of hosts for which, on encrypted connections,
24395 certificate verification must succeed.
24396 The &%tls_verify_certificates%& option must also be set.
24397 If both this option and &%tls_try_verify_hosts%& are unset
24398 operation is as if this option selected all hosts.
24399
24400
24401
24402
24403 .section "How the limits for the number of hosts to try are used" &&&
24404          "SECTvalhosmax"
24405 .cindex "host" "maximum number to try"
24406 .cindex "limit" "hosts; maximum number tried"
24407 There are two options that are concerned with the number of hosts that are
24408 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24409 &%hosts_max_try_hardlimit%&.
24410
24411
24412 The &%hosts_max_try%& option limits the number of hosts that are tried
24413 for a single delivery. However, despite the term &"host"& in its name, the
24414 option actually applies to each IP address independently. In other words, a
24415 multihomed host is treated as several independent hosts, just as it is for
24416 retrying.
24417
24418 Many of the larger ISPs have multiple MX records which often point to
24419 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24420 created as a result of routing one of these domains.
24421
24422 Trying every single IP address on such a long list does not seem sensible; if
24423 several at the top of the list fail, it is reasonable to assume there is some
24424 problem that is likely to affect all of them. Roughly speaking, the value of
24425 &%hosts_max_try%& is the maximum number that are tried before deferring the
24426 delivery. However, the logic cannot be quite that simple.
24427
24428 Firstly, IP addresses that are skipped because their retry times have not
24429 arrived do not count, and in addition, addresses that are past their retry
24430 limits are also not counted, even when they are tried. This means that when
24431 some IP addresses are past their retry limits, more than the value of
24432 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24433 that all IP addresses are considered before timing out an email address (but
24434 see below for an exception).
24435
24436 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24437 list to see if there is a subsequent host with a different (higher valued) MX.
24438 If there is, that host is considered next, and the current IP address is used
24439 but not counted. This behaviour helps in the case of a domain with a retry rule
24440 that hardly ever delays any hosts, as is now explained:
24441
24442 Consider the case of a long list of hosts with one MX value, and a few with a
24443 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24444 hosts at the top of the list are tried at first. With the default retry rule,
24445 which specifies increasing retry times, the higher MX hosts are eventually
24446 tried when those at the top of the list are skipped because they have not
24447 reached their retry times.
24448
24449 However, it is common practice to put a fixed short retry time on domains for
24450 large ISPs, on the grounds that their servers are rarely down for very long.
24451 Unfortunately, these are exactly the domains that tend to resolve to long lists
24452 of hosts. The short retry time means that the lowest MX hosts are tried every
24453 time. The attempts may be in a different order because of random sorting, but
24454 without the special MX check, the higher MX hosts would never be tried until
24455 all the lower MX hosts had timed out (which might be several days), because
24456 there are always some lower MX hosts that have reached their retry times. With
24457 the special check, Exim considers at least one IP address from each MX value at
24458 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24459 reached.
24460
24461 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24462 particular, Exim normally eventually tries all the IP addresses before timing
24463 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24464 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24465 been set up with hundreds of IP addresses for some domains. It can
24466 take a very long time indeed for an address to time out in these cases.
24467
24468 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24469 Exim never tries more than this number of IP addresses; if it hits this limit
24470 and they are all timed out, the email address is bounced, even though not all
24471 possible IP addresses have been tried.
24472 .ecindex IIDsmttra1
24473 .ecindex IIDsmttra2
24474
24475
24476
24477
24478
24479 . ////////////////////////////////////////////////////////////////////////////
24480 . ////////////////////////////////////////////////////////////////////////////
24481
24482 .chapter "Address rewriting" "CHAPrewrite"
24483 .scindex IIDaddrew "rewriting" "addresses"
24484 There are some circumstances in which Exim automatically rewrites domains in
24485 addresses. The two most common are when an address is given without a domain
24486 (referred to as an &"unqualified address"&) or when an address contains an
24487 abbreviated domain that is expanded by DNS lookup.
24488
24489 Unqualified envelope addresses are accepted only for locally submitted
24490 messages, or for messages that are received from hosts matching
24491 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24492 appropriate. Unqualified addresses in header lines are qualified if they are in
24493 locally submitted messages, or messages from hosts that are permitted to send
24494 unqualified envelope addresses. Otherwise, unqualified addresses in header
24495 lines are neither qualified nor rewritten.
24496
24497 One situation in which Exim does &'not'& automatically rewrite a domain is
24498 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24499 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24500 do this. The new RFCs do not contain this suggestion.
24501
24502
24503 .section "Explicitly configured address rewriting" "SECID147"
24504 This chapter describes the rewriting rules that can be used in the
24505 main rewrite section of the configuration file, and also in the generic
24506 &%headers_rewrite%& option that can be set on any transport.
24507
24508 Some people believe that configured address rewriting is a Mortal Sin.
24509 Others believe that life is not possible without it. Exim provides the
24510 facility; you do not have to use it.
24511
24512 The main rewriting rules that appear in the &"rewrite"& section of the
24513 configuration file are applied to addresses in incoming messages, both envelope
24514 addresses and addresses in header lines. Each rule specifies the types of
24515 address to which it applies.
24516
24517 Whether or not addresses in header lines are rewritten depends on the origin of
24518 the headers and the type of rewriting. Global rewriting, that is, rewriting
24519 rules from the rewrite section of the configuration file, is applied only to
24520 those headers that were received with the message. Header lines that are added
24521 by ACLs or by a system filter or by individual routers or transports (which
24522 are specific to individual recipient addresses) are not rewritten by the global
24523 rules.
24524
24525 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24526 applies all headers except those added by routers and transports. That is, as
24527 well as the headers that were received with the message, it also applies to
24528 headers that were added by an ACL or a system filter.
24529
24530
24531 In general, rewriting addresses from your own system or domain has some
24532 legitimacy. Rewriting other addresses should be done only with great care and
24533 in special circumstances. The author of Exim believes that rewriting should be
24534 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24535 Although it can sometimes be used as a routing tool, this is very strongly
24536 discouraged.
24537
24538 There are two commonly encountered circumstances where rewriting is used, as
24539 illustrated by these examples:
24540
24541 .ilist
24542 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24543 exchange mail with each other behind a firewall, but there is only a single
24544 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24545 &'hitch.fict.example'& when sending mail off-site.
24546 .next
24547 A host rewrites the local parts of its own users so that, for example,
24548 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24549 .endlist
24550
24551
24552
24553 .section "When does rewriting happen?" "SECID148"
24554 .cindex "rewriting" "timing of"
24555 .cindex "&ACL;" "rewriting addresses in"
24556 Configured address rewriting can take place at several different stages of a
24557 message's processing.
24558
24559 .vindex "&$sender_address$&"
24560 At the start of an ACL for MAIL, the sender address may have been rewritten
24561 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24562 ordinary rewrite rules have yet been applied. If, however, the sender address
24563 is verified in the ACL, it is rewritten before verification, and remains
24564 rewritten thereafter. The subsequent value of &$sender_address$& is the
24565 rewritten address. This also applies if sender verification happens in a
24566 RCPT ACL. Otherwise, when the sender address is not verified, it is
24567 rewritten as soon as a message's header lines have been received.
24568
24569 .vindex "&$domain$&"
24570 .vindex "&$local_part$&"
24571 Similarly, at the start of an ACL for RCPT, the current recipient's address
24572 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24573 rewrite rules have yet been applied to it. However, the behaviour is different
24574 from the sender address when a recipient is verified. The address is rewritten
24575 for the verification, but the rewriting is not remembered at this stage. The
24576 value of &$local_part$& and &$domain$& after verification are always the same
24577 as they were before (that is, they contain the unrewritten &-- except for
24578 SMTP-time rewriting &-- address).
24579
24580 As soon as a message's header lines have been received, all the envelope
24581 recipient addresses are permanently rewritten, and rewriting is also applied to
24582 the addresses in the header lines (if configured). This happens before adding
24583 any header lines that were specified in MAIL or RCPT ACLs, and
24584 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24585 before the DATA ACL and &[local_scan()]& functions are run.
24586
24587 When an address is being routed, either for delivery or for verification,
24588 rewriting is applied immediately to child addresses that are generated by
24589 redirection, unless &%no_rewrite%& is set on the router.
24590
24591 .cindex "envelope sender" "rewriting at transport time"
24592 .cindex "rewriting" "at transport time"
24593 .cindex "header lines" "rewriting at transport time"
24594 At transport time, additional rewriting of addresses in header lines can be
24595 specified by setting the generic &%headers_rewrite%& option on a transport.
24596 This option contains rules that are identical in form to those in the rewrite
24597 section of the configuration file. They are applied to the original message
24598 header lines and any that were added by ACLs or a system filter. They are not
24599 applied to header lines that are added by routers or the transport.
24600
24601 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24602 transport option. However, it is not possible to rewrite envelope recipients at
24603 transport time.
24604
24605
24606
24607
24608 .section "Testing the rewriting rules that apply on input" "SECID149"
24609 .cindex "rewriting" "testing"
24610 .cindex "testing" "rewriting"
24611 Exim's input rewriting configuration appears in a part of the run time
24612 configuration file headed by &"begin rewrite"&. It can be tested by the
24613 &%-brw%& command line option. This takes an address (which can be a full RFC
24614 2822 address) as its argument. The output is a list of how the address would be
24615 transformed by the rewriting rules for each of the different places it might
24616 appear in an incoming message, that is, for each different header and for the
24617 envelope sender and recipient fields. For example,
24618 .code
24619 exim -brw ph10@exim.workshop.example
24620 .endd
24621 might produce the output
24622 .code
24623 sender: Philip.Hazel@exim.workshop.example
24624 from: Philip.Hazel@exim.workshop.example
24625 to: ph10@exim.workshop.example
24626 cc: ph10@exim.workshop.example
24627 bcc: ph10@exim.workshop.example
24628 reply-to: Philip.Hazel@exim.workshop.example
24629 env-from: Philip.Hazel@exim.workshop.example
24630 env-to: ph10@exim.workshop.example
24631 .endd
24632 which shows that rewriting has been set up for that address when used in any of
24633 the source fields, but not when it appears as a recipient address. At the
24634 present time, there is no equivalent way of testing rewriting rules that are
24635 set for a particular transport.
24636
24637
24638 .section "Rewriting rules" "SECID150"
24639 .cindex "rewriting" "rules"
24640 The rewrite section of the configuration file consists of lines of rewriting
24641 rules in the form
24642 .display
24643 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24644 .endd
24645 Rewriting rules that are specified for the &%headers_rewrite%& generic
24646 transport option are given as a colon-separated list. Each item in the list
24647 takes the same form as a line in the main rewriting configuration (except that
24648 any colons must be doubled, of course).
24649
24650 The formats of source patterns and replacement strings are described below.
24651 Each is terminated by white space, unless enclosed in double quotes, in which
24652 case normal quoting conventions apply inside the quotes. The flags are single
24653 characters which may appear in any order. Spaces and tabs between them are
24654 ignored.
24655
24656 For each address that could potentially be rewritten, the rules are scanned in
24657 order, and replacements for the address from earlier rules can themselves be
24658 replaced by later rules (but see the &"q"& and &"R"& flags).
24659
24660 The order in which addresses are rewritten is undefined, may change between
24661 releases, and must not be relied on, with one exception: when a message is
24662 received, the envelope sender is always rewritten first, before any header
24663 lines are rewritten. For example, the replacement string for a rewrite of an
24664 address in &'To:'& must not assume that the message's address in &'From:'& has
24665 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24666 that the envelope sender has already been rewritten.
24667
24668 .vindex "&$domain$&"
24669 .vindex "&$local_part$&"
24670 The variables &$local_part$& and &$domain$& can be used in the replacement
24671 string to refer to the address that is being rewritten. Note that lookup-driven
24672 rewriting can be done by a rule of the form
24673 .code
24674 *@*   ${lookup ...
24675 .endd
24676 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24677 refer to the address that is being rewritten.
24678
24679
24680 .section "Rewriting patterns" "SECID151"
24681 .cindex "rewriting" "patterns"
24682 .cindex "address list" "in a rewriting pattern"
24683 The source pattern in a rewriting rule is any item which may appear in an
24684 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24685 single-item address list, which means that it is expanded before being tested
24686 against the address. As always, if you use a regular expression as a pattern,
24687 you must take care to escape dollar and backslash characters, or use the &`\N`&
24688 facility to suppress string expansion within the regular expression.
24689
24690 Domains in patterns should be given in lower case. Local parts in patterns are
24691 case-sensitive. If you want to do case-insensitive matching of local parts, you
24692 can use a regular expression that starts with &`^(?i)`&.
24693
24694 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24695 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24696 depending on the type of match which occurred. These can be used in the
24697 replacement string to insert portions of the incoming address. &$0$& always
24698 refers to the complete incoming address. When a regular expression is used, the
24699 numerical variables are set from its capturing subexpressions. For other types
24700 of pattern they are set as follows:
24701
24702 .ilist
24703 If a local part or domain starts with an asterisk, the numerical variables
24704 refer to the character strings matched by asterisks, with &$1$& associated with
24705 the first asterisk, and &$2$& with the second, if present. For example, if the
24706 pattern
24707 .code
24708 *queen@*.fict.example
24709 .endd
24710 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24711 .code
24712 $0 = hearts-queen@wonderland.fict.example
24713 $1 = hearts-
24714 $2 = wonderland
24715 .endd
24716 Note that if the local part does not start with an asterisk, but the domain
24717 does, it is &$1$& that contains the wild part of the domain.
24718
24719 .next
24720 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24721 of the domain are placed in the next available numerical variables. Suppose,
24722 for example, that the address &'foo@bar.baz.example'& is processed by a
24723 rewriting rule of the form
24724 .display
24725 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24726 .endd
24727 and the key in the file that matches the domain is &`*.baz.example`&. Then
24728 .code
24729 $1 = foo
24730 $2 = bar
24731 $3 = baz.example
24732 .endd
24733 If the address &'foo@baz.example'& is looked up, this matches the same
24734 wildcard file entry, and in this case &$2$& is set to the empty string, but
24735 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24736 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24737 whole domain. For non-partial domain lookups, no numerical variables are set.
24738 .endlist
24739
24740
24741 .section "Rewriting replacements" "SECID152"
24742 .cindex "rewriting" "replacements"
24743 If the replacement string for a rule is a single asterisk, addresses that
24744 match the pattern and the flags are &'not'& rewritten, and no subsequent
24745 rewriting rules are scanned. For example,
24746 .code
24747 hatta@lookingglass.fict.example  *  f
24748 .endd
24749 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24750 &'From:'& headers.
24751
24752 .vindex "&$domain$&"
24753 .vindex "&$local_part$&"
24754 If the replacement string is not a single asterisk, it is expanded, and must
24755 yield a fully qualified address. Within the expansion, the variables
24756 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24757 Any letters they contain retain their original case &-- they are not lower
24758 cased. The numerical variables are set up according to the type of pattern that
24759 matched the address, as described above. If the expansion is forced to fail by
24760 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24761 current rule is abandoned, but subsequent rules may take effect. Any other
24762 expansion failure causes the entire rewriting operation to be abandoned, and an
24763 entry written to the panic log.
24764
24765
24766
24767 .section "Rewriting flags" "SECID153"
24768 There are three different kinds of flag that may appear on rewriting rules:
24769
24770 .ilist
24771 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24772 c, f, h, r, s, t.
24773 .next
24774 A flag that specifies rewriting at SMTP time: S.
24775 .next
24776 Flags that control the rewriting process: Q, q, R, w.
24777 .endlist
24778
24779 For rules that are part of the &%headers_rewrite%& generic transport option,
24780 E, F, T, and S are not permitted.
24781
24782
24783
24784 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24785          "SECID154"
24786 .cindex "rewriting" "flags"
24787 If none of the following flag letters, nor the &"S"& flag (see section
24788 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24789 and to both the sender and recipient fields of the envelope, whereas a
24790 transport-time rewriting rule just applies to all headers. Otherwise, the
24791 rewriting rule is skipped unless the relevant addresses are being processed.
24792 .display
24793 &`E`&       rewrite all envelope fields
24794 &`F`&       rewrite the envelope From field
24795 &`T`&       rewrite the envelope To field
24796 &`b`&       rewrite the &'Bcc:'& header
24797 &`c`&       rewrite the &'Cc:'& header
24798 &`f`&       rewrite the &'From:'& header
24799 &`h`&       rewrite all headers
24800 &`r`&       rewrite the &'Reply-To:'& header
24801 &`s`&       rewrite the &'Sender:'& header
24802 &`t`&       rewrite the &'To:'& header
24803 .endd
24804 "All headers" means all of the headers listed above that can be selected
24805 individually, plus their &'Resent-'& versions. It does not include
24806 other headers such as &'Subject:'& etc.
24807
24808 You should be particularly careful about rewriting &'Sender:'& headers, and
24809 restrict this to special known cases in your own domains.
24810
24811
24812 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24813 .cindex "SMTP" "rewriting malformed addresses"
24814 .cindex "RCPT" "rewriting argument of"
24815 .cindex "MAIL" "rewriting argument of"
24816 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24817 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24818 before any other processing; even before syntax checking. The pattern is
24819 required to be a regular expression, and it is matched against the whole of the
24820 data for the command, including any surrounding angle brackets.
24821
24822 .vindex "&$domain$&"
24823 .vindex "&$local_part$&"
24824 This form of rewrite rule allows for the handling of addresses that are not
24825 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24826 input). Because the input is not required to be a syntactically valid address,
24827 the variables &$local_part$& and &$domain$& are not available during the
24828 expansion of the replacement string. The result of rewriting replaces the
24829 original address in the MAIL or RCPT command.
24830
24831
24832 .section "Flags controlling the rewriting process" "SECID155"
24833 There are four flags which control the way the rewriting process works. These
24834 take effect only when a rule is invoked, that is, when the address is of the
24835 correct type (matches the flags) and matches the pattern:
24836
24837 .ilist
24838 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24839 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24840 absence of &"Q"& the rewritten address must always include a domain.
24841 .next
24842 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24843 even if no rewriting actually takes place because of a &"fail"& in the
24844 expansion. The &"q"& flag is not effective if the address is of the wrong type
24845 (does not match the flags) or does not match the pattern.
24846 .next
24847 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24848 address, up to ten times. It can be combined with the &"q"& flag, to stop
24849 rewriting once it fails to match (after at least one successful rewrite).
24850 .next
24851 .cindex "rewriting" "whole addresses"
24852 When an address in a header is rewritten, the rewriting normally applies only
24853 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24854 left unchanged. For example, rewriting might change
24855 .code
24856 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24857 .endd
24858 into
24859 .code
24860 From: Ford Prefect <prefectf@hitch.fict.example>
24861 .endd
24862 .cindex "RFC 2047"
24863 Sometimes there is a need to replace the whole address item, and this can be
24864 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24865 causes an address in a header line to be rewritten, the entire address is
24866 replaced, not just the working part. The replacement must be a complete RFC
24867 2822 address, including the angle brackets if necessary. If text outside angle
24868 brackets contains a character whose value is greater than 126 or less than 32
24869 (except for tab), the text is encoded according to RFC 2047. The character set
24870 is taken from &%headers_charset%&, which gets its default at build time.
24871
24872 When the &"w"& flag is set on a rule that causes an envelope address to be
24873 rewritten, all but the working part of the replacement address is discarded.
24874 .endlist
24875
24876
24877 .section "Rewriting examples" "SECID156"
24878 Here is an example of the two common rewriting paradigms:
24879 .code
24880 *@*.hitch.fict.example  $1@hitch.fict.example
24881 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24882                      {$value}fail}@hitch.fict.example bctfrF
24883 .endd
24884 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24885 the string expansion to fail if the lookup does not succeed. In this context it
24886 has the effect of leaving the original address unchanged, but Exim goes on to
24887 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24888 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24889 explicitly, which would cause the rewritten address to be the same as before,
24890 at the cost of a small bit of processing. Not supplying either of these is an
24891 error, since the rewritten address would then contain no local part.
24892
24893 The first example above replaces the domain with a superior, more general
24894 domain. This may not be desirable for certain local parts. If the rule
24895 .code
24896 root@*.hitch.fict.example  *
24897 .endd
24898 were inserted before the first rule, rewriting would be suppressed for the
24899 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24900
24901 Rewriting can be made conditional on a number of tests, by making use of
24902 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24903 messages that originate outside the local host:
24904 .code
24905 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24906                          {$1@hitch.fict.example}fail}"
24907 .endd
24908 The replacement string is quoted in this example because it contains white
24909 space.
24910
24911 .cindex "rewriting" "bang paths"
24912 .cindex "bang paths" "rewriting"
24913 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24914 an address it treats it as an unqualified local part which it qualifies with
24915 the local qualification domain (if the source of the message is local or if the
24916 remote host is permitted to send unqualified addresses). Rewriting can
24917 sometimes be used to handle simple bang paths with a fixed number of
24918 components. For example, the rule
24919 .code
24920 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24921 .endd
24922 rewrites a two-component bang path &'host.name!user'& as the domain address
24923 &'user@host.name'&. However, there is a security implication in using this as
24924 a global rewriting rule for envelope addresses. It can provide a backdoor
24925 method for using your system as a relay, because the incoming addresses appear
24926 to be local. If the bang path addresses are received via SMTP, it is safer to
24927 use the &"S"& flag to rewrite them as they are received, so that relay checking
24928 can be done on the rewritten addresses.
24929 .ecindex IIDaddrew
24930
24931
24932
24933
24934
24935 . ////////////////////////////////////////////////////////////////////////////
24936 . ////////////////////////////////////////////////////////////////////////////
24937
24938 .chapter "Retry configuration" "CHAPretry"
24939 .scindex IIDretconf1 "retry" "configuration, description of"
24940 .scindex IIDregconf2 "configuration file" "retry section"
24941 The &"retry"& section of the runtime configuration file contains a list of
24942 retry rules that control how often Exim tries to deliver messages that cannot
24943 be delivered at the first attempt. If there are no retry rules (the section is
24944 empty or not present), there are no retries. In this situation, temporary
24945 errors are treated as permanent. The default configuration contains a single,
24946 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24947 line option can be used to test which retry rule will be used for a given
24948 address, domain and error.
24949
24950 The most common cause of retries is temporary failure to deliver to a remote
24951 host because the host is down, or inaccessible because of a network problem.
24952 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24953 address) basis, not on a per-message basis. Thus, if one message has recently
24954 been delayed, delivery of a new message to the same host is not immediately
24955 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24956 log selector is set, the message
24957 .cindex "retry" "time not reached"
24958 &"retry time not reached"& is written to the main log whenever a delivery is
24959 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24960 the handling of errors during remote deliveries.
24961
24962 Retry processing applies to routing as well as to delivering, except as covered
24963 in the next paragraph. The retry rules do not distinguish between these
24964 actions. It is not possible, for example, to specify different behaviour for
24965 failures to route the domain &'snark.fict.example'& and failures to deliver to
24966 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24967 added complication, so did not implement it. However, although they share the
24968 same retry rule, the actual retry times for routing and transporting a given
24969 domain are maintained independently.
24970
24971 When a delivery is not part of a queue run (typically an immediate delivery on
24972 receipt of a message), the routers are always run, and local deliveries are
24973 always attempted, even if retry times are set for them. This makes for better
24974 behaviour if one particular message is causing problems (for example, causing
24975 quota overflow, or provoking an error in a filter file). If such a delivery
24976 suffers a temporary failure, the retry data is updated as normal, and
24977 subsequent delivery attempts from queue runs occur only when the retry time for
24978 the local address is reached.
24979
24980 .section "Changing retry rules" "SECID157"
24981 If you change the retry rules in your configuration, you should consider
24982 whether or not to delete the retry data that is stored in Exim's spool area in
24983 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24984 always safe; that is why they are called &"hints"&.
24985
24986 The hints retry data contains suggested retry times based on the previous
24987 rules. In the case of a long-running problem with a remote host, it might
24988 record the fact that the host has timed out. If your new rules increase the
24989 timeout time for such a host, you should definitely remove the old retry data
24990 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24991 messages that it should now be retaining.
24992
24993
24994
24995 .section "Format of retry rules" "SECID158"
24996 .cindex "retry" "rules"
24997 Each retry rule occupies one line and consists of three or four parts,
24998 separated by white space: a pattern, an error name, an optional list of sender
24999 addresses, and a list of retry parameters. The pattern and sender lists must be
25000 enclosed in double quotes if they contain white space. The rules are searched
25001 in order until one is found where the pattern, error name, and sender list (if
25002 present) match the failing host or address, the error that occurred, and the
25003 message's sender, respectively.
25004
25005
25006 The pattern is any single item that may appear in an address list (see section
25007 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25008 which means that it is expanded before being tested against the address that
25009 has been delayed. A negated address list item is permitted. Address
25010 list processing treats a plain domain name as if it were preceded by &"*@"&,
25011 which makes it possible for many retry rules to start with just a domain. For
25012 example,
25013 .code
25014 lookingglass.fict.example        *  F,24h,30m;
25015 .endd
25016 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25017 whereas
25018 .code
25019 alice@lookingglass.fict.example  *  F,24h,30m;
25020 .endd
25021 applies only to temporary failures involving the local part &%alice%&.
25022 In practice, almost all rules start with a domain name pattern without a local
25023 part.
25024
25025 .cindex "regular expressions" "in retry rules"
25026 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25027 must match a complete address, not just a domain, because that is how regular
25028 expressions work in address lists.
25029 .display
25030 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25031 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25032 .endd
25033
25034
25035 .section "Choosing which retry rule to use for address errors" "SECID159"
25036 When Exim is looking for a retry rule after a routing attempt has failed (for
25037 example, after a DNS timeout), each line in the retry configuration is tested
25038 against the complete address only if &%retry_use_local_part%& is set for the
25039 router. Otherwise, only the domain is used, except when matching against a
25040 regular expression, when the local part of the address is replaced with &"*"&.
25041 A domain on its own can match a domain pattern, or a pattern that starts with
25042 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25043 &%check_local_user%& is true, and false for other routers.
25044
25045 Similarly, when Exim is looking for a retry rule after a local delivery has
25046 failed (for example, after a mailbox full error), each line in the retry
25047 configuration is tested against the complete address only if
25048 &%retry_use_local_part%& is set for the transport (it defaults true for all
25049 local transports).
25050
25051 .cindex "4&'xx'& responses" "retry rules for"
25052 However, when Exim is looking for a retry rule after a remote delivery attempt
25053 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25054 whole address is always used as the key when searching the retry rules. The
25055 rule that is found is used to create a retry time for the combination of the
25056 failing address and the message's sender. It is the combination of sender and
25057 recipient that is delayed in subsequent queue runs until its retry time is
25058 reached. You can delay the recipient without regard to the sender by setting
25059 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25060 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25061 commands.
25062
25063
25064
25065 .section "Choosing which retry rule to use for host and message errors" &&&
25066          "SECID160"
25067 For a temporary error that is not related to an individual address (for
25068 example, a connection timeout), each line in the retry configuration is checked
25069 twice. First, the name of the remote host is used as a domain name (preceded by
25070 &"*@"& when matching a regular expression). If this does not match the line,
25071 the domain from the email address is tried in a similar fashion. For example,
25072 suppose the MX records for &'a.b.c.example'& are
25073 .code
25074 a.b.c.example  MX  5  x.y.z.example
25075                MX  6  p.q.r.example
25076                MX  7  m.n.o.example
25077 .endd
25078 and the retry rules are
25079 .code
25080 p.q.r.example    *      F,24h,30m;
25081 a.b.c.example    *      F,4d,45m;
25082 .endd
25083 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25084 first rule matches neither the host nor the domain, so Exim looks at the second
25085 rule. This does not match the host, but it does match the domain, so it is used
25086 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25087 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25088 first retry rule is used, because it matches the host.
25089
25090 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25091 first rule to determine retry times, but for all the other hosts for the domain
25092 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25093 routing to &'a.b.c.example'& suffers a temporary failure.
25094
25095 &*Note*&: The host name is used when matching the patterns, not its IP address.
25096 However, if a message is routed directly to an IP address without the use of a
25097 host name, for example, if a &(manualroute)& router contains a setting such as:
25098 .code
25099 route_list = *.a.example  192.168.34.23
25100 .endd
25101 then the &"host name"& that is used when searching for a retry rule is the
25102 textual form of the IP address.
25103
25104 .section "Retry rules for specific errors" "SECID161"
25105 .cindex "retry" "specific errors; specifying"
25106 The second field in a retry rule is the name of a particular error, or an
25107 asterisk, which matches any error. The errors that can be tested for are:
25108
25109 .vlist
25110 .vitem &%auth_failed%&
25111 Authentication failed when trying to send to a host in the
25112 &%hosts_require_auth%& list in an &(smtp)& transport.
25113
25114 .vitem &%data_4xx%&
25115 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25116 after the command, or after sending the message's data.
25117
25118 .vitem &%mail_4xx%&
25119 A 4&'xx'& error was received for an outgoing MAIL command.
25120
25121 .vitem &%rcpt_4xx%&
25122 A 4&'xx'& error was received for an outgoing RCPT command.
25123 .endlist
25124
25125 For the three 4&'xx'& errors, either the first or both of the x's can be given
25126 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25127 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25128 and have retries every ten minutes with a one-hour timeout, you could set up a
25129 retry rule of this form:
25130 .code
25131 the.domain.name  rcpt_452   F,1h,10m
25132 .endd
25133 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25134 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25135
25136 .vlist
25137 .vitem &%lost_connection%&
25138 A server unexpectedly closed the SMTP connection. There may, of course,
25139 legitimate reasons for this (host died, network died), but if it repeats a lot
25140 for the same host, it indicates something odd.
25141
25142 .vitem &%lookup%&
25143 A DNS lookup for a host failed.
25144 Note that a &%dnslookup%& router will need to have matched
25145 its &%fail_defer_domains%& option for this retry type to be usable.
25146 Also note that a &%manualroute%& router will probably need
25147 its &%host_find_failed%& option set to &%defer%&.
25148
25149 .vitem &%refused_MX%&
25150 A connection to a host obtained from an MX record was refused.
25151
25152 .vitem &%refused_A%&
25153 A connection to a host not obtained from an MX record was refused.
25154
25155 .vitem &%refused%&
25156 A connection was refused.
25157
25158 .vitem &%timeout_connect_MX%&
25159 A connection attempt to a host obtained from an MX record timed out.
25160
25161 .vitem &%timeout_connect_A%&
25162 A connection attempt to a host not obtained from an MX record timed out.
25163
25164 .vitem &%timeout_connect%&
25165 A connection attempt timed out.
25166
25167 .vitem &%timeout_MX%&
25168 There was a timeout while connecting or during an SMTP session with a host
25169 obtained from an MX record.
25170
25171 .vitem &%timeout_A%&
25172 There was a timeout while connecting or during an SMTP session with a host not
25173 obtained from an MX record.
25174
25175 .vitem &%timeout%&
25176 There was a timeout while connecting or during an SMTP session.
25177
25178 .vitem &%tls_required%&
25179 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25180 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25181 to STARTTLS, or there was a problem setting up the TLS connection.
25182
25183 .vitem &%quota%&
25184 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25185 transport.
25186
25187 .vitem &%quota_%&<&'time'&>
25188 .cindex "quota" "error testing in retry rule"
25189 .cindex "retry" "quota error testing"
25190 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25191 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25192 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25193 for four days.
25194 .endlist
25195
25196 .cindex "mailbox" "time of last read"
25197 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25198 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25199 it should be based on the last time that the user accessed the mailbox.
25200 However, it is not always possible to determine this. Exim uses the following
25201 heuristic rules:
25202
25203 .ilist
25204 If the mailbox is a single file, the time of last access (the &"atime"&) is
25205 used. As no new messages are being delivered (because the mailbox is over
25206 quota), Exim does not access the file, so this is the time of last user access.
25207 .next
25208 .cindex "maildir format" "time of last read"
25209 For a maildir delivery, the time of last modification of the &_new_&
25210 subdirectory is used. As the mailbox is over quota, no new files are created in
25211 the &_new_& subdirectory, because no new messages are being delivered. Any
25212 change to the &_new_& subdirectory is therefore assumed to be the result of an
25213 MUA moving a new message to the &_cur_& directory when it is first read. The
25214 time that is used is therefore the last time that the user read a new message.
25215 .next
25216 For other kinds of multi-file mailbox, the time of last access cannot be
25217 obtained, so a retry rule that uses this type of error field is never matched.
25218 .endlist
25219
25220 The quota errors apply both to system-enforced quotas and to Exim's own quota
25221 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25222 when a local delivery is deferred because a partition is full (the ENOSPC
25223 error).
25224
25225
25226
25227 .section "Retry rules for specified senders" "SECID162"
25228 .cindex "retry" "rules; sender-specific"
25229 You can specify retry rules that apply only when the failing message has a
25230 specific sender. In particular, this can be used to define retry rules that
25231 apply only to bounce messages. The third item in a retry rule can be of this
25232 form:
25233 .display
25234 &`senders=`&<&'address list'&>
25235 .endd
25236 The retry timings themselves are then the fourth item. For example:
25237 .code
25238 *   rcpt_4xx   senders=:   F,1h,30m
25239 .endd
25240 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25241 host. If the address list contains white space, it must be enclosed in quotes.
25242 For example:
25243 .code
25244 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25245 .endd
25246 &*Warning*&: This facility can be unhelpful if it is used for host errors
25247 (which do not depend on the recipient). The reason is that the sender is used
25248 only to match the retry rule. Once the rule has been found for a host error,
25249 its contents are used to set a retry time for the host, and this will apply to
25250 all messages, not just those with specific senders.
25251
25252 When testing retry rules using &%-brt%&, you can supply a sender using the
25253 &%-f%& command line option, like this:
25254 .code
25255 exim -f "" -brt user@dom.ain
25256 .endd
25257 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25258 list is never matched.
25259
25260
25261
25262
25263
25264 .section "Retry parameters" "SECID163"
25265 .cindex "retry" "parameters in rules"
25266 The third (or fourth, if a senders list is present) field in a retry rule is a
25267 sequence of retry parameter sets, separated by semicolons. Each set consists of
25268 .display
25269 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25270 .endd
25271 The letter identifies the algorithm for computing a new retry time; the cutoff
25272 time is the time beyond which this algorithm no longer applies, and the
25273 arguments vary the algorithm's action. The cutoff time is measured from the
25274 time that the first failure for the domain (combined with the local part if
25275 relevant) was detected, not from the time the message was received.
25276
25277 .cindex "retry" "algorithms"
25278 .cindex "retry" "fixed intervals"
25279 .cindex "retry" "increasing intervals"
25280 .cindex "retry" "random intervals"
25281 The available algorithms are:
25282
25283 .ilist
25284 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25285 the interval.
25286 .next
25287 &'G'&: retry at geometrically increasing intervals. The first argument
25288 specifies a starting value for the interval, and the second a multiplier, which
25289 is used to increase the size of the interval at each retry.
25290 .next
25291 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25292 retry, the previous interval is multiplied by the factor in order to get a
25293 maximum for the next interval. The minimum interval is the first argument of
25294 the parameter, and an actual interval is chosen randomly between them. Such a
25295 rule has been found to be helpful in cluster configurations when all the
25296 members of the cluster restart at once, and may therefore synchronize their
25297 queue processing times.
25298 .endlist
25299
25300 When computing the next retry time, the algorithm definitions are scanned in
25301 order until one whose cutoff time has not yet passed is reached. This is then
25302 used to compute a new retry time that is later than the current time. In the
25303 case of fixed interval retries, this simply means adding the interval to the
25304 current time. For geometrically increasing intervals, retry intervals are
25305 computed from the rule's parameters until one that is greater than the previous
25306 interval is found. The main configuration variable
25307 .cindex "limit" "retry interval"
25308 .cindex "retry" "interval, maximum"
25309 .oindex "&%retry_interval_max%&"
25310 &%retry_interval_max%& limits the maximum interval between retries. It
25311 cannot be set greater than &`24h`&, which is its default value.
25312
25313 A single remote domain may have a number of hosts associated with it, and each
25314 host may have more than one IP address. Retry algorithms are selected on the
25315 basis of the domain name, but are applied to each IP address independently. If,
25316 for example, a host has two IP addresses and one is unusable, Exim will
25317 generate retry times for it and will not try to use it until its next retry
25318 time comes. Thus the good IP address is likely to be tried first most of the
25319 time.
25320
25321 .cindex "hints database" "use for retrying"
25322 Retry times are hints rather than promises. Exim does not make any attempt to
25323 run deliveries exactly at the computed times. Instead, a queue runner process
25324 starts delivery processes for delayed messages periodically, and these attempt
25325 new deliveries only for those addresses that have passed their next retry time.
25326 If a new message arrives for a deferred address, an immediate delivery attempt
25327 occurs only if the address has passed its retry time. In the absence of new
25328 messages, the minimum time between retries is the interval between queue runner
25329 processes. There is not much point in setting retry times of five minutes if
25330 your queue runners happen only once an hour, unless there are a significant
25331 number of incoming messages (which might be the case on a system that is
25332 sending everything to a smart host, for example).
25333
25334 The data in the retry hints database can be inspected by using the
25335 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25336 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25337 &'exinext'& utility script can be used to find out what the next retry times
25338 are for the hosts associated with a particular mail domain, and also for local
25339 deliveries that have been deferred.
25340
25341
25342 .section "Retry rule examples" "SECID164"
25343 Here are some example retry rules:
25344 .code
25345 alice@wonderland.fict.example quota_5d  F,7d,3h
25346 wonderland.fict.example       quota_5d
25347 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25348 lookingglass.fict.example     *         F,24h,30m;
25349 *                 refused_A   F,2h,20m;
25350 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25351 .endd
25352 The first rule sets up special handling for mail to
25353 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25354 mailbox has not been read for at least 5 days. Retries continue every three
25355 hours for 7 days. The second rule handles over-quota errors for all other local
25356 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25357 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25358 fail are bounced immediately if the mailbox has not been read for at least 5
25359 days.
25360
25361 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25362 happen every 15 minutes for an hour, then with geometrically increasing
25363 intervals until two days have passed since a delivery first failed. After the
25364 first hour there is a delay of one hour, then two hours, then four hours, and
25365 so on (this is a rather extreme example).
25366
25367 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25368 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25369 all other domains, with special action for connection refusal from hosts that
25370 were not obtained from an MX record.
25371
25372 The final rule in a retry configuration should always have asterisks in the
25373 first two fields so as to provide a general catch-all for any addresses that do
25374 not have their own special handling. This example tries every 15 minutes for 2
25375 hours, then with intervals starting at one hour and increasing by a factor of
25376 1.5 up to 16 hours, then every 8 hours up to 5 days.
25377
25378
25379
25380 .section "Timeout of retry data" "SECID165"
25381 .cindex "timeout" "of retry data"
25382 .oindex "&%retry_data_expire%&"
25383 .cindex "hints database" "data expiry"
25384 .cindex "retry" "timeout of data"
25385 Exim timestamps the data that it writes to its retry hints database. When it
25386 consults the data during a delivery it ignores any that is older than the value
25387 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25388 been tried for 7 days, Exim will try to deliver to it immediately a message
25389 arrives, and if that fails, it will calculate a retry time as if it were
25390 failing for the first time.
25391
25392 This improves the behaviour for messages routed to rarely-used hosts such as MX
25393 backups. If such a host was down at one time, and happens to be down again when
25394 Exim tries a month later, using the old retry data would imply that it had been
25395 down all the time, which is not a justified assumption.
25396
25397 If a host really is permanently dead, this behaviour causes a burst of retries
25398 every now and again, but only if messages routed to it are rare. If there is a
25399 message at least once every 7 days the retry data never expires.
25400
25401
25402
25403
25404 .section "Long-term failures" "SECID166"
25405 .cindex "delivery failure, long-term"
25406 .cindex "retry" "after long-term failure"
25407 Special processing happens when an email address has been failing for so long
25408 that the cutoff time for the last algorithm is reached. For example, using the
25409 default retry rule:
25410 .code
25411 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25412 .endd
25413 the cutoff time is four days. Reaching the retry cutoff is independent of how
25414 long any specific message has been failing; it is the length of continuous
25415 failure for the recipient address that counts.
25416
25417 When the cutoff time is reached for a local delivery, or for all the IP
25418 addresses associated with a remote delivery, a subsequent delivery failure
25419 causes Exim to give up on the address, and a bounce message is generated.
25420 In order to cater for new messages that use the failing address, a next retry
25421 time is still computed from the final algorithm, and is used as follows:
25422
25423 For local deliveries, one delivery attempt is always made for any subsequent
25424 messages. If this delivery fails, the address fails immediately. The
25425 post-cutoff retry time is not used.
25426
25427 If the delivery is remote, there are two possibilities, controlled by the
25428 .oindex "&%delay_after_cutoff%&"
25429 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25430 default. Until the post-cutoff retry time for one of the IP addresses is
25431 reached, the failing email address is bounced immediately, without a delivery
25432 attempt taking place. After that time, one new delivery attempt is made to
25433 those IP addresses that are past their retry times, and if that still fails,
25434 the address is bounced and new retry times are computed.
25435
25436 In other words, when all the hosts for a given email address have been failing
25437 for a long time, Exim bounces rather then defers until one of the hosts' retry
25438 times is reached. Then it tries once, and bounces if that attempt fails. This
25439 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25440 to a broken destination, but if the host does recover, Exim will eventually
25441 notice.
25442
25443 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25444 addresses are past their final cutoff time, Exim tries to deliver to those IP
25445 addresses that have not been tried since the message arrived. If there are
25446 no suitable IP addresses, or if they all fail, the address is bounced. In other
25447 words, it does not delay when a new message arrives, but tries the expired
25448 addresses immediately, unless they have been tried since the message arrived.
25449 If there is a continuous stream of messages for the failing domains, setting
25450 &%delay_after_cutoff%& false means that there will be many more attempts to
25451 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25452 true.
25453
25454 .section "Deliveries that work intermittently" "SECID167"
25455 .cindex "retry" "intermittently working deliveries"
25456 Some additional logic is needed to cope with cases where a host is
25457 intermittently available, or when a message has some attribute that prevents
25458 its delivery when others to the same address get through. In this situation,
25459 because some messages are successfully delivered, the &"retry clock"& for the
25460 host or address keeps getting reset by the successful deliveries, and so
25461 failing messages remain on the queue for ever because the cutoff time is never
25462 reached.
25463
25464 Two exceptional actions are applied to prevent this happening. The first
25465 applies to errors that are related to a message rather than a remote host.
25466 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25467 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25468 commands, and quota failures. For this type of error, if a message's arrival
25469 time is earlier than the &"first failed"& time for the error, the earlier time
25470 is used when scanning the retry rules to decide when to try next and when to
25471 time out the address.
25472
25473 The exceptional second action applies in all cases. If a message has been on
25474 the queue for longer than the cutoff time of any applicable retry rule for a
25475 given address, a delivery is attempted for that address, even if it is not yet
25476 time, and if this delivery fails, the address is timed out. A new retry time is
25477 not computed in this case, so that other messages for the same address are
25478 considered immediately.
25479 .ecindex IIDretconf1
25480 .ecindex IIDregconf2
25481
25482
25483
25484
25485
25486
25487 . ////////////////////////////////////////////////////////////////////////////
25488 . ////////////////////////////////////////////////////////////////////////////
25489
25490 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25491 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25492 .scindex IIDauthconf2 "authentication"
25493 The &"authenticators"& section of Exim's run time configuration is concerned
25494 with SMTP authentication. This facility is an extension to the SMTP protocol,
25495 described in RFC 2554, which allows a client SMTP host to authenticate itself
25496 to a server. This is a common way for a server to recognize clients that are
25497 permitted to use it as a relay. SMTP authentication is not of relevance to the
25498 transfer of mail between servers that have no managerial connection with each
25499 other.
25500
25501 .cindex "AUTH" "description of"
25502 Very briefly, the way SMTP authentication works is as follows:
25503
25504 .ilist
25505 The server advertises a number of authentication &'mechanisms'& in response to
25506 the client's EHLO command.
25507 .next
25508 The client issues an AUTH command, naming a specific mechanism. The command
25509 may, optionally, contain some authentication data.
25510 .next
25511 The server may issue one or more &'challenges'&, to which the client must send
25512 appropriate responses. In simple authentication mechanisms, the challenges are
25513 just prompts for user names and passwords. The server does not have to issue
25514 any challenges &-- in some mechanisms the relevant data may all be transmitted
25515 with the AUTH command.
25516 .next
25517 The server either accepts or denies authentication.
25518 .next
25519 If authentication succeeds, the client may optionally make use of the AUTH
25520 option on the MAIL command to pass an authenticated sender in subsequent
25521 mail transactions. Authentication lasts for the remainder of the SMTP
25522 connection.
25523 .next
25524 If authentication fails, the client may give up, or it may try a different
25525 authentication mechanism, or it may try transferring mail over the
25526 unauthenticated connection.
25527 .endlist
25528
25529 If you are setting up a client, and want to know which authentication
25530 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25531 SMTP port) on the server, and issue an EHLO command. The response to this
25532 includes the list of supported mechanisms. For example:
25533 .display
25534 &`$ `&&*&`telnet server.example 25`&*&
25535 &`Trying 192.168.34.25...`&
25536 &`Connected to server.example.`&
25537 &`Escape character is &#x0027;^]&#x0027;.`&
25538 &`220 server.example ESMTP Exim 4.20 ...`&
25539 &*&`ehlo client.example`&*&
25540 &`250-server.example Hello client.example [10.8.4.5]`&
25541 &`250-SIZE 52428800`&
25542 &`250-PIPELINING`&
25543 &`250-AUTH PLAIN`&
25544 &`250 HELP`&
25545 .endd
25546 The second-last line of this example output shows that the server supports
25547 authentication using the PLAIN mechanism. In Exim, the different authentication
25548 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25549 routers and transports, which authenticators are included in the binary is
25550 controlled by build-time definitions. The following are currently available,
25551 included by setting
25552 .code
25553 AUTH_CRAM_MD5=yes
25554 AUTH_CYRUS_SASL=yes
25555 AUTH_DOVECOT=yes
25556 AUTH_GSASL=yes
25557 AUTH_HEIMDAL_GSSAPI=yes
25558 AUTH_PLAINTEXT=yes
25559 AUTH_SPA=yes
25560 AUTH_TLS=yes
25561 .endd
25562 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25563 authentication mechanism (RFC 2195), and the second provides an interface to
25564 the Cyrus SASL authentication library.
25565 The third is an interface to Dovecot's authentication system, delegating the
25566 work via a socket interface.
25567 The fourth provides an interface to the GNU SASL authentication library, which
25568 provides mechanisms but typically not data sources.
25569 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25570 supporting setting a server keytab.
25571 The sixth can be configured to support
25572 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25573 not formally documented, but used by several MUAs. The seventh authenticator
25574 supports Microsoft's &'Secure Password Authentication'& mechanism.
25575 The eighth is an Exim authenticator but not an SMTP one;
25576 instead it can use information from a TLS negotiation.
25577
25578 The authenticators are configured using the same syntax as other drivers (see
25579 section &<<SECTfordricon>>&). If no authenticators are required, no
25580 authentication section need be present in the configuration file. Each
25581 authenticator can in principle have both server and client functions. When Exim
25582 is receiving SMTP mail, it is acting as a server; when it is sending out
25583 messages over SMTP, it is acting as a client. Authenticator configuration
25584 options are provided for use in both these circumstances.
25585
25586 To make it clear which options apply to which situation, the prefixes
25587 &%server_%& and &%client_%& are used on option names that are specific to
25588 either the server or the client function, respectively. Server and client
25589 functions are disabled if none of their options are set. If an authenticator is
25590 to be used for both server and client functions, a single definition, using
25591 both sets of options, is required. For example:
25592 .code
25593 cram:
25594   driver = cram_md5
25595   public_name = CRAM-MD5
25596   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25597   client_name = ph10
25598   client_secret = secret2
25599 .endd
25600 The &%server_%& option is used when Exim is acting as a server, and the
25601 &%client_%& options when it is acting as a client.
25602
25603 Descriptions of the individual authenticators are given in subsequent chapters.
25604 The remainder of this chapter covers the generic options for the
25605 authenticators, followed by general discussion of the way authentication works
25606 in Exim.
25607
25608 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25609 per-mechanism basis.  Please read carefully to determine which variables hold
25610 account labels such as usercodes and which hold passwords or other
25611 authenticating data.
25612
25613 Note that some mechanisms support two different identifiers for accounts: the
25614 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25615 and &'authz'& are commonly encountered.  The American spelling is standard here.
25616 Conceptually, authentication data such as passwords are tied to the identifier
25617 used to authenticate; servers may have rules to permit one user to act as a
25618 second user, so that after login the session is treated as though that second
25619 user had logged in.  That second user is the &'authorization id'&.  A robust
25620 configuration might confirm that the &'authz'& field is empty or matches the
25621 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25622 as verified data, the &'authz'& as an unverified request which the server might
25623 choose to honour.
25624
25625 A &'realm'& is a text string, typically a domain name, presented by a server
25626 to a client to help it select an account and credentials to use.  In some
25627 mechanisms, the client and server provably agree on the realm, but clients
25628 typically can not treat the realm as secure data to be blindly trusted.
25629
25630
25631
25632 .section "Generic options for authenticators" "SECID168"
25633 .cindex "authentication" "generic options"
25634 .cindex "options" "generic; for authenticators"
25635
25636 .option client_condition authenticators string&!! unset
25637 When Exim is authenticating as a client, it skips any authenticator whose
25638 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25639 used, for example, to skip plain text authenticators when the connection is not
25640 encrypted by a setting such as:
25641 .code
25642 client_condition = ${if !eq{$tls_out_cipher}{}}
25643 .endd
25644
25645
25646 .option client_set_id authenticators string&!! unset
25647 When client authentication succeeds, this condition is expanded; the
25648 result is used in the log lines for outbound messages.
25649 Typically it will be the user name used for authentication.
25650
25651
25652 .option driver authenticators string unset
25653 This option must always be set. It specifies which of the available
25654 authenticators is to be used.
25655
25656
25657 .option public_name authenticators string unset
25658 This option specifies the name of the authentication mechanism that the driver
25659 implements, and by which it is known to the outside world. These names should
25660 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25661 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25662 defaults to the driver's instance name.
25663
25664
25665 .option server_advertise_condition authenticators string&!! unset
25666 When a server is about to advertise an authentication mechanism, the condition
25667 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25668 mechanism is not advertised.
25669 If the expansion fails, the mechanism is not advertised. If the failure was not
25670 forced, and was not caused by a lookup defer, the incident is logged.
25671 See section &<<SECTauthexiser>>& below for further discussion.
25672
25673
25674 .option server_condition authenticators string&!! unset
25675 This option must be set for a &%plaintext%& server authenticator, where it
25676 is used directly to control authentication. See section &<<SECTplainserver>>&
25677 for details.
25678
25679 For the &(gsasl)& authenticator, this option is required for various
25680 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25681
25682 For the other authenticators, &%server_condition%& can be used as an additional
25683 authentication or authorization mechanism that is applied after the other
25684 authenticator conditions succeed. If it is set, it is expanded when the
25685 authenticator would otherwise return a success code. If the expansion is forced
25686 to fail, authentication fails. Any other expansion failure causes a temporary
25687 error code to be returned. If the result of a successful expansion is an empty
25688 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25689 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25690 other result, a temporary error code is returned, with the expanded string as
25691 the error text.
25692
25693
25694 .option server_debug_print authenticators string&!! unset
25695 If this option is set and authentication debugging is enabled (see the &%-d%&
25696 command line option), the string is expanded and included in the debugging
25697 output when the authenticator is run as a server. This can help with checking
25698 out the values of variables.
25699 If expansion of the string fails, the error message is written to the debugging
25700 output, and Exim carries on processing.
25701
25702
25703 .option server_set_id authenticators string&!! unset
25704 .vindex "&$authenticated_id$&"
25705 When an Exim server successfully authenticates a client, this string is
25706 expanded using data from the authentication, and preserved for any incoming
25707 messages in the variable &$authenticated_id$&. It is also included in the log
25708 lines for incoming messages. For example, a user/password authenticator
25709 configuration might preserve the user name that was used to authenticate, and
25710 refer to it subsequently during delivery of the message.
25711 If expansion fails, the option is ignored.
25712
25713
25714 .option server_mail_auth_condition authenticators string&!! unset
25715 This option allows a server to discard authenticated sender addresses supplied
25716 as part of MAIL commands in SMTP connections that are authenticated by the
25717 driver on which &%server_mail_auth_condition%& is set. The option is not used
25718 as part of the authentication process; instead its (unexpanded) value is
25719 remembered for later use.
25720 How it is used is described in the following section.
25721
25722
25723
25724
25725
25726 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25727 .cindex "authentication" "sender; authenticated"
25728 .cindex "AUTH" "on MAIL command"
25729 When a client supplied an AUTH= item on a MAIL command, Exim applies
25730 the following checks before accepting it as the authenticated sender of the
25731 message:
25732
25733 .ilist
25734 If the connection is not using extended SMTP (that is, HELO was used rather
25735 than EHLO), the use of AUTH= is a syntax error.
25736 .next
25737 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25738 .next
25739 .vindex "&$authenticated_sender$&"
25740 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25741 running, the value of &$authenticated_sender$& is set to the value obtained
25742 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25743 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25744 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25745 given for the MAIL command.
25746 .next
25747 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25748 is accepted and placed in &$authenticated_sender$& only if the client has
25749 authenticated.
25750 .next
25751 If the AUTH= value was accepted by either of the two previous rules, and
25752 the client has authenticated, and the authenticator has a setting for the
25753 &%server_mail_auth_condition%&, the condition is checked at this point. The
25754 valued that was saved from the authenticator is expanded. If the expansion
25755 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25756 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25757 the value of &$authenticated_sender$& is retained and passed on with the
25758 message.
25759 .endlist
25760
25761
25762 When &$authenticated_sender$& is set for a message, it is passed on to other
25763 hosts to which Exim authenticates as a client. Do not confuse this value with
25764 &$authenticated_id$&, which is a string obtained from the authentication
25765 process, and which is not usually a complete email address.
25766
25767 .vindex "&$sender_address$&"
25768 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25769 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25770 therefore make use of &$authenticated_sender$&. The converse is not true: the
25771 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25772 ACL is run.
25773
25774
25775
25776 .section "Authentication on an Exim server" "SECTauthexiser"
25777 .cindex "authentication" "on an Exim server"
25778 When Exim receives an EHLO command, it advertises the public names of those
25779 authenticators that are configured as servers, subject to the following
25780 conditions:
25781
25782 .ilist
25783 The client host must match &%auth_advertise_hosts%& (default *).
25784 .next
25785 It the &%server_advertise_condition%& option is set, its expansion must not
25786 yield the empty string, &"0"&, &"no"&, or &"false"&.
25787 .endlist
25788
25789 The order in which the authenticators are defined controls the order in which
25790 the mechanisms are advertised.
25791
25792 Some mail clients (for example, some versions of Netscape) require the user to
25793 provide a name and password for authentication whenever AUTH is advertised,
25794 even though authentication may not in fact be needed (for example, Exim may be
25795 set up to allow unconditional relaying from the client by an IP address check).
25796 You can make such clients more friendly by not advertising AUTH to them.
25797 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25798 that runs for RCPT) to relay without authentication, you should set
25799 .code
25800 auth_advertise_hosts = ! 10.9.8.0/24
25801 .endd
25802 so that no authentication mechanisms are advertised to them.
25803
25804 The &%server_advertise_condition%& controls the advertisement of individual
25805 authentication mechanisms. For example, it can be used to restrict the
25806 advertisement of a particular mechanism to encrypted connections, by a setting
25807 such as:
25808 .code
25809 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25810 .endd
25811 .vindex "&$tls_in_cipher$&"
25812 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25813 yields &"yes"&, which allows the advertisement to happen.
25814
25815 When an Exim server receives an AUTH command from a client, it rejects it
25816 immediately if AUTH was not advertised in response to an earlier EHLO
25817 command. This is the case if
25818
25819 .ilist
25820 The client host does not match &%auth_advertise_hosts%&; or
25821 .next
25822 No authenticators are configured with server options; or
25823 .next
25824 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25825 server authenticators.
25826 .endlist
25827
25828
25829 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25830 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25831 AUTH is accepted from any client host.
25832
25833 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25834 server authentication mechanism that was advertised in response to EHLO and
25835 that matches the one named in the AUTH command. If it finds one, it runs
25836 the appropriate authentication protocol, and authentication either succeeds or
25837 fails. If there is no matching advertised mechanism, the AUTH command is
25838 rejected with a 504 error.
25839
25840 .vindex "&$received_protocol$&"
25841 .vindex "&$sender_host_authenticated$&"
25842 When a message is received from an authenticated host, the value of
25843 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25844 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25845 public name) of the authenticator driver that successfully authenticated the
25846 client from which the message was received. This variable is empty if there was
25847 no successful authentication.
25848
25849
25850
25851
25852 .section "Testing server authentication" "SECID169"
25853 .cindex "authentication" "testing a server"
25854 .cindex "AUTH" "testing a server"
25855 .cindex "base64 encoding" "creating authentication test data"
25856 Exim's &%-bh%& option can be useful for testing server authentication
25857 configurations. The data for the AUTH command has to be sent using base64
25858 encoding. A quick way to produce such data for testing is the following Perl
25859 script:
25860 .code
25861 use MIME::Base64;
25862 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25863 .endd
25864 .cindex "binary zero" "in authentication data"
25865 This interprets its argument as a Perl string, and then encodes it. The
25866 interpretation as a Perl string allows binary zeros, which are required for
25867 some kinds of authentication, to be included in the data. For example, a
25868 command line to run this script on such data might be
25869 .code
25870 encode '\0user\0password'
25871 .endd
25872 Note the use of single quotes to prevent the shell interpreting the
25873 backslashes, so that they can be interpreted by Perl to specify characters
25874 whose code value is zero.
25875
25876 &*Warning 1*&: If either of the user or password strings starts with an octal
25877 digit, you must use three zeros instead of one after the leading backslash. If
25878 you do not, the octal digit that starts your string will be incorrectly
25879 interpreted as part of the code for the first character.
25880
25881 &*Warning 2*&: If there are characters in the strings that Perl interprets
25882 specially, you must use a Perl escape to prevent them being misinterpreted. For
25883 example, a command such as
25884 .code
25885 encode '\0user@domain.com\0pas$$word'
25886 .endd
25887 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25888
25889 If you have the &%mimencode%& command installed, another way to do produce
25890 base64-encoded strings is to run the command
25891 .code
25892 echo -e -n `\0user\0password' | mimencode
25893 .endd
25894 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25895 in the argument, and the &%-n%& option specifies no newline at the end of its
25896 output. However, not all versions of &%echo%& recognize these options, so you
25897 should check your version before relying on this suggestion.
25898
25899
25900
25901 .section "Authentication by an Exim client" "SECID170"
25902 .cindex "authentication" "on an Exim client"
25903 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25904 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25905 announces support for authentication, and the host matches an entry in either
25906 of these options, Exim (as a client) tries to authenticate as follows:
25907
25908 .ilist
25909 For each authenticator that is configured as a client, in the order in which
25910 they are defined in the configuration, it searches the authentication
25911 mechanisms announced by the server for one whose name matches the public name
25912 of the authenticator.
25913 .next
25914 .vindex "&$host$&"
25915 .vindex "&$host_address$&"
25916 When it finds one that matches, it runs the authenticator's client code. The
25917 variables &$host$& and &$host_address$& are available for any string expansions
25918 that the client might do. They are set to the server's name and IP address. If
25919 any expansion is forced to fail, the authentication attempt is abandoned, and
25920 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25921 delivery to be deferred.
25922 .next
25923 If the result of the authentication attempt is a temporary error or a timeout,
25924 Exim abandons trying to send the message to the host for the moment. It will
25925 try again later. If there are any backup hosts available, they are tried in the
25926 usual way.
25927 .next
25928 If the response to authentication is a permanent error (5&'xx'& code), Exim
25929 carries on searching the list of authenticators and tries another one if
25930 possible. If all authentication attempts give permanent errors, or if there are
25931 no attempts because no mechanisms match (or option expansions force failure),
25932 what happens depends on whether the host matches &%hosts_require_auth%& or
25933 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25934 delivery is deferred. The error can be detected in the retry rules, and thereby
25935 turned into a permanent error if you wish. In the second case, Exim tries to
25936 deliver the message unauthenticated.
25937 .endlist
25938
25939 .new
25940 Note that the hostlist test for whether to do authentication can be
25941 confused if name-IP lookups change between the time the peer is decided
25942 on and the transport running.  For example, with a manualroute
25943 router given a host name, and DNS "round-robin" use by that name: if
25944 the local resolver cache times out between the router and the transport
25945 running, the transport may get an IP for the name for its authentication
25946 check which does not match the connection peer IP.
25947 No authentication will then be done, despite the names being identical.
25948
25949 For such cases use a separate transport which always authenticates.
25950 .wen
25951
25952 .cindex "AUTH" "on MAIL command"
25953 When Exim has authenticated itself to a remote server, it adds the AUTH
25954 parameter to the MAIL commands it sends, if it has an authenticated sender for
25955 the message. If the message came from a remote host, the authenticated sender
25956 is the one that was receiving on an incoming MAIL command, provided that the
25957 incoming connection was authenticated and the &%server_mail_auth%& condition
25958 allowed the authenticated sender to be retained. If a local process calls Exim
25959 to send a message, the sender address that is built from the login name and
25960 &%qualify_domain%& is treated as authenticated. However, if the
25961 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25962 the authenticated sender that was received with the message.
25963 .ecindex IIDauthconf1
25964 .ecindex IIDauthconf2
25965
25966
25967
25968
25969
25970
25971 . ////////////////////////////////////////////////////////////////////////////
25972 . ////////////////////////////////////////////////////////////////////////////
25973
25974 .chapter "The plaintext authenticator" "CHAPplaintext"
25975 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25976 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25977 The &(plaintext)& authenticator can be configured to support the PLAIN and
25978 LOGIN authentication mechanisms, both of which transfer authentication data as
25979 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25980 security risk; you are strongly advised to insist on the use of SMTP encryption
25981 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25982 use unencrypted plain text, you should not use the same passwords for SMTP
25983 connections as you do for login accounts.
25984
25985 .section "Plaintext options" "SECID171"
25986 .cindex "options" "&(plaintext)& authenticator (server)"
25987 When configured as a server, &(plaintext)& uses the following options:
25988
25989 .option server_condition authenticators string&!! unset
25990 This is actually a global authentication option, but it must be set in order to
25991 configure the &(plaintext)& driver as a server. Its use is described below.
25992
25993 .option server_prompts plaintext string&!! unset
25994 The contents of this option, after expansion, must be a colon-separated list of
25995 prompt strings. If expansion fails, a temporary authentication rejection is
25996 given.
25997
25998 .section "Using plaintext in a server" "SECTplainserver"
25999 .cindex "AUTH" "in &(plaintext)& authenticator"
26000 .cindex "binary zero" "in &(plaintext)& authenticator"
26001 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26002         "in &(plaintext)& authenticator"
26003 .vindex "&$auth1$&, &$auth2$&, etc"
26004 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26005
26006 When running as a server, &(plaintext)& performs the authentication test by
26007 expanding a string. The data sent by the client with the AUTH command, or in
26008 response to subsequent prompts, is base64 encoded, and so may contain any byte
26009 values when decoded. If any data is supplied with the command, it is treated as
26010 a list of strings, separated by NULs (binary zeros), the first three of which
26011 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26012 (neither LOGIN nor PLAIN uses more than three strings).
26013
26014 For compatibility with previous releases of Exim, the values are also placed in
26015 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26016 variables for this purpose is now deprecated, as it can lead to confusion in
26017 string expansions that also use them for other things.
26018
26019 If there are more strings in &%server_prompts%& than the number of strings
26020 supplied with the AUTH command, the remaining prompts are used to obtain more
26021 data. Each response from the client may be a list of NUL-separated strings.
26022
26023 .vindex "&$authenticated_id$&"
26024 Once a sufficient number of data strings have been received,
26025 &%server_condition%& is expanded. If the expansion is forced to fail,
26026 authentication fails. Any other expansion failure causes a temporary error code
26027 to be returned. If the result of a successful expansion is an empty string,
26028 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26029 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26030 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26031 For any other result, a temporary error code is returned, with the expanded
26032 string as the error text
26033
26034 &*Warning*&: If you use a lookup in the expansion to find the user's
26035 password, be sure to make the authentication fail if the user is unknown.
26036 There are good and bad examples at the end of the next section.
26037
26038
26039
26040 .section "The PLAIN authentication mechanism" "SECID172"
26041 .cindex "PLAIN authentication mechanism"
26042 .cindex "authentication" "PLAIN mechanism"
26043 .cindex "binary zero" "in &(plaintext)& authenticator"
26044 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26045 sent as one item of data (that is, one combined string containing two NUL
26046 separators). The data is sent either as part of the AUTH command, or
26047 subsequently in response to an empty prompt from the server.
26048
26049 The second and third strings are a user name and a corresponding password.
26050 Using a single fixed user name and password as an example, this could be
26051 configured as follows:
26052 .code
26053 fixed_plain:
26054   driver = plaintext
26055   public_name = PLAIN
26056   server_prompts = :
26057   server_condition = \
26058     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26059   server_set_id = $auth2
26060 .endd
26061 Note that the default result strings from &%if%& (&"true"& or an empty string)
26062 are exactly what we want here, so they need not be specified. Obviously, if the
26063 password contains expansion-significant characters such as dollar, backslash,
26064 or closing brace, they have to be escaped.
26065
26066 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26067 the end of a string list are ignored). If all the data comes as part of the
26068 AUTH command, as is commonly the case, the prompt is not used. This
26069 authenticator is advertised in the response to EHLO as
26070 .code
26071 250-AUTH PLAIN
26072 .endd
26073 and a client host can authenticate itself by sending the command
26074 .code
26075 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26076 .endd
26077 As this contains three strings (more than the number of prompts), no further
26078 data is required from the client. Alternatively, the client may just send
26079 .code
26080 AUTH PLAIN
26081 .endd
26082 to initiate authentication, in which case the server replies with an empty
26083 prompt. The client must respond with the combined data string.
26084
26085 The data string is base64 encoded, as required by the RFC. This example,
26086 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26087 represents a zero byte. This is split up into three strings, the first of which
26088 is empty. The &%server_condition%& option in the authenticator checks that the
26089 second two are &`username`& and &`mysecret`& respectively.
26090
26091 Having just one fixed user name and password, as in this example, is not very
26092 realistic, though for a small organization with only a handful of
26093 authenticating clients it could make sense.
26094
26095 A more sophisticated instance of this authenticator could use the user name in
26096 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26097 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26098 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26099 This is an incorrect example:
26100 .code
26101 server_condition = \
26102   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26103 .endd
26104 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26105 which it then compares to the supplied password (&$auth3$&). Why is this example
26106 incorrect? It works fine for existing users, but consider what happens if a
26107 non-existent user name is given. The lookup fails, but as no success/failure
26108 strings are given for the lookup, it yields an empty string. Thus, to defeat
26109 the authentication, all a client has to do is to supply a non-existent user
26110 name and an empty password. The correct way of writing this test is:
26111 .code
26112 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26113   {${if eq{$value}{$auth3}}} {false}}
26114 .endd
26115 In this case, if the lookup succeeds, the result is checked; if the lookup
26116 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26117 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26118 always fails if its second argument is empty. However, the second way of
26119 writing the test makes the logic clearer.
26120
26121
26122 .section "The LOGIN authentication mechanism" "SECID173"
26123 .cindex "LOGIN authentication mechanism"
26124 .cindex "authentication" "LOGIN mechanism"
26125 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26126 in a number of programs. No data is sent with the AUTH command. Instead, a
26127 user name and password are supplied separately, in response to prompts. The
26128 plaintext authenticator can be configured to support this as in this example:
26129 .code
26130 fixed_login:
26131   driver = plaintext
26132   public_name = LOGIN
26133   server_prompts = User Name : Password
26134   server_condition = \
26135     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26136   server_set_id = $auth1
26137 .endd
26138 Because of the way plaintext operates, this authenticator accepts data supplied
26139 with the AUTH command (in contravention of the specification of LOGIN), but
26140 if the client does not supply it (as is the case for LOGIN clients), the prompt
26141 strings are used to obtain two data items.
26142
26143 Some clients are very particular about the precise text of the prompts. For
26144 example, Outlook Express is reported to recognize only &"Username:"& and
26145 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26146 strings. It uses the &%ldapauth%& expansion condition to check the user
26147 name and password by binding to an LDAP server:
26148 .code
26149 login:
26150   driver = plaintext
26151   public_name = LOGIN
26152   server_prompts = Username:: : Password::
26153   server_condition = ${if and{{ \
26154     !eq{}{$auth1} }{ \
26155     ldapauth{\
26156       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26157       pass=${quote:$auth2} \
26158       ldap://ldap.example.org/} }} }
26159   server_set_id = uid=$auth1,ou=people,o=example.org
26160 .endd
26161 We have to check that the username is not empty before using it, because LDAP
26162 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26163 operator to correctly quote the DN for authentication. However, the basic
26164 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26165 correct one to use for the password, because quoting is needed only to make
26166 the password conform to the Exim syntax. At the LDAP level, the password is an
26167 uninterpreted string.
26168
26169
26170 .section "Support for different kinds of authentication" "SECID174"
26171 A number of string expansion features are provided for the purpose of
26172 interfacing to different ways of user authentication. These include checking
26173 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26174 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26175 &<<SECTexpcond>>&.
26176
26177
26178
26179
26180 .section "Using plaintext in a client" "SECID175"
26181 .cindex "options" "&(plaintext)& authenticator (client)"
26182 The &(plaintext)& authenticator has two client options:
26183
26184 .option client_ignore_invalid_base64 plaintext boolean false
26185 If the client receives a server prompt that is not a valid base64 string,
26186 authentication is abandoned by default. However, if this option is set true,
26187 the error in the challenge is ignored and the client sends the response as
26188 usual.
26189
26190 .option client_send plaintext string&!! unset
26191 The string is a colon-separated list of authentication data strings. Each
26192 string is independently expanded before being sent to the server. The first
26193 string is sent with the AUTH command; any more strings are sent in response
26194 to prompts from the server. Before each string is expanded, the value of the
26195 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26196 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26197 way. Thus, the prompt that is received in response to sending the first string
26198 (with the AUTH command) can be used in the expansion of the second string, and
26199 so on. If an invalid base64 string is received when
26200 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26201 &$auth$&<&'n'&> variable.
26202
26203 &*Note*&: You cannot use expansion to create multiple strings, because
26204 splitting takes priority and happens first.
26205
26206 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26207 the data, further processing is applied to each string before it is sent. If
26208 there are any single circumflex characters in the string, they are converted to
26209 NULs. Should an actual circumflex be required as data, it must be doubled in
26210 the string.
26211
26212 This is an example of a client configuration that implements the PLAIN
26213 authentication mechanism with a fixed user name and password:
26214 .code
26215 fixed_plain:
26216   driver = plaintext
26217   public_name = PLAIN
26218   client_send = ^username^mysecret
26219 .endd
26220 The lack of colons means that the entire text is sent with the AUTH
26221 command, with the circumflex characters converted to NULs. A similar example
26222 that uses the LOGIN mechanism is:
26223 .code
26224 fixed_login:
26225   driver = plaintext
26226   public_name = LOGIN
26227   client_send = : username : mysecret
26228 .endd
26229 The initial colon means that the first string is empty, so no data is sent with
26230 the AUTH command itself. The remaining strings are sent in response to
26231 prompts.
26232 .ecindex IIDplaiauth1
26233 .ecindex IIDplaiauth2
26234
26235
26236
26237
26238 . ////////////////////////////////////////////////////////////////////////////
26239 . ////////////////////////////////////////////////////////////////////////////
26240
26241 .chapter "The cram_md5 authenticator" "CHID9"
26242 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26243 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26244 .cindex "CRAM-MD5 authentication mechanism"
26245 .cindex "authentication" "CRAM-MD5 mechanism"
26246 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26247 sends a challenge string to the client, and the response consists of a user
26248 name and the CRAM-MD5 digest of the challenge string combined with a secret
26249 string (password) which is known to both server and client. Thus, the secret
26250 is not sent over the network as plain text, which makes this authenticator more
26251 secure than &(plaintext)&. However, the downside is that the secret has to be
26252 available in plain text at either end.
26253
26254
26255 .section "Using cram_md5 as a server" "SECID176"
26256 .cindex "options" "&(cram_md5)& authenticator (server)"
26257 This authenticator has one server option, which must be set to configure the
26258 authenticator as a server:
26259
26260 .option server_secret cram_md5 string&!! unset
26261 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26262 When the server receives the client's response, the user name is placed in
26263 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26264 obtain the password for that user. The server then computes the CRAM-MD5 digest
26265 that the client should have sent, and checks that it received the correct
26266 string. If the expansion of &%server_secret%& is forced to fail, authentication
26267 fails. If the expansion fails for some other reason, a temporary error code is
26268 returned to the client.
26269
26270 For compatibility with previous releases of Exim, the user name is also placed
26271 in &$1$&. However, the use of this variables for this purpose is now
26272 deprecated, as it can lead to confusion in string expansions that also use
26273 numeric variables for other things.
26274
26275 For example, the following authenticator checks that the user name given by the
26276 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26277 user name, authentication fails.
26278 .code
26279 fixed_cram:
26280   driver = cram_md5
26281   public_name = CRAM-MD5
26282   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26283   server_set_id = $auth1
26284 .endd
26285 .vindex "&$authenticated_id$&"
26286 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26287 name in &$authenticated_id$&. A more typical configuration might look up the
26288 secret string in a file, using the user name as the key. For example:
26289 .code
26290 lookup_cram:
26291   driver = cram_md5
26292   public_name = CRAM-MD5
26293   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26294                   {$value}fail}
26295   server_set_id = $auth1
26296 .endd
26297 Note that this expansion explicitly forces failure if the lookup fails
26298 because &$auth1$& contains an unknown user name.
26299
26300 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26301 using the relevant libraries, you need to know the realm to specify in the
26302 lookup and then ask for the &"userPassword"& attribute for that user in that
26303 realm, with:
26304 .code
26305 cyrusless_crammd5:
26306   driver = cram_md5
26307   public_name = CRAM-MD5
26308   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26309                   dbmjz{/etc/sasldb2}{$value}fail}
26310   server_set_id = $auth1
26311 .endd
26312
26313 .section "Using cram_md5 as a client" "SECID177"
26314 .cindex "options" "&(cram_md5)& authenticator (client)"
26315 When used as a client, the &(cram_md5)& authenticator has two options:
26316
26317
26318
26319 .option client_name cram_md5 string&!! "the primary host name"
26320 This string is expanded, and the result used as the user name data when
26321 computing the response to the server's challenge.
26322
26323
26324 .option client_secret cram_md5 string&!! unset
26325 This option must be set for the authenticator to work as a client. Its value is
26326 expanded and the result used as the secret string when computing the response.
26327
26328
26329 .vindex "&$host$&"
26330 .vindex "&$host_address$&"
26331 Different user names and secrets can be used for different servers by referring
26332 to &$host$& or &$host_address$& in the options. Forced failure of either
26333 expansion string is treated as an indication that this authenticator is not
26334 prepared to handle this case. Exim moves on to the next configured client
26335 authenticator. Any other expansion failure causes Exim to give up trying to
26336 send the message to the current server.
26337
26338 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26339 strings, is:
26340 .code
26341 fixed_cram:
26342   driver = cram_md5
26343   public_name = CRAM-MD5
26344   client_name = ph10
26345   client_secret = secret
26346 .endd
26347 .ecindex IIDcramauth1
26348 .ecindex IIDcramauth2
26349
26350
26351
26352 . ////////////////////////////////////////////////////////////////////////////
26353 . ////////////////////////////////////////////////////////////////////////////
26354
26355 .chapter "The cyrus_sasl authenticator" "CHID10"
26356 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26357 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26358 .cindex "Cyrus" "SASL library"
26359 .cindex "Kerberos"
26360 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26361 Digital Ltd (&url(http://www.aldigital.co.uk)).
26362
26363 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26364 library implementation of the RFC 2222 (&"Simple Authentication and Security
26365 Layer"&). This library supports a number of authentication mechanisms,
26366 including PLAIN and LOGIN, but also several others that Exim does not support
26367 directly. In particular, there is support for Kerberos authentication.
26368
26369 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26370 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26371 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26372 name of the driver to determine which mechanism to support.
26373
26374 Where access to some kind of secret file is required, for example in GSSAPI
26375 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26376 user, and that the Cyrus SASL library has no way of escalating privileges
26377 by default. You may also find you need to set environment variables,
26378 depending on the driver you are using.
26379
26380 The application name provided by Exim is &"exim"&, so various SASL options may
26381 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26382 Kerberos, note that because of limitations in the GSSAPI interface,
26383 changing the server keytab might need to be communicated down to the Kerberos
26384 layer independently. The mechanism for doing so is dependent upon the Kerberos
26385 implementation.
26386
26387 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26388 may be set to point to an alternative keytab file. Exim will pass this
26389 variable through from its own inherited environment when started as root or the
26390 Exim user. The keytab file needs to be readable by the Exim user.
26391 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26392 environment variable.  In practice, for those releases, the Cyrus authenticator
26393 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26394 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26395
26396
26397 .section "Using cyrus_sasl as a server" "SECID178"
26398 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26399 (on a successful authentication) into &$auth1$&. For compatibility with
26400 previous releases of Exim, the username is also placed in &$1$&. However, the
26401 use of this variable for this purpose is now deprecated, as it can lead to
26402 confusion in string expansions that also use numeric variables for other
26403 things.
26404
26405
26406 .option server_hostname cyrus_sasl string&!! "see below"
26407 This option selects the hostname that is used when communicating with the
26408 library. The default value is &`$primary_hostname`&. It is up to the underlying
26409 SASL plug-in what it does with this data.
26410
26411
26412 .option server_mech cyrus_sasl string "see below"
26413 This option selects the authentication mechanism this driver should use. The
26414 default is the value of the generic &%public_name%& option. This option allows
26415 you to use a different underlying mechanism from the advertised name. For
26416 example:
26417 .code
26418 sasl:
26419   driver = cyrus_sasl
26420   public_name = X-ANYTHING
26421   server_mech = CRAM-MD5
26422   server_set_id = $auth1
26423 .endd
26424
26425 .option server_realm cyrus_sasl string&!! unset
26426 This specifies the SASL realm that the server claims to be in.
26427
26428
26429 .option server_service cyrus_sasl string &`smtp`&
26430 This is the SASL service that the server claims to implement.
26431
26432
26433 For straightforward cases, you do not need to set any of the authenticator's
26434 private options. All you need to do is to specify an appropriate mechanism as
26435 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26436 PLAIN, you could have two authenticators as follows:
26437 .code
26438 sasl_cram_md5:
26439   driver = cyrus_sasl
26440   public_name = CRAM-MD5
26441   server_set_id = $auth1
26442
26443 sasl_plain:
26444   driver = cyrus_sasl
26445   public_name = PLAIN
26446   server_set_id = $auth2
26447 .endd
26448 Cyrus SASL does implement the LOGIN authentication method, even though it is
26449 not a standard method. It is disabled by default in the source distribution,
26450 but it is present in many binary distributions.
26451 .ecindex IIDcyrauth1
26452 .ecindex IIDcyrauth2
26453
26454
26455
26456
26457 . ////////////////////////////////////////////////////////////////////////////
26458 . ////////////////////////////////////////////////////////////////////////////
26459 .chapter "The dovecot authenticator" "CHAPdovecot"
26460 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26461 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26462 This authenticator is an interface to the authentication facility of the
26463 Dovecot POP/IMAP server, which can support a number of authentication methods.
26464 Note that Dovecot must be configured to use auth-client not auth-userdb.
26465 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26466 to use the same mechanisms for SMTP authentication. This is a server
26467 authenticator only. There is only one option:
26468
26469 .option server_socket dovecot string unset
26470
26471 This option must specify the socket that is the interface to Dovecot
26472 authentication. The &%public_name%& option must specify an authentication
26473 mechanism that Dovecot is configured to support. You can have several
26474 authenticators for different mechanisms. For example:
26475 .code
26476 dovecot_plain:
26477   driver = dovecot
26478   public_name = PLAIN
26479   server_socket = /var/run/dovecot/auth-client
26480   server_set_id = $auth1
26481
26482 dovecot_ntlm:
26483   driver = dovecot
26484   public_name = NTLM
26485   server_socket = /var/run/dovecot/auth-client
26486   server_set_id = $auth1
26487 .endd
26488 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26489 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26490 option is passed in the Dovecot authentication command. If, for a TLS
26491 connection, a client certificate has been verified, the &"valid-client-cert"&
26492 option is passed. When authentication succeeds, the identity of the user
26493 who authenticated is placed in &$auth1$&.
26494 .ecindex IIDdcotauth1
26495 .ecindex IIDdcotauth2
26496
26497
26498 . ////////////////////////////////////////////////////////////////////////////
26499 . ////////////////////////////////////////////////////////////////////////////
26500 .chapter "The gsasl authenticator" "CHAPgsasl"
26501 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26502 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26503 .cindex "authentication" "GNU SASL"
26504 .cindex "authentication" "SASL"
26505 .cindex "authentication" "EXTERNAL"
26506 .cindex "authentication" "ANONYMOUS"
26507 .cindex "authentication" "PLAIN"
26508 .cindex "authentication" "LOGIN"
26509 .cindex "authentication" "DIGEST-MD5"
26510 .cindex "authentication" "CRAM-MD5"
26511 .cindex "authentication" "SCRAM-SHA-1"
26512 The &(gsasl)& authenticator provides server integration for the GNU SASL
26513 library and the mechanisms it provides.  This is new as of the 4.80 release
26514 and there are a few areas where the library does not let Exim smoothly
26515 scale to handle future authentication mechanisms, so no guarantee can be
26516 made that any particular new authentication mechanism will be supported
26517 without code changes in Exim.
26518
26519
26520 .option server_channelbinding gsasl boolean false
26521 Some authentication mechanisms are able to use external context at both ends
26522 of the session to bind the authentication to that context, and fail the
26523 authentication process if that context differs.  Specifically, some TLS
26524 ciphersuites can provide identifying information about the cryptographic
26525 context.
26526
26527 This means that certificate identity and verification becomes a non-issue,
26528 as a man-in-the-middle attack will cause the correct client and server to
26529 see different identifiers and authentication will fail.
26530
26531 This is currently only supported when using the GnuTLS library.  This is
26532 only usable by mechanisms which support "channel binding"; at time of
26533 writing, that's the SCRAM family.
26534
26535 This defaults off to ensure smooth upgrade across Exim releases, in case
26536 this option causes some clients to start failing.  Some future release
26537 of Exim may switch the default to be true.
26538
26539
26540 .option server_hostname gsasl string&!! "see below"
26541 This option selects the hostname that is used when communicating with the
26542 library. The default value is &`$primary_hostname`&.
26543 Some mechanisms will use this data.
26544
26545
26546 .option server_mech gsasl string "see below"
26547 This option selects the authentication mechanism this driver should use. The
26548 default is the value of the generic &%public_name%& option. This option allows
26549 you to use a different underlying mechanism from the advertised name. For
26550 example:
26551 .code
26552 sasl:
26553   driver = gsasl
26554   public_name = X-ANYTHING
26555   server_mech = CRAM-MD5
26556   server_set_id = $auth1
26557 .endd
26558
26559
26560 .option server_password gsasl string&!! unset
26561 Various mechanisms need access to the cleartext password on the server, so
26562 that proof-of-possession can be demonstrated on the wire, without sending
26563 the password itself.
26564
26565 The data available for lookup varies per mechanism.
26566 In all cases, &$auth1$& is set to the &'authentication id'&.
26567 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26568 if available, else the empty string.
26569 The &$auth3$& variable will always be the &'realm'& if available,
26570 else the empty string.
26571
26572 A forced failure will cause authentication to defer.
26573
26574 If using this option, it may make sense to set the &%server_condition%&
26575 option to be simply "true".
26576
26577
26578 .option server_realm gsasl string&!! unset
26579 This specifies the SASL realm that the server claims to be in.
26580 Some mechanisms will use this data.
26581
26582
26583 .option server_scram_iter gsasl string&!! unset
26584 This option provides data for the SCRAM family of mechanisms.
26585 &$auth1$& is not available at evaluation time.
26586 (This may change, as we receive feedback on use)
26587
26588
26589 .option server_scram_salt gsasl string&!! unset
26590 This option provides data for the SCRAM family of mechanisms.
26591 &$auth1$& is not available at evaluation time.
26592 (This may change, as we receive feedback on use)
26593
26594
26595 .option server_service gsasl string &`smtp`&
26596 This is the SASL service that the server claims to implement.
26597 Some mechanisms will use this data.
26598
26599
26600 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26601 .vindex "&$auth1$&, &$auth2$&, etc"
26602 These may be set when evaluating specific options, as detailed above.
26603 They will also be set when evaluating &%server_condition%&.
26604
26605 Unless otherwise stated below, the &(gsasl)& integration will use the following
26606 meanings for these variables:
26607
26608 .ilist
26609 .vindex "&$auth1$&"
26610 &$auth1$&: the &'authentication id'&
26611 .next
26612 .vindex "&$auth2$&"
26613 &$auth2$&: the &'authorization id'&
26614 .next
26615 .vindex "&$auth3$&"
26616 &$auth3$&: the &'realm'&
26617 .endlist
26618
26619 On a per-mechanism basis:
26620
26621 .ilist
26622 .cindex "authentication" "EXTERNAL"
26623 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26624 the &%server_condition%& option must be present.
26625 .next
26626 .cindex "authentication" "ANONYMOUS"
26627 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26628 the &%server_condition%& option must be present.
26629 .next
26630 .cindex "authentication" "GSSAPI"
26631 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26632 &$auth2$& will be set to the &'authorization id'&,
26633 the &%server_condition%& option must be present.
26634 .endlist
26635
26636 An &'anonymous token'& is something passed along as an unauthenticated
26637 identifier; this is analogous to FTP anonymous authentication passing an
26638 email address, or software-identifier@, as the "password".
26639
26640
26641 An example showing the password having the realm specified in the callback
26642 and demonstrating a Cyrus SASL to GSASL migration approach is:
26643 .code
26644 gsasl_cyrusless_crammd5:
26645   driver = gsasl
26646   public_name = CRAM-MD5
26647   server_realm = imap.example.org
26648   server_password = ${lookup{$auth1:$auth3:userPassword}\
26649                     dbmjz{/etc/sasldb2}{$value}fail}
26650   server_set_id = ${quote:$auth1}
26651   server_condition = yes
26652 .endd
26653
26654
26655 . ////////////////////////////////////////////////////////////////////////////
26656 . ////////////////////////////////////////////////////////////////////////////
26657
26658 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26659 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26660 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26661 .cindex "authentication" "GSSAPI"
26662 .cindex "authentication" "Kerberos"
26663 The &(heimdal_gssapi)& authenticator provides server integration for the
26664 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26665 reliably.
26666
26667 .option server_hostname heimdal_gssapi string&!! "see below"
26668 This option selects the hostname that is used, with &%server_service%&,
26669 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26670 identifier.  The default value is &`$primary_hostname`&.
26671
26672 .option server_keytab heimdal_gssapi string&!! unset
26673 If set, then Heimdal will not use the system default keytab (typically
26674 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26675 The value should be a pathname, with no &"file:"& prefix.
26676
26677 .option server_service heimdal_gssapi string&!! "smtp"
26678 This option specifies the service identifier used, in conjunction with
26679 &%server_hostname%&, for building the identifier for finding credentials
26680 from the keytab.
26681
26682
26683 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26684 Beware that these variables will typically include a realm, thus will appear
26685 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26686 not verified, so a malicious client can set it to anything.
26687
26688 The &$auth1$& field should be safely trustable as a value from the Key
26689 Distribution Center.  Note that these are not quite email addresses.
26690 Each identifier is for a role, and so the left-hand-side may include a
26691 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26692
26693 .vindex "&$auth1$&, &$auth2$&, etc"
26694 .ilist
26695 .vindex "&$auth1$&"
26696 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26697 .next
26698 .vindex "&$auth2$&"
26699 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26700 authentication.  If that was empty, this will also be set to the
26701 GSS Display Name.
26702 .endlist
26703
26704
26705 . ////////////////////////////////////////////////////////////////////////////
26706 . ////////////////////////////////////////////////////////////////////////////
26707
26708 .chapter "The spa authenticator" "CHAPspa"
26709 .scindex IIDspaauth1 "&(spa)& authenticator"
26710 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26711 .cindex "authentication" "Microsoft Secure Password"
26712 .cindex "authentication" "NTLM"
26713 .cindex "Microsoft Secure Password Authentication"
26714 .cindex "NTLM authentication"
26715 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26716 Password Authentication'& mechanism,
26717 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26718 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26719 taken from the Samba project (&url(http://www.samba.org)). The code for the
26720 server side was subsequently contributed by Tom Kistner. The mechanism works as
26721 follows:
26722
26723 .ilist
26724 After the AUTH command has been accepted, the client sends an SPA
26725 authentication request based on the user name and optional domain.
26726 .next
26727 The server sends back a challenge.
26728 .next
26729 The client builds a challenge response which makes use of the user's password
26730 and sends it to the server, which then accepts or rejects it.
26731 .endlist
26732
26733 Encryption is used to protect the password in transit.
26734
26735
26736
26737 .section "Using spa as a server" "SECID179"
26738 .cindex "options" "&(spa)& authenticator (server)"
26739 The &(spa)& authenticator has just one server option:
26740
26741 .option server_password spa string&!! unset
26742 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26743 This option is expanded, and the result must be the cleartext password for the
26744 authenticating user, whose name is at this point in &$auth1$&. For
26745 compatibility with previous releases of Exim, the user name is also placed in
26746 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26747 it can lead to confusion in string expansions that also use numeric variables
26748 for other things. For example:
26749 .code
26750 spa:
26751   driver = spa
26752   public_name = NTLM
26753   server_password = \
26754     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26755 .endd
26756 If the expansion is forced to fail, authentication fails. Any other expansion
26757 failure causes a temporary error code to be returned.
26758
26759
26760
26761
26762
26763 .section "Using spa as a client" "SECID180"
26764 .cindex "options" "&(spa)& authenticator (client)"
26765 The &(spa)& authenticator has the following client options:
26766
26767
26768
26769 .option client_domain spa string&!! unset
26770 This option specifies an optional domain for the authentication.
26771
26772
26773 .option client_password spa string&!! unset
26774 This option specifies the user's password, and must be set.
26775
26776
26777 .option client_username spa string&!! unset
26778 This option specifies the user name, and must be set. Here is an example of a
26779 configuration of this authenticator for use with the mail servers at
26780 &'msn.com'&:
26781 .code
26782 msn:
26783   driver = spa
26784   public_name = MSN
26785   client_username = msn/msn_username
26786   client_password = msn_plaintext_password
26787   client_domain = DOMAIN_OR_UNSET
26788 .endd
26789 .ecindex IIDspaauth1
26790 .ecindex IIDspaauth2
26791
26792
26793
26794
26795
26796 . ////////////////////////////////////////////////////////////////////////////
26797 . ////////////////////////////////////////////////////////////////////////////
26798
26799 .chapter "The tls authenticator" "CHAPtlsauth"
26800 .scindex IIDtlsauth1 "&(tls)& authenticator"
26801 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26802 .cindex "authentication" "Client Certificate"
26803 .cindex "authentication" "X509"
26804 .cindex "Certificate-based authentication"
26805 The &(tls)& authenticator provides server support for
26806 authentication based on client certificates.
26807
26808 It is not an SMTP authentication mechanism and is not
26809 advertised by the server as part of the SMTP EHLO response.
26810 It is an Exim authenticator in the sense that it affects
26811 the protocol element of the log line, can be tested for
26812 by the &%authenticated%& ACL condition, and can set
26813 the &$authenticated_id$& variable.
26814
26815 The client must present a verifiable certificate,
26816 for which it must have been requested via the
26817 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26818 (see &<<CHAPTLS>>&).
26819
26820 If an authenticator of this type is configured it is
26821 run before any SMTP-level communication is done,
26822 and can authenticate the connection.
26823 If it does, SMTP authentication is not offered.
26824
26825 A maximum of one authenticator of this type may be present.
26826
26827
26828 .cindex "options" "&(tls)& authenticator (server)"
26829 The &(tls)& authenticator has three server options:
26830
26831 .option server_param1 tls string&!! unset
26832 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26833 This option is expanded after the TLS negotiation and
26834 the result is placed in &$auth1$&.
26835 If the expansion is forced to fail, authentication fails. Any other expansion
26836 failure causes a temporary error code to be returned.
26837
26838 .option server_param2 tls string&!! unset
26839 .option server_param3 tls string&!! unset
26840 As above, for &$auth2$& and &$auth3$&.
26841
26842 &%server_param1%& may also be spelled &%server_param%&.
26843
26844
26845 Example:
26846 .code
26847 tls:
26848   driver = tls
26849   server_param1 =     ${certextract {subj_altname,mail,>:} \
26850                                     {$tls_in_peercert}}
26851   server_condition =  ${if forany {$auth1} \
26852                             {!= {0} \
26853                                 {${lookup ldap{ldap:///\
26854                          mailname=${quote_ldap_dn:${lc:$item}},\
26855                          ou=users,LDAP_DC?mailid} {$value}{0} \
26856                        }    }   } }
26857   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26858 .endd
26859 This accepts a client certificate that is verifiable against any
26860 of your configured trust-anchors
26861 (which usually means the full set of public CAs)
26862 and which has a SAN with a good account name.
26863 Note that the client cert is on the wire in-clear, including the SAN,
26864 whereas a plaintext SMTP AUTH done inside TLS is not.
26865
26866 . An alternative might use
26867 . .code
26868 .   server_param1 = ${sha256:$tls_in_peercert}
26869 . .endd
26870 . to require one of a set of specific certs that define a given account
26871 . (the verification is still required, but mostly irrelevant).
26872 . This would help for per-device use.
26873 .
26874 . However, for the future we really need support for checking a
26875 . user cert in LDAP - which probably wants a base-64 DER.
26876
26877 .ecindex IIDtlsauth1
26878 .ecindex IIDtlsauth2
26879
26880
26881 Note that because authentication is traditionally an SMTP operation,
26882 the &%authenticated%& ACL condition cannot be used in
26883 a connect- or helo-ACL.
26884
26885
26886
26887 . ////////////////////////////////////////////////////////////////////////////
26888 . ////////////////////////////////////////////////////////////////////////////
26889
26890 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26891          "Encrypted SMTP connections"
26892 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26893 .scindex IIDencsmtp2 "SMTP" "encryption"
26894 .cindex "TLS" "on SMTP connection"
26895 .cindex "OpenSSL"
26896 .cindex "GnuTLS"
26897 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26898 Sockets Layer), is implemented by making use of the OpenSSL library or the
26899 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26900 cryptographic code in the Exim distribution itself for implementing TLS. In
26901 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26902 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26903 You also need to understand the basic concepts of encryption at a managerial
26904 level, and in particular, the way that public keys, private keys, and
26905 certificates are used.
26906
26907 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26908 connection is established, the client issues a STARTTLS command. If the
26909 server accepts this, the client and the server negotiate an encryption
26910 mechanism. If the negotiation succeeds, the data that subsequently passes
26911 between them is encrypted.
26912
26913 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26914 and if so, what cipher suite is in use, whether the client supplied a
26915 certificate, and whether or not that certificate was verified. This makes it
26916 possible for an Exim server to deny or accept certain commands based on the
26917 encryption state.
26918
26919 &*Warning*&: Certain types of firewall and certain anti-virus products can
26920 disrupt TLS connections. You need to turn off SMTP scanning for these products
26921 in order to get TLS to work.
26922
26923
26924
26925 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26926          "SECID284"
26927 .cindex "ssmtp protocol"
26928 .cindex "smtps protocol"
26929 .cindex "SMTP" "ssmtp protocol"
26930 .cindex "SMTP" "smtps protocol"
26931 Early implementations of encrypted SMTP used a different TCP port from normal
26932 SMTP, and expected an encryption negotiation to start immediately, instead of
26933 waiting for a STARTTLS command from the client using the standard SMTP
26934 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26935 allocated for this purpose.
26936
26937 This approach was abandoned when encrypted SMTP was standardized, but there are
26938 still some legacy clients that use it. Exim supports these clients by means of
26939 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26940 numbers; the most common use is expected to be:
26941 .code
26942 tls_on_connect_ports = 465
26943 .endd
26944 The port numbers specified by this option apply to all SMTP connections, both
26945 via the daemon and via &'inetd'&. You still need to specify all the ports that
26946 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26947 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26948 an extra port &-- rather, it specifies different behaviour on a port that is
26949 defined elsewhere.
26950
26951 There is also a &%-tls-on-connect%& command line option. This overrides
26952 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26953
26954
26955
26956
26957
26958
26959 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26960 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26961 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26962 followed later, when the first versions of GnuTLS were released. To build Exim
26963 to use GnuTLS, you need to set
26964 .code
26965 USE_GNUTLS=yes
26966 .endd
26967 in Local/Makefile, in addition to
26968 .code
26969 SUPPORT_TLS=yes
26970 .endd
26971 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26972 include files and libraries for GnuTLS can be found.
26973
26974 There are some differences in usage when using GnuTLS instead of OpenSSL:
26975
26976 .ilist
26977 The &%tls_verify_certificates%& option
26978 cannot be the path of a directory
26979 for GnuTLS versions before 3.3.6
26980 (for later versions, or OpenSSL, it can be either).
26981 .next
26982 The default value for &%tls_dhparam%& differs for historical reasons.
26983 .next
26984 .vindex "&$tls_in_peerdn$&"
26985 .vindex "&$tls_out_peerdn$&"
26986 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26987 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26988 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26989 .next
26990 OpenSSL identifies cipher suites using hyphens as separators, for example:
26991 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26992 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26993 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26994 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26995 to handle its own older variants) when processing lists of cipher suites in the
26996 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26997 option).
26998 .next
26999 The &%tls_require_ciphers%& options operate differently, as described in the
27000 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27001 .next
27002 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27003 When using OpenSSL, this option is ignored.
27004 (If an API is found to let OpenSSL be configured in this way,
27005 let the Exim Maintainers know and we'll likely use it).
27006 .next
27007 Some other recently added features may only be available in one or the other.
27008 This should be documented with the feature.  If the documentation does not
27009 explicitly state that the feature is infeasible in the other TLS
27010 implementation, then patches are welcome.
27011 .endlist
27012
27013
27014 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27015 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27016 an explicit path; if the latter, then the text about generation still applies,
27017 but not the chosen filename.
27018 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27019 See the documentation of &%tls_dhparam%& for more information.
27020
27021 GnuTLS uses D-H parameters that may take a substantial amount of time
27022 to compute. It is unreasonable to re-compute them for every TLS session.
27023 Therefore, Exim keeps this data in a file in its spool directory, called
27024 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27025 of bits requested.
27026 The file is owned by the Exim user and is readable only by
27027 its owner. Every Exim process that start up GnuTLS reads the D-H
27028 parameters from this file. If the file does not exist, the first Exim process
27029 that needs it computes the data and writes it to a temporary file which is
27030 renamed once it is complete. It does not matter if several Exim processes do
27031 this simultaneously (apart from wasting a few resources). Once a file is in
27032 place, new Exim processes immediately start using it.
27033
27034 For maximum security, the parameters that are stored in this file should be
27035 recalculated periodically, the frequency depending on your paranoia level.
27036 If you are avoiding using the fixed D-H primes published in RFCs, then you
27037 are concerned about some advanced attacks and will wish to do this; if you do
27038 not regenerate then you might as well stick to the standard primes.
27039
27040 Arranging this is easy in principle; just delete the file when you want new
27041 values to be computed. However, there may be a problem. The calculation of new
27042 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27043 If the system is not very active, &_/dev/random_& may delay returning data
27044 until enough randomness (entropy) is available. This may cause Exim to hang for
27045 a substantial amount of time, causing timeouts on incoming connections.
27046
27047 The solution is to generate the parameters externally to Exim. They are stored
27048 in &_gnutls-params-N_& in PEM format, which means that they can be
27049 generated externally using the &(certtool)& command that is part of GnuTLS.
27050
27051 To replace the parameters with new ones, instead of deleting the file
27052 and letting Exim re-create it, you can generate new parameters using
27053 &(certtool)& and, when this has been done, replace Exim's cache file by
27054 renaming. The relevant commands are something like this:
27055 .code
27056 # ls
27057 [ look for file; assume gnutls-params-2236 is the most recent ]
27058 # rm -f new-params
27059 # touch new-params
27060 # chown exim:exim new-params
27061 # chmod 0600 new-params
27062 # certtool --generate-dh-params --bits 2236 >>new-params
27063 # openssl dhparam -noout -text -in new-params | head
27064 [ check the first line, make sure it's not more than 2236;
27065   if it is, then go back to the start ("rm") and repeat
27066   until the size generated is at most the size requested ]
27067 # chmod 0400 new-params
27068 # mv new-params gnutls-params-2236
27069 .endd
27070 If Exim never has to generate the parameters itself, the possibility of
27071 stalling is removed.
27072
27073 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27074 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27075 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27076 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27077 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27078 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27079 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27080 which applies to all D-H usage, client or server.  If the value returned by
27081 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27082 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27083 limit, which is still much higher than Exim historically used.
27084
27085 The filename and bits used will change as the GnuTLS maintainers change the
27086 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27087 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27088 2432 bits, while NSS is limited to 2236 bits.
27089
27090 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27091 increase the chance of the generated prime actually being within acceptable
27092 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27093 procedure above.  There is no sane procedure available to Exim to double-check
27094 the size of the generated prime, so it might still be too large.
27095
27096
27097 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27098 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27099 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27100 There is a function in the OpenSSL library that can be passed a list of cipher
27101 suites before the cipher negotiation takes place. This specifies which ciphers
27102 are acceptable. The list is colon separated and may contain names like
27103 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27104 directly to this function call.
27105 Many systems will install the OpenSSL manual-pages, so you may have
27106 &'ciphers(1)'& available to you.
27107 The following quotation from the OpenSSL
27108 documentation specifies what forms of item are allowed in the cipher string:
27109
27110 .ilist
27111 It can consist of a single cipher suite such as RC4-SHA.
27112 .next
27113 It can represent a list of cipher suites containing a certain algorithm,
27114 or cipher suites of a certain type. For example SHA1 represents all
27115 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27116 SSL v3 algorithms.
27117 .next
27118 Lists of cipher suites can be combined in a single cipher string using
27119 the + character. This is used as a logical and operation. For example
27120 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27121 algorithms.
27122 .endlist
27123
27124 Each cipher string can be optionally preceded by one of the characters &`!`&,
27125 &`-`& or &`+`&.
27126 .ilist
27127 If &`!`& is used, the ciphers are permanently deleted from the list. The
27128 ciphers deleted can never reappear in the list even if they are explicitly
27129 stated.
27130 .next
27131 If &`-`& is used, the ciphers are deleted from the list, but some or all
27132 of the ciphers can be added again by later options.
27133 .next
27134 If &`+`& is used, the ciphers are moved to the end of the list. This
27135 option does not add any new ciphers; it just moves matching existing ones.
27136 .endlist
27137
27138 If none of these characters is present, the string is interpreted as
27139 a list of ciphers to be appended to the current preference list. If the list
27140 includes any ciphers already present they will be ignored: that is, they will
27141 not be moved to the end of the list.
27142 .endlist
27143
27144 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27145 string:
27146 .code
27147 # note single-quotes to get ! past any shell history expansion
27148 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27149 .endd
27150
27151 This example will let the library defaults be permitted on the MX port, where
27152 there's probably no identity verification anyway, but ups the ante on the
27153 submission ports where the administrator might have some influence on the
27154 choice of clients used:
27155 .code
27156 # OpenSSL variant; see man ciphers(1)
27157 tls_require_ciphers = ${if =={$received_port}{25}\
27158                            {DEFAULT}\
27159                            {HIGH:!MD5:!SHA1}}
27160 .endd
27161
27162
27163
27164 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27165          "SECTreqciphgnu"
27166 .cindex "GnuTLS" "specifying parameters for"
27167 .cindex "TLS" "specifying ciphers (GnuTLS)"
27168 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27169 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27170 .cindex "TLS" "specifying protocols (GnuTLS)"
27171 .cindex "TLS" "specifying priority string (GnuTLS)"
27172 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27173 The GnuTLS library allows the caller to provide a "priority string", documented
27174 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27175 ciphersuite specification in OpenSSL.
27176
27177 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27178 and controls both protocols and ciphers.
27179
27180 The &%tls_require_ciphers%& option is available both as an global option,
27181 controlling how Exim behaves as a server, and also as an option of the
27182 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27183 the value is string expanded.  The resulting string is not an Exim list and
27184 the string is given to the GnuTLS library, so that Exim does not need to be
27185 aware of future feature enhancements of GnuTLS.
27186
27187 Documentation of the strings accepted may be found in the GnuTLS manual, under
27188 "Priority strings".  This is online as
27189 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27190 but beware that this relates to GnuTLS 3, which may be newer than the version
27191 installed on your system.  If you are using GnuTLS 3,
27192 then the example code
27193 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27194 on that site can be used to test a given string.
27195
27196 For example:
27197 .code
27198 # Disable older versions of protocols
27199 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27200 .endd
27201
27202 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27203 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27204 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27205
27206 This example will let the library defaults be permitted on the MX port, where
27207 there's probably no identity verification anyway, and lowers security further
27208 by increasing compatibility; but this ups the ante on the submission ports
27209 where the administrator might have some influence on the choice of clients
27210 used:
27211 .code
27212 # GnuTLS variant
27213 tls_require_ciphers = ${if =={$received_port}{25}\
27214                            {NORMAL:%COMPAT}\
27215                            {SECURE128}}
27216 .endd
27217
27218
27219 .section "Configuring an Exim server to use TLS" "SECID182"
27220 .cindex "TLS" "configuring an Exim server"
27221 When Exim has been built with TLS support, it advertises the availability of
27222 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27223 but not to any others. The default value of this option is unset, which means
27224 that STARTTLS is not advertised at all. This default is chosen because you
27225 need to set some other options in order to make TLS available, and also it is
27226 sensible for systems that want to use TLS only as a client.
27227
27228 If a client issues a STARTTLS command and there is some configuration
27229 problem in the server, the command is rejected with a 454 error. If the client
27230 persists in trying to issue SMTP commands, all except QUIT are rejected
27231 with the error
27232 .code
27233 554 Security failure
27234 .endd
27235 If a STARTTLS command is issued within an existing TLS session, it is
27236 rejected with a 554 error code.
27237
27238 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27239 must be set to match some hosts. The default is * which matches all hosts.
27240
27241 .new
27242 If this is all you do, TLS encryption will be enabled but not authentication -
27243 meaning that the peer has no assurance it is actually you he is talking to.
27244 You gain protection from a passive sniffer listening on the wire but not
27245 from someone able to intercept the communication.
27246 .wen
27247
27248 Further protection requires some further configuration at the server end.
27249
27250 It is rumoured that all existing clients that support TLS/SSL use RSA
27251 encryption. To make this work you need to set, in the server,
27252 .code
27253 tls_certificate = /some/file/name
27254 tls_privatekey = /some/file/name
27255 .endd
27256 These options are, in fact, expanded strings, so you can make them depend on
27257 the identity of the client that is connected if you wish. The first file
27258 contains the server's X509 certificate, and the second contains the private key
27259 that goes with it. These files need to be
27260 PEM format and readable by the Exim user, and must
27261 always be given as full path names.
27262 The key must not be password-protected.
27263 They can be the same file if both the
27264 certificate and the key are contained within it. If &%tls_privatekey%& is not
27265 set, or if its expansion is forced to fail or results in an empty string, this
27266 is assumed to be the case. The certificate file may also contain intermediate
27267 certificates that need to be sent to the client to enable it to authenticate
27268 the server's certificate.
27269
27270 If you do not understand about certificates and keys, please try to find a
27271 source of this background information, which is not Exim-specific. (There are a
27272 few comments below in section &<<SECTcerandall>>&.)
27273
27274 &*Note*&: These options do not apply when Exim is operating as a client &--
27275 they apply only in the case of a server. If you need to use a certificate in an
27276 Exim client, you must set the options of the same names in an &(smtp)&
27277 transport.
27278
27279 With just these options, an Exim server will be able to use TLS. It does not
27280 require the client to have a certificate (but see below for how to insist on
27281 this). There is one other option that may be needed in other situations. If
27282 .code
27283 tls_dhparam = /some/file/name
27284 .endd
27285 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27286 with the parameters contained in the file.
27287 Set this to &`none`& to disable use of DH entirely, by making no prime
27288 available:
27289 .code
27290 tls_dhparam = none
27291 .endd
27292 This may also be set to a string identifying a standard prime to be used for
27293 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27294 used is &`ike23`&.  There are a few standard primes available, see the
27295 documentation for &%tls_dhparam%& for the complete list.
27296
27297 See the command
27298 .code
27299 openssl dhparam
27300 .endd
27301 for a way of generating file data.
27302
27303 The strings supplied for these three options are expanded every time a client
27304 host connects. It is therefore possible to use different certificates and keys
27305 for different hosts, if you so wish, by making use of the client's IP address
27306 in &$sender_host_address$& to control the expansion. If a string expansion is
27307 forced to fail, Exim behaves as if the option is not set.
27308
27309 .cindex "cipher" "logging"
27310 .cindex "log" "TLS cipher"
27311 .vindex "&$tls_in_cipher$&"
27312 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27313 an incoming TLS connection. It is included in the &'Received:'& header of an
27314 incoming message (by default &-- you can, of course, change this), and it is
27315 also included in the log line that records a message's arrival, keyed by
27316 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27317 condition can be used to test for specific cipher suites in ACLs.
27318
27319 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27320 can check the name of the cipher suite and vary their actions accordingly. The
27321 cipher suite names vary, depending on which TLS library is being used. For
27322 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27323 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27324 documentation for more details.
27325
27326 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27327 (again depending on the &%tls_cipher%& log selector).
27328
27329
27330 .section "Requesting and verifying client certificates" "SECID183"
27331 .cindex "certificate" "verification of client"
27332 .cindex "TLS" "client certificate verification"
27333 If you want an Exim server to request a certificate when negotiating a TLS
27334 session with a client, you must set either &%tls_verify_hosts%& or
27335 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27336 apply to all TLS connections. For any host that matches one of these options,
27337 Exim requests a certificate as part of the setup of the TLS session. The
27338 contents of the certificate are verified by comparing it with a list of
27339 expected certificates.
27340 These may be the system default set (depending on library version),
27341 an explicit file or,
27342 depending on library version, a directory, identified by
27343 &%tls_verify_certificates%&.
27344
27345 A file can contain multiple certificates, concatenated end to end. If a
27346 directory is used
27347 (OpenSSL only),
27348 each certificate must be in a separate file, with a name (or a symbolic link)
27349 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27350 certificate. You can compute the relevant hash by running the command
27351 .code
27352 openssl x509 -hash -noout -in /cert/file
27353 .endd
27354 where &_/cert/file_& contains a single certificate.
27355
27356 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27357 what happens if the client does not supply a certificate, or if the certificate
27358 does not match any of the certificates in the collection named by
27359 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27360 attempt to set up a TLS session is aborted, and the incoming connection is
27361 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27362 session continues. ACLs that run for subsequent SMTP commands can detect the
27363 fact that no certificate was verified, and vary their actions accordingly. For
27364 example, you can insist on a certificate before accepting a message for
27365 relaying, but not when the message is destined for local delivery.
27366
27367 .vindex "&$tls_in_peerdn$&"
27368 When a client supplies a certificate (whether it verifies or not), the value of
27369 the Distinguished Name of the certificate is made available in the variable
27370 &$tls_in_peerdn$& during subsequent processing of the message.
27371
27372 .cindex "log" "distinguished name"
27373 Because it is often a long text string, it is not included in the log line or
27374 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27375 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27376 &%received_header_text%& to change the &'Received:'& header. When no
27377 certificate is supplied, &$tls_in_peerdn$& is empty.
27378
27379
27380 .section "Revoked certificates" "SECID184"
27381 .cindex "TLS" "revoked certificates"
27382 .cindex "revocation list"
27383 .cindex "certificate" "revocation list"
27384 .cindex "OCSP" "stapling"
27385 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27386 certificates are revoked. If you have such a list, you can pass it to an Exim
27387 server using the global option called &%tls_crl%& and to an Exim client using
27388 an identically named option for the &(smtp)& transport. In each case, the value
27389 of the option is expanded and must then be the name of a file that contains a
27390 CRL in PEM format.
27391 The downside is that clients have to periodically re-download a potentially huge
27392 file from every certificate authority they know of.
27393
27394 The way with most moving parts at query time is Online Certificate
27395 Status Protocol (OCSP), where the client verifies the certificate
27396 against an OCSP server run by the CA.  This lets the CA track all
27397 usage of the certs.  It requires running software with access to the
27398 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27399 is based on HTTP and can be proxied accordingly.
27400
27401 The only widespread OCSP server implementation (known to this writer)
27402 comes as part of OpenSSL and aborts on an invalid request, such as
27403 connecting to the port and then disconnecting.  This requires
27404 re-entering the passphrase each time some random client does this.
27405
27406 The third way is OCSP Stapling; in this, the server using a certificate
27407 issued by the CA periodically requests an OCSP proof of validity from
27408 the OCSP server, then serves it up inline as part of the TLS
27409 negotiation.   This approach adds no extra round trips, does not let the
27410 CA track users, scales well with number of certs issued by the CA and is
27411 resilient to temporary OCSP server failures, as long as the server
27412 starts retrying to fetch an OCSP proof some time before its current
27413 proof expires.  The downside is that it requires server support.
27414
27415 Unless Exim is built with the support disabled,
27416 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27417 support for OCSP stapling is included.
27418
27419 There is a global option called &%tls_ocsp_file%&.
27420 The file specified therein is expected to be in DER format, and contain
27421 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27422 option will be re-expanded for SNI, if the &%tls_certificate%& option
27423 contains &`tls_in_sni`&, as per other TLS options.
27424
27425 Exim does not at this time implement any support for fetching a new OCSP
27426 proof.  The burden is on the administrator to handle this, outside of
27427 Exim.  The file specified should be replaced atomically, so that the
27428 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27429 on each connection, so a new file will be handled transparently on the
27430 next connection.
27431
27432 When built with OpenSSL Exim will check for a valid next update timestamp
27433 in the OCSP proof; if not present, or if the proof has expired, it will be
27434 ignored.
27435
27436 For the client to be able to verify the stapled OCSP the server must
27437 also supply, in its stapled information, any intermediate
27438 certificates for the chain leading to the OCSP proof from the signer
27439 of the server certificate.  There may be zero or one such. These
27440 intermediate certificates should be added to the server OCSP stapling
27441 file named by &%tls_ocsp_file%&.
27442
27443 Note that the proof only covers the terminal server certificate,
27444 not any of the chain from CA to it.
27445
27446 There is no current way to staple a proof for a client certificate.
27447
27448 .code
27449   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27450   OCSP server is supplied.  The server URL may be included in the
27451   server certificate, if the CA is helpful.
27452
27453   One failure mode seen was the OCSP Signer cert expiring before the end
27454   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27455   noted this as invalid overall, but the re-fetch script did not.
27456 .endd
27457
27458
27459
27460
27461 .section "Configuring an Exim client to use TLS" "SECID185"
27462 .cindex "cipher" "logging"
27463 .cindex "log" "TLS cipher"
27464 .cindex "log" "distinguished name"
27465 .cindex "TLS" "configuring an Exim client"
27466 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27467 deliveries as well as to incoming, the latter one causing logging of the
27468 server certificate's DN. The remaining client configuration for TLS is all
27469 within the &(smtp)& transport.
27470
27471 It is not necessary to set any options to have TLS work in the &(smtp)&
27472 transport. If Exim is built with TLS support, and TLS is advertised by a
27473 server, the &(smtp)& transport always tries to start a TLS session. However,
27474 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27475 transport) to a list of server hosts for which TLS should not be used.
27476
27477 If you do not want Exim to attempt to send messages unencrypted when an attempt
27478 to set up an encrypted connection fails in any way, you can set
27479 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27480 those hosts, delivery is always deferred if an encrypted connection cannot be
27481 set up. If there are any other hosts for the address, they are tried in the
27482 usual way.
27483
27484 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27485 the message unencrypted. It always does this if the response to STARTTLS is
27486 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27487 session after a success response code, what happens is controlled by the
27488 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27489 delivery to this host is deferred, and other hosts (if available) are tried. If
27490 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27491 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27492 negotiation fails, Exim closes the current connection (because it is in an
27493 unknown state), opens a new one to the same host, and then tries the delivery
27494 unencrypted.
27495
27496 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27497 transport provide the client with a certificate, which is passed to the server
27498 if it requests it. If the server is Exim, it will request a certificate only if
27499 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27500
27501 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27502 specifies a collection of expected server certificates.
27503 These may be the system default set (depending on library version),
27504 a file or,
27505 depending on library version, a directory,
27506 must name a file or,
27507 for OpenSSL only (not GnuTLS), a directory.
27508 The client verifies the server's certificate
27509 against this collection, taking into account any revoked certificates that are
27510 in the list defined by &%tls_crl%&.
27511 Failure to verify fails the TLS connection unless either of the
27512 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27513
27514 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27515 certificate verification to the listed servers.  Verification either must
27516 or need not succeed respectively.
27517
27518 The &(smtp)& transport has two OCSP-related options:
27519 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27520 is requested and required for the connection to proceed.  The default
27521 value is empty.
27522 &%hosts_request_ocsp%&; a host-list for which (additionally)
27523 a Certificate Status is requested (but not necessarily verified).  The default
27524 value is "*" meaning that requests are made unless configured
27525 otherwise.
27526
27527 The host(s) should also be in &%hosts_require_tls%&, and
27528 &%tls_verify_certificates%& configured for the transport,
27529 for OCSP to be relevant.
27530
27531 If
27532 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27533 list of permitted cipher suites. If either of these checks fails, delivery to
27534 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27535 alternative hosts, if any.
27536
27537  &*Note*&:
27538 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27539 is operating as a client. Exim does not assume that a server certificate (set
27540 by the global options of the same name) should also be used when operating as a
27541 client.
27542
27543 .vindex "&$host$&"
27544 .vindex "&$host_address$&"
27545 All the TLS options in the &(smtp)& transport are expanded before use, with
27546 &$host$& and &$host_address$& containing the name and address of the server to
27547 which the client is connected. Forced failure of an expansion causes Exim to
27548 behave as if the relevant option were unset.
27549
27550 .vindex &$tls_out_bits$&
27551 .vindex &$tls_out_cipher$&
27552 .vindex &$tls_out_peerdn$&
27553 .vindex &$tls_out_sni$&
27554 Before an SMTP connection is established, the
27555 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27556 variables are emptied. (Until the first connection, they contain the values
27557 that were set when the message was received.) If STARTTLS is subsequently
27558 successfully obeyed, these variables are set to the relevant values for the
27559 outgoing connection.
27560
27561
27562
27563 .section "Use of TLS Server Name Indication" "SECTtlssni"
27564 .cindex "TLS" "Server Name Indication"
27565 .vindex "&$tls_in_sni$&"
27566 .oindex "&%tls_in_sni%&"
27567 With TLS1.0 or above, there is an extension mechanism by which extra
27568 information can be included at various points in the protocol.  One of these
27569 extensions, documented in RFC 6066 (and before that RFC 4366) is
27570 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27571 client in the initial handshake, so that the server can examine the servername
27572 within and possibly choose to use different certificates and keys (and more)
27573 for this session.
27574
27575 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27576 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27577 address.
27578
27579 With SMTP to MX, there are the same problems here as in choosing the identity
27580 against which to validate a certificate: you can't rely on insecure DNS to
27581 provide the identity which you then cryptographically verify.  So this will
27582 be of limited use in that environment.
27583
27584 With SMTP to Submission, there is a well-defined hostname which clients are
27585 connecting to and can validate certificates against.  Thus clients &*can*&
27586 choose to include this information in the TLS negotiation.  If this becomes
27587 wide-spread, then hosters can choose to present different certificates to
27588 different clients.  Or even negotiate different cipher suites.
27589
27590 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27591 if not empty, will be sent on a TLS session as part of the handshake.  There's
27592 nothing more to it.  Choosing a sensible value not derived insecurely is the
27593 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27594 for the lifetime of the client connection (including during authentication).
27595
27596 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27597 received from a client.
27598 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27599
27600 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27601 option (prior to expansion) then the following options will be re-expanded
27602 during TLS session handshake, to permit alternative values to be chosen:
27603
27604 .ilist
27605 .vindex "&%tls_certificate%&"
27606 &%tls_certificate%&
27607 .next
27608 .vindex "&%tls_crl%&"
27609 &%tls_crl%&
27610 .next
27611 .vindex "&%tls_privatekey%&"
27612 &%tls_privatekey%&
27613 .next
27614 .vindex "&%tls_verify_certificates%&"
27615 &%tls_verify_certificates%&
27616 .next
27617 .vindex "&%tls_ocsp_file%&"
27618 &%tls_ocsp_file%&
27619 .endlist
27620
27621 Great care should be taken to deal with matters of case, various injection
27622 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27623 can always be referenced; it is important to remember that &$tls_in_sni$& is
27624 arbitrary unverified data provided prior to authentication.
27625 .new
27626 Further, the initial certificate is loaded before SNI is arrived, so
27627 an expansion for &%tls_certificate%& must have a default which is used
27628 when &$tls_in_sni$& is empty.
27629 .wen
27630
27631 The Exim developers are proceeding cautiously and so far no other TLS options
27632 are re-expanded.
27633
27634 When Exim is built against OpenSSL, OpenSSL must have been built with support
27635 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27636 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27637 see &`-servername`& in the output, then OpenSSL has support.
27638
27639 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27640 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27641 built, then you have SNI support).
27642
27643
27644
27645 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27646          "SECTmulmessam"
27647 .cindex "multiple SMTP deliveries with TLS"
27648 .cindex "TLS" "multiple message deliveries"
27649 Exim sends multiple messages down the same TCP/IP connection by starting up
27650 an entirely new delivery process for each message, passing the socket from
27651 one process to the next. This implementation does not fit well with the use
27652 of TLS, because there is quite a lot of state information associated with a TLS
27653 connection, not just a socket identification. Passing all the state information
27654 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27655 session before passing the socket to a new process. The new process may then
27656 try to start a new TLS session, and if successful, may try to re-authenticate
27657 if AUTH is in use, before sending the next message.
27658
27659 The RFC is not clear as to whether or not an SMTP session continues in clear
27660 after TLS has been shut down, or whether TLS may be restarted again later, as
27661 just described. However, if the server is Exim, this shutdown and
27662 reinitialization works. It is not known which (if any) other servers operate
27663 successfully if the client closes a TLS session and continues with unencrypted
27664 SMTP, but there are certainly some that do not work. For such servers, Exim
27665 should not pass the socket to another process, because the failure of the
27666 subsequent attempt to use it would cause Exim to record a temporary host error,
27667 and delay other deliveries to that host.
27668
27669 To test for this case, Exim sends an EHLO command to the server after
27670 closing down the TLS session. If this fails in any way, the connection is
27671 closed instead of being passed to a new delivery process, but no retry
27672 information is recorded.
27673
27674 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27675 &(smtp)& transport to match those hosts for which Exim should not pass
27676 connections to new processes if TLS has been used.
27677
27678
27679
27680
27681 .section "Certificates and all that" "SECTcerandall"
27682 .cindex "certificate" "references to discussion"
27683 In order to understand fully how TLS works, you need to know about
27684 certificates, certificate signing, and certificate authorities. This is not the
27685 place to give a tutorial, especially as I do not know very much about it
27686 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27687 to Apache, currently at
27688 .display
27689 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27690 .endd
27691 Other parts of the &'modssl'& documentation are also helpful, and have
27692 links to further files.
27693 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27694 0-201-61598-3), contains both introductory and more in-depth descriptions.
27695 Some sample programs taken from the book are available from
27696 .display
27697 &url(http://www.rtfm.com/openssl-examples/)
27698 .endd
27699
27700
27701 .section "Certificate chains" "SECID186"
27702 The file named by &%tls_certificate%& may contain more than one
27703 certificate. This is useful in the case where the certificate that is being
27704 sent is validated by an intermediate certificate which the other end does
27705 not have. Multiple certificates must be in the correct order in the file.
27706 First the host's certificate itself, then the first intermediate
27707 certificate to validate the issuer of the host certificate, then the next
27708 intermediate certificate to validate the issuer of the first intermediate
27709 certificate, and so on, until finally (optionally) the root certificate.
27710 The root certificate must already be trusted by the recipient for
27711 validation to succeed, of course, but if it's not preinstalled, sending the
27712 root certificate along with the rest makes it available for the user to
27713 install if the receiving end is a client MUA that can interact with a user.
27714
27715 Note that certificates using MD5 are unlikely to work on today's Internet;
27716 even if your libraries allow loading them for use in Exim when acting as a
27717 server, increasingly clients will not accept such certificates.  The error
27718 diagnostics in such a case can be frustratingly vague.
27719
27720
27721
27722 .section "Self-signed certificates" "SECID187"
27723 .cindex "certificate" "self-signed"
27724 You can create a self-signed certificate using the &'req'& command provided
27725 with OpenSSL, like this:
27726 . ==== Do not shorten the duration here without reading and considering
27727 . ==== the text below.  Please leave it at 9999 days.
27728 .code
27729 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27730             -days 9999 -nodes
27731 .endd
27732 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27733 delimited and so can be identified independently. The &%-days%& option
27734 specifies a period for which the certificate is valid. The &%-nodes%& option is
27735 important: if you do not set it, the key is encrypted with a passphrase
27736 that you are prompted for, and any use that is made of the key causes more
27737 prompting for the passphrase. This is not helpful if you are going to use
27738 this certificate and key in an MTA, where prompting is not possible.
27739
27740 . ==== I expect to still be working 26 years from now.  The less technical
27741 . ==== debt I create, in terms of storing up trouble for my later years, the
27742 . ==== happier I will be then.  We really have reached the point where we
27743 . ==== should start, at the very least, provoking thought and making folks
27744 . ==== pause before proceeding, instead of leaving all the fixes until two
27745 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27746 . ==== -pdp, 2012
27747 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27748 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27749 the above command might produce a date in the past.  Think carefully about
27750 the lifetime of the systems you're deploying, and either reduce the duration
27751 of the certificate or reconsider your platform deployment.  (At time of
27752 writing, reducing the duration is the most likely choice, but the inexorable
27753 progression of time takes us steadily towards an era where this will not
27754 be a sensible resolution).
27755
27756 A self-signed certificate made in this way is sufficient for testing, and
27757 may be adequate for all your requirements if you are mainly interested in
27758 encrypting transfers, and not in secure identification.
27759
27760 However, many clients require that the certificate presented by the server be a
27761 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27762 certificate. In this situation, the self-signed certificate described above
27763 must be installed on the client host as a trusted root &'certification
27764 authority'& (CA), and the certificate used by Exim must be a user certificate
27765 signed with that self-signed certificate.
27766
27767 For information on creating self-signed CA certificates and using them to sign
27768 user certificates, see the &'General implementation overview'& chapter of the
27769 Open-source PKI book, available online at
27770 &url(http://ospkibook.sourceforge.net/).
27771 .ecindex IIDencsmtp1
27772 .ecindex IIDencsmtp2
27773
27774
27775
27776 . ////////////////////////////////////////////////////////////////////////////
27777 . ////////////////////////////////////////////////////////////////////////////
27778
27779 .chapter "Access control lists" "CHAPACL"
27780 .scindex IIDacl "&ACL;" "description"
27781 .cindex "control of incoming mail"
27782 .cindex "message" "controlling incoming"
27783 .cindex "policy control" "access control lists"
27784 Access Control Lists (ACLs) are defined in a separate section of the run time
27785 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27786 name, terminated by a colon. Here is a complete ACL section that contains just
27787 one very small ACL:
27788 .code
27789 begin acl
27790 small_acl:
27791   accept   hosts = one.host.only
27792 .endd
27793 You can have as many lists as you like in the ACL section, and the order in
27794 which they appear does not matter. The lists are self-terminating.
27795
27796 The majority of ACLs are used to control Exim's behaviour when it receives
27797 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27798 when a local process submits a message using SMTP by specifying the &%-bs%&
27799 option. The most common use is for controlling which recipients are accepted
27800 in incoming messages. In addition, you can define an ACL that is used to check
27801 local non-SMTP messages. The default configuration file contains an example of
27802 a realistic ACL for checking RCPT commands. This is discussed in chapter
27803 &<<CHAPdefconfil>>&.
27804
27805
27806 .section "Testing ACLs" "SECID188"
27807 The &%-bh%& command line option provides a way of testing your ACL
27808 configuration locally by running a fake SMTP session with which you interact.
27809
27810
27811 .section "Specifying when ACLs are used" "SECID189"
27812 .cindex "&ACL;" "options for specifying"
27813 In order to cause an ACL to be used, you have to name it in one of the relevant
27814 options in the main part of the configuration. These options are:
27815 .cindex "AUTH" "ACL for"
27816 .cindex "DATA" "ACLs for"
27817 .cindex "ETRN" "ACL for"
27818 .cindex "EXPN" "ACL for"
27819 .cindex "HELO" "ACL for"
27820 .cindex "EHLO" "ACL for"
27821 .cindex "DKIM" "ACL for"
27822 .cindex "MAIL" "ACL for"
27823 .cindex "QUIT, ACL for"
27824 .cindex "RCPT" "ACL for"
27825 .cindex "STARTTLS, ACL for"
27826 .cindex "VRFY" "ACL for"
27827 .cindex "SMTP" "connection, ACL for"
27828 .cindex "non-SMTP messages" "ACLs for"
27829 .cindex "MIME content scanning" "ACL for"
27830 .cindex "PRDR" "ACL for"
27831
27832 .table2 140pt
27833 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27834 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27835 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27836 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27837 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27838 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27839 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27840 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27841 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27842 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27843 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27844 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27845 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27846 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27847 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27848 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27849 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27850 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27851 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27852 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27853 .endtable
27854
27855 For example, if you set
27856 .code
27857 acl_smtp_rcpt = small_acl
27858 .endd
27859 the little ACL defined above is used whenever Exim receives a RCPT command
27860 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27861 done when RCPT commands arrive. A rejection of RCPT should cause the
27862 sending MTA to give up on the recipient address contained in the RCPT
27863 command, whereas rejection at other times may cause the client MTA to keep on
27864 trying to deliver the message. It is therefore recommended that you do as much
27865 testing as possible at RCPT time.
27866
27867
27868 .section "The non-SMTP ACLs" "SECID190"
27869 .cindex "non-SMTP messages" "ACLs for"
27870 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27871 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27872 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27873 the state of the SMTP connection such as encryption and authentication) are not
27874 relevant and are forbidden in these ACLs. However, the sender and recipients
27875 are known, so the &%senders%& and &%sender_domains%& conditions and the
27876 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27877 &$authenticated_sender$& are also available. You can specify added header lines
27878 in any of these ACLs.
27879
27880 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27881 non-SMTP message, before any of the message has been read. (This is the
27882 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27883 batched SMTP input, it runs after the DATA command has been reached. The
27884 result of this ACL is ignored; it cannot be used to reject a message. If you
27885 really need to, you could set a value in an ACL variable here and reject based
27886 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27887 controls, and in particular, it can be used to set
27888 .code
27889 control = suppress_local_fixups
27890 .endd
27891 This cannot be used in the other non-SMTP ACLs because by the time they are
27892 run, it is too late.
27893
27894 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27895 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27896
27897 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27898 kind of rejection is treated as permanent, because there is no way of sending a
27899 temporary error for these kinds of message.
27900
27901
27902 .section "The SMTP connect ACL" "SECID191"
27903 .cindex "SMTP" "connection, ACL for"
27904 .oindex &%smtp_banner%&
27905 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27906 session, after the test specified by &%host_reject_connection%& (which is now
27907 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27908 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27909 the message override the banner message that is otherwise specified by the
27910 &%smtp_banner%& option.
27911
27912
27913 .section "The EHLO/HELO ACL" "SECID192"
27914 .cindex "EHLO" "ACL for"
27915 .cindex "HELO" "ACL for"
27916 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27917 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27918 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27919 Note that a client may issue more than one EHLO or HELO command in an SMTP
27920 session, and indeed is required to issue a new EHLO or HELO after successfully
27921 setting up encryption following a STARTTLS command.
27922
27923 Note also that a deny neither forces the client to go away nor means that
27924 mail will be refused on the connection.  Consider checking for
27925 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27926
27927 If the command is accepted by an &%accept%& verb that has a &%message%&
27928 modifier, the message may not contain more than one line (it will be truncated
27929 at the first newline and a panic logged if it does). Such a message cannot
27930 affect the EHLO options that are listed on the second and subsequent lines of
27931 an EHLO response.
27932
27933
27934 .section "The DATA ACLs" "SECID193"
27935 .cindex "DATA" "ACLs for"
27936 Two ACLs are associated with the DATA command, because it is two-stage
27937 command, with two responses being sent to the client.
27938 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27939 is obeyed. This gives you control after all the RCPT commands, but before
27940 the message itself is received. It offers the opportunity to give a negative
27941 response to the DATA command before the data is transmitted. Header lines
27942 added by MAIL or RCPT ACLs are not visible at this time, but any that
27943 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27944
27945 You cannot test the contents of the message, for example, to verify addresses
27946 in the headers, at RCPT time or when the DATA command is received. Such
27947 tests have to appear in the ACL that is run after the message itself has been
27948 received, before the final response to the DATA command is sent. This is
27949 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27950 associated with the DATA command.
27951
27952 .new
27953 .cindex CHUNKING "BDAT command"
27954 .cindex BDAT "SMTP command"
27955 .cindex "RFC 3030" CHUNKING
27956 If CHUNKING was advertised and a BDAT command sequence is received,
27957 the &%acl_smtp_predata%& ACL is not run.
27958 . XXX why not?  It should be possible, for the first BDAT.
27959 The &%acl_smtp_data%& is run after the last BDAT command and all of
27960 the data specified is received.
27961 .wen
27962
27963 For both of these ACLs, it is not possible to reject individual recipients. An
27964 error response rejects the entire message. Unfortunately, it is known that some
27965 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27966 before or after the data) correctly &-- they keep the message on their queues
27967 and try again later, but that is their problem, though it does waste some of
27968 your resources.
27969
27970 The &%acl_smtp_data%& ACL is run after
27971 the &%acl_smtp_data_prdr%&,
27972 the &%acl_smtp_dkim%&
27973 and the &%acl_smtp_mime%& ACLs.
27974
27975 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27976 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27977 enabled (which is the default).
27978
27979 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27980 received, and is executed for each DKIM signature found in a message.  If not
27981 otherwise specified, the default action is to accept.
27982
27983 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27984
27985 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27986
27987
27988 .section "The SMTP MIME ACL" "SECID194"
27989 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27990 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27991
27992 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27993
27994
27995 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27996 .cindex "PRDR" "ACL for"
27997 .oindex "&%prdr_enable%&"
27998 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27999 with PRDR support enabled (which is the default).
28000 It becomes active only when the PRDR feature is negotiated between
28001 client and server for a message, and more than one recipient
28002 has been accepted.
28003
28004 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28005 has been received, and is executed once for each recipient of the message
28006 with &$local_part$& and &$domain$& valid.
28007 The test may accept, defer or deny for individual recipients.
28008 The &%acl_smtp_data%& will still be called after this ACL and
28009 can reject the message overall, even if this ACL has accepted it
28010 for some or all recipients.
28011
28012 PRDR may be used to support per-user content filtering.  Without it
28013 one must defer any recipient after the first that has a different
28014 content-filter configuration.  With PRDR, the RCPT-time check
28015 .cindex "PRDR" "variable for"
28016 for this can be disabled when the variable &$prdr_requested$&
28017 is &"yes"&.
28018 Any required difference in behaviour of the main DATA-time
28019 ACL should however depend on the PRDR-time ACL having run, as Exim
28020 will avoid doing so in some situations (e.g.  single-recipient mails).
28021
28022 See also the &%prdr_enable%& global option
28023 and the &%hosts_try_prdr%& smtp transport option.
28024
28025 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28026 If the ACL is not defined, processing completes as if
28027 the feature was not requested by the client.
28028
28029 .section "The QUIT ACL" "SECTQUITACL"
28030 .cindex "QUIT, ACL for"
28031 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28032 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28033 does not in fact control any access.
28034 For this reason, it may only accept
28035 or warn as its final result.
28036
28037 This ACL can be used for tasks such as custom logging at the end of an SMTP
28038 session. For example, you can use ACL variables in other ACLs to count
28039 messages, recipients, etc., and log the totals at QUIT time using one or
28040 more &%logwrite%& modifiers on a &%warn%& verb.
28041
28042 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28043 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28044
28045 You do not need to have a final &%accept%&, but if you do, you can use a
28046 &%message%& modifier to specify custom text that is sent as part of the 221
28047 response to QUIT.
28048
28049 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28050 failure (for example, failure to open a log file, or when Exim is bombing out
28051 because it has detected an unrecoverable error), all SMTP commands from the
28052 client are given temporary error responses until QUIT is received or the
28053 connection is closed. In these special cases, the QUIT ACL does not run.
28054
28055
28056 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28057 .vindex &$acl_smtp_notquit$&
28058 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28059 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28060 trouble, such as being unable to write to its log files, this ACL is not run,
28061 because it might try to do things (such as write to log files) that make the
28062 situation even worse.
28063
28064 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28065 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28066 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28067 and &%warn%&.
28068
28069 .vindex &$smtp_notquit_reason$&
28070 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28071 to a string that indicates the reason for the termination of the SMTP
28072 connection. The possible values are:
28073 .table2
28074 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28075 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28076 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28077 .irow &`connection-lost`&          "The SMTP connection has been lost"
28078 .irow &`data-timeout`&             "Timeout while reading message data"
28079 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28080 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28081 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28082 .irow &`synchronization-error`&    "SMTP synchronization error"
28083 .irow &`tls-failed`&               "TLS failed to start"
28084 .endtable
28085 In most cases when an SMTP connection is closed without having received QUIT,
28086 Exim sends an SMTP response message before actually closing the connection.
28087 With the exception of the &`acl-drop`& case, the default message can be
28088 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28089 &%drop%& verb in another ACL, it is the message from the other ACL that is
28090 used.
28091
28092
28093 .section "Finding an ACL to use" "SECID195"
28094 .cindex "&ACL;" "finding which to use"
28095 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28096 you can use different ACLs in different circumstances. For example,
28097 .code
28098 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28099                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28100 .endd
28101 In the default configuration file there are some example settings for
28102 providing an RFC 4409 message submission service on port 587 and a
28103 non-standard &"smtps"& service on port 465. You can use a string
28104 expansion like this to choose an ACL for MUAs on these ports which is
28105 more appropriate for this purpose than the default ACL on port 25.
28106
28107 The expanded string does not have to be the name of an ACL in the
28108 configuration file; there are other possibilities. Having expanded the
28109 string, Exim searches for an ACL as follows:
28110
28111 .ilist
28112 If the string begins with a slash, Exim uses it as a file name, and reads its
28113 contents as an ACL. The lines are processed in the same way as lines in the
28114 Exim configuration file. In particular, continuation lines are supported, blank
28115 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28116 If the file does not exist or cannot be read, an error occurs (typically
28117 causing a temporary failure of whatever caused the ACL to be run). For example:
28118 .code
28119 acl_smtp_data = /etc/acls/\
28120   ${lookup{$sender_host_address}lsearch\
28121   {/etc/acllist}{$value}{default}}
28122 .endd
28123 This looks up an ACL file to use on the basis of the host's IP address, falling
28124 back to a default if the lookup fails. If an ACL is successfully read from a
28125 file, it is retained in memory for the duration of the Exim process, so that it
28126 can be re-used without having to re-read the file.
28127 .next
28128 If the string does not start with a slash, and does not contain any spaces,
28129 Exim searches the ACL section of the configuration for an ACL whose name
28130 matches the string.
28131 .next
28132 If no named ACL is found, or if the string contains spaces, Exim parses
28133 the string as an inline ACL. This can save typing in cases where you just
28134 want to have something like
28135 .code
28136 acl_smtp_vrfy = accept
28137 .endd
28138 in order to allow free use of the VRFY command. Such a string may contain
28139 newlines; it is processed in the same way as an ACL that is read from a file.
28140 .endlist
28141
28142
28143
28144
28145 .section "ACL return codes" "SECID196"
28146 .cindex "&ACL;" "return codes"
28147 Except for the QUIT ACL, which does not affect the SMTP return code (see
28148 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28149 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28150 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28151 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28152 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28153 This also causes a 4&'xx'& return code.
28154
28155 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28156 &"deny"&, because there is no mechanism for passing temporary errors to the
28157 submitters of non-SMTP messages.
28158
28159
28160 ACLs that are relevant to message reception may also return &"discard"&. This
28161 has the effect of &"accept"&, but causes either the entire message or an
28162 individual recipient address to be discarded. In other words, it is a
28163 blackholing facility. Use it with care.
28164
28165 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28166 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28167 RCPT ACL is to discard just the one recipient address. If there are no
28168 recipients left when the message's data is received, the DATA ACL is not
28169 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28170 remaining recipients. The &"discard"& return is not permitted for the
28171 &%acl_smtp_predata%& ACL.
28172
28173 .new
28174 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28175 is done on the address and the result determines the SMTP response.
28176 .wen
28177
28178
28179 .cindex "&[local_scan()]& function" "when all recipients discarded"
28180 The &[local_scan()]& function is always run, even if there are no remaining
28181 recipients; it may create new recipients.
28182
28183
28184
28185 .section "Unset ACL options" "SECID197"
28186 .cindex "&ACL;" "unset options"
28187 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28188 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28189 not defined at all. For any defined ACL, the default action when control
28190 reaches the end of the ACL statements is &"deny"&.
28191
28192 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28193 these two are ACLs that are used only for their side effects. They cannot be
28194 used to accept or reject anything.
28195
28196 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28197 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28198 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28199 when the ACL is not defined is &"accept"&.
28200
28201 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28202 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28203 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28204 messages over an SMTP connection. For an example, see the ACL in the default
28205 configuration file.
28206
28207
28208
28209
28210 .section "Data for message ACLs" "SECID198"
28211 .cindex "&ACL;" "data for message ACL"
28212 .vindex &$domain$&
28213 .vindex &$local_part$&
28214 .vindex &$sender_address$&
28215 .vindex &$sender_host_address$&
28216 .vindex &$smtp_command$&
28217 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28218 that contain information about the host and the message's sender (for example,
28219 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28220 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28221 &$local_part$& are set from the argument address. The entire SMTP command
28222 is available in &$smtp_command$&.
28223
28224 When an ACL for the AUTH parameter of MAIL is running, the variables that
28225 contain information about the host are set, but &$sender_address$& is not yet
28226 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28227 how it is used.
28228
28229 .vindex "&$message_size$&"
28230 The &$message_size$& variable is set to the value of the SIZE parameter on
28231 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28232 that parameter is not given. The value is updated to the true message size by
28233 the time the final DATA ACL is run (after the message data has been
28234 received).
28235
28236 .vindex "&$rcpt_count$&"
28237 .vindex "&$recipients_count$&"
28238 The &$rcpt_count$& variable increases by one for each RCPT command received.
28239 The &$recipients_count$& variable increases by one each time a RCPT command is
28240 accepted, so while an ACL for RCPT is being processed, it contains the number
28241 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28242 &$rcpt_count$& contains the total number of RCPT commands, and
28243 &$recipients_count$& contains the total number of accepted recipients.
28244
28245
28246
28247
28248
28249 .section "Data for non-message ACLs" "SECTdatfornon"
28250 .cindex "&ACL;" "data for non-message ACL"
28251 .vindex &$smtp_command_argument$&
28252 .vindex &$smtp_command$&
28253 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28254 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28255 and the entire SMTP command is available in &$smtp_command$&.
28256 These variables can be tested using a &%condition%& condition. For example,
28257 here is an ACL for use with AUTH, which insists that either the session is
28258 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28259 does not permit authentication methods that use cleartext passwords on
28260 unencrypted connections.
28261 .code
28262 acl_check_auth:
28263   accept encrypted = *
28264   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28265                      {CRAM-MD5}}
28266   deny   message   = TLS encryption or CRAM-MD5 required
28267 .endd
28268 (Another way of applying this restriction is to arrange for the authenticators
28269 that use cleartext passwords not to be advertised when the connection is not
28270 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28271 option to do this.)
28272
28273
28274
28275 .section "Format of an ACL" "SECID199"
28276 .cindex "&ACL;" "format of"
28277 .cindex "&ACL;" "verbs, definition of"
28278 An individual ACL consists of a number of statements. Each statement starts
28279 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28280 Modifiers can change the way the verb operates, define error and log messages,
28281 set variables, insert delays, and vary the processing of accepted messages.
28282
28283 If all the conditions are met, the verb is obeyed. The same condition may be
28284 used (with different arguments) more than once in the same statement. This
28285 provides a means of specifying an &"and"& conjunction between conditions. For
28286 example:
28287 .code
28288 deny  dnslists = list1.example
28289       dnslists = list2.example
28290 .endd
28291 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28292 the conditions and modifiers when it reaches a condition that fails. What
28293 happens then depends on the verb (and in one case, on a special modifier). Not
28294 all the conditions make sense at every testing point. For example, you cannot
28295 test a sender address in the ACL that is run for a VRFY command.
28296
28297
28298 .section "ACL verbs" "SECID200"
28299 The ACL verbs are as follows:
28300
28301 .ilist
28302 .cindex "&%accept%& ACL verb"
28303 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28304 of the conditions are not met, what happens depends on whether &%endpass%&
28305 appears among the conditions (for syntax see below). If the failing condition
28306 is before &%endpass%&, control is passed to the next ACL statement; if it is
28307 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28308 check a RCPT command:
28309 .code
28310 accept domains = +local_domains
28311        endpass
28312        verify = recipient
28313 .endd
28314 If the recipient domain does not match the &%domains%& condition, control
28315 passes to the next statement. If it does match, the recipient is verified, and
28316 the command is accepted if verification succeeds. However, if verification
28317 fails, the ACL yields &"deny"&, because the failing condition is after
28318 &%endpass%&.
28319
28320 The &%endpass%& feature has turned out to be confusing to many people, so its
28321 use is not recommended nowadays. It is always possible to rewrite an ACL so
28322 that &%endpass%& is not needed, and it is no longer used in the default
28323 configuration.
28324
28325 .cindex "&%message%& ACL modifier" "with &%accept%&"
28326 If a &%message%& modifier appears on an &%accept%& statement, its action
28327 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28328 (when an &%accept%& verb either accepts or passes control to the next
28329 statement), &%message%& can be used to vary the message that is sent when an
28330 SMTP command is accepted. For example, in a RCPT ACL you could have:
28331 .display
28332 &`accept  `&<&'some conditions'&>
28333 &`        message = OK, I will allow you through today`&
28334 .endd
28335 You can specify an SMTP response code, optionally followed by an &"extended
28336 response code"& at the start of the message, but the first digit must be the
28337 same as would be sent by default, which is 2 for an &%accept%& verb.
28338
28339 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28340 an error message that is used when access is denied. This behaviour is retained
28341 for backward compatibility, but current &"best practice"& is to avoid the use
28342 of &%endpass%&.
28343
28344
28345 .next
28346 .cindex "&%defer%& ACL verb"
28347 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28348 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28349 &%defer%& is the same as &%deny%&, because there is no way of sending a
28350 temporary error. For a RCPT command, &%defer%& is much the same as using a
28351 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28352 be used in any ACL, and even for a recipient it might be a simpler approach.
28353
28354
28355 .next
28356 .cindex "&%deny%& ACL verb"
28357 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28358 the conditions are not met, control is passed to the next ACL statement. For
28359 example,
28360 .code
28361 deny dnslists = blackholes.mail-abuse.org
28362 .endd
28363 rejects commands from hosts that are on a DNS black list.
28364
28365
28366 .next
28367 .cindex "&%discard%& ACL verb"
28368 &%discard%&: This verb behaves like &%accept%&, except that it returns
28369 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28370 that are concerned with receiving messages. When all the conditions are true,
28371 the sending entity receives a &"success"& response. However, &%discard%& causes
28372 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28373 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28374 message's recipients are discarded. Recipients that are discarded before DATA
28375 do not appear in the log line when the &%received_recipients%& log selector is set.
28376
28377 If the &%log_message%& modifier is set when &%discard%& operates,
28378 its contents are added to the line that is automatically written to the log.
28379 The &%message%& modifier operates exactly as it does for &%accept%&.
28380
28381
28382 .next
28383 .cindex "&%drop%& ACL verb"
28384 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28385 forcibly closed after the 5&'xx'& error message has been sent. For example:
28386 .code
28387 drop   message   = I don't take more than 20 RCPTs
28388        condition = ${if > {$rcpt_count}{20}}
28389 .endd
28390 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28391 The connection is always dropped after sending a 550 response.
28392
28393 .next
28394 .cindex "&%require%& ACL verb"
28395 &%require%&: If all the conditions are met, control is passed to the next ACL
28396 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28397 example, when checking a RCPT command,
28398 .code
28399 require message = Sender did not verify
28400         verify  = sender
28401 .endd
28402 passes control to subsequent statements only if the message's sender can be
28403 verified. Otherwise, it rejects the command. Note the positioning of the
28404 &%message%& modifier, before the &%verify%& condition. The reason for this is
28405 discussed in section &<<SECTcondmodproc>>&.
28406
28407 .next
28408 .cindex "&%warn%& ACL verb"
28409 &%warn%&: If all the conditions are true, a line specified by the
28410 &%log_message%& modifier is written to Exim's main log. Control always passes
28411 to the next ACL statement. If any condition is false, the log line is not
28412 written. If an identical log line is requested several times in the same
28413 message, only one copy is actually written to the log. If you want to force
28414 duplicates to be written, use the &%logwrite%& modifier instead.
28415
28416 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28417 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28418 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28419 first failing condition. There is more about adding header lines in section
28420 &<<SECTaddheadacl>>&.
28421
28422 If any condition on a &%warn%& statement cannot be completed (that is, there is
28423 some sort of defer), the log line specified by &%log_message%& is not written.
28424 This does not include the case of a forced failure from a lookup, which
28425 is considered to be a successful completion. After a defer, no further
28426 conditions or modifiers in the &%warn%& statement are processed. The incident
28427 is logged, and the ACL continues to be processed, from the next statement
28428 onwards.
28429
28430
28431 .vindex "&$acl_verify_message$&"
28432 When one of the &%warn%& conditions is an address verification that fails, the
28433 text of the verification failure message is in &$acl_verify_message$&. If you
28434 want this logged, you must set it up explicitly. For example:
28435 .code
28436 warn   !verify = sender
28437        log_message = sender verify failed: $acl_verify_message
28438 .endd
28439 .endlist
28440
28441 At the end of each ACL there is an implicit unconditional &%deny%&.
28442
28443 As you can see from the examples above, the conditions and modifiers are
28444 written one to a line, with the first one on the same line as the verb, and
28445 subsequent ones on following lines. If you have a very long condition, you can
28446 continue it onto several physical lines by the usual backslash continuation
28447 mechanism. It is conventional to align the conditions vertically.
28448
28449
28450
28451 .section "ACL variables" "SECTaclvariables"
28452 .cindex "&ACL;" "variables"
28453 There are some special variables that can be set during ACL processing. They
28454 can be used to pass information between different ACLs, different invocations
28455 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28456 transports, and filters that are used to deliver a message. The names of these
28457 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28458 an underscore, but the remainder of the name can be any sequence of
28459 alphanumeric characters and underscores that you choose. There is no limit on
28460 the number of ACL variables. The two sets act as follows:
28461 .ilist
28462 The values of those variables whose names begin with &$acl_c$& persist
28463 throughout an SMTP connection. They are never reset. Thus, a value that is set
28464 while receiving one message is still available when receiving the next message
28465 on the same SMTP connection.
28466 .next
28467 The values of those variables whose names begin with &$acl_m$& persist only
28468 while a message is being received. They are reset afterwards. They are also
28469 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28470 .endlist
28471
28472 When a message is accepted, the current values of all the ACL variables are
28473 preserved with the message and are subsequently made available at delivery
28474 time. The ACL variables are set by a modifier called &%set%&. For example:
28475 .code
28476 accept hosts = whatever
28477        set acl_m4 = some value
28478 accept authenticated = *
28479        set acl_c_auth = yes
28480 .endd
28481 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28482 be set. If you want to set a variable without taking any action, you can use a
28483 &%warn%& verb without any other modifiers or conditions.
28484
28485 .oindex &%strict_acl_vars%&
28486 What happens if a syntactically valid but undefined ACL variable is
28487 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28488 false (the default), an empty string is substituted; if it is true, an
28489 error is generated.
28490
28491 Versions of Exim before 4.64 have a limited set of numbered variables, but
28492 their names are compatible, so there is no problem with upgrading.
28493
28494
28495 .section "Condition and modifier processing" "SECTcondmodproc"
28496 .cindex "&ACL;" "conditions; processing"
28497 .cindex "&ACL;" "modifiers; processing"
28498 An exclamation mark preceding a condition negates its result. For example:
28499 .code
28500 deny   domains = *.dom.example
28501       !verify  = recipient
28502 .endd
28503 causes the ACL to return &"deny"& if the recipient domain ends in
28504 &'dom.example'& and the recipient address cannot be verified. Sometimes
28505 negation can be used on the right-hand side of a condition. For example, these
28506 two statements are equivalent:
28507 .code
28508 deny  hosts = !192.168.3.4
28509 deny !hosts =  192.168.3.4
28510 .endd
28511 However, for many conditions (&%verify%& being a good example), only left-hand
28512 side negation of the whole condition is possible.
28513
28514 The arguments of conditions and modifiers are expanded. A forced failure
28515 of an expansion causes a condition to be ignored, that is, it behaves as if the
28516 condition is true. Consider these two statements:
28517 .code
28518 accept  senders = ${lookup{$host_name}lsearch\
28519                   {/some/file}{$value}fail}
28520 accept  senders = ${lookup{$host_name}lsearch\
28521                   {/some/file}{$value}{}}
28522 .endd
28523 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28524 the returned list is searched, but if the lookup fails the behaviour is
28525 different in the two cases. The &%fail%& in the first statement causes the
28526 condition to be ignored, leaving no further conditions. The &%accept%& verb
28527 therefore succeeds. The second statement, however, generates an empty list when
28528 the lookup fails. No sender can match an empty list, so the condition fails,
28529 and therefore the &%accept%& also fails.
28530
28531 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28532 specify actions that are taken as the conditions for a statement are checked;
28533 others specify text for messages that are used when access is denied or a
28534 warning is generated. The &%control%& modifier affects the way an incoming
28535 message is handled.
28536
28537 The positioning of the modifiers in an ACL statement is important, because the
28538 processing of a verb ceases as soon as its outcome is known. Only those
28539 modifiers that have already been encountered will take effect. For example,
28540 consider this use of the &%message%& modifier:
28541 .code
28542 require message = Can't verify sender
28543         verify  = sender
28544         message = Can't verify recipient
28545         verify  = recipient
28546         message = This message cannot be used
28547 .endd
28548 If sender verification fails, Exim knows that the result of the statement is
28549 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28550 so its text is used as the error message. If sender verification succeeds, but
28551 recipient verification fails, the second message is used. If recipient
28552 verification succeeds, the third message becomes &"current"&, but is never used
28553 because there are no more conditions to cause failure.
28554
28555 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28556 modifier that is used, because all the conditions must be true for rejection to
28557 happen. Specifying more than one &%message%& modifier does not make sense, and
28558 the message can even be specified after all the conditions. For example:
28559 .code
28560 deny   hosts = ...
28561       !senders = *@my.domain.example
28562        message = Invalid sender from client host
28563 .endd
28564 The &"deny"& result does not happen until the end of the statement is reached,
28565 by which time Exim has set up the message.
28566
28567
28568
28569 .section "ACL modifiers" "SECTACLmodi"
28570 .cindex "&ACL;" "modifiers; list of"
28571 The ACL modifiers are as follows:
28572
28573 .vlist
28574 .vitem &*add_header*&&~=&~<&'text'&>
28575 This modifier specifies one or more header lines that are to be added to an
28576 incoming message, assuming, of course, that the message is ultimately
28577 accepted. For details, see section &<<SECTaddheadacl>>&.
28578
28579 .vitem &*continue*&&~=&~<&'text'&>
28580 .cindex "&%continue%& ACL modifier"
28581 .cindex "database" "updating in ACL"
28582 This modifier does nothing of itself, and processing of the ACL always
28583 continues with the next condition or modifier. The value of &%continue%& is in
28584 the side effects of expanding its argument. Typically this could be used to
28585 update a database. It is really just a syntactic tidiness, to avoid having to
28586 write rather ugly lines like this:
28587 .display
28588 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28589 .endd
28590 Instead, all you need is
28591 .display
28592 &`continue = `&<&'some expansion'&>
28593 .endd
28594
28595 .vitem &*control*&&~=&~<&'text'&>
28596 .cindex "&%control%& ACL modifier"
28597 This modifier affects the subsequent processing of the SMTP connection or of an
28598 incoming message that is accepted. The effect of the first type of control
28599 lasts for the duration of the connection, whereas the effect of the second type
28600 lasts only until the current message has been received. The message-specific
28601 controls always apply to the whole message, not to individual recipients,
28602 even if the &%control%& modifier appears in a RCPT ACL.
28603
28604 As there are now quite a few controls that can be applied, they are described
28605 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28606 in several different ways. For example:
28607
28608 . ==== As this is a nested list, any displays it contains must be indented
28609 . ==== as otherwise they are too far to the left. That comment applies only
28610 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28611 . ==== way.
28612
28613 .ilist
28614 It can be at the end of an &%accept%& statement:
28615 .code
28616     accept  ...some conditions
28617             control = queue_only
28618 .endd
28619 In this case, the control is applied when this statement yields &"accept"&, in
28620 other words, when the conditions are all true.
28621
28622 .next
28623 It can be in the middle of an &%accept%& statement:
28624 .code
28625     accept  ...some conditions...
28626             control = queue_only
28627             ...some more conditions...
28628 .endd
28629 If the first set of conditions are true, the control is applied, even if the
28630 statement does not accept because one of the second set of conditions is false.
28631 In this case, some subsequent statement must yield &"accept"& for the control
28632 to be relevant.
28633
28634 .next
28635 It can be used with &%warn%& to apply the control, leaving the
28636 decision about accepting or denying to a subsequent verb. For
28637 example:
28638 .code
28639     warn    ...some conditions...
28640             control = freeze
28641     accept  ...
28642 .endd
28643 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28644 &%logwrite%&, so it does not add anything to the message and does not write a
28645 log entry.
28646
28647 .next
28648 If you want to apply a control unconditionally, you can use it with a
28649 &%require%& verb. For example:
28650 .code
28651     require  control = no_multiline_responses
28652 .endd
28653 .endlist
28654
28655 .vitem &*delay*&&~=&~<&'time'&>
28656 .cindex "&%delay%& ACL modifier"
28657 .oindex "&%-bh%&"
28658 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28659 the time interval before proceeding. However, when testing Exim using the
28660 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28661 output instead). The time is given in the usual Exim notation, and the delay
28662 happens as soon as the modifier is processed. In an SMTP session, pending
28663 output is flushed before the delay is imposed.
28664
28665 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28666 example:
28667 .code
28668 deny    ...some conditions...
28669         delay = 30s
28670 .endd
28671 The delay happens if all the conditions are true, before the statement returns
28672 &"deny"&. Compare this with:
28673 .code
28674 deny    delay = 30s
28675         ...some conditions...
28676 .endd
28677 which waits for 30s before processing the conditions. The &%delay%& modifier
28678 can also be used with &%warn%& and together with &%control%&:
28679 .code
28680 warn    ...some conditions...
28681         delay = 2m
28682         control = freeze
28683 accept  ...
28684 .endd
28685
28686 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28687 responses to several commands are no longer buffered and sent in one packet (as
28688 they would normally be) because all output is flushed before imposing the
28689 delay. This optimization is disabled so that a number of small delays do not
28690 appear to the client as one large aggregated delay that might provoke an
28691 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28692 using a &%control%& modifier to set &%no_delay_flush%&.
28693
28694
28695 .vitem &*endpass*&
28696 .cindex "&%endpass%& ACL modifier"
28697 This modifier, which has no argument, is recognized only in &%accept%& and
28698 &%discard%& statements. It marks the boundary between the conditions whose
28699 failure causes control to pass to the next statement, and the conditions whose
28700 failure causes the ACL to return &"deny"&. This concept has proved to be
28701 confusing to some people, so the use of &%endpass%& is no longer recommended as
28702 &"best practice"&. See the description of &%accept%& above for more details.
28703
28704
28705 .vitem &*log_message*&&~=&~<&'text'&>
28706 .cindex "&%log_message%& ACL modifier"
28707 This modifier sets up a message that is used as part of the log message if the
28708 ACL denies access or a &%warn%& statement's conditions are true. For example:
28709 .code
28710 require log_message = wrong cipher suite $tls_in_cipher
28711         encrypted   = DES-CBC3-SHA
28712 .endd
28713 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28714 example:
28715 .display
28716 &`discard `&<&'some conditions'&>
28717 &`        log_message = Discarded $local_part@$domain because...`&
28718 .endd
28719 When access is denied, &%log_message%& adds to any underlying error message
28720 that may exist because of a condition failure. For example, while verifying a
28721 recipient address, a &':fail:'& redirection might have already set up a
28722 message.
28723
28724 The message may be defined before the conditions to which it applies, because
28725 the string expansion does not happen until Exim decides that access is to be
28726 denied. This means that any variables that are set by the condition are
28727 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28728 variables are set after a DNS black list lookup succeeds. If the expansion of
28729 &%log_message%& fails, or if the result is an empty string, the modifier is
28730 ignored.
28731
28732 .vindex "&$acl_verify_message$&"
28733 If you want to use a &%warn%& statement to log the result of an address
28734 verification, you can use &$acl_verify_message$& to include the verification
28735 error message.
28736
28737 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28738 the start of the logged message. If the same warning log message is requested
28739 more than once while receiving  a single email message, only one copy is
28740 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28741 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28742 is logged for a successful &%warn%& statement.
28743
28744 If &%log_message%& is not present and there is no underlying error message (for
28745 example, from the failure of address verification), but &%message%& is present,
28746 the &%message%& text is used for logging rejections. However, if any text for
28747 logging contains newlines, only the first line is logged. In the absence of
28748 both &%log_message%& and &%message%&, a default built-in message is used for
28749 logging rejections.
28750
28751
28752 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28753 .cindex "&%log_reject_target%& ACL modifier"
28754 .cindex "logging in ACL" "specifying which log"
28755 This modifier makes it possible to specify which logs are used for messages
28756 about ACL rejections. Its argument is a colon-separated list of words that can
28757 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28758 may be empty, in which case a rejection is not logged at all. For example, this
28759 ACL fragment writes no logging information when access is denied:
28760 .display
28761 &`deny `&<&'some conditions'&>
28762 &`     log_reject_target =`&
28763 .endd
28764 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28765 permanent and temporary rejections. Its effect lasts for the rest of the
28766 current ACL.
28767
28768
28769 .vitem &*logwrite*&&~=&~<&'text'&>
28770 .cindex "&%logwrite%& ACL modifier"
28771 .cindex "logging in ACL" "immediate"
28772 This modifier writes a message to a log file as soon as it is encountered when
28773 processing an ACL. (Compare &%log_message%&, which, except in the case of
28774 &%warn%& and &%discard%&, is used only if the ACL statement denies
28775 access.) The &%logwrite%& modifier can be used to log special incidents in
28776 ACLs. For example:
28777 .display
28778 &`accept `&<&'some special conditions'&>
28779 &`       control  = freeze`&
28780 &`       logwrite = froze message because ...`&
28781 .endd
28782 By default, the message is written to the main log. However, it may begin
28783 with a colon, followed by a comma-separated list of log names, and then
28784 another colon, to specify exactly which logs are to be written. For
28785 example:
28786 .code
28787 logwrite = :main,reject: text for main and reject logs
28788 logwrite = :panic: text for panic log only
28789 .endd
28790
28791
28792 .vitem &*message*&&~=&~<&'text'&>
28793 .cindex "&%message%& ACL modifier"
28794 This modifier sets up a text string that is expanded and used as a response
28795 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28796 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28797 there is some complication if &%endpass%& is involved; see the description of
28798 &%accept%& for details.)
28799
28800 The expansion of the message happens at the time Exim decides that the ACL is
28801 to end, not at the time it processes &%message%&. If the expansion fails, or
28802 generates an empty string, the modifier is ignored. Here is an example where
28803 &%message%& must be specified first, because the ACL ends with a rejection if
28804 the &%hosts%& condition fails:
28805 .code
28806 require  message = Host not recognized
28807          hosts = 10.0.0.0/8
28808 .endd
28809 (Once a condition has failed, no further conditions or modifiers are
28810 processed.)
28811
28812 .cindex "SMTP" "error codes"
28813 .oindex "&%smtp_banner%&
28814 For ACLs that are triggered by SMTP commands, the message is returned as part
28815 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28816 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28817 is accepted. In the case of the connect ACL, accepting with a message modifier
28818 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28819 accept message may not contain more than one line (otherwise it will be
28820 truncated at the first newline and a panic logged), and it cannot affect the
28821 EHLO options.
28822
28823 When SMTP is involved, the message may begin with an overriding response code,
28824 consisting of three digits optionally followed by an &"extended response code"&
28825 of the form &'n.n.n'&, each code being followed by a space. For example:
28826 .code
28827 deny  message = 599 1.2.3 Host not welcome
28828       hosts = 192.168.34.0/24
28829 .endd
28830 The first digit of the supplied response code must be the same as would be sent
28831 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28832 access, but for the predata ACL, note that the default success code is 354, not
28833 2&'xx'&.
28834
28835 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28836 the message modifier cannot override the 221 response code.
28837
28838 The text in a &%message%& modifier is literal; any quotes are taken as
28839 literals, but because the string is expanded, backslash escapes are processed
28840 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28841 response.
28842
28843 .vindex "&$acl_verify_message$&"
28844 For ACLs that are called by an &%acl =%& ACL condition, the message is
28845 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28846
28847 If &%message%& is used on a statement that verifies an address, the message
28848 specified overrides any message that is generated by the verification process.
28849 However, the original message is available in the variable
28850 &$acl_verify_message$&, so you can incorporate it into your message if you
28851 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28852 routers to be passed back as part of the SMTP response, you should either not
28853 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28854
28855 For compatibility with previous releases of Exim, a &%message%& modifier that
28856 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28857 modifier, but this usage is now deprecated. However, &%message%& acts only when
28858 all the conditions are true, wherever it appears in an ACL command, whereas
28859 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28860 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28861 effect.
28862
28863
28864 .new
28865 .vitem &*queue*&&~=&~<&'text'&>
28866 This modifier specifies the use of a named queue for spool files
28867 for the message.
28868 It can only be used before the message is received (i.e. not in
28869 the DATA ACL).
28870 This could be used, for example, for known high-volume burst sources
28871 of traffic, or for quarantine of messages.
28872 Separate queue-runner processes will be needed for named queues.
28873 If the text after expansion is empty, the default queue is used.
28874 .wen
28875
28876
28877 .vitem &*remove_header*&&~=&~<&'text'&>
28878 This modifier specifies one or more header names in a colon-separated list
28879  that are to be removed from an incoming message, assuming, of course, that
28880 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28881
28882
28883 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28884 .cindex "&%set%& ACL modifier"
28885 This modifier puts a value into one of the ACL variables (see section
28886 &<<SECTaclvariables>>&).
28887
28888
28889 .vitem &*udpsend*&&~=&~<&'parameters'&>
28890 This modifier sends a UDP packet, for purposes such as statistics
28891 collection or behaviour monitoring. The parameters are expanded, and
28892 the result of the expansion must be a colon-separated list consisting
28893 of a destination server, port number, and the packet contents. The
28894 server can be specified as a host name or IPv4 or IPv6 address. The
28895 separator can be changed with the usual angle bracket syntax. For
28896 example, you might want to collect information on which hosts connect
28897 when:
28898 .code
28899 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28900              $tod_zulu $sender_host_address
28901 .endd
28902 .endlist
28903
28904
28905
28906
28907 .section "Use of the control modifier" "SECTcontrols"
28908 .cindex "&%control%& ACL modifier"
28909 The &%control%& modifier supports the following settings:
28910
28911 .vlist
28912 .vitem &*control&~=&~allow_auth_unadvertised*&
28913 This modifier allows a client host to use the SMTP AUTH command even when it
28914 has not been advertised in response to EHLO. Furthermore, because there are
28915 apparently some really broken clients that do this, Exim will accept AUTH after
28916 HELO (rather than EHLO) when this control is set. It should be used only if you
28917 really need it, and you should limit its use to those broken clients that do
28918 not work without it. For example:
28919 .code
28920 warn hosts   = 192.168.34.25
28921      control = allow_auth_unadvertised
28922 .endd
28923 Normally, when an Exim server receives an AUTH command, it checks the name of
28924 the authentication mechanism that is given in the command to ensure that it
28925 matches an advertised mechanism. When this control is set, the check that a
28926 mechanism has been advertised is bypassed. Any configured mechanism can be used
28927 by the client. This control is permitted only in the connection and HELO ACLs.
28928
28929
28930 .vitem &*control&~=&~caseful_local_part*& &&&
28931        &*control&~=&~caselower_local_part*&
28932 .cindex "&ACL;" "case of local part in"
28933 .cindex "case of local parts"
28934 .vindex "&$local_part$&"
28935 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28936 (that is, during RCPT processing). By default, the contents of &$local_part$&
28937 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28938 any uppercase letters in the original local part are restored in &$local_part$&
28939 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28940 is encountered.
28941
28942 These controls affect only the current recipient. Moreover, they apply only to
28943 local part handling that takes place directly in the ACL (for example, as a key
28944 in lookups). If a test to verify the recipient is obeyed, the case-related
28945 handling of the local part during the verification is controlled by the router
28946 configuration (see the &%caseful_local_part%& generic router option).
28947
28948 This facility could be used, for example, to add a spam score to local parts
28949 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28950 spam score:
28951 .code
28952 warn  control = caseful_local_part
28953       set acl_m4 = ${eval:\
28954                      $acl_m4 + \
28955                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28956                     }
28957       control = caselower_local_part
28958 .endd
28959 Notice that we put back the lower cased version afterwards, assuming that
28960 is what is wanted for subsequent tests.
28961
28962
28963 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
28964 .cindex "&ACL;" "cutthrough routing"
28965 .cindex "cutthrough" "requesting"
28966 This option requests delivery be attempted while the item is being received.
28967
28968 The option is usable in the RCPT ACL.
28969 If enabled for a message received via smtp and routed to an smtp transport,
28970 and only one transport, interface, destination host and port combination
28971 is used for all recipients of the message,
28972 then the delivery connection is made while the receiving connection is open
28973 and data is copied from one to the other.
28974
28975 An attempt to set this option for any recipient but the first
28976 for a mail will be quietly ignored.
28977 If a recipient-verify callout
28978 (with use_sender)
28979 connection is subsequently
28980 requested in the same ACL it is held open and used for
28981 any subsequent recipients and the data,
28982 otherwise one is made after the initial RCPT ACL completes.
28983
28984 Note that routers are used in verify mode,
28985 and cannot depend on content of received headers.
28986 Note also that headers cannot be
28987 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28988 Headers may be modified by routers (subject to the above) and transports.
28989
28990 All the usual ACLs are called; if one results in the message being
28991 rejected, all effort spent in delivery (including the costs on
28992 the ultimate destination) will be wasted.
28993 Note that in the case of data-time ACLs this includes the entire
28994 message body.
28995
28996 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28997 of outgoing messages is done, because it sends data to the ultimate destination
28998 before the entire message has been received from the source.
28999 It is not supported for messages received with the SMTP PRDR
29000 .new
29001 or CHUNKING
29002 .wen
29003 options in use.
29004
29005 Should the ultimate destination system positively accept or reject the mail,
29006 a corresponding indication is given to the source system and nothing is queued.
29007 If the item is successfully delivered in cutthrough mode
29008 the delivery log lines are tagged with ">>" rather than "=>" and appear
29009 before the acceptance "<=" line.
29010
29011 .new
29012 If there is a temporary error the item is queued for later delivery in the
29013 usual fashion.
29014 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29015 to the control; the default value is &"spool"& and the alternate value
29016 &"pass"& copies an SMTP defer response from the target back to the initiator
29017 and does not queue the message.
29018 Note that this is independent of any recipient verify conditions in the ACL.
29019 .wen
29020
29021 Delivery in this mode avoids the generation of a bounce mail to a
29022 (possibly faked)
29023 sender when the destination system is doing content-scan based rejection.
29024
29025
29026 .vitem &*control&~=&~debug/*&<&'options'&>
29027 .cindex "&ACL;" "enabling debug logging"
29028 .cindex "debugging" "enabling from an ACL"
29029 This control turns on debug logging, almost as though Exim had been invoked
29030 with &`-d`&, with the output going to a new logfile, by default called
29031 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
29032 may access any variables already defined.  The logging may be adjusted with
29033 the &'opts'& option, which takes the same values as the &`-d`& command-line
29034 option.
29035 .new
29036 Logging may be stopped, and the file removed, with the &'kill'& option.
29037 .wen
29038 Some examples (which depend on variables that don't exist in all
29039 contexts):
29040 .code
29041       control = debug
29042       control = debug/tag=.$sender_host_address
29043       control = debug/opts=+expand+acl
29044       control = debug/tag=.$message_exim_id/opts=+expand
29045       control = debug/kill
29046 .endd
29047
29048
29049 .vitem &*control&~=&~dkim_disable_verify*&
29050 .cindex "disable DKIM verify"
29051 .cindex "DKIM" "disable verify"
29052 This control turns off DKIM verification processing entirely.  For details on
29053 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
29054
29055
29056 .vitem &*control&~=&~dscp/*&<&'value'&>
29057 .cindex "&ACL;" "setting DSCP value"
29058 .cindex "DSCP" "inbound"
29059 This option causes the DSCP value associated with the socket for the inbound
29060 connection to be adjusted to a given value, given as one of a number of fixed
29061 strings or to numeric value.
29062 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29063 Common values include &`throughput`&, &`mincost`&, and on newer systems
29064 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29065
29066 The outbound packets from Exim will be marked with this value in the header
29067 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29068 that these values will have any effect, not be stripped by networking
29069 equipment, or do much of anything without cooperation with your Network
29070 Engineer and those of all network operators between the source and destination.
29071
29072
29073 .vitem &*control&~=&~enforce_sync*& &&&
29074        &*control&~=&~no_enforce_sync*&
29075 .cindex "SMTP" "synchronization checking"
29076 .cindex "synchronization checking in SMTP"
29077 These controls make it possible to be selective about when SMTP synchronization
29078 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29079 state of the switch (it is true by default). See the description of this option
29080 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29081
29082 The effect of these two controls lasts for the remainder of the SMTP
29083 connection. They can appear in any ACL except the one for the non-SMTP
29084 messages. The most straightforward place to put them is in the ACL defined by
29085 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29086 before the first synchronization check. The expected use is to turn off the
29087 synchronization checks for badly-behaved hosts that you nevertheless need to
29088 work with.
29089
29090
29091 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29092 .cindex "fake defer"
29093 .cindex "defer, fake"
29094 This control works in exactly the same way as &%fakereject%& (described below)
29095 except that it causes an SMTP 450 response after the message data instead of a
29096 550 response. You must take care when using &%fakedefer%& because it causes the
29097 messages to be duplicated when the sender retries. Therefore, you should not
29098 use &%fakedefer%& if the message is to be delivered normally.
29099
29100 .vitem &*control&~=&~fakereject/*&<&'message'&>
29101 .cindex "fake rejection"
29102 .cindex "rejection, fake"
29103 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29104 words, only when an SMTP message is being received. If Exim accepts the
29105 message, instead the final 250 response, a 550 rejection message is sent.
29106 However, Exim proceeds to deliver the message as normal. The control applies
29107 only to the current message, not to any subsequent ones that may be received in
29108 the same SMTP connection.
29109
29110 The text for the 550 response is taken from the &%control%& modifier. If no
29111 message is supplied, the following is used:
29112 .code
29113 550-Your message has been rejected but is being
29114 550-kept for evaluation.
29115 550-If it was a legitimate message, it may still be
29116 550 delivered to the target recipient(s).
29117 .endd
29118 This facility should be used with extreme caution.
29119
29120 .vitem &*control&~=&~freeze*&
29121 .cindex "frozen messages" "forcing in ACL"
29122 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29123 other words, only when a message is being received. If the message is accepted,
29124 it is placed on Exim's queue and frozen. The control applies only to the
29125 current message, not to any subsequent ones that may be received in the same
29126 SMTP connection.
29127
29128 This modifier can optionally be followed by &`/no_tell`&. If the global option
29129 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29130 is told about the freezing), provided all the &*control=freeze*& modifiers that
29131 are obeyed for the current message have the &`/no_tell`& option.
29132
29133 .vitem &*control&~=&~no_delay_flush*&
29134 .cindex "SMTP" "output flushing, disabling for delay"
29135 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29136 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29137 use. This control, as long as it is encountered before the &%delay%& modifier,
29138 disables such output flushing.
29139
29140 .vitem &*control&~=&~no_callout_flush*&
29141 .cindex "SMTP" "output flushing, disabling for callout"
29142 Exim normally flushes SMTP output before performing a callout in an ACL, to
29143 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29144 use. This control, as long as it is encountered before the &%verify%& condition
29145 that causes the callout, disables such output flushing.
29146
29147 .vitem &*control&~=&~no_mbox_unspool*&
29148 This control is available when Exim is compiled with the content scanning
29149 extension. Content scanning may require a copy of the current message, or parts
29150 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29151 or spam scanner. Normally, such copies are deleted when they are no longer
29152 needed. If this control is set, the copies are not deleted. The control applies
29153 only to the current message, not to any subsequent ones that may be received in
29154 the same SMTP connection. It is provided for debugging purposes and is unlikely
29155 to be useful in production.
29156
29157 .vitem &*control&~=&~no_multiline_responses*&
29158 .cindex "multiline responses, suppressing"
29159 This control is permitted for any ACL except the one for non-SMTP messages.
29160 It seems that there are broken clients in use that cannot handle multiline
29161 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29162
29163 If this control is set, multiline SMTP responses from ACL rejections are
29164 suppressed. One way of doing this would have been to put out these responses as
29165 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29166 (&"use multiline responses for more"& it says &-- ha!), and some of the
29167 responses might get close to that. So this facility, which is after all only a
29168 sop to broken clients, is implemented by doing two very easy things:
29169
29170 .ilist
29171 Extra information that is normally output as part of a rejection caused by
29172 sender verification failure is omitted. Only the final line (typically &"sender
29173 verification failed"&) is sent.
29174 .next
29175 If a &%message%& modifier supplies a multiline response, only the first
29176 line is output.
29177 .endlist
29178
29179 The setting of the switch can, of course, be made conditional on the
29180 calling host. Its effect lasts until the end of the SMTP connection.
29181
29182 .vitem &*control&~=&~no_pipelining*&
29183 .cindex "PIPELINING" "suppressing advertising"
29184 This control turns off the advertising of the PIPELINING extension to SMTP in
29185 the current session. To be useful, it must be obeyed before Exim sends its
29186 response to an EHLO command. Therefore, it should normally appear in an ACL
29187 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29188 &%pipelining_advertise_hosts%&.
29189
29190 .vitem &*control&~=&~queue_only*&
29191 .oindex "&%queue_only%&"
29192 .cindex "queueing incoming messages"
29193 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29194 other words, only when a message is being received. If the message is accepted,
29195 it is placed on Exim's queue and left there for delivery by a subsequent queue
29196 runner. No immediate delivery process is started. In other words, it has the
29197 effect as the &%queue_only%& global option. However, the control applies only
29198 to the current message, not to any subsequent ones that may be received in the
29199 same SMTP connection.
29200
29201 .vitem &*control&~=&~submission/*&<&'options'&>
29202 .cindex "message" "submission"
29203 .cindex "submission mode"
29204 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29205 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29206 the current message is a submission from a local MUA. In this case, Exim
29207 operates in &"submission mode"&, and applies certain fixups to the message if
29208 necessary. For example, it adds a &'Date:'& header line if one is not present.
29209 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29210 late (the message has already been created).
29211
29212 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29213 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29214 submission mode; the available options for this control are described there.
29215 The control applies only to the current message, not to any subsequent ones
29216 that may be received in the same SMTP connection.
29217
29218 .vitem &*control&~=&~suppress_local_fixups*&
29219 .cindex "submission fixups, suppressing"
29220 This control applies to locally submitted (non TCP/IP) messages, and is the
29221 complement of &`control = submission`&. It disables the fixups that are
29222 normally applied to locally-submitted messages. Specifically:
29223
29224 .ilist
29225 Any &'Sender:'& header line is left alone (in this respect, it is a
29226 dynamic version of &%local_sender_retain%&).
29227 .next
29228 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29229 .next
29230 There is no check that &'From:'& corresponds to the actual sender.
29231 .endlist ilist
29232
29233 This control may be useful when a remotely-originated message is accepted,
29234 passed to some scanning program, and then re-submitted for delivery. It can be
29235 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29236 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29237 data is read.
29238
29239 &*Note:*& This control applies only to the current message, not to any others
29240 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29241
29242 .vitem &*control&~=&~utf8_downconvert*&
29243 This control enables conversion of UTF-8 in message addresses
29244 to a-label form.
29245 For details see section &<<SECTi18nMTA>>&.
29246 .endlist vlist
29247
29248
29249 .section "Summary of message fixup control" "SECTsummesfix"
29250 All four possibilities for message fixups can be specified:
29251
29252 .ilist
29253 Locally submitted, fixups applied: the default.
29254 .next
29255 Locally submitted, no fixups applied: use
29256 &`control = suppress_local_fixups`&.
29257 .next
29258 Remotely submitted, no fixups applied: the default.
29259 .next
29260 Remotely submitted, fixups applied: use &`control = submission`&.
29261 .endlist
29262
29263
29264
29265 .section "Adding header lines in ACLs" "SECTaddheadacl"
29266 .cindex "header lines" "adding in an ACL"
29267 .cindex "header lines" "position of added lines"
29268 .cindex "&%add_header%& ACL modifier"
29269 The &%add_header%& modifier can be used to add one or more extra header lines
29270 to an incoming message, as in this example:
29271 .code
29272 warn dnslists = sbl.spamhaus.org : \
29273                 dialup.mail-abuse.org
29274      add_header = X-blacklisted-at: $dnslist_domain
29275 .endd
29276 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29277 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29278 receiving a message). The message must ultimately be accepted for
29279 &%add_header%& to have any significant effect. You can use &%add_header%& with
29280 any ACL verb, including &%deny%& (though this is potentially useful only in a
29281 RCPT ACL).
29282
29283 Headers will not be added to the message if the modifier is used in
29284 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29285
29286 Leading and trailing newlines are removed from
29287 the data for the &%add_header%& modifier; if it then
29288 contains one or more newlines that
29289 are not followed by a space or a tab, it is assumed to contain multiple header
29290 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29291 front of any line that is not a valid header line.
29292
29293 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29294 They are added to the message before processing the DATA and MIME ACLs.
29295 However, if an identical header line is requested more than once, only one copy
29296 is actually added to the message. Further header lines may be accumulated
29297 during the DATA and MIME ACLs, after which they are added to the message, again
29298 with duplicates suppressed. Thus, it is possible to add two identical header
29299 lines to an SMTP message, but only if one is added before DATA and one after.
29300 In the case of non-SMTP messages, new headers are accumulated during the
29301 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29302 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29303 are included in the entry that is written to the reject log.
29304
29305 .cindex "header lines" "added; visibility of"
29306 Header lines are not visible in string expansions
29307 of message headers
29308 until they are added to the
29309 message. It follows that header lines defined in the MAIL, RCPT, and predata
29310 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29311 header lines that are added by the DATA or MIME ACLs are not visible in those
29312 ACLs. Because of this restriction, you cannot use header lines as a way of
29313 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29314 this, you can use ACL variables, as described in section
29315 &<<SECTaclvariables>>&.
29316
29317 The list of headers yet to be added is given by the &%$headers_added%& variable.
29318
29319 The &%add_header%& modifier acts immediately as it is encountered during the
29320 processing of an ACL. Notice the difference between these two cases:
29321 .display
29322 &`accept add_header = ADDED: some text`&
29323 &`       `&<&'some condition'&>
29324
29325 &`accept `&<&'some condition'&>
29326 &`       add_header = ADDED: some text`&
29327 .endd
29328 In the first case, the header line is always added, whether or not the
29329 condition is true. In the second case, the header line is added only if the
29330 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29331 ACL statement. All those that are encountered before a condition fails are
29332 honoured.
29333
29334 .cindex "&%warn%& ACL verb"
29335 For compatibility with previous versions of Exim, a &%message%& modifier for a
29336 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29337 effect only if all the conditions are true, even if it appears before some of
29338 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29339 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29340 are present on a &%warn%& verb, both are processed according to their
29341 specifications.
29342
29343 By default, new header lines are added to a message at the end of the existing
29344 header lines. However, you can specify that any particular header line should
29345 be added right at the start (before all the &'Received:'& lines), immediately
29346 after the first block of &'Received:'& lines, or immediately before any line
29347 that is not a &'Received:'& or &'Resent-something:'& header.
29348
29349 This is done by specifying &":at_start:"&, &":after_received:"&, or
29350 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29351 header line, respectively. (Header text cannot start with a colon, as there has
29352 to be a header name first.) For example:
29353 .code
29354 warn add_header = \
29355        :after_received:X-My-Header: something or other...
29356 .endd
29357 If more than one header line is supplied in a single &%add_header%& modifier,
29358 each one is treated independently and can therefore be placed differently. If
29359 you add more than one line at the start, or after the Received: block, they end
29360 up in reverse order.
29361
29362 &*Warning*&: This facility currently applies only to header lines that are
29363 added in an ACL. It does NOT work for header lines that are added in a
29364 system filter or in a router or transport.
29365
29366
29367
29368 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29369 .cindex "header lines" "removing in an ACL"
29370 .cindex "header lines" "position of removed lines"
29371 .cindex "&%remove_header%& ACL modifier"
29372 The &%remove_header%& modifier can be used to remove one or more header lines
29373 from an incoming message, as in this example:
29374 .code
29375 warn   message        = Remove internal headers
29376        remove_header  = x-route-mail1 : x-route-mail2
29377 .endd
29378 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29379 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29380 receiving a message). The message must ultimately be accepted for
29381 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29382 with any ACL verb, including &%deny%&, though this is really not useful for
29383 any verb that doesn't result in a delivered message.
29384
29385 Headers will not be removed from the message if the modifier is used in
29386 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29387
29388 More than one header can be removed at the same time by using a colon separated
29389 list of header names. The header matching is case insensitive. Wildcards are
29390 not permitted, nor is list expansion performed, so you cannot use hostlists to
29391 create a list of headers, however both connection and message variable expansion
29392 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29393 .code
29394 warn   hosts           = +internal_hosts
29395        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29396 warn   message         = Remove internal headers
29397        remove_header   = $acl_c_ihdrs
29398 .endd
29399 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29400 They are removed from the message before processing the DATA and MIME ACLs.
29401 There is no harm in attempting to remove the same header twice nor is removing
29402 a non-existent header. Further header lines to be removed may be accumulated
29403 during the DATA and MIME ACLs, after which they are removed from the message,
29404 if present. In the case of non-SMTP messages, headers to be removed are
29405 accumulated during the non-SMTP ACLs, and are removed from the message after
29406 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29407 ACL, there really is no effect because there is no logging of what headers
29408 would have been removed.
29409
29410 .cindex "header lines" "removed; visibility of"
29411 Header lines are not visible in string expansions until the DATA phase when it
29412 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29413 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29414 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29415 this restriction, you cannot use header lines as a way of controlling data
29416 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29417 you should instead use ACL variables, as described in section
29418 &<<SECTaclvariables>>&.
29419
29420 The &%remove_header%& modifier acts immediately as it is encountered during the
29421 processing of an ACL. Notice the difference between these two cases:
29422 .display
29423 &`accept remove_header = X-Internal`&
29424 &`       `&<&'some condition'&>
29425
29426 &`accept `&<&'some condition'&>
29427 &`       remove_header = X-Internal`&
29428 .endd
29429 In the first case, the header line is always removed, whether or not the
29430 condition is true. In the second case, the header line is removed only if the
29431 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29432 same ACL statement. All those that are encountered before a condition fails
29433 are honoured.
29434
29435 &*Warning*&: This facility currently applies only to header lines that are
29436 present during ACL processing. It does NOT remove header lines that are added
29437 in a system filter or in a router or transport.
29438
29439
29440
29441
29442 .section "ACL conditions" "SECTaclconditions"
29443 .cindex "&ACL;" "conditions; list of"
29444 Some of the conditions listed in this section are available only when Exim is
29445 compiled with the content-scanning extension. They are included here briefly
29446 for completeness. More detailed descriptions can be found in the discussion on
29447 content scanning in chapter &<<CHAPexiscan>>&.
29448
29449 Not all conditions are relevant in all circumstances. For example, testing
29450 senders and recipients does not make sense in an ACL that is being run as the
29451 result of the arrival of an ETRN command, and checks on message headers can be
29452 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29453 can use the same condition (with different parameters) more than once in the
29454 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29455 The conditions are as follows:
29456
29457
29458 .vlist
29459 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29460 .cindex "&ACL;" "nested"
29461 .cindex "&ACL;" "indirect"
29462 .cindex "&ACL;" "arguments"
29463 .cindex "&%acl%& ACL condition"
29464 The possible values of the argument are the same as for the
29465 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29466 &"accept"& the condition is true; if it returns &"deny"& the condition is
29467 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29468 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29469 condition false. This means that further processing of the &%warn%& verb
29470 ceases, but processing of the ACL continues.
29471
29472 If the argument is a named ACL, up to nine space-separated optional values
29473 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29474 and $acl_narg is set to the count of values.
29475 Previous values of these variables are restored after the call returns.
29476 The name and values are expanded separately.
29477 Note that spaces in complex expansions which are used as arguments
29478 will act as argument separators.
29479
29480 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29481 the connection is dropped. If it returns &"discard"&, the verb must be
29482 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29483 conditions are tested.
29484
29485 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29486 loops. This condition allows you to use different ACLs in different
29487 circumstances. For example, different ACLs can be used to handle RCPT commands
29488 for different local users or different local domains.
29489
29490 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29491 .cindex "&%authenticated%& ACL condition"
29492 .cindex "authentication" "ACL checking"
29493 .cindex "&ACL;" "testing for authentication"
29494 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29495 the name of the authenticator is tested against the list. To test for
29496 authentication by any authenticator, you can set
29497 .code
29498 authenticated = *
29499 .endd
29500
29501 .vitem &*condition&~=&~*&<&'string'&>
29502 .cindex "&%condition%& ACL condition"
29503 .cindex "customizing" "ACL condition"
29504 .cindex "&ACL;" "customized test"
29505 .cindex "&ACL;" "testing, customized"
29506 This feature allows you to make up custom conditions. If the result of
29507 expanding the string is an empty string, the number zero, or one of the strings
29508 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29509 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29510 any other value, some error is assumed to have occurred, and the ACL returns
29511 &"defer"&. However, if the expansion is forced to fail, the condition is
29512 ignored. The effect is to treat it as true, whether it is positive or
29513 negative.
29514
29515 .vitem &*decode&~=&~*&<&'location'&>
29516 .cindex "&%decode%& ACL condition"
29517 This condition is available only when Exim is compiled with the
29518 content-scanning extension, and it is allowed only in the ACL defined by
29519 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29520 If all goes well, the condition is true. It is false only if there are
29521 problems such as a syntax error or a memory shortage. For more details, see
29522 chapter &<<CHAPexiscan>>&.
29523
29524 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29525 .cindex "&%dnslists%& ACL condition"
29526 .cindex "DNS list" "in ACL"
29527 .cindex "black list (DNS)"
29528 .cindex "&ACL;" "testing a DNS list"
29529 This condition checks for entries in DNS black lists. These are also known as
29530 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29531 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29532 different variants of this condition to describe briefly here. See sections
29533 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29534
29535 .vitem &*domains&~=&~*&<&'domain&~list'&>
29536 .cindex "&%domains%& ACL condition"
29537 .cindex "domain" "ACL checking"
29538 .cindex "&ACL;" "testing a recipient domain"
29539 .vindex "&$domain_data$&"
29540 This condition is relevant only after a RCPT command. It checks that the domain
29541 of the recipient address is in the domain list. If percent-hack processing is
29542 enabled, it is done before this test is done. If the check succeeds with a
29543 lookup, the result of the lookup is placed in &$domain_data$& until the next
29544 &%domains%& test.
29545
29546 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29547 use &%domains%& in a DATA ACL.
29548
29549
29550 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29551 .cindex "&%encrypted%& ACL condition"
29552 .cindex "encryption" "checking in an ACL"
29553 .cindex "&ACL;" "testing for encryption"
29554 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29555 name of the cipher suite in use is tested against the list. To test for
29556 encryption without testing for any specific cipher suite(s), set
29557 .code
29558 encrypted = *
29559 .endd
29560
29561
29562 .vitem &*hosts&~=&~*&<&'host&~list'&>
29563 .cindex "&%hosts%& ACL condition"
29564 .cindex "host" "ACL checking"
29565 .cindex "&ACL;" "testing the client host"
29566 This condition tests that the calling host matches the host list. If you have
29567 name lookups or wildcarded host names and IP addresses in the same host list,
29568 you should normally put the IP addresses first. For example, you could have:
29569 .code
29570 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29571 .endd
29572 The lookup in this example uses the host name for its key. This is implied by
29573 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29574 and it wouldn't matter which way round you had these two items.)
29575
29576 The reason for the problem with host names lies in the left-to-right way that
29577 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29578 but when it reaches an item that requires a host name, it fails if it cannot
29579 find a host name to compare with the pattern. If the above list is given in the
29580 opposite order, the &%accept%& statement fails for a host whose name cannot be
29581 found, even if its IP address is 10.9.8.7.
29582
29583 If you really do want to do the name check first, and still recognize the IP
29584 address even if the name lookup fails, you can rewrite the ACL like this:
29585 .code
29586 accept hosts = dbm;/etc/friendly/hosts
29587 accept hosts = 10.9.8.7
29588 .endd
29589 The default action on failing to find the host name is to assume that the host
29590 is not in the list, so the first &%accept%& statement fails. The second
29591 statement can then check the IP address.
29592
29593 .vindex "&$host_data$&"
29594 If a &%hosts%& condition is satisfied by means of a lookup, the result
29595 of the lookup is made available in the &$host_data$& variable. This
29596 allows you, for example, to set up a statement like this:
29597 .code
29598 deny  hosts = net-lsearch;/some/file
29599 message = $host_data
29600 .endd
29601 which gives a custom error message for each denied host.
29602
29603 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29604 .cindex "&%local_parts%& ACL condition"
29605 .cindex "local part" "ACL checking"
29606 .cindex "&ACL;" "testing a local part"
29607 .vindex "&$local_part_data$&"
29608 This condition is relevant only after a RCPT command. It checks that the local
29609 part of the recipient address is in the list. If percent-hack processing is
29610 enabled, it is done before this test. If the check succeeds with a lookup, the
29611 result of the lookup is placed in &$local_part_data$&, which remains set until
29612 the next &%local_parts%& test.
29613
29614 .vitem &*malware&~=&~*&<&'option'&>
29615 .cindex "&%malware%& ACL condition"
29616 .cindex "&ACL;" "virus scanning"
29617 .cindex "&ACL;" "scanning for viruses"
29618 This condition is available only when Exim is compiled with the
29619 content-scanning extension. It causes the incoming message to be scanned for
29620 viruses. For details, see chapter &<<CHAPexiscan>>&.
29621
29622 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29623 .cindex "&%mime_regex%& ACL condition"
29624 .cindex "&ACL;" "testing by regex matching"
29625 This condition is available only when Exim is compiled with the
29626 content-scanning extension, and it is allowed only in the ACL defined by
29627 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29628 with any of the regular expressions. For details, see chapter
29629 &<<CHAPexiscan>>&.
29630
29631 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29632 .cindex "rate limiting"
29633 This condition can be used to limit the rate at which a user or host submits
29634 messages. Details are given in section &<<SECTratelimiting>>&.
29635
29636 .vitem &*recipients&~=&~*&<&'address&~list'&>
29637 .cindex "&%recipients%& ACL condition"
29638 .cindex "recipient" "ACL checking"
29639 .cindex "&ACL;" "testing a recipient"
29640 This condition is relevant only after a RCPT command. It checks the entire
29641 recipient address against a list of recipients.
29642
29643 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29644 .cindex "&%regex%& ACL condition"
29645 .cindex "&ACL;" "testing by regex matching"
29646 This condition is available only when Exim is compiled with the
29647 content-scanning extension, and is available only in the DATA, MIME, and
29648 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29649 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29650
29651 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29652 .cindex "&%sender_domains%& ACL condition"
29653 .cindex "sender" "ACL checking"
29654 .cindex "&ACL;" "testing a sender domain"
29655 .vindex "&$domain$&"
29656 .vindex "&$sender_address_domain$&"
29657 This condition tests the domain of the sender of the message against the given
29658 domain list. &*Note*&: The domain of the sender address is in
29659 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29660 of this condition. This is an exception to the general rule for testing domain
29661 lists. It is done this way so that, if this condition is used in an ACL for a
29662 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29663 influence the sender checking.
29664
29665 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29666 relaying, because sender addresses are easily, and commonly, forged.
29667
29668 .vitem &*senders&~=&~*&<&'address&~list'&>
29669 .cindex "&%senders%& ACL condition"
29670 .cindex "sender" "ACL checking"
29671 .cindex "&ACL;" "testing a sender"
29672 This condition tests the sender of the message against the given list. To test
29673 for a bounce message, which has an empty sender, set
29674 .code
29675 senders = :
29676 .endd
29677 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29678 relaying, because sender addresses are easily, and commonly, forged.
29679
29680 .vitem &*spam&~=&~*&<&'username'&>
29681 .cindex "&%spam%& ACL condition"
29682 .cindex "&ACL;" "scanning for spam"
29683 This condition is available only when Exim is compiled with the
29684 content-scanning extension. It causes the incoming message to be scanned by
29685 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29686
29687 .vitem &*verify&~=&~certificate*&
29688 .cindex "&%verify%& ACL condition"
29689 .cindex "TLS" "client certificate verification"
29690 .cindex "certificate" "verification of client"
29691 .cindex "&ACL;" "certificate verification"
29692 .cindex "&ACL;" "testing a TLS certificate"
29693 This condition is true in an SMTP session if the session is encrypted, and a
29694 certificate was received from the client, and the certificate was verified. The
29695 server requests a certificate only if the client matches &%tls_verify_hosts%&
29696 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29697
29698 .vitem &*verify&~=&~csa*&
29699 .cindex "CSA verification"
29700 This condition checks whether the sending host (the client) is authorized to
29701 send email. Details of how this works are given in section
29702 &<<SECTverifyCSA>>&.
29703
29704 .vitem &*verify&~=&~header_names_ascii*&
29705 .cindex "&%verify%& ACL condition"
29706 .cindex "&ACL;" "verifying header names only ASCII"
29707 .cindex "header lines" "verifying header names only ASCII"
29708 .cindex "verifying" "header names only ASCII"
29709 This condition is relevant only in an ACL that is run after a message has been
29710 received, that is, in an ACL specified by &%acl_smtp_data%& or
29711 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29712 there are no non-ASCII characters, also excluding control characters.  The
29713 allowable characters are decimal ASCII values 33 through 126.
29714
29715 Exim itself will handle headers with non-ASCII characters, but it can cause
29716 problems for downstream applications, so this option will allow their
29717 detection and rejection in the DATA ACL's.
29718
29719 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29720 .cindex "&%verify%& ACL condition"
29721 .cindex "&ACL;" "verifying sender in the header"
29722 .cindex "header lines" "verifying the sender in"
29723 .cindex "sender" "verifying in header"
29724 .cindex "verifying" "sender in header"
29725 This condition is relevant only in an ACL that is run after a message has been
29726 received, that is, in an ACL specified by &%acl_smtp_data%& or
29727 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29728 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29729 is loosely thought of as a &"sender"& address (hence the name of the test).
29730 However, an address that appears in one of these headers need not be an address
29731 that accepts bounce messages; only sender addresses in envelopes are required
29732 to accept bounces. Therefore, if you use the callout option on this check, you
29733 might want to arrange for a non-empty address in the MAIL command.
29734
29735 Details of address verification and the options are given later, starting at
29736 section &<<SECTaddressverification>>& (callouts are described in section
29737 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29738 condition to restrict it to bounce messages only:
29739 .code
29740 deny    senders = :
29741         message = A valid sender header is required for bounces
29742        !verify  = header_sender
29743 .endd
29744
29745 .vitem &*verify&~=&~header_syntax*&
29746 .cindex "&%verify%& ACL condition"
29747 .cindex "&ACL;" "verifying header syntax"
29748 .cindex "header lines" "verifying syntax"
29749 .cindex "verifying" "header syntax"
29750 This condition is relevant only in an ACL that is run after a message has been
29751 received, that is, in an ACL specified by &%acl_smtp_data%& or
29752 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29753 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29754 and &'Bcc:'&), returning true if there are no problems.
29755 Unqualified addresses (local parts without domains) are
29756 permitted only in locally generated messages and from hosts that match
29757 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29758 appropriate.
29759
29760 Note that this condition is a syntax check only. However, a common spamming
29761 ploy used to be to send syntactically invalid headers such as
29762 .code
29763 To: @
29764 .endd
29765 and this condition can be used to reject such messages, though they are not as
29766 common as they used to be.
29767
29768 .vitem &*verify&~=&~helo*&
29769 .cindex "&%verify%& ACL condition"
29770 .cindex "&ACL;" "verifying HELO/EHLO"
29771 .cindex "HELO" "verifying"
29772 .cindex "EHLO" "verifying"
29773 .cindex "verifying" "EHLO"
29774 .cindex "verifying" "HELO"
29775 This condition is true if a HELO or EHLO command has been received from the
29776 client host, and its contents have been verified. If there has been no previous
29777 attempt to verify the HELO/EHLO contents, it is carried out when this
29778 condition is encountered. See the description of the &%helo_verify_hosts%& and
29779 &%helo_try_verify_hosts%& options for details of how to request verification
29780 independently of this condition.
29781
29782 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29783 option), this condition is always true.
29784
29785
29786 .vitem &*verify&~=&~not_blind*&
29787 .cindex "verifying" "not blind"
29788 .cindex "bcc recipients, verifying none"
29789 This condition checks that there are no blind (bcc) recipients in the message.
29790 Every envelope recipient must appear either in a &'To:'& header line or in a
29791 &'Cc:'& header line for this condition to be true. Local parts are checked
29792 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29793 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29794 used only in a DATA or non-SMTP ACL.
29795
29796 There are, of course, many legitimate messages that make use of blind (bcc)
29797 recipients. This check should not be used on its own for blocking messages.
29798
29799
29800 .vitem &*verify&~=&~recipient/*&<&'options'&>
29801 .cindex "&%verify%& ACL condition"
29802 .cindex "&ACL;" "verifying recipient"
29803 .cindex "recipient" "verifying"
29804 .cindex "verifying" "recipient"
29805 .vindex "&$address_data$&"
29806 This condition is relevant only after a RCPT command. It verifies the current
29807 recipient. Details of address verification are given later, starting at section
29808 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29809 of &$address_data$& is the last value that was set while routing the address.
29810 This applies even if the verification fails. When an address that is being
29811 verified is redirected to a single address, verification continues with the new
29812 address, and in that case, the subsequent value of &$address_data$& is the
29813 value for the child address.
29814
29815 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29816 .cindex "&%verify%& ACL condition"
29817 .cindex "&ACL;" "verifying host reverse lookup"
29818 .cindex "host" "verifying reverse lookup"
29819 This condition ensures that a verified host name has been looked up from the IP
29820 address of the client host. (This may have happened already if the host name
29821 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29822 Verification ensures that the host name obtained from a reverse DNS lookup, or
29823 one of its aliases, does, when it is itself looked up in the DNS, yield the
29824 original IP address.
29825
29826 There is one possible option, &`defer_ok`&.  If this is present and a
29827 DNS operation returns a temporary error, the verify condition succeeds.
29828
29829 If this condition is used for a locally generated message (that is, when there
29830 is no client host involved), it always succeeds.
29831
29832 .vitem &*verify&~=&~sender/*&<&'options'&>
29833 .cindex "&%verify%& ACL condition"
29834 .cindex "&ACL;" "verifying sender"
29835 .cindex "sender" "verifying"
29836 .cindex "verifying" "sender"
29837 This condition is relevant only after a MAIL or RCPT command, or after a
29838 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29839 the message's sender is empty (that is, this is a bounce message), the
29840 condition is true. Otherwise, the sender address is verified.
29841
29842 .vindex "&$address_data$&"
29843 .vindex "&$sender_address_data$&"
29844 If there is data in the &$address_data$& variable at the end of routing, its
29845 value is placed in &$sender_address_data$& at the end of verification. This
29846 value can be used in subsequent conditions and modifiers in the same ACL
29847 statement. It does not persist after the end of the current statement. If you
29848 want to preserve the value for longer, you can save it in an ACL variable.
29849
29850 Details of verification are given later, starting at section
29851 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29852 to avoid doing it more than once per message.
29853
29854 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29855 .cindex "&%verify%& ACL condition"
29856 This is a variation of the previous option, in which a modified address is
29857 verified as a sender.
29858
29859 .new
29860 Note that '/' is legal in local-parts; if the address may have such
29861 (eg. is generated from the received message)
29862 they must be protected from the options parsing by doubling:
29863 .code
29864 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
29865 .endd
29866 .wen
29867 .endlist
29868
29869
29870
29871 .section "Using DNS lists" "SECTmorednslists"
29872 .cindex "DNS list" "in ACL"
29873 .cindex "black list (DNS)"
29874 .cindex "&ACL;" "testing a DNS list"
29875 In its simplest form, the &%dnslists%& condition tests whether the calling host
29876 is on at least one of a number of DNS lists by looking up the inverted IP
29877 address in one or more DNS domains. (Note that DNS list domains are not mail
29878 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29879 special options instead.) For example, if the calling host's IP
29880 address is 192.168.62.43, and the ACL statement is
29881 .code
29882 deny dnslists = blackholes.mail-abuse.org : \
29883                 dialups.mail-abuse.org
29884 .endd
29885 the following records are looked up:
29886 .code
29887 43.62.168.192.blackholes.mail-abuse.org
29888 43.62.168.192.dialups.mail-abuse.org
29889 .endd
29890 As soon as Exim finds an existing DNS record, processing of the list stops.
29891 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29892 to test that a host is on more than one list (an &"and"& conjunction), you can
29893 use two separate conditions:
29894 .code
29895 deny dnslists = blackholes.mail-abuse.org
29896      dnslists = dialups.mail-abuse.org
29897 .endd
29898 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29899 behaves as if the host does not match the list item, that is, as if the DNS
29900 record does not exist. If there are further items in the DNS list, they are
29901 processed.
29902
29903 This is usually the required action when &%dnslists%& is used with &%deny%&
29904 (which is the most common usage), because it prevents a DNS failure from
29905 blocking mail. However, you can change this behaviour by putting one of the
29906 following special items in the list:
29907 .display
29908 &`+include_unknown `&   behave as if the item is on the list
29909 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29910 &`+defer_unknown   `&   give a temporary error
29911 .endd
29912 .cindex "&`+include_unknown`&"
29913 .cindex "&`+exclude_unknown`&"
29914 .cindex "&`+defer_unknown`&"
29915 Each of these applies to any subsequent items on the list. For example:
29916 .code
29917 deny dnslists = +defer_unknown : foo.bar.example
29918 .endd
29919 Testing the list of domains stops as soon as a match is found. If you want to
29920 warn for one list and block for another, you can use two different statements:
29921 .code
29922 deny  dnslists = blackholes.mail-abuse.org
29923 warn  message  = X-Warn: sending host is on dialups list
29924       dnslists = dialups.mail-abuse.org
29925 .endd
29926 .cindex caching "of dns lookup"
29927 .cindex DNS TTL
29928 DNS list lookups are cached by Exim for the duration of the SMTP session
29929 (but limited by the DNS return TTL value),
29930 so a lookup based on the IP address is done at most once for any incoming
29931 connection (assuming long-enough TTL).
29932 Exim does not share information between multiple incoming
29933 connections (but your local name server cache should be active).
29934
29935
29936
29937 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29938 .cindex "DNS list" "keyed by explicit IP address"
29939 By default, the IP address that is used in a DNS list lookup is the IP address
29940 of the calling host. However, you can specify another IP address by listing it
29941 after the domain name, introduced by a slash. For example:
29942 .code
29943 deny dnslists = black.list.tld/192.168.1.2
29944 .endd
29945 This feature is not very helpful with explicit IP addresses; it is intended for
29946 use with IP addresses that are looked up, for example, the IP addresses of the
29947 MX hosts or nameservers of an email sender address. For an example, see section
29948 &<<SECTmulkeyfor>>& below.
29949
29950
29951
29952
29953 .section "DNS lists keyed on domain names" "SECID202"
29954 .cindex "DNS list" "keyed by domain name"
29955 There are some lists that are keyed on domain names rather than inverted IP
29956 addresses (see for example the &'domain based zones'& link at
29957 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29958 with these lists. You can change the name that is looked up in a DNS list by
29959 listing it after the domain name, introduced by a slash. For example,
29960 .code
29961 deny  message  = Sender's domain is listed at $dnslist_domain
29962       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29963 .endd
29964 This particular example is useful only in ACLs that are obeyed after the
29965 RCPT or DATA commands, when a sender address is available. If (for
29966 example) the message's sender is &'user@tld.example'& the name that is looked
29967 up by this example is
29968 .code
29969 tld.example.dsn.rfc-ignorant.org
29970 .endd
29971 A single &%dnslists%& condition can contain entries for both names and IP
29972 addresses. For example:
29973 .code
29974 deny dnslists = sbl.spamhaus.org : \
29975                 dsn.rfc-ignorant.org/$sender_address_domain
29976 .endd
29977 The first item checks the sending host's IP address; the second checks a domain
29978 name. The whole condition is true if either of the DNS lookups succeeds.
29979
29980
29981
29982
29983 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29984 .cindex "DNS list" "multiple keys for"
29985 The syntax described above for looking up explicitly-defined values (either
29986 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29987 name for the DNS list, what follows the slash can in fact be a list of items.
29988 As with all lists in Exim, the default separator is a colon. However, because
29989 this is a sublist within the list of DNS blacklist domains, it is necessary
29990 either to double the separators like this:
29991 .code
29992 dnslists = black.list.tld/name.1::name.2
29993 .endd
29994 or to change the separator character, like this:
29995 .code
29996 dnslists = black.list.tld/<;name.1;name.2
29997 .endd
29998 If an item in the list is an IP address, it is inverted before the DNS
29999 blacklist domain is appended. If it is not an IP address, no inversion
30000 occurs. Consider this condition:
30001 .code
30002 dnslists = black.list.tld/<;192.168.1.2;a.domain
30003 .endd
30004 The DNS lookups that occur are:
30005 .code
30006 2.1.168.192.black.list.tld
30007 a.domain.black.list.tld
30008 .endd
30009 Once a DNS record has been found (that matches a specific IP return
30010 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30011 are done. If there is a temporary DNS error, the rest of the sublist of domains
30012 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30013 only if no other DNS lookup in this sublist succeeds. In other words, a
30014 successful lookup for any of the items in the sublist overrides a temporary
30015 error for a previous item.
30016
30017 The ability to supply a list of items after the slash is in some sense just a
30018 syntactic convenience. These two examples have the same effect:
30019 .code
30020 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30021 dnslists = black.list.tld/a.domain::b.domain
30022 .endd
30023 However, when the data for the list is obtained from a lookup, the second form
30024 is usually much more convenient. Consider this example:
30025 .code
30026 deny message  = The mail servers for the domain \
30027                 $sender_address_domain \
30028                 are listed at $dnslist_domain ($dnslist_value); \
30029                 see $dnslist_text.
30030      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30031                                    ${lookup dnsdb {>|mxh=\
30032                                    $sender_address_domain} }} }
30033 .endd
30034 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30035 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30036 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30037 of expanding the condition might be something like this:
30038 .code
30039 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30040 .endd
30041 Thus, this example checks whether or not the IP addresses of the sender
30042 domain's mail servers are on the Spamhaus black list.
30043
30044 The key that was used for a successful DNS list lookup is put into the variable
30045 &$dnslist_matched$& (see section &<<SECID204>>&).
30046
30047
30048
30049
30050 .section "Data returned by DNS lists" "SECID203"
30051 .cindex "DNS list" "data returned from"
30052 DNS lists are constructed using address records in the DNS. The original RBL
30053 just used the address 127.0.0.1 on the right hand side of each record, but the
30054 RBL+ list and some other lists use a number of values with different meanings.
30055 The values used on the RBL+ list are:
30056 .display
30057 127.1.0.1  RBL
30058 127.1.0.2  DUL
30059 127.1.0.3  DUL and RBL
30060 127.1.0.4  RSS
30061 127.1.0.5  RSS and RBL
30062 127.1.0.6  RSS and DUL
30063 127.1.0.7  RSS and DUL and RBL
30064 .endd
30065 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30066 different values. Some DNS lists may return more than one address record;
30067 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30068
30069
30070 .section "Variables set from DNS lists" "SECID204"
30071 .cindex "expansion" "variables, set from DNS list"
30072 .cindex "DNS list" "variables set from"
30073 .vindex "&$dnslist_domain$&"
30074 .vindex "&$dnslist_matched$&"
30075 .vindex "&$dnslist_text$&"
30076 .vindex "&$dnslist_value$&"
30077 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30078 the name of the overall domain that matched (for example,
30079 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30080 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30081 the DNS record. When the key is an IP address, it is not reversed in
30082 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30083 cases, for example:
30084 .code
30085 deny dnslists = spamhaus.example
30086 .endd
30087 the key is also available in another variable (in this case,
30088 &$sender_host_address$&). In more complicated cases, however, this is not true.
30089 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30090 might generate a dnslists lookup like this:
30091 .code
30092 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30093 .endd
30094 If this condition succeeds, the value in &$dnslist_matched$& might be
30095 &`192.168.6.7`& (for example).
30096
30097 If more than one address record is returned by the DNS lookup, all the IP
30098 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30099 The variable &$dnslist_text$& contains the contents of any associated TXT
30100 record. For lists such as RBL+ the TXT record for a merged entry is often not
30101 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30102 information.
30103
30104 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30105 &-- although these appear before the condition in the ACL, they are not
30106 expanded until after it has failed. For example:
30107 .code
30108 deny    hosts = !+local_networks
30109         message = $sender_host_address is listed \
30110                   at $dnslist_domain
30111         dnslists = rbl-plus.mail-abuse.example
30112 .endd
30113
30114
30115
30116 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30117 .cindex "DNS list" "matching specific returned data"
30118 You can add an equals sign and an IP address after a &%dnslists%& domain name
30119 in order to restrict its action to DNS records with a matching right hand side.
30120 For example,
30121 .code
30122 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30123 .endd
30124 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30125 any address record is considered to be a match. For the moment, we assume
30126 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30127 describes how multiple records are handled.
30128
30129 More than one IP address may be given for checking, using a comma as a
30130 separator. These are alternatives &-- if any one of them matches, the
30131 &%dnslists%& condition is true. For example:
30132 .code
30133 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30134 .endd
30135 If you want to specify a constraining address list and also specify names or IP
30136 addresses to be looked up, the constraining address list must be specified
30137 first. For example:
30138 .code
30139 deny dnslists = dsn.rfc-ignorant.org\
30140                 =127.0.0.2/$sender_address_domain
30141 .endd
30142
30143 If the character &`&&`& is used instead of &`=`&, the comparison for each
30144 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30145 In other words, the listed addresses are used as bit masks. The comparison is
30146 true if all the bits in the mask are present in the address that is being
30147 tested. For example:
30148 .code
30149 dnslists = a.b.c&0.0.0.3
30150 .endd
30151 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30152 want to test whether one bit or another bit is present (as opposed to both
30153 being present), you must use multiple values. For example:
30154 .code
30155 dnslists = a.b.c&0.0.0.1,0.0.0.2
30156 .endd
30157 matches if the final component of the address is an odd number or two times
30158 an odd number.
30159
30160
30161
30162 .section "Negated DNS matching conditions" "SECID205"
30163 You can supply a negative list of IP addresses as part of a &%dnslists%&
30164 condition. Whereas
30165 .code
30166 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30167 .endd
30168 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30169 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30170 .code
30171 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30172 .endd
30173 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30174 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30175 words, the result of the test is inverted if an exclamation mark appears before
30176 the &`=`& (or the &`&&`&) sign.
30177
30178 &*Note*&: This kind of negation is not the same as negation in a domain,
30179 host, or address list (which is why the syntax is different).
30180
30181 If you are using just one list, the negation syntax does not gain you much. The
30182 previous example is precisely equivalent to
30183 .code
30184 deny  dnslists = a.b.c
30185      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30186 .endd
30187 However, if you are using multiple lists, the negation syntax is clearer.
30188 Consider this example:
30189 .code
30190 deny  dnslists = sbl.spamhaus.org : \
30191                  list.dsbl.org : \
30192                  dnsbl.njabl.org!=127.0.0.3 : \
30193                  relays.ordb.org
30194 .endd
30195 Using only positive lists, this would have to be:
30196 .code
30197 deny  dnslists = sbl.spamhaus.org : \
30198                  list.dsbl.org
30199 deny  dnslists = dnsbl.njabl.org
30200      !dnslists = dnsbl.njabl.org=127.0.0.3
30201 deny  dnslists = relays.ordb.org
30202 .endd
30203 which is less clear, and harder to maintain.
30204
30205
30206
30207
30208 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30209 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30210 thereby providing more than one IP address. When an item in a &%dnslists%& list
30211 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30212 the match to specific results from the DNS lookup, there are two ways in which
30213 the checking can be handled. For example, consider the condition:
30214 .code
30215 dnslists = a.b.c=127.0.0.1
30216 .endd
30217 What happens if the DNS lookup for the incoming IP address yields both
30218 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30219 condition true because at least one given value was found, or is it false
30220 because at least one of the found values was not listed? And how does this
30221 affect negated conditions? Both possibilities are provided for with the help of
30222 additional separators &`==`& and &`=&&`&.
30223
30224 .ilist
30225 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30226 IP addresses matches one of the listed addresses. For the example above, the
30227 condition is true because 127.0.0.1 matches.
30228 .next
30229 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30230 looked up IP addresses matches one of the listed addresses. If the condition is
30231 changed to:
30232 .code
30233 dnslists = a.b.c==127.0.0.1
30234 .endd
30235 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30236 false because 127.0.0.2 is not listed. You would need to have:
30237 .code
30238 dnslists = a.b.c==127.0.0.1,127.0.0.2
30239 .endd
30240 for the condition to be true.
30241 .endlist
30242
30243 When &`!`& is used to negate IP address matching, it inverts the result, giving
30244 the precise opposite of the behaviour above. Thus:
30245 .ilist
30246 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30247 addresses matches one of the listed addresses. Consider:
30248 .code
30249 dnslists = a.b.c!&0.0.0.1
30250 .endd
30251 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30252 false because 127.0.0.1 matches.
30253 .next
30254 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30255 looked up IP address that does not match. Consider:
30256 .code
30257 dnslists = a.b.c!=&0.0.0.1
30258 .endd
30259 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30260 true, because 127.0.0.2 does not match. You would need to have:
30261 .code
30262 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30263 .endd
30264 for the condition to be false.
30265 .endlist
30266 When the DNS lookup yields only a single IP address, there is no difference
30267 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30268
30269
30270
30271
30272 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30273 .cindex "DNS list" "information from merged"
30274 When the facility for restricting the matching IP values in a DNS list is used,
30275 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30276 the true reason for rejection. This happens when lists are merged and the IP
30277 address in the A record is used to distinguish them; unfortunately there is
30278 only one TXT record. One way round this is not to use merged lists, but that
30279 can be inefficient because it requires multiple DNS lookups where one would do
30280 in the vast majority of cases when the host of interest is not on any of the
30281 lists.
30282
30283 A less inefficient way of solving this problem is available. If
30284 two domain names, comma-separated, are given, the second is used first to
30285 do an initial check, making use of any IP value restrictions that are set.
30286 If there is a match, the first domain is used, without any IP value
30287 restrictions, to get the TXT record. As a byproduct of this, there is also
30288 a check that the IP being tested is indeed on the first list. The first
30289 domain is the one that is put in &$dnslist_domain$&. For example:
30290 .code
30291 reject message  = \
30292          rejected because $sender_host_address is blacklisted \
30293          at $dnslist_domain\n$dnslist_text
30294        dnslists = \
30295          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30296          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30297 .endd
30298 For the first blacklist item, this starts by doing a lookup in
30299 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30300 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30301 value, and as long as something is found, it looks for the corresponding TXT
30302 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30303 The second blacklist item is processed similarly.
30304
30305 If you are interested in more than one merged list, the same list must be
30306 given several times, but because the results of the DNS lookups are cached,
30307 the DNS calls themselves are not repeated. For example:
30308 .code
30309 reject dnslists = \
30310          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30311          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30312          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30313          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30314 .endd
30315 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30316 values matches (or if no record is found), this is the only lookup that is
30317 done. Only if there is a match is one of the more specific lists consulted.
30318
30319
30320
30321 .section "DNS lists and IPv6" "SECTmorednslistslast"
30322 .cindex "IPv6" "DNS black lists"
30323 .cindex "DNS list" "IPv6 usage"
30324 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30325 nibble by nibble. For example, if the calling host's IP address is
30326 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30327 .code
30328 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30329   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30330 .endd
30331 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30332 lists contain wildcard records, intended for IPv4, that interact badly with
30333 IPv6. For example, the DNS entry
30334 .code
30335 *.3.some.list.example.    A    127.0.0.1
30336 .endd
30337 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30338 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30339
30340 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30341 &%condition%& condition, as in this example:
30342 .code
30343 deny   condition = ${if isip4{$sender_host_address}}
30344        dnslists  = some.list.example
30345 .endd
30346
30347 If an explicit key is being used for a DNS lookup and it may be an IPv6
30348 address you should specify alternate list separators for both the outer
30349 (DNS list name) list and inner (lookup keys) list:
30350 .code
30351        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30352 .endd
30353
30354 .section "Rate limiting incoming messages" "SECTratelimiting"
30355 .cindex "rate limiting" "client sending"
30356 .cindex "limiting client sending rates"
30357 .oindex "&%smtp_ratelimit_*%&"
30358 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30359 which clients can send email. This is more powerful than the
30360 &%smtp_ratelimit_*%& options, because those options control the rate of
30361 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30362 works across all connections (concurrent and sequential) from the same client
30363 host. The syntax of the &%ratelimit%& condition is:
30364 .display
30365 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30366 .endd
30367 If the average client sending rate is less than &'m'& messages per time
30368 period &'p'& then the condition is false; otherwise it is true.
30369
30370 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30371 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30372 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30373 of &'p'&.
30374
30375 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30376 time interval, for example, &`8h`& for eight hours. A larger time constant
30377 means that it takes Exim longer to forget a client's past behaviour. The
30378 parameter &'m'& is the maximum number of messages that a client is permitted to
30379 send in each time interval. It also specifies the number of messages permitted
30380 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30381 constant, you can allow a client to send more messages in a burst without
30382 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30383 both small, messages must be sent at an even rate.
30384
30385 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30386 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30387 when deploying the &%ratelimit%& ACL condition. The script prints usage
30388 instructions when it is run with no arguments.
30389
30390 The key is used to look up the data for calculating the client's average
30391 sending rate. This data is stored in Exim's spool directory, alongside the
30392 retry and other hints databases. The default key is &$sender_host_address$&,
30393 which means Exim computes the sending rate of each client host IP address.
30394 By changing the key you can change how Exim identifies clients for the purpose
30395 of ratelimiting. For example, to limit the sending rate of each authenticated
30396 user, independent of the computer they are sending from, set the key to
30397 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30398 example, &$authenticated_id$& is only meaningful if the client has
30399 authenticated (which you can check with the &%authenticated%& ACL condition).
30400
30401 The lookup key does not have to identify clients: If you want to limit the
30402 rate at which a recipient receives messages, you can use the key
30403 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30404 ACL.
30405
30406 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30407 specifies what Exim measures the rate of, for example messages or recipients
30408 or bytes. You can adjust the measurement using the &%unique=%& and/or
30409 &%count=%& options. You can also control when Exim updates the recorded rate
30410 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30411 separated by a slash, like the other parameters. They may appear in any order.
30412
30413 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30414 any options that alter the meaning of the stored data. The limit &'m'& is not
30415 stored, so you can alter the configured maximum rate and Exim will still
30416 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30417 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30418 behaviour. The lookup key is not affected by changes to the update mode and
30419 the &%count=%& option.
30420
30421
30422 .section "Ratelimit options for what is being measured" "ratoptmea"
30423 .cindex "rate limiting" "per_* options"
30424 The &%per_conn%& option limits the client's connection rate. It is not
30425 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30426 &%acl_not_smtp_start%& ACLs.
30427
30428 The &%per_mail%& option limits the client's rate of sending messages. This is
30429 the default if none of the &%per_*%& options is specified. It can be used in
30430 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30431 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30432
30433 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30434 the same ACLs as the &%per_mail%& option, though it is best to use this option
30435 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30436 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30437 in its MAIL command, which may be inaccurate or completely missing. You can
30438 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30439 in kilobytes, megabytes, or gigabytes, respectively.
30440
30441 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30442 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30443 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30444 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30445 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30446 in either case the rate limiting engine will see a message with many
30447 recipients as a large high-speed burst.
30448
30449 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30450 number of different recipients that the client has sent messages to in the
30451 last time period. That is, if the client repeatedly sends messages to the same
30452 recipient, its measured rate is not increased. This option can only be used in
30453 &%acl_smtp_rcpt%&.
30454
30455 The &%per_cmd%& option causes Exim to recompute the rate every time the
30456 condition is processed. This can be used to limit the rate of any SMTP
30457 command. If it is used in multiple ACLs it can limit the aggregate rate of
30458 multiple different commands.
30459
30460 The &%count=%& option can be used to alter how much Exim adds to the client's
30461 measured rate. For example, the &%per_byte%& option is equivalent to
30462 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30463 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30464 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30465
30466 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30467
30468
30469 .section "Ratelimit update modes" "ratoptupd"
30470 .cindex "rate limiting" "reading data without updating"
30471 You can specify one of three options with the &%ratelimit%& condition to
30472 control when its database is updated. This section describes the &%readonly%&
30473 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30474
30475 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30476 previously-computed rate to check against the limit.
30477
30478 For example, you can test the client's sending rate and deny it access (when
30479 it is too fast) in the connect ACL. If the client passes this check then it
30480 can go on to send a message, in which case its recorded rate will be updated
30481 in the MAIL ACL. Subsequent connections from the same client will check this
30482 new rate.
30483 .code
30484 acl_check_connect:
30485  deny ratelimit = 100 / 5m / readonly
30486     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30487                   (max $sender_rate_limit)
30488 # ...
30489 acl_check_mail:
30490  warn ratelimit = 100 / 5m / strict
30491     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30492                   (max $sender_rate_limit)
30493 .endd
30494
30495 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30496 processing a message then it may increase the client's measured rate more than
30497 it should. For example, this will happen if you check the &%per_rcpt%& option
30498 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30499 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30500 multiple update problems by using the &%readonly%& option on later ratelimit
30501 checks.
30502
30503 The &%per_*%& options described above do not make sense in some ACLs. If you
30504 use a &%per_*%& option in an ACL where it is not normally permitted then the
30505 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30506 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30507 next section) so you must specify the &%readonly%& option explicitly.
30508
30509
30510 .section "Ratelimit options for handling fast clients" "ratoptfast"
30511 .cindex "rate limiting" "strict and leaky modes"
30512 If a client's average rate is greater than the maximum, the rate limiting
30513 engine can react in two possible ways, depending on the presence of the
30514 &%strict%& or &%leaky%& update modes. This is independent of the other
30515 counter-measures (such as rejecting the message) that may be specified by the
30516 rest of the ACL.
30517
30518 The &%leaky%& (default) option means that the client's recorded rate is not
30519 updated if it is above the limit. The effect of this is that Exim measures the
30520 client's average rate of successfully sent email, which cannot be greater than
30521 the maximum allowed. If the client is over the limit it may suffer some
30522 counter-measures (as specified in the ACL), but it will still be able to send
30523 email at the configured maximum rate, whatever the rate of its attempts. This
30524 is generally the better choice if you have clients that retry automatically.
30525 For example, it does not prevent a sender with an over-aggressive retry rate
30526 from getting any email through.
30527
30528 The &%strict%& option means that the client's recorded rate is always
30529 updated. The effect of this is that Exim measures the client's average rate
30530 of attempts to send email, which can be much higher than the maximum it is
30531 actually allowed. If the client is over the limit it may be subjected to
30532 counter-measures by the ACL. It must slow down and allow sufficient time to
30533 pass that its computed rate falls below the maximum before it can send email
30534 again. The time (the number of smoothing periods) it must wait and not
30535 attempt to send mail can be calculated with this formula:
30536 .code
30537         ln(peakrate/maxrate)
30538 .endd
30539
30540
30541 .section "Limiting the rate of different events" "ratoptuniq"
30542 .cindex "rate limiting" "counting unique events"
30543 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30544 rate of different events. For example, the &%per_addr%& option uses this
30545 mechanism to count the number of different recipients that the client has
30546 sent messages to in the last time period; it is equivalent to
30547 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30548 measure the rate that a client uses different sender addresses with the
30549 options &`per_mail/unique=$sender_address`&.
30550
30551 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30552 has seen for that key. The whole set is thrown away when it is older than the
30553 rate smoothing period &'p'&, so each different event is counted at most once
30554 per period. In the &%leaky%& update mode, an event that causes the client to
30555 go over the limit is not added to the set, in the same way that the client's
30556 recorded rate is not updated in the same situation.
30557
30558 When you combine the &%unique=%& and &%readonly%& options, the specific
30559 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30560 rate.
30561
30562 The &%unique=%& mechanism needs more space in the ratelimit database than the
30563 other &%ratelimit%& options in order to store the event set. The number of
30564 unique values is potentially as large as the rate limit, so the extra space
30565 required increases with larger limits.
30566
30567 The uniqueification is not perfect: there is a small probability that Exim
30568 will think a new event has happened before. If the sender's rate is less than
30569 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30570 the measured rate can go above the limit, in which case Exim may under-count
30571 events by a significant margin. Fortunately, if the rate is high enough (2.7
30572 times the limit) that the false positive rate goes above 9%, then Exim will
30573 throw away the over-full event set before the measured rate falls below the
30574 limit. Therefore the only harm should be that exceptionally high sending rates
30575 are logged incorrectly; any countermeasures you configure will be as effective
30576 as intended.
30577
30578
30579 .section "Using rate limiting" "useratlim"
30580 Exim's other ACL facilities are used to define what counter-measures are taken
30581 when the rate limit is exceeded. This might be anything from logging a warning
30582 (for example, while measuring existing sending rates in order to define
30583 policy), through time delays to slow down fast senders, up to rejecting the
30584 message. For example:
30585 .code
30586 # Log all senders' rates
30587 warn ratelimit = 0 / 1h / strict
30588      log_message = Sender rate $sender_rate / $sender_rate_period
30589
30590 # Slow down fast senders; note the need to truncate $sender_rate
30591 # at the decimal point.
30592 warn ratelimit = 100 / 1h / per_rcpt / strict
30593      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30594                    $sender_rate_limit }s
30595
30596 # Keep authenticated users under control
30597 deny authenticated = *
30598      ratelimit = 100 / 1d / strict / $authenticated_id
30599
30600 # System-wide rate limit
30601 defer message = Sorry, too busy. Try again later.
30602      ratelimit = 10 / 1s / $primary_hostname
30603
30604 # Restrict incoming rate from each host, with a default
30605 # set using a macro and special cases looked up in a table.
30606 defer message = Sender rate exceeds $sender_rate_limit \
30607                messages per $sender_rate_period
30608      ratelimit = ${lookup {$sender_host_address} \
30609                    cdb {DB/ratelimits.cdb} \
30610                    {$value} {RATELIMIT} }
30611 .endd
30612 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30613 especially with the &%per_rcpt%& option, you may suffer from a performance
30614 bottleneck caused by locking on the ratelimit hints database. Apart from
30615 making your ACLs less complicated, you can reduce the problem by using a
30616 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30617 this means that Exim will lose its hints data after a reboot (including retry
30618 hints, the callout cache, and ratelimit data).
30619
30620
30621
30622 .section "Address verification" "SECTaddressverification"
30623 .cindex "verifying address" "options for"
30624 .cindex "policy control" "address verification"
30625 Several of the &%verify%& conditions described in section
30626 &<<SECTaclconditions>>& cause addresses to be verified. Section
30627 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30628 The verification conditions can be followed by options that modify the
30629 verification process. The options are separated from the keyword and from each
30630 other by slashes, and some of them contain parameters. For example:
30631 .code
30632 verify = sender/callout
30633 verify = recipient/defer_ok/callout=10s,defer_ok
30634 .endd
30635 The first stage of address verification, which always happens, is to run the
30636 address through the routers, in &"verify mode"&. Routers can detect the
30637 difference between verification and routing for delivery, and their actions can
30638 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30639 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30640 The available options are as follows:
30641
30642 .ilist
30643 If the &%callout%& option is specified, successful routing to one or more
30644 remote hosts is followed by a &"callout"& to those hosts as an additional
30645 check. Callouts and their sub-options are discussed in the next section.
30646 .next
30647 If there is a defer error while doing verification routing, the ACL
30648 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30649 options, the condition is forced to be true instead. Note that this is a main
30650 verification option as well as a suboption for callouts.
30651 .next
30652 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30653 discusses the reporting of sender address verification failures.
30654 .next
30655 The &%success_on_redirect%& option causes verification always to succeed
30656 immediately after a successful redirection. By default, if a redirection
30657 generates just one address, that address is also verified. See further
30658 discussion in section &<<SECTredirwhilveri>>&.
30659 .endlist
30660
30661 .cindex "verifying address" "differentiating failures"
30662 .vindex "&$recipient_verify_failure$&"
30663 .vindex "&$sender_verify_failure$&"
30664 .vindex "&$acl_verify_message$&"
30665 After an address verification failure, &$acl_verify_message$& contains the
30666 error message that is associated with the failure. It can be preserved by
30667 coding like this:
30668 .code
30669 warn  !verify = sender
30670        set acl_m0 = $acl_verify_message
30671 .endd
30672 If you are writing your own custom rejection message or log message when
30673 denying access, you can use this variable to include information about the
30674 verification failure.
30675
30676 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30677 appropriate) contains one of the following words:
30678
30679 .ilist
30680 &%qualify%&: The address was unqualified (no domain), and the message
30681 was neither local nor came from an exempted host.
30682 .next
30683 &%route%&: Routing failed.
30684 .next
30685 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30686 occurred at or before the MAIL command (that is, on initial
30687 connection, HELO, or MAIL).
30688 .next
30689 &%recipient%&: The RCPT command in a callout was rejected.
30690 .next
30691 &%postmaster%&: The postmaster check in a callout was rejected.
30692 .endlist
30693
30694 The main use of these variables is expected to be to distinguish between
30695 rejections of MAIL and rejections of RCPT in callouts.
30696
30697
30698
30699
30700 .section "Callout verification" "SECTcallver"
30701 .cindex "verifying address" "by callout"
30702 .cindex "callout" "verification"
30703 .cindex "SMTP" "callout verification"
30704 For non-local addresses, routing verifies the domain, but is unable to do any
30705 checking of the local part. There are situations where some means of verifying
30706 the local part is desirable. One way this can be done is to make an SMTP
30707 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30708 a subsequent host for a recipient address, to see if the host accepts the
30709 address. We use the term &'callout'& to cover both cases. Note that for a
30710 sender address, the callback is not to the client host that is trying to
30711 deliver the message, but to one of the hosts that accepts incoming mail for the
30712 sender's domain.
30713
30714 Exim does not do callouts by default. If you want them to happen, you must
30715 request them by setting appropriate options on the &%verify%& condition, as
30716 described below. This facility should be used with care, because it can add a
30717 lot of resource usage to the cost of verifying an address. However, Exim does
30718 cache the results of callouts, which helps to reduce the cost. Details of
30719 caching are in section &<<SECTcallvercache>>&.
30720
30721 Recipient callouts are usually used only between hosts that are controlled by
30722 the same administration. For example, a corporate gateway host could use
30723 callouts to check for valid recipients on an internal mailserver. A successful
30724 callout does not guarantee that a real delivery to the address would succeed;
30725 on the other hand, a failing callout does guarantee that a delivery would fail.
30726
30727 If the &%callout%& option is present on a condition that verifies an address, a
30728 second stage of verification occurs if the address is successfully routed to
30729 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30730 &(manualroute)& router, where the router specifies the hosts. However, if a
30731 router that does not set up hosts routes to an &(smtp)& transport with a
30732 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30733 &%hosts_override%& set, its hosts are always used, whether or not the router
30734 supplies a host list.
30735 Callouts are only supported on &(smtp)& transports.
30736
30737 The port that is used is taken from the transport, if it is specified and is a
30738 remote transport. (For routers that do verification only, no transport need be
30739 specified.) Otherwise, the default SMTP port is used. If a remote transport
30740 specifies an outgoing interface, this is used; otherwise the interface is not
30741 specified. Likewise, the text that is used for the HELO command is taken from
30742 the transport's &%helo_data%& option; if there is no transport, the value of
30743 &$smtp_active_hostname$& is used.
30744
30745 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30746 test whether a bounce message could be delivered to the sender address. The
30747 following SMTP commands are sent:
30748 .display
30749 &`HELO `&<&'local host name'&>
30750 &`MAIL FROM:<>`&
30751 &`RCPT TO:`&<&'the address to be tested'&>
30752 &`QUIT`&
30753 .endd
30754 LHLO is used instead of HELO if the transport's &%protocol%& option is
30755 set to &"lmtp"&.
30756
30757 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30758 settings.
30759
30760 A recipient callout check is similar. By default, it also uses an empty address
30761 for the sender. This default is chosen because most hosts do not make use of
30762 the sender address when verifying a recipient. Using the same address means
30763 that a single cache entry can be used for each recipient. Some sites, however,
30764 do make use of the sender address when verifying. These are catered for by the
30765 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30766
30767 If the response to the RCPT command is a 2&'xx'& code, the verification
30768 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30769 Exim tries the next host, if any. If there is a problem with all the remote
30770 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30771 &%callout%& option is given, in which case the condition is forced to succeed.
30772
30773 .cindex "SMTP" "output flushing, disabling for callout"
30774 A callout may take a little time. For this reason, Exim normally flushes SMTP
30775 output before performing a callout in an ACL, to avoid unexpected timeouts in
30776 clients when the SMTP PIPELINING extension is in use. The flushing can be
30777 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30778
30779
30780
30781
30782 .section "Additional parameters for callouts" "CALLaddparcall"
30783 .cindex "callout" "additional parameters for"
30784 The &%callout%& option can be followed by an equals sign and a number of
30785 optional parameters, separated by commas. For example:
30786 .code
30787 verify = recipient/callout=10s,defer_ok
30788 .endd
30789 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30790 separate verify options, is retained for backwards compatibility, but is now
30791 deprecated. The additional parameters for &%callout%& are as follows:
30792
30793
30794 .vlist
30795 .vitem <&'a&~time&~interval'&>
30796 .cindex "callout" "timeout, specifying"
30797 This specifies the timeout that applies for the callout attempt to each host.
30798 For example:
30799 .code
30800 verify = sender/callout=5s
30801 .endd
30802 The default is 30 seconds. The timeout is used for each response from the
30803 remote host. It is also used for the initial connection, unless overridden by
30804 the &%connect%& parameter.
30805
30806
30807 .vitem &*connect&~=&~*&<&'time&~interval'&>
30808 .cindex "callout" "connection timeout, specifying"
30809 This parameter makes it possible to set a different (usually smaller) timeout
30810 for making the SMTP connection. For example:
30811 .code
30812 verify = sender/callout=5s,connect=1s
30813 .endd
30814 If not specified, this timeout defaults to the general timeout value.
30815
30816 .vitem &*defer_ok*&
30817 .cindex "callout" "defer, action on"
30818 When this parameter is present, failure to contact any host, or any other kind
30819 of temporary error, is treated as success by the ACL. However, the cache is not
30820 updated in this circumstance.
30821
30822 .vitem &*fullpostmaster*&
30823 .cindex "callout" "full postmaster check"
30824 This operates like the &%postmaster%& option (see below), but if the check for
30825 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30826 accordance with the specification in RFC 2821. The RFC states that the
30827 unqualified address &'postmaster'& should be accepted.
30828
30829
30830 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30831 .cindex "callout" "sender when verifying header"
30832 When verifying addresses in header lines using the &%header_sender%&
30833 verification option, Exim behaves by default as if the addresses are envelope
30834 sender addresses from a message. Callout verification therefore tests to see
30835 whether a bounce message could be delivered, by using an empty address in the
30836 MAIL command. However, it is arguable that these addresses might never be used
30837 as envelope senders, and could therefore justifiably reject bounce messages
30838 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30839 address to use in the MAIL command. For example:
30840 .code
30841 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30842 .endd
30843 This parameter is available only for the &%header_sender%& verification option.
30844
30845
30846 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30847 .cindex "callout" "overall timeout, specifying"
30848 This parameter sets an overall timeout for performing a callout verification.
30849 For example:
30850 .code
30851 verify = sender/callout=5s,maxwait=30s
30852 .endd
30853 This timeout defaults to four times the callout timeout for individual SMTP
30854 commands. The overall timeout applies when there is more than one host that can
30855 be tried. The timeout is checked before trying the next host. This prevents
30856 very long delays if there are a large number of hosts and all are timing out
30857 (for example, when network connections are timing out).
30858
30859
30860 .vitem &*no_cache*&
30861 .cindex "callout" "cache, suppressing"
30862 .cindex "caching callout, suppressing"
30863 When this parameter is given, the callout cache is neither read nor updated.
30864
30865 .vitem &*postmaster*&
30866 .cindex "callout" "postmaster; checking"
30867 When this parameter is set, a successful callout check is followed by a similar
30868 check for the local part &'postmaster'& at the same domain. If this address is
30869 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30870 the postmaster check is recorded in a cache record; if it is a failure, this is
30871 used to fail subsequent callouts for the domain without a connection being
30872 made, until the cache record expires.
30873
30874 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30875 The postmaster check uses an empty sender in the MAIL command by default.
30876 You can use this parameter to do a postmaster check using a different address.
30877 For example:
30878 .code
30879 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30880 .endd
30881 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30882 one overrides. The &%postmaster%& parameter is equivalent to this example:
30883 .code
30884 require  verify = sender/callout=postmaster_mailfrom=
30885 .endd
30886 &*Warning*&: The caching arrangements for postmaster checking do not take
30887 account of the sender address. It is assumed that either the empty address or
30888 a fixed non-empty address will be used. All that Exim remembers is that the
30889 postmaster check for the domain succeeded or failed.
30890
30891
30892 .vitem &*random*&
30893 .cindex "callout" "&""random""& check"
30894 When this parameter is set, before doing the normal callout check, Exim does a
30895 check for a &"random"& local part at the same domain. The local part is not
30896 really random &-- it is defined by the expansion of the option
30897 &%callout_random_local_part%&, which defaults to
30898 .code
30899 $primary_hostname-$tod_epoch-testing
30900 .endd
30901 The idea here is to try to determine whether the remote host accepts all local
30902 parts without checking. If it does, there is no point in doing callouts for
30903 specific local parts. If the &"random"& check succeeds, the result is saved in
30904 a cache record, and used to force the current and subsequent callout checks to
30905 succeed without a connection being made, until the cache record expires.
30906
30907 .vitem &*use_postmaster*&
30908 .cindex "callout" "sender for recipient check"
30909 This parameter applies to recipient callouts only. For example:
30910 .code
30911 deny  !verify = recipient/callout=use_postmaster
30912 .endd
30913 .vindex "&$qualify_domain$&"
30914 It causes a non-empty postmaster address to be used in the MAIL command when
30915 performing the callout for the recipient, and also for a &"random"& check if
30916 that is configured. The local part of the address is &`postmaster`& and the
30917 domain is the contents of &$qualify_domain$&.
30918
30919 .vitem &*use_sender*&
30920 This option applies to recipient callouts only. For example:
30921 .code
30922 require  verify = recipient/callout=use_sender
30923 .endd
30924 It causes the message's actual sender address to be used in the MAIL
30925 command when performing the callout, instead of an empty address. There is no
30926 need to use this option unless you know that the called hosts make use of the
30927 sender when checking recipients. If used indiscriminately, it reduces the
30928 usefulness of callout caching.
30929 .endlist
30930
30931 If you use any of the parameters that set a non-empty sender for the MAIL
30932 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30933 &%use_sender%&), you should think about possible loops. Recipient checking is
30934 usually done between two hosts that are under the same management, and the host
30935 that receives the callouts is not normally configured to do callouts itself.
30936 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30937 these circumstances.
30938
30939 However, if you use a non-empty sender address for a callout to an arbitrary
30940 host, there is the likelihood that the remote host will itself initiate a
30941 callout check back to your host. As it is checking what appears to be a message
30942 sender, it is likely to use an empty address in MAIL, thus avoiding a
30943 callout loop. However, to be on the safe side it would be best to set up your
30944 own ACLs so that they do not do sender verification checks when the recipient
30945 is the address you use for header sender or postmaster callout checking.
30946
30947 Another issue to think about when using non-empty senders for callouts is
30948 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30949 by the sender/recipient combination; thus, for any given recipient, many more
30950 actual callouts are performed than when an empty sender or postmaster is used.
30951
30952
30953
30954
30955 .section "Callout caching" "SECTcallvercache"
30956 .cindex "hints database" "callout cache"
30957 .cindex "callout" "cache, description of"
30958 .cindex "caching" "callout"
30959 Exim caches the results of callouts in order to reduce the amount of resources
30960 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30961 option. A hints database called &"callout"& is used for the cache. Two
30962 different record types are used: one records the result of a callout check for
30963 a specific address, and the other records information that applies to the
30964 entire domain (for example, that it accepts the local part &'postmaster'&).
30965
30966 When an original callout fails, a detailed SMTP error message is given about
30967 the failure. However, for subsequent failures use the cache data, this message
30968 is not available.
30969
30970 The expiry times for negative and positive address cache records are
30971 independent, and can be set by the global options &%callout_negative_expire%&
30972 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30973
30974 If a host gives a negative response to an SMTP connection, or rejects any
30975 commands up to and including
30976 .code
30977 MAIL FROM:<>
30978 .endd
30979 (but not including the MAIL command with a non-empty address),
30980 any callout attempt is bound to fail. Exim remembers such failures in a
30981 domain cache record, which it uses to fail callouts for the domain without
30982 making new connections, until the domain record times out. There are two
30983 separate expiry times for domain cache records:
30984 &%callout_domain_negative_expire%& (default 3h) and
30985 &%callout_domain_positive_expire%& (default 7d).
30986
30987 Domain records expire when the negative expiry time is reached if callouts
30988 cannot be made for the domain, or if the postmaster check failed.
30989 Otherwise, they expire when the positive expiry time is reached. This
30990 ensures that, for example, a host that stops accepting &"random"& local parts
30991 will eventually be noticed.
30992
30993 The callout caching mechanism is based on the domain of the address that is
30994 being tested. If the domain routes to several hosts, it is assumed that their
30995 behaviour will be the same.
30996
30997
30998
30999 .section "Sender address verification reporting" "SECTsenaddver"
31000 .cindex "verifying" "suppressing error details"
31001 See section &<<SECTaddressverification>>& for a general discussion of
31002 verification. When sender verification fails in an ACL, the details of the
31003 failure are given as additional output lines before the 550 response to the
31004 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31005 you might see:
31006 .code
31007 MAIL FROM:<xyz@abc.example>
31008 250 OK
31009 RCPT TO:<pqr@def.example>
31010 550-Verification failed for <xyz@abc.example>
31011 550-Called:   192.168.34.43
31012 550-Sent:     RCPT TO:<xyz@abc.example>
31013 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31014 550 Sender verification failed
31015 .endd
31016 If more than one RCPT command fails in the same way, the details are given
31017 only for the first of them. However, some administrators do not want to send
31018 out this much information. You can suppress the details by adding
31019 &`/no_details`& to the ACL statement that requests sender verification. For
31020 example:
31021 .code
31022 verify = sender/no_details
31023 .endd
31024
31025 .section "Redirection while verifying" "SECTredirwhilveri"
31026 .cindex "verifying" "redirection while"
31027 .cindex "address redirection" "while verifying"
31028 A dilemma arises when a local address is redirected by aliasing or forwarding
31029 during verification: should the generated addresses themselves be verified,
31030 or should the successful expansion of the original address be enough to verify
31031 it? By default, Exim takes the following pragmatic approach:
31032
31033 .ilist
31034 When an incoming address is redirected to just one child address, verification
31035 continues with the child address, and if that fails to verify, the original
31036 verification also fails.
31037 .next
31038 When an incoming address is redirected to more than one child address,
31039 verification does not continue. A success result is returned.
31040 .endlist
31041
31042 This seems the most reasonable behaviour for the common use of aliasing as a
31043 way of redirecting different local parts to the same mailbox. It means, for
31044 example, that a pair of alias entries of the form
31045 .code
31046 A.Wol:   aw123
31047 aw123:   :fail: Gone away, no forwarding address
31048 .endd
31049 work as expected, with both local parts causing verification failure. When a
31050 redirection generates more than one address, the behaviour is more like a
31051 mailing list, where the existence of the alias itself is sufficient for
31052 verification to succeed.
31053
31054 It is possible, however, to change the default behaviour so that all successful
31055 redirections count as successful verifications, however many new addresses are
31056 generated. This is specified by the &%success_on_redirect%& verification
31057 option. For example:
31058 .code
31059 require verify = recipient/success_on_redirect/callout=10s
31060 .endd
31061 In this example, verification succeeds if a router generates a new address, and
31062 the callout does not occur, because no address was routed to a remote host.
31063
31064 When verification is being tested via the &%-bv%& option, the treatment of
31065 redirections is as just described, unless the &%-v%& or any debugging option is
31066 also specified. In that case, full verification is done for every generated
31067 address and a report is output for each of them.
31068
31069
31070
31071 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31072 .cindex "CSA" "verifying"
31073 Client SMTP Authorization is a system that allows a site to advertise
31074 which machines are and are not permitted to send email. This is done by placing
31075 special SRV records in the DNS; these are looked up using the client's HELO
31076 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31077 Authorization checks in Exim are performed by the ACL condition:
31078 .code
31079 verify = csa
31080 .endd
31081 This fails if the client is not authorized. If there is a DNS problem, or if no
31082 valid CSA SRV record is found, or if the client is authorized, the condition
31083 succeeds. These three cases can be distinguished using the expansion variable
31084 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31085 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31086 be likely to cause problems for legitimate email.
31087
31088 The error messages produced by the CSA code include slightly more
31089 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31090 looking up the CSA SRV record, or problems looking up the CSA target
31091 address record. There are four reasons for &$csa_status$& being &"fail"&:
31092
31093 .ilist
31094 The client's host name is explicitly not authorized.
31095 .next
31096 The client's IP address does not match any of the CSA target IP addresses.
31097 .next
31098 The client's host name is authorized but it has no valid target IP addresses
31099 (for example, the target's addresses are IPv6 and the client is using IPv4).
31100 .next
31101 The client's host name has no CSA SRV record but a parent domain has asserted
31102 that all subdomains must be explicitly authorized.
31103 .endlist
31104
31105 The &%csa%& verification condition can take an argument which is the domain to
31106 use for the DNS query. The default is:
31107 .code
31108 verify = csa/$sender_helo_name
31109 .endd
31110 This implementation includes an extension to CSA. If the query domain
31111 is an address literal such as [192.0.2.95], or if it is a bare IP
31112 address, Exim searches for CSA SRV records in the reverse DNS as if
31113 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31114 meaningful to say:
31115 .code
31116 verify = csa/$sender_host_address
31117 .endd
31118 In fact, this is the check that Exim performs if the client does not say HELO.
31119 This extension can be turned off by setting the main configuration option
31120 &%dns_csa_use_reverse%& to be false.
31121
31122 If a CSA SRV record is not found for the domain itself, a search
31123 is performed through its parent domains for a record which might be
31124 making assertions about subdomains. The maximum depth of this search is limited
31125 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31126 default. Exim does not look for CSA SRV records in a top level domain, so the
31127 default settings handle HELO domains as long as seven
31128 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31129 of legitimate HELO domains.
31130
31131 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31132 direct SRV lookups, this is not sufficient because of the extra parent domain
31133 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31134 addresses into lookups in the reverse DNS space. The result of a successful
31135 lookup such as:
31136 .code
31137 ${lookup dnsdb {csa=$sender_helo_name}}
31138 .endd
31139 has two space-separated fields: an authorization code and a target host name.
31140 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31141 authorization required but absent, or &"?"& for unknown.
31142
31143
31144
31145
31146 .section "Bounce address tag validation" "SECTverifyPRVS"
31147 .cindex "BATV, verifying"
31148 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31149 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31150 Genuine incoming bounce messages should therefore always be addressed to
31151 recipients that have a valid tag. This scheme is a way of detecting unwanted
31152 bounce messages caused by sender address forgeries (often called &"collateral
31153 spam"&), because the recipients of such messages do not include valid tags.
31154
31155 There are two expansion items to help with the implementation of the BATV
31156 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31157 the original envelope sender address by using a simple key to add a hash of the
31158 address and some time-based randomizing information. The &%prvs%& expansion
31159 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31160 The syntax of these expansion items is described in section
31161 &<<SECTexpansionitems>>&.
31162
31163 As an example, suppose the secret per-address keys are stored in an MySQL
31164 database. A query to look up the key for an address could be defined as a macro
31165 like this:
31166 .code
31167 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31168                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31169                 }{$value}}
31170 .endd
31171 Suppose also that the senders who make use of BATV are defined by an address
31172 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31173 use this:
31174 .code
31175 # Bounces: drop unsigned addresses for BATV senders
31176 deny message = This address does not send an unsigned reverse path
31177      senders = :
31178      recipients = +batv_senders
31179
31180 # Bounces: In case of prvs-signed address, check signature.
31181 deny message = Invalid reverse path signature.
31182      senders = :
31183      condition  = ${prvscheck {$local_part@$domain}\
31184                   {PRVSCHECK_SQL}{1}}
31185      !condition = $prvscheck_result
31186 .endd
31187 The first statement rejects recipients for bounce messages that are addressed
31188 to plain BATV sender addresses, because it is known that BATV senders do not
31189 send out messages with plain sender addresses. The second statement rejects
31190 recipients that are prvs-signed, but with invalid signatures (either because
31191 the key is wrong, or the signature has timed out).
31192
31193 A non-prvs-signed address is not rejected by the second statement, because the
31194 &%prvscheck%& expansion yields an empty string if its first argument is not a
31195 prvs-signed address, thus causing the &%condition%& condition to be false. If
31196 the first argument is a syntactically valid prvs-signed address, the yield is
31197 the third string (in this case &"1"&), whether or not the cryptographic and
31198 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31199 of the checks (empty for failure, &"1"& for success).
31200
31201 There is one more issue you must consider when implementing prvs-signing:
31202 you have to ensure that the routers accept prvs-signed addresses and
31203 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31204 router to remove the signature with a configuration along these lines:
31205 .code
31206 batv_redirect:
31207   driver = redirect
31208   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31209 .endd
31210 This works because, if the third argument of &%prvscheck%& is empty, the result
31211 of the expansion of a prvs-signed address is the decoded value of the original
31212 address. This router should probably be the first of your routers that handles
31213 local addresses.
31214
31215 To create BATV-signed addresses in the first place, a transport of this form
31216 can be used:
31217 .code
31218 external_smtp_batv:
31219   driver = smtp
31220   return_path = ${prvs {$return_path} \
31221                        {${lookup mysql{SELECT \
31222                        secret FROM batv_prvs WHERE \
31223                        sender='${quote_mysql:$sender_address}'} \
31224                        {$value}fail}}}
31225 .endd
31226 If no key can be found for the existing return path, no signing takes place.
31227
31228
31229
31230 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31231 .cindex "&ACL;" "relay control"
31232 .cindex "relaying" "control by ACL"
31233 .cindex "policy control" "relay control"
31234 An MTA is said to &'relay'& a message if it receives it from some host and
31235 delivers it directly to another host as a result of a remote address contained
31236 within it. Redirecting a local address via an alias or forward file and then
31237 passing the message on to another host is not relaying,
31238 .cindex "&""percent hack""&"
31239 but a redirection as a result of the &"percent hack"& is.
31240
31241 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31242 A host which is acting as a gateway or an MX backup is concerned with incoming
31243 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31244 a host which is acting as a smart host for a number of clients is concerned
31245 with outgoing relaying from those clients to the Internet at large. Often the
31246 same host is fulfilling both functions,
31247 . ///
31248 . as illustrated in the diagram below,
31249 . ///
31250 but in principle these two kinds of relaying are entirely independent. What is
31251 not wanted is the transmission of mail from arbitrary remote hosts through your
31252 system to arbitrary domains.
31253
31254
31255 You can implement relay control by means of suitable statements in the ACL that
31256 runs for each RCPT command. For convenience, it is often easiest to use
31257 Exim's named list facility to define the domains and hosts involved. For
31258 example, suppose you want to do the following:
31259
31260 .ilist
31261 Deliver a number of domains to mailboxes on the local host (or process them
31262 locally in some other way). Let's say these are &'my.dom1.example'& and
31263 &'my.dom2.example'&.
31264 .next
31265 Relay mail for a number of other domains for which you are the secondary MX.
31266 These might be &'friend1.example'& and &'friend2.example'&.
31267 .next
31268 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31269 Suppose your LAN is 192.168.45.0/24.
31270 .endlist
31271
31272
31273 In the main part of the configuration, you put the following definitions:
31274 .code
31275 domainlist local_domains    = my.dom1.example : my.dom2.example
31276 domainlist relay_to_domains = friend1.example : friend2.example
31277 hostlist   relay_from_hosts = 192.168.45.0/24
31278 .endd
31279 Now you can use these definitions in the ACL that is run for every RCPT
31280 command:
31281 .code
31282 acl_check_rcpt:
31283   accept domains = +local_domains : +relay_to_domains
31284   accept hosts   = +relay_from_hosts
31285 .endd
31286 The first statement accepts any RCPT command that contains an address in
31287 the local or relay domains. For any other domain, control passes to the second
31288 statement, which accepts the command only if it comes from one of the relay
31289 hosts. In practice, you will probably want to make your ACL more sophisticated
31290 than this, for example, by including sender and recipient verification. The
31291 default configuration includes a more comprehensive example, which is described
31292 in chapter &<<CHAPdefconfil>>&.
31293
31294
31295
31296 .section "Checking a relay configuration" "SECTcheralcon"
31297 .cindex "relaying" "checking control of"
31298 You can check the relay characteristics of your configuration in the same way
31299 that you can test any ACL behaviour for an incoming SMTP connection, by using
31300 the &%-bh%& option to run a fake SMTP session with which you interact.
31301 .ecindex IIDacl
31302
31303
31304
31305 . ////////////////////////////////////////////////////////////////////////////
31306 . ////////////////////////////////////////////////////////////////////////////
31307
31308 .chapter "Content scanning at ACL time" "CHAPexiscan"
31309 .scindex IIDcosca "content scanning" "at ACL time"
31310 The extension of Exim to include content scanning at ACL time, formerly known
31311 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31312 was integrated into the main source for Exim release 4.50, and Tom continues to
31313 maintain it. Most of the wording of this chapter is taken from Tom's
31314 specification.
31315
31316 It is also possible to scan the content of messages at other times. The
31317 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31318 scanning after all the ACLs have run. A transport filter can be used to scan
31319 messages at delivery time (see the &%transport_filter%& option, described in
31320 chapter &<<CHAPtransportgeneric>>&).
31321
31322 If you want to include the ACL-time content-scanning features when you compile
31323 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31324 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31325
31326 .ilist
31327 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31328 for all MIME parts for SMTP and non-SMTP messages, respectively.
31329 .next
31330 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31331 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31332 run at the end of message reception (the &%acl_smtp_data%& ACL).
31333 .next
31334 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31335 of messages, or parts of messages, for debugging purposes.
31336 .next
31337 Additional expansion variables that are set in the new ACL and by the new
31338 conditions.
31339 .next
31340 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31341 .endlist
31342
31343 Content-scanning is continually evolving, and new features are still being
31344 added. While such features are still unstable and liable to incompatible
31345 changes, they are made available in Exim by setting options whose names begin
31346 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31347 this manual. You can find out about them by reading the file called
31348 &_doc/experimental.txt_&.
31349
31350 All the content-scanning facilities work on a MBOX copy of the message that is
31351 temporarily created in a file called:
31352 .display
31353 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31354 .endd
31355 The &_.eml_& extension is a friendly hint to virus scanners that they can
31356 expect an MBOX-like structure inside that file. The file is created when the
31357 first content scanning facility is called. Subsequent calls to content
31358 scanning conditions open the same file again. The directory is recursively
31359 removed when the &%acl_smtp_data%& ACL has finished running, unless
31360 .code
31361 control = no_mbox_unspool
31362 .endd
31363 has been encountered. When the MIME ACL decodes files, they are put into the
31364 same directory by default.
31365
31366
31367
31368 .section "Scanning for viruses" "SECTscanvirus"
31369 .cindex "virus scanning"
31370 .cindex "content scanning" "for viruses"
31371 .cindex "content scanning" "the &%malware%& condition"
31372 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31373 It supports a &"generic"& interface to scanners called via the shell, and
31374 specialized interfaces for &"daemon"& type virus scanners, which are resident
31375 in memory and thus are much faster.
31376
31377 A timeout of 2 minutes is applied to a scanner call (by default);
31378 if it expires then a defer action is taken.
31379
31380 .oindex "&%av_scanner%&"
31381 You can set the &%av_scanner%& option in the main part of the configuration
31382 to specify which scanner to use, together with any additional options that
31383 are needed. The basic syntax is as follows:
31384 .display
31385 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31386 .endd
31387 If you do not set &%av_scanner%&, it defaults to
31388 .code
31389 av_scanner = sophie:/var/run/sophie
31390 .endd
31391 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31392 before use.
31393 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31394 The following scanner types are supported in this release:
31395
31396 .vlist
31397 .vitem &%avast%&
31398 .cindex "virus scanners" "avast"
31399 This is the scanner daemon of Avast. It has been tested with Avast Core
31400 Security (currently at version 1.1.7).
31401 You can get a trial version at &url(http://www.avast.com) or for Linux
31402 at &url(http://www.avast.com/linux-server-antivirus).
31403 This scanner type takes one option,
31404 which can be either a full path to a UNIX socket,
31405 or host and port specifiers separated by white space.
31406 The host may be a name or an IP address; the port is either a
31407 single number or a pair of numbers with a dash between.
31408 Any further options are given, on separate lines,
31409 to the daemon as options before the main scan command.
31410 For example:
31411 .code
31412 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31413 av_scanner = avast:192.168.2.22 5036
31414 .endd
31415 If you omit the argument, the default path
31416 &_/var/run/avast/scan.sock_&
31417 is used.
31418 If you use a remote host,
31419 you need to make Exim's spool directory available to it,
31420 as the scanner is passed a file path, not file contents.
31421 For information about available commands and their options you may use
31422 .code
31423 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31424     FLAGS
31425     SENSITIVITY
31426     PACK
31427 .endd
31428
31429
31430 .vitem &%aveserver%&
31431 .cindex "virus scanners" "Kaspersky"
31432 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31433 at &url(http://www.kaspersky.com). This scanner type takes one option,
31434 which is the path to the daemon's UNIX socket. The default is shown in this
31435 example:
31436 .code
31437 av_scanner = aveserver:/var/run/aveserver
31438 .endd
31439
31440
31441 .vitem &%clamd%&
31442 .cindex "virus scanners" "clamd"
31443 This daemon-type scanner is GPL and free. You can get it at
31444 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31445 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31446 in the MIME ACL. This is no longer believed to be necessary.
31447
31448 The options are a list of server specifiers, which may be
31449 a UNIX socket specification,
31450 a TCP socket specification,
31451 or a (global) option.
31452
31453 A socket specification consists of a space-separated list.
31454 For a Unix socket the first element is a full path for the socket,
31455 for a TCP socket the first element is the IP address
31456 and the second a port number,
31457 Any further elements are per-server (non-global) options.
31458 These per-server options are supported:
31459 .code
31460 retry=<timespec>        Retry on connect fail
31461 .endd
31462
31463 The &`retry`& option specifies a time after which a single retry for
31464 a failed connect is made.  The default is to not retry.
31465
31466 If a Unix socket file is specified, only one server is supported.
31467
31468 Examples:
31469 .code
31470 av_scanner = clamd:/opt/clamd/socket
31471 av_scanner = clamd:192.0.2.3 1234
31472 av_scanner = clamd:192.0.2.3 1234:local
31473 av_scanner = clamd:192.0.2.3 1234 retry=10s
31474 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31475 .endd
31476 If the value of av_scanner points to a UNIX socket file or contains the
31477 &`local`&
31478 option, then the ClamAV interface will pass a filename containing the data
31479 to be scanned, which will should normally result in less I/O happening and be
31480 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31481 Exim does not assume that there is a common filesystem with the remote host.
31482 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31483 you be running a version of ClamAV prior to 0.95.
31484
31485 The final example shows that multiple TCP targets can be specified.  Exim will
31486 randomly use one for each incoming email (i.e. it load balances them).  Note
31487 that only TCP targets may be used if specifying a list of scanners; a UNIX
31488 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31489 unavailable, Exim will try the remaining one(s) until it finds one that works.
31490 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31491 not keep track of scanner state between multiple messages, and the scanner
31492 selection is random, so the message will get logged in the mainlog for each
31493 email that the down scanner gets chosen first (message wrapped to be readable):
31494 .code
31495 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31496    clamd: connection to localhost, port 3310 failed
31497    (Connection refused)
31498 .endd
31499
31500 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31501 contributing the code for this scanner.
31502
31503 .vitem &%cmdline%&
31504 .cindex "virus scanners" "command line interface"
31505 This is the keyword for the generic command line scanner interface. It can be
31506 used to attach virus scanners that are invoked from the shell. This scanner
31507 type takes 3 mandatory options:
31508
31509 .olist
31510 The full path and name of the scanner binary, with all command line options,
31511 and a placeholder (&`%s`&) for the directory to scan.
31512
31513 .next
31514 A regular expression to match against the STDOUT and STDERR output of the
31515 virus scanner. If the expression matches, a virus was found. You must make
31516 absolutely sure that this expression matches on &"virus found"&. This is called
31517 the &"trigger"& expression.
31518
31519 .next
31520 Another regular expression, containing exactly one pair of parentheses, to
31521 match the name of the virus found in the scanners output. This is called the
31522 &"name"& expression.
31523 .endlist olist
31524
31525 For example, Sophos Sweep reports a virus on a line like this:
31526 .code
31527 Virus 'W32/Magistr-B' found in file ./those.bat
31528 .endd
31529 For the trigger expression, we can match the phrase &"found in file"&. For the
31530 name expression, we want to extract the W32/Magistr-B string, so we can match
31531 for the single quotes left and right of it. Altogether, this makes the
31532 configuration setting:
31533 .code
31534 av_scanner = cmdline:\
31535              /path/to/sweep -ss -all -rec -archive %s:\
31536              found in file:'(.+)'
31537 .endd
31538 .vitem &%drweb%&
31539 .cindex "virus scanners" "DrWeb"
31540 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31541 takes one option,
31542 either a full path to a UNIX socket,
31543 or host and port specifiers separated by white space.
31544 The host may be a name or an IP address; the port is either a
31545 single number or a pair of numbers with a dash between.
31546 For example:
31547 .code
31548 av_scanner = drweb:/var/run/drwebd.sock
31549 av_scanner = drweb:192.168.2.20 31337
31550 .endd
31551 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31552 is used. Thanks to Alex Miller for contributing the code for this scanner.
31553
31554 .vitem &%f-protd%&
31555 .cindex "virus scanners" "f-protd"
31556 The f-protd scanner is accessed via HTTP over TCP.
31557 One argument is taken, being a space-separated hostname and port number
31558 (or port-range).
31559 For example:
31560 .code
31561 av_scanner = f-protd:localhost 10200-10204
31562 .endd
31563 If you omit the argument, the default values show above are used.
31564
31565 .vitem &%fsecure%&
31566 .cindex "virus scanners" "F-Secure"
31567 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31568 argument which is the path to a UNIX socket. For example:
31569 .code
31570 av_scanner = fsecure:/path/to/.fsav
31571 .endd
31572 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31573 Thelmen for contributing the code for this scanner.
31574
31575 .vitem &%kavdaemon%&
31576 .cindex "virus scanners" "Kaspersky"
31577 This is the scanner daemon of Kaspersky Version 4. This version of the
31578 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31579 scanner type takes one option, which is the path to the daemon's UNIX socket.
31580 For example:
31581 .code
31582 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31583 .endd
31584 The default path is &_/var/run/AvpCtl_&.
31585
31586 .vitem &%mksd%&
31587 .cindex "virus scanners" "mksd"
31588 This is a daemon type scanner that is aimed mainly at Polish users, though some
31589 parts of documentation are now available in English. You can get it at
31590 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31591 the maximum number of processes used simultaneously to scan the attachments,
31592 provided that mksd has
31593 been run with at least the same number of child processes. For example:
31594 .code
31595 av_scanner = mksd:2
31596 .endd
31597 You can safely omit this option (the default value is 1).
31598
31599 .vitem &%sock%&
31600 .cindex "virus scanners" "simple socket-connected"
31601 This is a general-purpose way of talking to simple scanner daemons
31602 running on the local machine.
31603 There are four options:
31604 an address (which may be an IP address and port, or the path of a Unix socket),
31605 a commandline to send (may include a single %s which will be replaced with
31606 the path to the mail file to be scanned),
31607 an RE to trigger on from the returned data,
31608 an RE to extract malware_name from the returned data.
31609 For example:
31610 .code
31611 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31612 .endd
31613 Default for the socket specifier is &_/tmp/malware.sock_&.
31614 Default for the commandline is &_%s\n_&.
31615 Both regular-expressions are required.
31616
31617 .vitem &%sophie%&
31618 .cindex "virus scanners" "Sophos and Sophie"
31619 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31620 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31621 for this scanner type is the path to the UNIX socket that Sophie uses for
31622 client communication. For example:
31623 .code
31624 av_scanner = sophie:/tmp/sophie
31625 .endd
31626 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31627 the option.
31628 .endlist
31629
31630 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31631 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31632 ACL.
31633
31634 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31635 makes it possible to use different scanners. See further below for an example.
31636 The &%malware%& condition caches its results, so when you use it multiple times
31637 for the same message, the actual scanning process is only carried out once.
31638 However, using expandable items in &%av_scanner%& disables this caching, in
31639 which case each use of the &%malware%& condition causes a new scan of the
31640 message.
31641
31642 The &%malware%& condition takes a right-hand argument that is expanded before
31643 use and taken as a list, slash-separated by default.
31644 The first element can then be one of
31645
31646 .ilist
31647 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31648 The condition succeeds if a virus was found, and fail otherwise. This is the
31649 recommended usage.
31650 .next
31651 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31652 the condition fails immediately.
31653 .next
31654 A regular expression, in which case the message is scanned for viruses. The
31655 condition succeeds if a virus is found and its name matches the regular
31656 expression. This allows you to take special actions on certain types of virus.
31657 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31658 unless the separator is changed (in the usual way).
31659 .endlist
31660
31661 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31662 messages even if there is a problem with the virus scanner.
31663 Otherwise, such a problem causes the ACL to defer.
31664
31665 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31666 specify a non-default timeout.  The default is two minutes.
31667 For example:
31668 .code
31669 malware = * / defer_ok / tmo=10s
31670 .endd
31671 A timeout causes the ACL to defer.
31672
31673 .vindex "&$callout_address$&"
31674 When a connection is made to the scanner the expansion variable &$callout_address$&
31675 is set to record the actual address used.
31676
31677 .vindex "&$malware_name$&"
31678 When a virus is found, the condition sets up an expansion variable called
31679 &$malware_name$& that contains the name of the virus. You can use it in a
31680 &%message%& modifier that specifies the error returned to the sender, and/or in
31681 logging data.
31682
31683 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31684 imposed by your anti-virus scanner.
31685
31686 Here is a very simple scanning example:
31687 .code
31688 deny message = This message contains malware ($malware_name)
31689      malware = *
31690 .endd
31691 The next example accepts messages when there is a problem with the scanner:
31692 .code
31693 deny message = This message contains malware ($malware_name)
31694      malware = */defer_ok
31695 .endd
31696 The next example shows how to use an ACL variable to scan with both sophie and
31697 aveserver. It assumes you have set:
31698 .code
31699 av_scanner = $acl_m0
31700 .endd
31701 in the main Exim configuration.
31702 .code
31703 deny message = This message contains malware ($malware_name)
31704      set acl_m0 = sophie
31705      malware = *
31706
31707 deny message = This message contains malware ($malware_name)
31708      set acl_m0 = aveserver
31709      malware = *
31710 .endd
31711
31712
31713 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31714 .cindex "content scanning" "for spam"
31715 .cindex "spam scanning"
31716 .cindex "SpamAssassin"
31717 .cindex "Rspamd"
31718 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31719 score and a report for the message.
31720 Support is also provided for Rspamd.
31721
31722 For more information about installation and configuration of SpamAssassin or
31723 Rspamd refer to their respective websites at
31724 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31725
31726 SpamAssassin can be installed with CPAN by running:
31727 .code
31728 perl -MCPAN -e 'install Mail::SpamAssassin'
31729 .endd
31730 SpamAssassin has its own set of configuration files. Please review its
31731 documentation to see how you can tweak it. The default installation should work
31732 nicely, however.
31733
31734 .oindex "&%spamd_address%&"
31735 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31736 intend to use an instance running on the local host you do not need to set
31737 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31738 you must set the &%spamd_address%& option in the global part of the Exim
31739 configuration as follows (example):
31740 .code
31741 spamd_address = 192.168.99.45 387
31742 .endd
31743 The SpamAssassin protocol relies on a TCP half-close from the client.
31744 If your SpamAssassin client side is running a Linux system with an
31745 iptables firewall, consider setting
31746 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
31747 timeout, Exim uses when waiting for a response from the SpamAssassin
31748 server (currently defaulting to 120s).  With a lower value the Linux
31749 connection tracking may consider your half-closed connection as dead too
31750 soon.
31751
31752
31753 To use Rspamd (which by default listens on all local addresses
31754 on TCP port 11333)
31755 you should add &%variant=rspamd%& after the address/port pair, for example:
31756 .code
31757 spamd_address = 127.0.0.1 11333 variant=rspamd
31758 .endd
31759
31760 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31761 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31762 file name instead of an address/port pair:
31763 .code
31764 spamd_address = /var/run/spamd_socket
31765 .endd
31766 You can have multiple &%spamd%& servers to improve scalability. These can
31767 reside on other hardware reachable over the network. To specify multiple
31768 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31769 option, separated with colons (the separator can be changed in the usual way):
31770 .code
31771 spamd_address = 192.168.2.10 783 : \
31772                 192.168.2.11 783 : \
31773                 192.168.2.12 783
31774 .endd
31775 Up to 32 &%spamd%& servers are supported.
31776 When a server fails to respond to the connection attempt, all other
31777 servers are tried until one succeeds. If no server responds, the &%spam%&
31778 condition defers.
31779
31780 Unix and TCP socket specifications may be mixed in any order.
31781 Each element of the list is a list itself, space-separated by default
31782 and changeable in the usual way; take care to not double the separator.
31783
31784 For TCP socket specifications a host name or IP (v4 or v6, but
31785 subject to list-separator quoting rules) address can be used,
31786 and the port can be one or a dash-separated pair.
31787 In the latter case, the range is tried in strict order.
31788
31789 Elements after the first for Unix sockets, or second for TCP socket,
31790 are options.
31791 The supported options are:
31792 .code
31793 pri=<priority>      Selection priority
31794 weight=<value>      Selection bias
31795 time=<start>-<end>  Use only between these times of day
31796 retry=<timespec>    Retry on connect fail
31797 tmo=<timespec>      Connection time limit
31798 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31799 .endd
31800
31801 The &`pri`& option specifies a priority for the server within the list,
31802 higher values being tried first.
31803 The default priority is 1.
31804
31805 The &`weight`& option specifies a selection bias.
31806 Within a priority set
31807 servers are queried in a random fashion, weighted by this value.
31808 The default value for selection bias is 1.
31809
31810 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31811 in the local time zone; each element being one or more digits.
31812 Either the seconds or both minutes and seconds, plus the leading &`.`&
31813 characters, may be omitted and will be taken as zero.
31814
31815 Timeout specifications for the &`retry`& and &`tmo`& options
31816 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31817
31818 The &`tmo`& option specifies an overall timeout for communication.
31819 The default value is two minutes.
31820
31821 The &`retry`& option specifies a time after which a single retry for
31822 a failed connect is made.
31823 The default is to not retry.
31824
31825 The &%spamd_address%& variable is expanded before use if it starts with
31826 a dollar sign. In this case, the expansion may return a string that is
31827 used as the list so that multiple spamd servers can be the result of an
31828 expansion.
31829
31830 .vindex "&$callout_address$&"
31831 When a connection is made to the server the expansion variable &$callout_address$&
31832 is set to record the actual address used.
31833
31834 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31835 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31836 .code
31837 deny message = This message was classified as SPAM
31838      spam = joe
31839 .endd
31840 The right-hand side of the &%spam%& condition specifies a name. This is
31841 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31842 to scan using a specific profile, but rather use the SpamAssassin system-wide
31843 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31844 Rspamd does not use this setting. However, you must put something on the
31845 right-hand side.
31846
31847 The name allows you to use per-domain or per-user antispam profiles in
31848 principle, but this is not straightforward in practice, because a message may
31849 have multiple recipients, not necessarily all in the same domain. Because the
31850 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31851 read the contents of the message, the variables &$local_part$& and &$domain$&
31852 are not set.
31853 Careful enforcement of single-recipient messages
31854 (e.g. by responding with defer in the recipient ACL for all recipients
31855 after the first),
31856 or the use of PRDR,
31857 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31858 are needed to use this feature.
31859
31860 The right-hand side of the &%spam%& condition is expanded before being used, so
31861 you can put lookups or conditions there. When the right-hand side evaluates to
31862 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31863
31864
31865 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31866 large ones may cause significant performance degradation. As most spam messages
31867 are quite small, it is recommended that you do not scan the big ones. For
31868 example:
31869 .code
31870 deny message = This message was classified as SPAM
31871      condition = ${if < {$message_size}{10K}}
31872      spam = nobody
31873 .endd
31874
31875 The &%spam%& condition returns true if the threshold specified in the user's
31876 SpamAssassin profile has been matched or exceeded. If you want to use the
31877 &%spam%& condition for its side effects (see the variables below), you can make
31878 it always return &"true"& by appending &`:true`& to the username.
31879
31880 .cindex "spam scanning" "returned variables"
31881 When the &%spam%& condition is run, it sets up a number of expansion
31882 variables.
31883 Except for &$spam_report$&,
31884 these variables are saved with the received message so are
31885 available for use at delivery time.
31886
31887 .vlist
31888 .vitem &$spam_score$&
31889 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31890 for inclusion in log or reject messages.
31891
31892 .vitem &$spam_score_int$&
31893 The spam score of the message, multiplied by ten, as an integer value. For
31894 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31895 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31896 The integer value is useful for numeric comparisons in conditions.
31897
31898 .vitem &$spam_bar$&
31899 A string consisting of a number of &"+"& or &"-"& characters, representing the
31900 integer part of the spam score value. A spam score of 4.4 would have a
31901 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31902 headers, since MUAs can match on such strings. The maximum length of the
31903 spam bar is 50 characters.
31904
31905 .vitem &$spam_report$&
31906 A multiline text table, containing the full SpamAssassin report for the
31907 message. Useful for inclusion in headers or reject messages.
31908 This variable is only usable in a DATA-time ACL.
31909 .new
31910 Beware that SpamAssassin may return non-ASCII characters, especially
31911 when running in country-specific locales, which are not legal
31912 unencoded in headers.
31913 .wen
31914
31915 .vitem &$spam_action$&
31916 For SpamAssassin either 'reject' or 'no action' depending on the
31917 spam score versus threshold.
31918 For Rspamd, the recommended action.
31919
31920 .endlist
31921
31922 The &%spam%& condition caches its results unless expansion in
31923 spamd_address was used. If you call it again with the same user name, it
31924 does not scan again, but rather returns the same values as before.
31925
31926 The &%spam%& condition returns DEFER if there is any error while running
31927 the message through SpamAssassin or if the expansion of spamd_address
31928 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31929 statement block), append &`/defer_ok`& to the right-hand side of the
31930 spam condition, like this:
31931 .code
31932 deny message = This message was classified as SPAM
31933      spam    = joe/defer_ok
31934 .endd
31935 This causes messages to be accepted even if there is a problem with &%spamd%&.
31936
31937 Here is a longer, commented example of the use of the &%spam%&
31938 condition:
31939 .code
31940 # put headers in all messages (no matter if spam or not)
31941 warn  spam = nobody:true
31942       add_header = X-Spam-Score: $spam_score ($spam_bar)
31943       add_header = X-Spam-Report: $spam_report
31944
31945 # add second subject line with *SPAM* marker when message
31946 # is over threshold
31947 warn  spam = nobody
31948       add_header = Subject: *SPAM* $h_Subject:
31949
31950 # reject spam at high scores (> 12)
31951 deny  message = This message scored $spam_score spam points.
31952       spam = nobody:true
31953       condition = ${if >{$spam_score_int}{120}{1}{0}}
31954 .endd
31955
31956
31957
31958 .section "Scanning MIME parts" "SECTscanmimepart"
31959 .cindex "content scanning" "MIME parts"
31960 .cindex "MIME content scanning"
31961 .oindex "&%acl_smtp_mime%&"
31962 .oindex "&%acl_not_smtp_mime%&"
31963 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31964 each MIME part of an SMTP message, including multipart types, in the sequence
31965 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31966 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31967 options may both refer to the same ACL if you want the same processing in both
31968 cases.
31969
31970 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31971 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31972 the case of a non-SMTP message. However, a MIME ACL is called only if the
31973 message contains a &'Content-Type:'& header line. When a call to a MIME
31974 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31975 result code is sent to the client. In the case of an SMTP message, the
31976 &%acl_smtp_data%& ACL is not called when this happens.
31977
31978 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31979 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31980 condition to match against the raw MIME part. You can also use the
31981 &%mime_regex%& condition to match against the decoded MIME part (see section
31982 &<<SECTscanregex>>&).
31983
31984 At the start of a MIME ACL, a number of variables are set from the header
31985 information for the relevant MIME part. These are described below. The contents
31986 of the MIME part are not by default decoded into a disk file except for MIME
31987 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31988 part into a disk file, you can use the &%decode%& condition. The general
31989 syntax is:
31990 .display
31991 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31992 .endd
31993 The right hand side is expanded before use. After expansion,
31994 the value can be:
31995
31996 .olist
31997 &"0"& or &"false"&, in which case no decoding is done.
31998 .next
31999 The string &"default"&. In that case, the file is put in the temporary
32000 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32001 a sequential file name consisting of the message id and a sequence number. The
32002 full path and name is available in &$mime_decoded_filename$& after decoding.
32003 .next
32004 A full path name starting with a slash. If the full name is an existing
32005 directory, it is used as a replacement for the default directory. The filename
32006 is then sequentially assigned. If the path does not exist, it is used as
32007 the full path and file name.
32008 .next
32009 If the string does not start with a slash, it is used as the
32010 filename, and the default path is then used.
32011 .endlist
32012 The &%decode%& condition normally succeeds. It is only false for syntax
32013 errors or unusual circumstances such as memory shortages. You can easily decode
32014 a file with its original, proposed filename using
32015 .code
32016 decode = $mime_filename
32017 .endd
32018 However, you should keep in mind that &$mime_filename$& might contain
32019 anything. If you place files outside of the default path, they are not
32020 automatically unlinked.
32021
32022 For RFC822 attachments (these are messages attached to messages, with a
32023 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32024 as for the primary message, only that the &$mime_is_rfc822$& expansion
32025 variable is set (see below). Attached messages are always decoded to disk
32026 before being checked, and the files are unlinked once the check is done.
32027
32028 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32029 used to match regular expressions against raw and decoded MIME parts,
32030 respectively. They are described in section &<<SECTscanregex>>&.
32031
32032 .cindex "MIME content scanning" "returned variables"
32033 The following list describes all expansion variables that are
32034 available in the MIME ACL:
32035
32036 .vlist
32037 .vitem &$mime_boundary$&
32038 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32039 have a boundary string, which is stored in this variable. If the current part
32040 has no boundary parameter in the &'Content-Type:'& header, this variable
32041 contains the empty string.
32042
32043 .vitem &$mime_charset$&
32044 This variable contains the character set identifier, if one was found in the
32045 &'Content-Type:'& header. Examples for charset identifiers are:
32046 .code
32047 us-ascii
32048 gb2312 (Chinese)
32049 iso-8859-1
32050 .endd
32051 Please note that this value is not normalized, so you should do matches
32052 case-insensitively.
32053
32054 .vitem &$mime_content_description$&
32055 This variable contains the normalized content of the &'Content-Description:'&
32056 header. It can contain a human-readable description of the parts content. Some
32057 implementations repeat the filename for attachments here, but they are usually
32058 only used for display purposes.
32059
32060 .vitem &$mime_content_disposition$&
32061 This variable contains the normalized content of the &'Content-Disposition:'&
32062 header. You can expect strings like &"attachment"& or &"inline"& here.
32063
32064 .vitem &$mime_content_id$&
32065 This variable contains the normalized content of the &'Content-ID:'& header.
32066 This is a unique ID that can be used to reference a part from another part.
32067
32068 .vitem &$mime_content_size$&
32069 This variable is set only after the &%decode%& modifier (see above) has been
32070 successfully run. It contains the size of the decoded part in kilobytes. The
32071 size is always rounded up to full kilobytes, so only a completely empty part
32072 has a &$mime_content_size$& of zero.
32073
32074 .vitem &$mime_content_transfer_encoding$&
32075 This variable contains the normalized content of the
32076 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32077 type. Typical values are &"base64"& and &"quoted-printable"&.
32078
32079 .vitem &$mime_content_type$&
32080 If the MIME part has a &'Content-Type:'& header, this variable contains its
32081 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32082 are some examples of popular MIME types, as they may appear in this variable:
32083 .code
32084 text/plain
32085 text/html
32086 application/octet-stream
32087 image/jpeg
32088 audio/midi
32089 .endd
32090 If the MIME part has no &'Content-Type:'& header, this variable contains the
32091 empty string.
32092
32093 .vitem &$mime_decoded_filename$&
32094 This variable is set only after the &%decode%& modifier (see above) has been
32095 successfully run. It contains the full path and file name of the file
32096 containing the decoded data.
32097 .endlist
32098
32099 .cindex "RFC 2047"
32100 .vlist
32101 .vitem &$mime_filename$&
32102 This is perhaps the most important of the MIME variables. It contains a
32103 proposed filename for an attachment, if one was found in either the
32104 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32105 RFC2047
32106 or RFC2231
32107 decoded, but no additional sanity checks are done.
32108  If no filename was
32109 found, this variable contains the empty string.
32110
32111 .vitem &$mime_is_coverletter$&
32112 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32113 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32114 content in the cover letter, while not restricting attachments at all.
32115
32116 The variable contains 1 (true) for a MIME part believed to be part of the
32117 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32118 follows:
32119
32120 .olist
32121 The outermost MIME part of a message is always a cover letter.
32122
32123 .next
32124 If a multipart/alternative or multipart/related MIME part is a cover letter,
32125 so are all MIME subparts within that multipart.
32126
32127 .next
32128 If any other multipart is a cover letter, the first subpart is a cover letter,
32129 and the rest are attachments.
32130
32131 .next
32132 All parts contained within an attachment multipart are attachments.
32133 .endlist olist
32134
32135 As an example, the following will ban &"HTML mail"& (including that sent with
32136 alternative plain text), while allowing HTML files to be attached. HTML
32137 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32138 .code
32139 deny message = HTML mail is not accepted here
32140 !condition = $mime_is_rfc822
32141 condition = $mime_is_coverletter
32142 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32143 .endd
32144 .vitem &$mime_is_multipart$&
32145 This variable has the value 1 (true) when the current part has the main type
32146 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32147 Since multipart entities only serve as containers for other parts, you may not
32148 want to carry out specific actions on them.
32149
32150 .vitem &$mime_is_rfc822$&
32151 This variable has the value 1 (true) if the current part is not a part of the
32152 checked message itself, but part of an attached message. Attached message
32153 decoding is fully recursive.
32154
32155 .vitem &$mime_part_count$&
32156 This variable is a counter that is raised for each processed MIME part. It
32157 starts at zero for the very first part (which is usually a multipart). The
32158 counter is per-message, so it is reset when processing RFC822 attachments (see
32159 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32160 complete, so you can use it in the DATA ACL to determine the number of MIME
32161 parts of a message. For non-MIME messages, this variable contains the value -1.
32162 .endlist
32163
32164
32165
32166 .section "Scanning with regular expressions" "SECTscanregex"
32167 .cindex "content scanning" "with regular expressions"
32168 .cindex "regular expressions" "content scanning with"
32169 You can specify your own custom regular expression matches on the full body of
32170 the message, or on individual MIME parts.
32171
32172 The &%regex%& condition takes one or more regular expressions as arguments and
32173 matches them against the full message (when called in the DATA ACL) or a raw
32174 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32175 linewise, with a maximum line length of 32K characters. That means you cannot
32176 have multiline matches with the &%regex%& condition.
32177
32178 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32179 to 32K of decoded content (the whole content at once, not linewise). If the
32180 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32181 is decoded automatically when &%mime_regex%& is executed (using default path
32182 and filename values). If the decoded data is larger than  32K, only the first
32183 32K characters are checked.
32184
32185 The regular expressions are passed as a colon-separated list. To include a
32186 literal colon, you must double it. Since the whole right-hand side string is
32187 expanded before being used, you must also escape dollar signs and backslashes
32188 with more backslashes, or use the &`\N`& facility to disable expansion.
32189 Here is a simple example that contains two regular expressions:
32190 .code
32191 deny message = contains blacklisted regex ($regex_match_string)
32192      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32193 .endd
32194 The conditions returns true if any one of the regular expressions matches. The
32195 &$regex_match_string$& expansion variable is then set up and contains the
32196 matching regular expression.
32197 The expansion variables &$regex1$& &$regex2$& etc
32198 are set to any substrings captured by the regular expression.
32199
32200 &*Warning*&: With large messages, these conditions can be fairly
32201 CPU-intensive.
32202
32203 .ecindex IIDcosca
32204
32205
32206
32207
32208 . ////////////////////////////////////////////////////////////////////////////
32209 . ////////////////////////////////////////////////////////////////////////////
32210
32211 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32212          "Local scan function"
32213 .scindex IIDlosca "&[local_scan()]& function" "description of"
32214 .cindex "customizing" "input scan using C function"
32215 .cindex "policy control" "by local scan function"
32216 In these days of email worms, viruses, and ever-increasing spam, some sites
32217 want to apply a lot of checking to messages before accepting them.
32218
32219 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32220 passing messages to external virus and spam scanning software. You can also do
32221 a certain amount in Exim itself through string expansions and the &%condition%&
32222 condition in the ACL that runs after the SMTP DATA command or the ACL for
32223 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32224
32225 To allow for further customization to a site's own requirements, there is the
32226 possibility of linking Exim with a private message scanning function, written
32227 in C. If you want to run code that is written in something other than C, you
32228 can of course use a little C stub to call it.
32229
32230 The local scan function is run once for every incoming message, at the point
32231 when Exim is just about to accept the message.
32232 It can therefore be used to control non-SMTP messages from local processes as
32233 well as messages arriving via SMTP.
32234
32235 Exim applies a timeout to calls of the local scan function, and there is an
32236 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32237 Zero means &"no timeout"&.
32238 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32239 before calling the local scan function, so that the most common types of crash
32240 are caught. If the timeout is exceeded or one of those signals is caught, the
32241 incoming message is rejected with a temporary error if it is an SMTP message.
32242 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32243 code. The incident is logged on the main and reject logs.
32244
32245
32246
32247 .section "Building Exim to use a local scan function" "SECID207"
32248 .cindex "&[local_scan()]& function" "building Exim to use"
32249 To make use of the local scan function feature, you must tell Exim where your
32250 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32251 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32252 directory, so you might set
32253 .code
32254 LOCAL_SCAN_SOURCE=Local/local_scan.c
32255 .endd
32256 for example. The function must be called &[local_scan()]&. It is called by
32257 Exim after it has received a message, when the success return code is about to
32258 be sent. This is after all the ACLs have been run. The return code from your
32259 function controls whether the message is actually accepted or not. There is a
32260 commented template function (that just accepts the message) in the file
32261 _src/local_scan.c_.
32262
32263 If you want to make use of Exim's run time configuration file to set options
32264 for your &[local_scan()]& function, you must also set
32265 .code
32266 LOCAL_SCAN_HAS_OPTIONS=yes
32267 .endd
32268 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32269
32270
32271
32272
32273 .section "API for local_scan()" "SECTapiforloc"
32274 .cindex "&[local_scan()]& function" "API description"
32275 You must include this line near the start of your code:
32276 .code
32277 #include "local_scan.h"
32278 .endd
32279 This header file defines a number of variables and other values, and the
32280 prototype for the function itself. Exim is coded to use unsigned char values
32281 almost exclusively, and one of the things this header defines is a shorthand
32282 for &`unsigned char`& called &`uschar`&.
32283 It also contains the following macro definitions, to simplify casting character
32284 strings and pointers to character strings:
32285 .code
32286 #define CS   (char *)
32287 #define CCS  (const char *)
32288 #define CSS  (char **)
32289 #define US   (unsigned char *)
32290 #define CUS  (const unsigned char *)
32291 #define USS  (unsigned char **)
32292 .endd
32293 The function prototype for &[local_scan()]& is:
32294 .code
32295 extern int local_scan(int fd, uschar **return_text);
32296 .endd
32297 The arguments are as follows:
32298
32299 .ilist
32300 &%fd%& is a file descriptor for the file that contains the body of the message
32301 (the -D file). The file is open for reading and writing, but updating it is not
32302 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32303
32304 The descriptor is positioned at character 19 of the file, which is the first
32305 character of the body itself, because the first 19 characters are the message
32306 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32307 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32308 case this changes in some future version.
32309 .next
32310 &%return_text%& is an address which you can use to return a pointer to a text
32311 string at the end of the function. The value it points to on entry is NULL.
32312 .endlist
32313
32314 The function must return an &%int%& value which is one of the following macros:
32315
32316 .vlist
32317 .vitem &`LOCAL_SCAN_ACCEPT`&
32318 .vindex "&$local_scan_data$&"
32319 The message is accepted. If you pass back a string of text, it is saved with
32320 the message, and made available in the variable &$local_scan_data$&. No
32321 newlines are permitted (if there are any, they are turned into spaces) and the
32322 maximum length of text is 1000 characters.
32323
32324 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32325 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32326 queued without immediate delivery, and is frozen.
32327
32328 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32329 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32330 queued without immediate delivery.
32331
32332 .vitem &`LOCAL_SCAN_REJECT`&
32333 The message is rejected; the returned text is used as an error message which is
32334 passed back to the sender and which is also logged. Newlines are permitted &--
32335 they cause a multiline response for SMTP rejections, but are converted to
32336 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32337 used.
32338
32339 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32340 The message is temporarily rejected; the returned text is used as an error
32341 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32342 problem"& is used.
32343
32344 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32345 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32346 message is not written to the reject log. It has the effect of unsetting the
32347 &%rejected_header%& log selector for just this rejection. If
32348 &%rejected_header%& is already unset (see the discussion of the
32349 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32350 same as LOCAL_SCAN_REJECT.
32351
32352 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32353 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32354 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32355 .endlist
32356
32357 If the message is not being received by interactive SMTP, rejections are
32358 reported by writing to &%stderr%& or by sending an email, as configured by the
32359 &%-oe%& command line options.
32360
32361
32362
32363 .section "Configuration options for local_scan()" "SECTconoptloc"
32364 .cindex "&[local_scan()]& function" "configuration options"
32365 It is possible to have option settings in the main configuration file
32366 that set values in static variables in the &[local_scan()]& module. If you
32367 want to do this, you must have the line
32368 .code
32369 LOCAL_SCAN_HAS_OPTIONS=yes
32370 .endd
32371 in your &_Local/Makefile_& when you build Exim. (This line is in
32372 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32373 file, you must define static variables to hold the option values, and a table
32374 to define them.
32375
32376 The table must be a vector called &%local_scan_options%&, of type
32377 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32378 and a pointer to the variable that holds the value. The entries must appear in
32379 alphabetical order. Following &%local_scan_options%& you must also define a
32380 variable called &%local_scan_options_count%& that contains the number of
32381 entries in the table. Here is a short example, showing two kinds of option:
32382 .code
32383 static int my_integer_option = 42;
32384 static uschar *my_string_option = US"a default string";
32385
32386 optionlist local_scan_options[] = {
32387   { "my_integer", opt_int,       &my_integer_option },
32388   { "my_string",  opt_stringptr, &my_string_option }
32389 };
32390
32391 int local_scan_options_count =
32392   sizeof(local_scan_options)/sizeof(optionlist);
32393 .endd
32394 The values of the variables can now be changed from Exim's runtime
32395 configuration file by including a local scan section as in this example:
32396 .code
32397 begin local_scan
32398 my_integer = 99
32399 my_string = some string of text...
32400 .endd
32401 The available types of option data are as follows:
32402
32403 .vlist
32404 .vitem &*opt_bool*&
32405 This specifies a boolean (true/false) option. The address should point to a
32406 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32407 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32408 whether such a variable has been set at all, you can initialize it to
32409 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32410 values.)
32411
32412 .vitem &*opt_fixed*&
32413 This specifies a fixed point number, such as is used for load averages.
32414 The address should point to a variable of type &`int`&. The value is stored
32415 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32416
32417 .vitem &*opt_int*&
32418 This specifies an integer; the address should point to a variable of type
32419 &`int`&. The value may be specified in any of the integer formats accepted by
32420 Exim.
32421
32422 .vitem &*opt_mkint*&
32423 This is the same as &%opt_int%&, except that when such a value is output in a
32424 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32425 printed with the suffix K or M.
32426
32427 .vitem &*opt_octint*&
32428 This also specifies an integer, but the value is always interpreted as an
32429 octal integer, whether or not it starts with the digit zero, and it is
32430 always output in octal.
32431
32432 .vitem &*opt_stringptr*&
32433 This specifies a string value; the address must be a pointer to a
32434 variable that points to a string (for example, of type &`uschar *`&).
32435
32436 .vitem &*opt_time*&
32437 This specifies a time interval value. The address must point to a variable of
32438 type &`int`&. The value that is placed there is a number of seconds.
32439 .endlist
32440
32441 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32442 out the values of all the &[local_scan()]& options.
32443
32444
32445
32446 .section "Available Exim variables" "SECID208"
32447 .cindex "&[local_scan()]& function" "available Exim variables"
32448 The header &_local_scan.h_& gives you access to a number of C variables. These
32449 are the only ones that are guaranteed to be maintained from release to release.
32450 Note, however, that you can obtain the value of any Exim expansion variable,
32451 including &$recipients$&, by calling &'expand_string()'&. The exported
32452 C variables are as follows:
32453
32454 .vlist
32455 .vitem &*int&~body_linecount*&
32456 This variable contains the number of lines in the message's body.
32457
32458 .vitem &*int&~body_zerocount*&
32459 This variable contains the number of binary zero bytes in the message's body.
32460
32461 .vitem &*unsigned&~int&~debug_selector*&
32462 This variable is set to zero when no debugging is taking place. Otherwise, it
32463 is a bitmap of debugging selectors. Two bits are identified for use in
32464 &[local_scan()]&; they are defined as macros:
32465
32466 .ilist
32467 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32468 testing option that is not privileged &-- any caller may set it. All the
32469 other selector bits can be set only by admin users.
32470
32471 .next
32472 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32473 by the &`+local_scan`& debug selector. It is not included in the default set
32474 of debugging bits.
32475 .endlist ilist
32476
32477 Thus, to write to the debugging output only when &`+local_scan`& has been
32478 selected, you should use code like this:
32479 .code
32480 if ((debug_selector & D_local_scan) != 0)
32481   debug_printf("xxx", ...);
32482 .endd
32483 .vitem &*uschar&~*expand_string_message*&
32484 After a failing call to &'expand_string()'& (returned value NULL), the
32485 variable &%expand_string_message%& contains the error message, zero-terminated.
32486
32487 .vitem &*header_line&~*header_list*&
32488 A pointer to a chain of header lines. The &%header_line%& structure is
32489 discussed below.
32490
32491 .vitem &*header_line&~*header_last*&
32492 A pointer to the last of the header lines.
32493
32494 .vitem &*uschar&~*headers_charset*&
32495 The value of the &%headers_charset%& configuration option.
32496
32497 .vitem &*BOOL&~host_checking*&
32498 This variable is TRUE during a host checking session that is initiated by the
32499 &%-bh%& command line option.
32500
32501 .vitem &*uschar&~*interface_address*&
32502 The IP address of the interface that received the message, as a string. This
32503 is NULL for locally submitted messages.
32504
32505 .vitem &*int&~interface_port*&
32506 The port on which this message was received. When testing with the &%-bh%&
32507 command line option, the value of this variable is -1 unless a port has been
32508 specified via the &%-oMi%& option.
32509
32510 .vitem &*uschar&~*message_id*&
32511 This variable contains Exim's message id for the incoming message (the value of
32512 &$message_exim_id$&) as a zero-terminated string.
32513
32514 .vitem &*uschar&~*received_protocol*&
32515 The name of the protocol by which the message was received.
32516
32517 .vitem &*int&~recipients_count*&
32518 The number of accepted recipients.
32519
32520 .vitem &*recipient_item&~*recipients_list*&
32521 .cindex "recipient" "adding in local scan"
32522 .cindex "recipient" "removing in local scan"
32523 The list of accepted recipients, held in a vector of length
32524 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32525 can add additional recipients by calling &'receive_add_recipient()'& (see
32526 below). You can delete recipients by removing them from the vector and
32527 adjusting the value in &%recipients_count%&. In particular, by setting
32528 &%recipients_count%& to zero you remove all recipients. If you then return the
32529 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32530 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32531 and then call &'receive_add_recipient()'& as often as needed.
32532
32533 .vitem &*uschar&~*sender_address*&
32534 The envelope sender address. For bounce messages this is the empty string.
32535
32536 .vitem &*uschar&~*sender_host_address*&
32537 The IP address of the sending host, as a string. This is NULL for
32538 locally-submitted messages.
32539
32540 .vitem &*uschar&~*sender_host_authenticated*&
32541 The name of the authentication mechanism that was used, or NULL if the message
32542 was not received over an authenticated SMTP connection.
32543
32544 .vitem &*uschar&~*sender_host_name*&
32545 The name of the sending host, if known.
32546
32547 .vitem &*int&~sender_host_port*&
32548 The port on the sending host.
32549
32550 .vitem &*BOOL&~smtp_input*&
32551 This variable is TRUE for all SMTP input, including BSMTP.
32552
32553 .vitem &*BOOL&~smtp_batched_input*&
32554 This variable is TRUE for BSMTP input.
32555
32556 .vitem &*int&~store_pool*&
32557 The contents of this variable control which pool of memory is used for new
32558 requests. See section &<<SECTmemhanloc>>& for details.
32559 .endlist
32560
32561
32562 .section "Structure of header lines" "SECID209"
32563 The &%header_line%& structure contains the members listed below.
32564 You can add additional header lines by calling the &'header_add()'& function
32565 (see below). You can cause header lines to be ignored (deleted) by setting
32566 their type to *.
32567
32568
32569 .vlist
32570 .vitem &*struct&~header_line&~*next*&
32571 A pointer to the next header line, or NULL for the last line.
32572
32573 .vitem &*int&~type*&
32574 A code identifying certain headers that Exim recognizes. The codes are printing
32575 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32576 Notice in particular that any header line whose type is * is not transmitted
32577 with the message. This flagging is used for header lines that have been
32578 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32579 lines.) Effectively, * means &"deleted"&.
32580
32581 .vitem &*int&~slen*&
32582 The number of characters in the header line, including the terminating and any
32583 internal newlines.
32584
32585 .vitem &*uschar&~*text*&
32586 A pointer to the text of the header. It always ends with a newline, followed by
32587 a zero byte. Internal newlines are preserved.
32588 .endlist
32589
32590
32591
32592 .section "Structure of recipient items" "SECID210"
32593 The &%recipient_item%& structure contains these members:
32594
32595 .vlist
32596 .vitem &*uschar&~*address*&
32597 This is a pointer to the recipient address as it was received.
32598
32599 .vitem &*int&~pno*&
32600 This is used in later Exim processing when top level addresses are created by
32601 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32602 and must always contain -1 at this stage.
32603
32604 .vitem &*uschar&~*errors_to*&
32605 If this value is not NULL, bounce messages caused by failing to deliver to the
32606 recipient are sent to the address it contains. In other words, it overrides the
32607 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32608 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32609 an unqualified address, Exim qualifies it using the domain from
32610 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32611 is NULL for all recipients.
32612 .endlist
32613
32614
32615
32616 .section "Available Exim functions" "SECID211"
32617 .cindex "&[local_scan()]& function" "available Exim functions"
32618 The header &_local_scan.h_& gives you access to a number of Exim functions.
32619 These are the only ones that are guaranteed to be maintained from release to
32620 release:
32621
32622 .vlist
32623 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32624        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32625
32626 This function creates a child process that runs the command specified by
32627 &%argv%&. The environment for the process is specified by &%envp%&, which can
32628 be NULL if no environment variables are to be passed. A new umask is supplied
32629 for the process in &%newumask%&.
32630
32631 Pipes to the standard input and output of the new process are set up
32632 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32633 standard error is cloned to the standard output. If there are any file
32634 descriptors &"in the way"& in the new process, they are closed. If the final
32635 argument is TRUE, the new process is made into a process group leader.
32636
32637 The function returns the pid of the new process, or -1 if things go wrong.
32638
32639 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32640 This function waits for a child process to terminate, or for a timeout (in
32641 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32642 return value is as follows:
32643
32644 .ilist
32645 >= 0
32646
32647 The process terminated by a normal exit and the value is the process
32648 ending status.
32649
32650 .next
32651 < 0 and > &--256
32652
32653 The process was terminated by a signal and the value is the negation of the
32654 signal number.
32655
32656 .next
32657 &--256
32658
32659 The process timed out.
32660 .next
32661 &--257
32662
32663 The was some other error in wait(); &%errno%& is still set.
32664 .endlist
32665
32666 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32667 This function provide you with a means of submitting a new message to
32668 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32669 want, but this packages it all up for you.) The function creates a pipe,
32670 forks a subprocess that is running
32671 .code
32672 exim -t -oem -oi -f <>
32673 .endd
32674 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32675 that is connected to the standard input. The yield of the function is the PID
32676 of the subprocess. You can then write a message to the file descriptor, with
32677 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32678
32679 When you have finished, call &'child_close()'& to wait for the process to
32680 finish and to collect its ending status. A timeout value of zero is usually
32681 fine in this circumstance. Unless you have made a mistake with the recipient
32682 addresses, you should get a return code of zero.
32683
32684
32685 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32686        *sender_authentication)*&
32687 This function is a more sophisticated version of &'child_open()'&. The command
32688 that it runs is:
32689 .display
32690 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32691 .endd
32692 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32693
32694
32695 .vitem &*void&~debug_printf(char&~*,&~...)*&
32696 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32697 output is written to the standard error stream. If no debugging is selected,
32698 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32699 conditional on the &`local_scan`& debug selector by coding like this:
32700 .code
32701 if ((debug_selector & D_local_scan) != 0)
32702   debug_printf("xxx", ...);
32703 .endd
32704
32705 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32706 This is an interface to Exim's string expansion code. The return value is the
32707 expanded string, or NULL if there was an expansion failure.
32708 The C variable &%expand_string_message%& contains an error message after an
32709 expansion failure. If expansion does not change the string, the return value is
32710 the pointer to the input string. Otherwise, the return value points to a new
32711 block of memory that was obtained by a call to &'store_get()'&. See section
32712 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32713
32714 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32715 This function allows you to an add additional header line at the end of the
32716 existing ones. The first argument is the type, and should normally be a space
32717 character. The second argument is a format string and any number of
32718 substitution arguments as for &[sprintf()]&. You may include internal newlines
32719 if you want, and you must ensure that the string ends with a newline.
32720
32721 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32722         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32723 This function adds a new header line at a specified point in the header
32724 chain. The header itself is specified as for &'header_add()'&.
32725
32726 If &%name%& is NULL, the new header is added at the end of the chain if
32727 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32728 NULL, the header lines are searched for the first non-deleted header that
32729 matches the name. If one is found, the new header is added before it if
32730 &%after%& is false. If &%after%& is true, the new header is added after the
32731 found header and any adjacent subsequent ones with the same name (even if
32732 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32733 option controls where the header is added. If it is true, addition is at the
32734 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32735 headers, or at the top if there are no &'Received:'& headers, you could use
32736 .code
32737 header_add_at_position(TRUE, US"Received", TRUE,
32738   ' ', "X-xxx: ...");
32739 .endd
32740 Normally, there is always at least one non-deleted &'Received:'& header, but
32741 there may not be if &%received_header_text%& expands to an empty string.
32742
32743
32744 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32745 This function removes header lines. If &%occurrence%& is zero or negative, all
32746 occurrences of the header are removed. If occurrence is greater than zero, that
32747 particular instance of the header is removed. If no header(s) can be found that
32748 match the specification, the function does nothing.
32749
32750
32751 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32752         int&~length,&~BOOL&~notdel)*&"
32753 This function tests whether the given header has the given name. It is not just
32754 a string comparison, because white space is permitted between the name and the
32755 colon. If the &%notdel%& argument is true, a false return is forced for all
32756 &"deleted"& headers; otherwise they are not treated specially. For example:
32757 .code
32758 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32759 .endd
32760 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32761 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32762 This function base64-encodes a string, which is passed by address and length.
32763 The text may contain bytes of any value, including zero. The result is passed
32764 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32765 zero-terminated.
32766
32767 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32768 This function decodes a base64-encoded string. Its arguments are a
32769 zero-terminated base64-encoded string and the address of a variable that is set
32770 to point to the result, which is in dynamic memory. The length of the decoded
32771 string is the yield of the function. If the input is invalid base64 data, the
32772 yield is -1. A zero byte is added to the end of the output string to make it
32773 easy to interpret as a C string (assuming it contains no zeros of its own). The
32774 added zero byte is not included in the returned count.
32775
32776 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32777 This function checks for a match in a domain list. Domains are always
32778 matched caselessly. The return value is one of the following:
32779 .display
32780 &`OK     `& match succeeded
32781 &`FAIL   `& match failed
32782 &`DEFER  `& match deferred
32783 .endd
32784 DEFER is usually caused by some kind of lookup defer, such as the
32785 inability to contact a database.
32786
32787 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32788         BOOL&~caseless)*&"
32789 This function checks for a match in a local part list. The third argument
32790 controls case-sensitivity. The return values are as for
32791 &'lss_match_domain()'&.
32792
32793 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32794         BOOL&~caseless)*&"
32795 This function checks for a match in an address list. The third argument
32796 controls the case-sensitivity of the local part match. The domain is always
32797 matched caselessly. The return values are as for &'lss_match_domain()'&.
32798
32799 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32800         uschar&~*list)*&"
32801 This function checks for a match in a host list. The most common usage is
32802 expected to be
32803 .code
32804 lss_match_host(sender_host_name, sender_host_address, ...)
32805 .endd
32806 .vindex "&$sender_host_address$&"
32807 An empty address field matches an empty item in the host list. If the host name
32808 is NULL, the name corresponding to &$sender_host_address$& is automatically
32809 looked up if a host name is required to match an item in the list. The return
32810 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32811 returns ERROR in the case when it had to look up a host name, but the lookup
32812 failed.
32813
32814 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32815         *format,&~...)*&"
32816 This function writes to Exim's log files. The first argument should be zero (it
32817 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32818 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32819 them. It specifies to which log or logs the message is written. The remaining
32820 arguments are a format and relevant insertion arguments. The string should not
32821 contain any newlines, not even at the end.
32822
32823
32824 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32825 This function adds an additional recipient to the message. The first argument
32826 is the recipient address. If it is unqualified (has no domain), it is qualified
32827 with the &%qualify_recipient%& domain. The second argument must always be -1.
32828
32829 This function does not allow you to specify a private &%errors_to%& address (as
32830 described with the structure of &%recipient_item%& above), because it pre-dates
32831 the addition of that field to the structure. However, it is easy to add such a
32832 value afterwards. For example:
32833 .code
32834  receive_add_recipient(US"monitor@mydom.example", -1);
32835  recipients_list[recipients_count-1].errors_to =
32836    US"postmaster@mydom.example";
32837 .endd
32838
32839 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32840 This is a convenience function to remove a named recipient from the list of
32841 recipients. It returns true if a recipient was removed, and false if no
32842 matching recipient could be found. The argument must be a complete email
32843 address.
32844 .endlist
32845
32846
32847 .cindex "RFC 2047"
32848 .vlist
32849 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32850   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32851 This function decodes strings that are encoded according to RFC 2047. Typically
32852 these are the contents of header lines. First, each &"encoded word"& is decoded
32853 from the Q or B encoding into a byte-string. Then, if provided with the name of
32854 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32855 made  to translate the result to the named character set. If this fails, the
32856 binary string is returned with an error message.
32857
32858 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32859 maximum MIME word length is enforced. The third argument is the target
32860 encoding, or NULL if no translation is wanted.
32861
32862 .cindex "binary zero" "in RFC 2047 decoding"
32863 .cindex "RFC 2047" "binary zero in"
32864 If a binary zero is encountered in the decoded string, it is replaced by the
32865 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32866 not be 0 because header lines are handled as zero-terminated strings.
32867
32868 The function returns the result of processing the string, zero-terminated; if
32869 &%lenptr%& is not NULL, the length of the result is set in the variable to
32870 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32871
32872 If an error is encountered, the function returns NULL and uses the &%error%&
32873 argument to return an error message. The variable pointed to by &%error%& is
32874 set to NULL if there is no error; it may be set non-NULL even when the function
32875 returns a non-NULL value if decoding was successful, but there was a problem
32876 with translation.
32877
32878
32879 .vitem &*int&~smtp_fflush(void)*&
32880 This function is used in conjunction with &'smtp_printf()'&, as described
32881 below.
32882
32883 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32884 The arguments of this function are like &[printf()]&; it writes to the SMTP
32885 output stream. You should use this function only when there is an SMTP output
32886 stream, that is, when the incoming message is being received via interactive
32887 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32888 is FALSE. If you want to test for an incoming message from another host (as
32889 opposed to a local process that used the &%-bs%& command line option), you can
32890 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32891 is involved.
32892
32893 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32894 output function, so it can be used for all forms of SMTP connection.
32895
32896 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32897 must start with an appropriate response code: 550 if you are going to return
32898 LOCAL_SCAN_REJECT, 451 if you are going to return
32899 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32900 initial lines of a multi-line response, the code must be followed by a hyphen
32901 to indicate that the line is not the final response line. You must also ensure
32902 that the lines you write terminate with CRLF. For example:
32903 .code
32904 smtp_printf("550-this is some extra info\r\n");
32905 return LOCAL_SCAN_REJECT;
32906 .endd
32907 Note that you can also create multi-line responses by including newlines in
32908 the data returned via the &%return_text%& argument. The added value of using
32909 &'smtp_printf()'& is that, for instance, you could introduce delays between
32910 multiple output lines.
32911
32912 The &'smtp_printf()'& function does not return any error indication, because it
32913 does not automatically flush pending output, and therefore does not test
32914 the state of the stream. (In the main code of Exim, flushing and error
32915 detection is done when Exim is ready for the next SMTP input command.) If
32916 you want to flush the output and check for an error (for example, the
32917 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32918 arguments. It flushes the output stream, and returns a non-zero value if there
32919 is an error.
32920
32921 .vitem &*void&~*store_get(int)*&
32922 This function accesses Exim's internal store (memory) manager. It gets a new
32923 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32924 runs out of memory. See the next section for a discussion of memory handling.
32925
32926 .vitem &*void&~*store_get_perm(int)*&
32927 This function is like &'store_get()'&, but it always gets memory from the
32928 permanent pool. See the next section for a discussion of memory handling.
32929
32930 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32931 See below.
32932
32933 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32934 See below.
32935
32936 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32937 These three functions create strings using Exim's dynamic memory facilities.
32938 The first makes a copy of an entire string. The second copies up to a maximum
32939 number of characters, indicated by the second argument. The third uses a format
32940 and insertion arguments to create a new string. In each case, the result is a
32941 pointer to a new string in the current memory pool. See the next section for
32942 more discussion.
32943 .endlist
32944
32945
32946
32947 .section "More about Exim's memory handling" "SECTmemhanloc"
32948 .cindex "&[local_scan()]& function" "memory handling"
32949 No function is provided for freeing memory, because that is never needed.
32950 The dynamic memory that Exim uses when receiving a message is automatically
32951 recycled if another message is received by the same process (this applies only
32952 to incoming SMTP connections &-- other input methods can supply only one
32953 message at a time). After receiving the last message, a reception process
32954 terminates.
32955
32956 Because it is recycled, the normal dynamic memory cannot be used for holding
32957 data that must be preserved over a number of incoming messages on the same SMTP
32958 connection. However, Exim in fact uses two pools of dynamic memory; the second
32959 one is not recycled, and can be used for this purpose.
32960
32961 If you want to allocate memory that remains available for subsequent messages
32962 in the same SMTP connection, you should set
32963 .code
32964 store_pool = POOL_PERM
32965 .endd
32966 before calling the function that does the allocation. There is no need to
32967 restore the value if you do not need to; however, if you do want to revert to
32968 the normal pool, you can either restore the previous value of &%store_pool%& or
32969 set it explicitly to POOL_MAIN.
32970
32971 The pool setting applies to all functions that get dynamic memory, including
32972 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32973 There is also a convenience function called &'store_get_perm()'& that gets a
32974 block of memory from the permanent pool while preserving the value of
32975 &%store_pool%&.
32976 .ecindex IIDlosca
32977
32978
32979
32980
32981 . ////////////////////////////////////////////////////////////////////////////
32982 . ////////////////////////////////////////////////////////////////////////////
32983
32984 .chapter "System-wide message filtering" "CHAPsystemfilter"
32985 .scindex IIDsysfil1 "filter" "system filter"
32986 .scindex IIDsysfil2 "filtering all mail"
32987 .scindex IIDsysfil3 "system filter"
32988 The previous chapters (on ACLs and the local scan function) describe checks
32989 that can be applied to messages before they are accepted by a host. There is
32990 also a mechanism for checking messages once they have been received, but before
32991 they are delivered. This is called the &'system filter'&.
32992
32993 The system filter operates in a similar manner to users' filter files, but it
32994 is run just once per message (however many recipients the message has).
32995 It should not normally be used as a substitute for routing, because &%deliver%&
32996 commands in a system router provide new envelope recipient addresses.
32997 The system filter must be an Exim filter. It cannot be a Sieve filter.
32998
32999 The system filter is run at the start of a delivery attempt, before any routing
33000 is done. If a message fails to be completely delivered at the first attempt,
33001 the system filter is run again at the start of every retry.
33002 If you want your filter to do something only once per message, you can make use
33003 of the &%first_delivery%& condition in an &%if%& command in the filter to
33004 prevent it happening on retries.
33005
33006 .vindex "&$domain$&"
33007 .vindex "&$local_part$&"
33008 &*Warning*&: Because the system filter runs just once, variables that are
33009 specific to individual recipient addresses, such as &$local_part$& and
33010 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33011 you want to run a centrally-specified filter for each recipient address
33012 independently, you can do so by setting up a suitable &(redirect)& router, as
33013 described in section &<<SECTperaddfil>>& below.
33014
33015
33016 .section "Specifying a system filter" "SECID212"
33017 .cindex "uid (user id)" "system filter"
33018 .cindex "gid (group id)" "system filter"
33019 The name of the file that contains the system filter must be specified by
33020 setting &%system_filter%&. If you want the filter to run under a uid and gid
33021 other than root, you must also set &%system_filter_user%& and
33022 &%system_filter_group%& as appropriate. For example:
33023 .code
33024 system_filter = /etc/mail/exim.filter
33025 system_filter_user = exim
33026 .endd
33027 If a system filter generates any deliveries directly to files or pipes (via the
33028 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33029 specified by setting &%system_filter_file_transport%& and
33030 &%system_filter_pipe_transport%&, respectively. Similarly,
33031 &%system_filter_reply_transport%& must be set to handle any messages generated
33032 by the &%reply%& command.
33033
33034
33035 .section "Testing a system filter" "SECID213"
33036 You can run simple tests of a system filter in the same way as for a user
33037 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33038 are permitted only in system filters are recognized.
33039
33040 If you want to test the combined effect of a system filter and a user filter,
33041 you can use both &%-bF%& and &%-bf%& on the same command line.
33042
33043
33044
33045 .section "Contents of a system filter" "SECID214"
33046 The language used to specify system filters is the same as for users' filter
33047 files. It is described in the separate end-user document &'Exim's interface to
33048 mail filtering'&. However, there are some additional features that are
33049 available only in system filters; these are described in subsequent sections.
33050 If they are encountered in a user's filter file or when testing with &%-bf%&,
33051 they cause errors.
33052
33053 .cindex "frozen messages" "manual thaw; testing in filter"
33054 There are two special conditions which, though available in users' filter
33055 files, are designed for use in system filters. The condition &%first_delivery%&
33056 is true only for the first attempt at delivering a message, and
33057 &%manually_thawed%& is true only if the message has been frozen, and
33058 subsequently thawed by an admin user. An explicit forced delivery counts as a
33059 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33060
33061 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33062 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33063 succeed, it will not be tried again.
33064 If you want Exim to retry an unseen delivery until it succeeds, you should
33065 arrange to set it up every time the filter runs.
33066
33067 When a system filter finishes running, the values of the variables &$n0$& &--
33068 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33069 users' filter files. Thus a system filter can, for example, set up &"scores"&
33070 to which users' filter files can refer.
33071
33072
33073
33074 .section "Additional variable for system filters" "SECID215"
33075 .vindex "&$recipients$&"
33076 The expansion variable &$recipients$&, containing a list of all the recipients
33077 of the message (separated by commas and white space), is available in system
33078 filters. It is not available in users' filters for privacy reasons.
33079
33080
33081
33082 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33083 .cindex "freezing messages"
33084 .cindex "message" "freezing"
33085 .cindex "message" "forced failure"
33086 .cindex "&%fail%&" "in system filter"
33087 .cindex "&%freeze%& in system filter"
33088 .cindex "&%defer%& in system filter"
33089 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33090 always available in system filters, but are not normally enabled in users'
33091 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33092 for the &(redirect)& router.) These commands can optionally be followed by the
33093 word &%text%& and a string containing an error message, for example:
33094 .code
33095 fail text "this message looks like spam to me"
33096 .endd
33097 The keyword &%text%& is optional if the next character is a double quote.
33098
33099 The &%defer%& command defers delivery of the original recipients of the
33100 message. The &%fail%& command causes all the original recipients to be failed,
33101 and a bounce message to be created. The &%freeze%& command suspends all
33102 delivery attempts for the original recipients. In all cases, any new deliveries
33103 that are specified by the filter are attempted as normal after the filter has
33104 run.
33105
33106 The &%freeze%& command is ignored if the message has been manually unfrozen and
33107 not manually frozen since. This means that automatic freezing by a system
33108 filter can be used as a way of checking out suspicious messages. If a message
33109 is found to be all right, manually unfreezing it allows it to be delivered.
33110
33111 .cindex "log" "&%fail%& command log line"
33112 .cindex "&%fail%&" "log line; reducing"
33113 The text given with a fail command is used as part of the bounce message as
33114 well as being written to the log. If the message is quite long, this can fill
33115 up a lot of log space when such failures are common. To reduce the size of the
33116 log message, Exim interprets the text in a special way if it starts with the
33117 two characters &`<<`& and contains &`>>`& later. The text between these two
33118 strings is written to the log, and the rest of the text is used in the bounce
33119 message. For example:
33120 .code
33121 fail "<<filter test 1>>Your message is rejected \
33122      because it contains attachments that we are \
33123      not prepared to receive."
33124 .endd
33125
33126 .cindex "loop" "caused by &%fail%&"
33127 Take great care with the &%fail%& command when basing the decision to fail on
33128 the contents of the message, because the bounce message will of course include
33129 the contents of the original message and will therefore trigger the &%fail%&
33130 command again (causing a mail loop) unless steps are taken to prevent this.
33131 Testing the &%error_message%& condition is one way to prevent this. You could
33132 use, for example
33133 .code
33134 if $message_body contains "this is spam" and not error_message
33135 then fail text "spam is not wanted here" endif
33136 .endd
33137 though of course that might let through unwanted bounce messages. The
33138 alternative is clever checking of the body and/or headers to detect bounces
33139 generated by the filter.
33140
33141 The interpretation of a system filter file ceases after a
33142 &%defer%&,
33143 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33144 set up earlier in the filter file are honoured, so you can use a sequence such
33145 as
33146 .code
33147 mail ...
33148 freeze
33149 .endd
33150 to send a specified message when the system filter is freezing (or deferring or
33151 failing) a message. The normal deliveries for the message do not, of course,
33152 take place.
33153
33154
33155
33156 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33157 .cindex "header lines" "adding; in system filter"
33158 .cindex "header lines" "removing; in system filter"
33159 .cindex "filter" "header lines; adding/removing"
33160 Two filter commands that are available only in system filters are:
33161 .code
33162 headers add <string>
33163 headers remove <string>
33164 .endd
33165 The argument for the &%headers add%& is a string that is expanded and then
33166 added to the end of the message's headers. It is the responsibility of the
33167 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33168 space is ignored, and if the string is otherwise empty, or if the expansion is
33169 forced to fail, the command has no effect.
33170
33171 You can use &"\n"& within the string, followed by white space, to specify
33172 continued header lines. More than one header may be added in one command by
33173 including &"\n"& within the string without any following white space. For
33174 example:
33175 .code
33176 headers add "X-header-1: ....\n  \
33177              continuation of X-header-1 ...\n\
33178              X-header-2: ...."
33179 .endd
33180 Note that the header line continuation white space after the first newline must
33181 be placed before the backslash that continues the input string, because white
33182 space after input continuations is ignored.
33183
33184 The argument for &%headers remove%& is a colon-separated list of header names.
33185 This command applies only to those headers that are stored with the message;
33186 those that are added at delivery time (such as &'Envelope-To:'& and
33187 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33188 header with the same name, they are all removed.
33189
33190 The &%headers%& command in a system filter makes an immediate change to the set
33191 of header lines that was received with the message (with possible additions
33192 from ACL processing). Subsequent commands in the system filter operate on the
33193 modified set, which also forms the basis for subsequent message delivery.
33194 Unless further modified during routing or transporting, this set of headers is
33195 used for all recipients of the message.
33196
33197 During routing and transporting, the variables that refer to the contents of
33198 header lines refer only to those lines that are in this set. Thus, header lines
33199 that are added by a system filter are visible to users' filter files and to all
33200 routers and transports. This contrasts with the manipulation of header lines by
33201 routers and transports, which is not immediate, but which instead is saved up
33202 until the message is actually being written (see section
33203 &<<SECTheadersaddrem>>&).
33204
33205 If the message is not delivered at the first attempt, header lines that were
33206 added by the system filter are stored with the message, and so are still
33207 present at the next delivery attempt. Header lines that were removed are still
33208 present, but marked &"deleted"& so that they are not transported with the
33209 message. For this reason, it is usual to make the &%headers%& command
33210 conditional on &%first_delivery%& so that the set of header lines is not
33211 modified more than once.
33212
33213 Because header modification in a system filter acts immediately, you have to
33214 use an indirect approach if you want to modify the contents of a header line.
33215 For example:
33216 .code
33217 headers add "Old-Subject: $h_subject:"
33218 headers remove "Subject"
33219 headers add "Subject: new subject (was: $h_old-subject:)"
33220 headers remove "Old-Subject"
33221 .endd
33222
33223
33224
33225 .section "Setting an errors address in a system filter" "SECID217"
33226 .cindex "envelope sender"
33227 In a system filter, if a &%deliver%& command is followed by
33228 .code
33229 errors_to <some address>
33230 .endd
33231 in order to change the envelope sender (and hence the error reporting) for that
33232 delivery, any address may be specified. (In a user filter, only the current
33233 user's address can be set.) For example, if some mail is being monitored, you
33234 might use
33235 .code
33236 unseen deliver monitor@spying.example errors_to root@local.example
33237 .endd
33238 to take a copy which would not be sent back to the normal error reporting
33239 address if its delivery failed.
33240
33241
33242
33243 .section "Per-address filtering" "SECTperaddfil"
33244 .vindex "&$domain$&"
33245 .vindex "&$local_part$&"
33246 In contrast to the system filter, which is run just once per message for each
33247 delivery attempt, it is also possible to set up a system-wide filtering
33248 operation that runs once for each recipient address. In this case, variables
33249 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33250 filter file could be made dependent on them. This is an example of a router
33251 which implements such a filter:
33252 .code
33253 central_filter:
33254   check_local_user
33255   driver = redirect
33256   domains = +local_domains
33257   file = /central/filters/$local_part
33258   no_verify
33259   allow_filter
33260   allow_freeze
33261 .endd
33262 The filter is run in a separate process under its own uid. Therefore, either
33263 &%check_local_user%& must be set (as above), in which case the filter is run as
33264 the local user, or the &%user%& option must be used to specify which user to
33265 use. If both are set, &%user%& overrides.
33266
33267 Care should be taken to ensure that none of the commands in the filter file
33268 specify a significant delivery if the message is to go on to be delivered to
33269 its intended recipient. The router will not then claim to have dealt with the
33270 address, so it will be passed on to subsequent routers to be delivered in the
33271 normal way.
33272 .ecindex IIDsysfil1
33273 .ecindex IIDsysfil2
33274 .ecindex IIDsysfil3
33275
33276
33277
33278
33279
33280
33281 . ////////////////////////////////////////////////////////////////////////////
33282 . ////////////////////////////////////////////////////////////////////////////
33283
33284 .chapter "Message processing" "CHAPmsgproc"
33285 .scindex IIDmesproc "message" "general processing"
33286 Exim performs various transformations on the sender and recipient addresses of
33287 all messages that it handles, and also on the messages' header lines. Some of
33288 these are optional and configurable, while others always take place. All of
33289 this processing, except rewriting as a result of routing, and the addition or
33290 removal of header lines while delivering, happens when a message is received,
33291 before it is placed on Exim's queue.
33292
33293 Some of the automatic processing takes place by default only for
33294 &"locally-originated"& messages. This adjective is used to describe messages
33295 that are not received over TCP/IP, but instead are passed to an Exim process on
33296 its standard input. This includes the interactive &"local SMTP"& case that is
33297 set up by the &%-bs%& command line option.
33298
33299 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33300 or ::1) are not considered to be locally-originated. Exim does not treat the
33301 loopback interface specially in any way.
33302
33303 If you want the loopback interface to be treated specially, you must ensure
33304 that there are appropriate entries in your ACLs.
33305
33306
33307
33308
33309 .section "Submission mode for non-local messages" "SECTsubmodnon"
33310 .cindex "message" "submission"
33311 .cindex "submission mode"
33312 Processing that happens automatically for locally-originated messages (unless
33313 &%suppress_local_fixups%& is set) can also be requested for messages that are
33314 received over TCP/IP. The term &"submission mode"& is used to describe this
33315 state. Submission mode is set by the modifier
33316 .code
33317 control = submission
33318 .endd
33319 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33320 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33321 a local submission, and is normally used when the source of the message is
33322 known to be an MUA running on a client host (as opposed to an MTA). For
33323 example, to set submission mode for messages originating on the IPv4 loopback
33324 interface, you could include the following in the MAIL ACL:
33325 .code
33326 warn  hosts = 127.0.0.1
33327       control = submission
33328 .endd
33329 .cindex "&%sender_retain%& submission option"
33330 There are some options that can be used when setting submission mode. A slash
33331 is used to separate options. For example:
33332 .code
33333 control = submission/sender_retain
33334 .endd
33335 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33336 true and &%local_from_check%& false for the current incoming message. The first
33337 of these allows an existing &'Sender:'& header in the message to remain, and
33338 the second suppresses the check to ensure that &'From:'& matches the
33339 authenticated sender. With this setting, Exim still fixes up messages by adding
33340 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33341 attempt to check sender authenticity in header lines.
33342
33343 When &%sender_retain%& is not set, a submission mode setting may specify a
33344 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33345 example:
33346 .code
33347 control = submission/domain=some.domain
33348 .endd
33349 The domain may be empty. How this value is used is described in sections
33350 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33351 that allows you to specify the user's full name for inclusion in a created
33352 &'Sender:'& or &'From:'& header line. For example:
33353 .code
33354 accept authenticated = *
33355        control = submission/domain=wonderland.example/\
33356                             name=${lookup {$authenticated_id} \
33357                                    lsearch {/etc/exim/namelist}}
33358 .endd
33359 Because the name may contain any characters, including slashes, the &%name%&
33360 option must be given last. The remainder of the string is used as the name. For
33361 the example above, if &_/etc/exim/namelist_& contains:
33362 .code
33363 bigegg:  Humpty Dumpty
33364 .endd
33365 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33366 line would be:
33367 .code
33368 Sender: Humpty Dumpty <bigegg@wonderland.example>
33369 .endd
33370 .cindex "return path" "in submission mode"
33371 By default, submission mode forces the return path to the same address as is
33372 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33373 specified, the return path is also left unchanged.
33374
33375 &*Note*&: The changes caused by submission mode take effect after the predata
33376 ACL. This means that any sender checks performed before the fix-ups use the
33377 untrusted sender address specified by the user, not the trusted sender address
33378 specified by submission mode. Although this might be slightly unexpected, it
33379 does mean that you can configure ACL checks to spot that a user is trying to
33380 spoof another's address.
33381
33382 .section "Line endings" "SECTlineendings"
33383 .cindex "line endings"
33384 .cindex "carriage return"
33385 .cindex "linefeed"
33386 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33387 linefeed) is the line ending for messages transmitted over the Internet using
33388 SMTP over TCP/IP. However, within individual operating systems, different
33389 conventions are used. For example, Unix-like systems use just LF, but others
33390 use CRLF or just CR.
33391
33392 Exim was designed for Unix-like systems, and internally, it stores messages
33393 using the system's convention of a single LF as a line terminator. When
33394 receiving a message, all line endings are translated to this standard format.
33395 Originally, it was thought that programs that passed messages directly to an
33396 MTA within an operating system would use that system's convention. Experience
33397 has shown that this is not the case; for example, there are Unix applications
33398 that use CRLF in this circumstance. For this reason, and for compatibility with
33399 other MTAs, the way Exim handles line endings for all messages is now as
33400 follows:
33401
33402 .ilist
33403 LF not preceded by CR is treated as a line ending.
33404 .next
33405 CR is treated as a line ending; if it is immediately followed by LF, the LF
33406 is ignored.
33407 .next
33408 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33409 nor a local message in the state where a line containing only a dot is a
33410 terminator.
33411 .next
33412 If a bare CR is encountered within a header line, an extra space is added after
33413 the line terminator so as not to end the header line. The reasoning behind this
33414 is that bare CRs in header lines are most likely either to be mistakes, or
33415 people trying to play silly games.
33416 .next
33417 If the first header line received in a message ends with CRLF, a subsequent
33418 bare LF in a header line is treated in the same way as a bare CR in a header
33419 line.
33420 .endlist
33421
33422
33423
33424
33425
33426 .section "Unqualified addresses" "SECID218"
33427 .cindex "unqualified addresses"
33428 .cindex "address" "qualification"
33429 By default, Exim expects every envelope address it receives from an external
33430 host to be fully qualified. Unqualified addresses cause negative responses to
33431 SMTP commands. However, because SMTP is used as a means of transporting
33432 messages from MUAs running on personal workstations, there is sometimes a
33433 requirement to accept unqualified addresses from specific hosts or IP networks.
33434
33435 Exim has two options that separately control which hosts may send unqualified
33436 sender or recipient addresses in SMTP commands, namely
33437 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33438 cases, if an unqualified address is accepted, it is qualified by adding the
33439 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33440
33441 .oindex "&%qualify_domain%&"
33442 .oindex "&%qualify_recipient%&"
33443 Unqualified addresses in header lines are automatically qualified for messages
33444 that are locally originated, unless the &%-bnq%& option is given on the command
33445 line. For messages received over SMTP, unqualified addresses in header lines
33446 are qualified only if unqualified addresses are permitted in SMTP commands. In
33447 other words, such qualification is also controlled by
33448 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33449
33450
33451
33452
33453 .section "The UUCP From line" "SECID219"
33454 .cindex "&""From""& line"
33455 .cindex "UUCP" "&""From""& line"
33456 .cindex "sender" "address"
33457 .oindex "&%uucp_from_pattern%&"
33458 .oindex "&%uucp_from_sender%&"
33459 .cindex "envelope sender"
33460 .cindex "Sendmail compatibility" "&""From""& line"
33461 Messages that have come from UUCP (and some other applications) often begin
33462 with a line containing the envelope sender and a timestamp, following the word
33463 &"From"&. Examples of two common formats are:
33464 .code
33465 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33466 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33467 .endd
33468 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33469 Exim recognizes such lines at the start of messages that are submitted to it
33470 via the command line (that is, on the standard input). It does not recognize
33471 such lines in incoming SMTP messages, unless the sending host matches
33472 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33473 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33474 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33475 default value matches the two common cases shown above and puts the address
33476 that follows &"From"& into &$1$&.
33477
33478 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33479 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33480 a trusted user, the message's sender address is constructed by expanding the
33481 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33482 then parsed as an RFC 2822 address. If there is no domain, the local part is
33483 qualified with &%qualify_domain%& unless it is the empty string. However, if
33484 the command line &%-f%& option is used, it overrides the &"From"& line.
33485
33486 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33487 sender address is not changed. This is also the case for incoming SMTP messages
33488 that are permitted to contain &"From"& lines.
33489
33490 Only one &"From"& line is recognized. If there is more than one, the second is
33491 treated as a data line that starts the body of the message, as it is not valid
33492 as a header line. This also happens if a &"From"& line is present in an
33493 incoming SMTP message from a source that is not permitted to send them.
33494
33495
33496
33497 .section "Resent- header lines" "SECID220"
33498 .cindex "&%Resent-%& header lines"
33499 .cindex "header lines" "Resent-"
33500 RFC 2822 makes provision for sets of header lines starting with the string
33501 &`Resent-`& to be added to a message when it is resent by the original
33502 recipient to somebody else. These headers are &'Resent-Date:'&,
33503 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33504 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33505
33506 .blockquote
33507 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33508 processing of replies or other such automatic actions on messages.'&
33509 .endblockquote
33510
33511 This leaves things a bit vague as far as other processing actions such as
33512 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33513 follows:
33514
33515 .ilist
33516 A &'Resent-From:'& line that just contains the login id of the submitting user
33517 is automatically rewritten in the same way as &'From:'& (see below).
33518 .next
33519 If there's a rewriting rule for a particular header line, it is also applied to
33520 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33521 &'From:'& also rewrites &'Resent-From:'&.
33522 .next
33523 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33524 also removed.
33525 .next
33526 For a locally-submitted message,
33527 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33528 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33529 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33530 included in log lines in this case.
33531 .next
33532 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33533 &%Resent-%& header lines are present.
33534 .endlist
33535
33536
33537
33538
33539 .section "The Auto-Submitted: header line" "SECID221"
33540 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33541 includes the header line:
33542 .code
33543 Auto-Submitted: auto-replied
33544 .endd
33545
33546 .section "The Bcc: header line" "SECID222"
33547 .cindex "&'Bcc:'& header line"
33548 If Exim is called with the &%-t%& option, to take recipient addresses from a
33549 message's header, it removes any &'Bcc:'& header line that may exist (after
33550 extracting its addresses). If &%-t%& is not present on the command line, any
33551 existing &'Bcc:'& is not removed.
33552
33553
33554 .section "The Date: header line" "SECID223"
33555 .cindex "&'Date:'& header line"
33556 .cindex "header lines" "Date:"
33557 If a locally-generated or submission-mode message has no &'Date:'& header line,
33558 Exim adds one, using the current date and time, unless the
33559 &%suppress_local_fixups%& control has been specified.
33560
33561 .section "The Delivery-date: header line" "SECID224"
33562 .cindex "&'Delivery-date:'& header line"
33563 .oindex "&%delivery_date_remove%&"
33564 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33565 set. Exim can be configured to add them to the final delivery of messages. (See
33566 the generic &%delivery_date_add%& transport option.) They should not be present
33567 in messages in transit. If the &%delivery_date_remove%& configuration option is
33568 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33569 messages.
33570
33571
33572 .section "The Envelope-to: header line" "SECID225"
33573 .cindex "&'Envelope-to:'& header line"
33574 .cindex "header lines" "Envelope-to:"
33575 .oindex "&%envelope_to_remove%&"
33576 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33577 Exim can be configured to add them to the final delivery of messages. (See the
33578 generic &%envelope_to_add%& transport option.) They should not be present in
33579 messages in transit. If the &%envelope_to_remove%& configuration option is set
33580 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33581 messages.
33582
33583
33584 .section "The From: header line" "SECTthefrohea"
33585 .cindex "&'From:'& header line"
33586 .cindex "header lines" "From:"
33587 .cindex "Sendmail compatibility" "&""From""& line"
33588 .cindex "message" "submission"
33589 .cindex "submission mode"
33590 If a submission-mode message does not contain a &'From:'& header line, Exim
33591 adds one if either of the following conditions is true:
33592
33593 .ilist
33594 The envelope sender address is not empty (that is, this is not a bounce
33595 message). The added header line copies the envelope sender address.
33596 .next
33597 .vindex "&$authenticated_id$&"
33598 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33599 .olist
33600 .vindex "&$qualify_domain$&"
33601 If no domain is specified by the submission control, the local part is
33602 &$authenticated_id$& and the domain is &$qualify_domain$&.
33603 .next
33604 If a non-empty domain is specified by the submission control, the local
33605 part is &$authenticated_id$&, and the domain is the specified domain.
33606 .next
33607 If an empty domain is specified by the submission control,
33608 &$authenticated_id$& is assumed to be the complete address.
33609 .endlist
33610 .endlist
33611
33612 A non-empty envelope sender takes precedence.
33613
33614 If a locally-generated incoming message does not contain a &'From:'& header
33615 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33616 containing the sender's address. The calling user's login name and full name
33617 are used to construct the address, as described in section &<<SECTconstr>>&.
33618 They are obtained from the password data by calling &[getpwuid()]& (but see the
33619 &%unknown_login%& configuration option). The address is qualified with
33620 &%qualify_domain%&.
33621
33622 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33623 &'From:'& header line containing just the unqualified login name of the calling
33624 user, this is replaced by an address containing the user's login name and full
33625 name as described in section &<<SECTconstr>>&.
33626
33627
33628 .section "The Message-ID: header line" "SECID226"
33629 .cindex "&'Message-ID:'& header line"
33630 .cindex "header lines" "Message-ID:"
33631 .cindex "message" "submission"
33632 .oindex "&%message_id_header_text%&"
33633 If a locally-generated or submission-mode incoming message does not contain a
33634 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33635 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33636 to the message. If there are any &'Resent-:'& headers in the message, it
33637 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33638 message id, preceded by the letter E to ensure it starts with a letter, and
33639 followed by @ and the primary host name. Additional information can be included
33640 in this header line by setting the &%message_id_header_text%& and/or
33641 &%message_id_header_domain%& options.
33642
33643
33644 .section "The Received: header line" "SECID227"
33645 .cindex "&'Received:'& header line"
33646 .cindex "header lines" "Received:"
33647 A &'Received:'& header line is added at the start of every message. The
33648 contents are defined by the &%received_header_text%& configuration option, and
33649 Exim automatically adds a semicolon and a timestamp to the configured string.
33650
33651 The &'Received:'& header is generated as soon as the message's header lines
33652 have been received. At this stage, the timestamp in the &'Received:'& header
33653 line is the time that the message started to be received. This is the value
33654 that is seen by the DATA ACL and by the &[local_scan()]& function.
33655
33656 Once a message is accepted, the timestamp in the &'Received:'& header line is
33657 changed to the time of acceptance, which is (apart from a small delay while the
33658 -H spool file is written) the earliest time at which delivery could start.
33659
33660
33661 .section "The References: header line" "SECID228"
33662 .cindex "&'References:'& header line"
33663 .cindex "header lines" "References:"
33664 Messages created by the &(autoreply)& transport include a &'References:'&
33665 header line. This is constructed according to the rules that are described in
33666 section 3.64 of RFC 2822 (which states that replies should contain such a
33667 header line), and section 3.14 of RFC 3834 (which states that automatic
33668 responses are not different in this respect). However, because some mail
33669 processing software does not cope well with very long header lines, no more
33670 than 12 message IDs are copied from the &'References:'& header line in the
33671 incoming message. If there are more than 12, the first one and then the final
33672 11 are copied, before adding the message ID of the incoming message.
33673
33674
33675
33676 .section "The Return-path: header line" "SECID229"
33677 .cindex "&'Return-path:'& header line"
33678 .cindex "header lines" "Return-path:"
33679 .oindex "&%return_path_remove%&"
33680 &'Return-path:'& header lines are defined as something an MTA may insert when
33681 it does the final delivery of messages. (See the generic &%return_path_add%&
33682 transport option.) Therefore, they should not be present in messages in
33683 transit. If the &%return_path_remove%& configuration option is set (the
33684 default), Exim removes &'Return-path:'& header lines from incoming messages.
33685
33686
33687
33688 .section "The Sender: header line" "SECTthesenhea"
33689 .cindex "&'Sender:'& header line"
33690 .cindex "message" "submission"
33691 .cindex "header lines" "Sender:"
33692 For a locally-originated message from an untrusted user, Exim may remove an
33693 existing &'Sender:'& header line, and it may add a new one. You can modify
33694 these actions by setting the &%local_sender_retain%& option true, the
33695 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33696 control setting.
33697
33698 When a local message is received from an untrusted user and
33699 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33700 control has not been set, a check is made to see if the address given in the
33701 &'From:'& header line is the correct (local) sender of the message. The address
33702 that is expected has the login name as the local part and the value of
33703 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33704 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33705 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33706 line is added to the message.
33707
33708 If you set &%local_from_check%& false, this checking does not occur. However,
33709 the removal of an existing &'Sender:'& line still happens, unless you also set
33710 &%local_sender_retain%& to be true. It is not possible to set both of these
33711 options true at the same time.
33712
33713 .cindex "submission mode"
33714 By default, no processing of &'Sender:'& header lines is done for messages
33715 received over TCP/IP or for messages submitted by trusted users. However, when
33716 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33717 not specified on the submission control, the following processing takes place:
33718
33719 .vindex "&$authenticated_id$&"
33720 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33721 authenticated, and &$authenticated_id$& is not empty, a sender address is
33722 created as follows:
33723
33724 .ilist
33725 .vindex "&$qualify_domain$&"
33726 If no domain is specified by the submission control, the local part is
33727 &$authenticated_id$& and the domain is &$qualify_domain$&.
33728 .next
33729 If a non-empty domain is specified by the submission control, the local part
33730 is &$authenticated_id$&, and the domain is the specified domain.
33731 .next
33732 If an empty domain is specified by the submission control,
33733 &$authenticated_id$& is assumed to be the complete address.
33734 .endlist
33735
33736 This address is compared with the address in the &'From:'& header line. If they
33737 are different, a &'Sender:'& header line containing the created address is
33738 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33739 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33740
33741 .cindex "return path" "created from &'Sender:'&"
33742 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33743 the message (the envelope sender address) is changed to be the same address,
33744 except in the case of submission mode when &%sender_retain%& is specified.
33745
33746
33747
33748 .section "Adding and removing header lines in routers and transports" &&&
33749          "SECTheadersaddrem"
33750 .cindex "header lines" "adding; in router or transport"
33751 .cindex "header lines" "removing; in router or transport"
33752 When a message is delivered, the addition and removal of header lines can be
33753 specified in a system filter, or on any of the routers and transports that
33754 process the message. Section &<<SECTaddremheasys>>& contains details about
33755 modifying headers in a system filter. Header lines can also be added in an ACL
33756 as a message is received (see section &<<SECTaddheadacl>>&).
33757
33758 In contrast to what happens in a system filter, header modifications that are
33759 specified on routers and transports apply only to the particular recipient
33760 addresses that are being processed by those routers and transports. These
33761 changes do not actually take place until a copy of the message is being
33762 transported. Therefore, they do not affect the basic set of header lines, and
33763 they do not affect the values of the variables that refer to header lines.
33764
33765 &*Note*&: In particular, this means that any expansions in the configuration of
33766 the transport cannot refer to the modified header lines, because such
33767 expansions all occur before the message is actually transported.
33768
33769 For both routers and transports, the argument of a &%headers_add%&
33770 option must be in the form of one or more RFC 2822 header lines, separated by
33771 newlines (coded as &"\n"&). For example:
33772 .code
33773 headers_add = X-added-header: added by $primary_hostname\n\
33774               X-added-second: another added header line
33775 .endd
33776 Exim does not check the syntax of these added header lines.
33777
33778 Multiple &%headers_add%& options for a single router or transport can be
33779 specified; the values will append to a single list of header lines.
33780 Each header-line is separately expanded.
33781
33782 The argument of a &%headers_remove%& option must consist of a colon-separated
33783 list of header names. This is confusing, because header names themselves are
33784 often terminated by colons. In this case, the colons are the list separators,
33785 not part of the names. For example:
33786 .code
33787 headers_remove = return-receipt-to:acknowledge-to
33788 .endd
33789
33790 Multiple &%headers_remove%& options for a single router or transport can be
33791 specified; the arguments will append to a single header-names list.
33792 Each item is separately expanded.
33793 Note that colons in complex expansions which are used to
33794 form all or part of a &%headers_remove%& list
33795 will act as list separators.
33796
33797 When &%headers_add%& or &%headers_remove%& is specified on a router,
33798 items are expanded at routing time,
33799 and then associated with all addresses that are
33800 accepted by that router, and also with any new addresses that it generates. If
33801 an address passes through several routers as a result of aliasing or
33802 forwarding, the changes are cumulative.
33803
33804 .oindex "&%unseen%&"
33805 However, this does not apply to multiple routers that result from the use of
33806 the &%unseen%& option. Any header modifications that were specified by the
33807 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33808
33809 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33810 settings cannot be delivered together in a batch, so a transport is always
33811 dealing with a set of addresses that have the same header-processing
33812 requirements.
33813
33814 The transport starts by writing the original set of header lines that arrived
33815 with the message, possibly modified by the system filter. As it writes out
33816 these lines, it consults the list of header names that were attached to the
33817 recipient address(es) by &%headers_remove%& options in routers, and it also
33818 consults the transport's own &%headers_remove%& option. Header lines whose
33819 names are on either of these lists are not written out. If there are multiple
33820 instances of any listed header, they are all skipped.
33821
33822 After the remaining original header lines have been written, new header
33823 lines that were specified by routers' &%headers_add%& options are written, in
33824 the order in which they were attached to the address. These are followed by any
33825 header lines specified by the transport's &%headers_add%& option.
33826
33827 This way of handling header line modifications in routers and transports has
33828 the following consequences:
33829
33830 .ilist
33831 The original set of header lines, possibly modified by the system filter,
33832 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33833 to it, at all times.
33834 .next
33835 Header lines that are added by a router's
33836 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33837 expansion syntax in subsequent routers or the transport.
33838 .next
33839 Conversely, header lines that are specified for removal by &%headers_remove%&
33840 in a router remain visible to subsequent routers and the transport.
33841 .next
33842 Headers added to an address by &%headers_add%& in a router cannot be removed by
33843 a later router or by a transport.
33844 .next
33845 An added header can refer to the contents of an original header that is to be
33846 removed, even it has the same name as the added header. For example:
33847 .code
33848 headers_remove = subject
33849 headers_add = Subject: new subject (was: $h_subject:)
33850 .endd
33851 .endlist
33852
33853 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33854 for a &(redirect)& router that has the &%one_time%& option set.
33855
33856
33857
33858
33859
33860 .section "Constructed addresses" "SECTconstr"
33861 .cindex "address" "constructed"
33862 .cindex "constructed address"
33863 When Exim constructs a sender address for a locally-generated message, it uses
33864 the form
33865 .display
33866 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33867 .endd
33868 For example:
33869 .code
33870 Zaphod Beeblebrox <zaphod@end.univ.example>
33871 .endd
33872 The user name is obtained from the &%-F%& command line option if set, or
33873 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33874 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33875 ampersand character, this is replaced by the login name with the first letter
33876 upper cased, as is conventional in a number of operating systems. See the
33877 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33878 The &%unknown_username%& option can be used to specify user names in cases when
33879 there is no password file entry.
33880
33881 .cindex "RFC 2047"
33882 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33883 parts of it if necessary. In addition, if it contains any non-printing
33884 characters, it is encoded as described in RFC 2047, which defines a way of
33885 including non-ASCII characters in header lines. The value of the
33886 &%headers_charset%& option specifies the name of the encoding that is used (the
33887 characters are assumed to be in this encoding). The setting of
33888 &%print_topbitchars%& controls whether characters with the top bit set (that
33889 is, with codes greater than 127) count as printing characters or not.
33890
33891
33892
33893 .section "Case of local parts" "SECID230"
33894 .cindex "case of local parts"
33895 .cindex "local part" "case of"
33896 RFC 2822 states that the case of letters in the local parts of addresses cannot
33897 be assumed to be non-significant. Exim preserves the case of local parts of
33898 addresses, but by default it uses a lower-cased form when it is routing,
33899 because on most Unix systems, usernames are in lower case and case-insensitive
33900 routing is required. However, any particular router can be made to use the
33901 original case for local parts by setting the &%caseful_local_part%& generic
33902 router option.
33903
33904 .cindex "mixed-case login names"
33905 If you must have mixed-case user names on your system, the best way to proceed,
33906 assuming you want case-independent handling of incoming email, is to set up
33907 your first router to convert incoming local parts in your domains to the
33908 correct case by means of a file lookup. For example:
33909 .code
33910 correct_case:
33911   driver = redirect
33912   domains = +local_domains
33913   data = ${lookup{$local_part}cdb\
33914               {/etc/usercased.cdb}{$value}fail}\
33915               @$domain
33916 .endd
33917 For this router, the local part is forced to lower case by the default action
33918 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33919 up a new local part in the correct case. If you then set &%caseful_local_part%&
33920 on any subsequent routers which process your domains, they will operate on
33921 local parts with the correct case in a case-sensitive manner.
33922
33923
33924
33925 .section "Dots in local parts" "SECID231"
33926 .cindex "dot" "in local part"
33927 .cindex "local part" "dots in"
33928 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33929 part may not begin or end with a dot, nor have two consecutive dots in the
33930 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33931 empty components for compatibility.
33932
33933
33934
33935 .section "Rewriting addresses" "SECID232"
33936 .cindex "rewriting" "addresses"
33937 Rewriting of sender and recipient addresses, and addresses in headers, can
33938 happen automatically, or as the result of configuration options, as described
33939 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33940 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33941
33942 Automatic rewriting includes qualification, as mentioned above. The other case
33943 in which it can happen is when an incomplete non-local domain is given. The
33944 routing process may cause this to be expanded into the full domain name. For
33945 example, a header such as
33946 .code
33947 To: hare@teaparty
33948 .endd
33949 might get rewritten as
33950 .code
33951 To: hare@teaparty.wonderland.fict.example
33952 .endd
33953 Rewriting as a result of routing is the one kind of message processing that
33954 does not happen at input time, as it cannot be done until the address has
33955 been routed.
33956
33957 Strictly, one should not do &'any'& deliveries of a message until all its
33958 addresses have been routed, in case any of the headers get changed as a
33959 result of routing. However, doing this in practice would hold up many
33960 deliveries for unreasonable amounts of time, just because one address could not
33961 immediately be routed. Exim therefore does not delay other deliveries when
33962 routing of one or more addresses is deferred.
33963 .ecindex IIDmesproc
33964
33965
33966
33967 . ////////////////////////////////////////////////////////////////////////////
33968 . ////////////////////////////////////////////////////////////////////////////
33969
33970 .chapter "SMTP processing" "CHAPSMTP"
33971 .scindex IIDsmtpproc1 "SMTP" "processing details"
33972 .scindex IIDsmtpproc2 "LMTP" "processing details"
33973 Exim supports a number of different ways of using the SMTP protocol, and its
33974 LMTP variant, which is an interactive protocol for transferring messages into a
33975 closed mail store application. This chapter contains details of how SMTP is
33976 processed. For incoming mail, the following are available:
33977
33978 .ilist
33979 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33980 .next
33981 SMTP over the standard input and output (the &%-bs%& option);
33982 .next
33983 Batched SMTP on the standard input (the &%-bS%& option).
33984 .endlist
33985
33986 For mail delivery, the following are available:
33987
33988 .ilist
33989 SMTP over TCP/IP (the &(smtp)& transport);
33990 .next
33991 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33992 &"lmtp"&);
33993 .next
33994 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33995 transport);
33996 .next
33997 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33998 the &%use_bsmtp%& option set).
33999 .endlist
34000
34001 &'Batched SMTP'& is the name for a process in which batches of messages are
34002 stored in or read from files (or pipes), in a format in which SMTP commands are
34003 used to contain the envelope information.
34004
34005
34006
34007 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34008 .cindex "SMTP" "outgoing over TCP/IP"
34009 .cindex "outgoing SMTP over TCP/IP"
34010 .cindex "LMTP" "over TCP/IP"
34011 .cindex "outgoing LMTP over TCP/IP"
34012 .cindex "EHLO"
34013 .cindex "HELO"
34014 .cindex "SIZE option on MAIL command"
34015 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34016 The &%protocol%& option selects which protocol is to be used, but the actual
34017 processing is the same in both cases.
34018
34019 If, in response to its EHLO command, Exim is told that the SIZE
34020 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34021 command. The value of <&'n'&> is the message size plus the value of the
34022 &%size_addition%& option (default 1024) to allow for additions to the message
34023 such as per-transport header lines, or changes made in a
34024 .cindex "transport" "filter"
34025 .cindex "filter" "transport filter"
34026 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34027 suppressed.
34028
34029 If the remote server advertises support for PIPELINING, Exim uses the
34030 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34031 required for the transaction.
34032
34033 If the remote server advertises support for the STARTTLS command, and Exim
34034 was built to support TLS encryption, it tries to start a TLS session unless the
34035 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34036 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34037 is called for verification.
34038
34039 If the remote server advertises support for the AUTH command, Exim scans
34040 the authenticators configuration for any suitable client settings, as described
34041 in chapter &<<CHAPSMTPAUTH>>&.
34042
34043 .cindex "carriage return"
34044 .cindex "linefeed"
34045 Responses from the remote host are supposed to be terminated by CR followed by
34046 LF. However, there are known to be hosts that do not send CR characters, so in
34047 order to be able to interwork with such hosts, Exim treats LF on its own as a
34048 line terminator.
34049
34050 If a message contains a number of different addresses, all those with the same
34051 characteristics (for example, the same envelope sender) that resolve to the
34052 same set of hosts, in the same order, are sent in a single SMTP transaction,
34053 even if they are for different domains, unless there are more than the setting
34054 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34055 they are split into groups containing no more than &%max_rcpt%&s addresses
34056 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34057 in parallel sessions. The order of hosts with identical MX values is not
34058 significant when checking whether addresses can be batched in this way.
34059
34060 When the &(smtp)& transport suffers a temporary failure that is not
34061 message-related, Exim updates its transport-specific database, which contains
34062 records indexed by host name that remember which messages are waiting for each
34063 particular host. It also updates the retry database with new retry times.
34064
34065 .cindex "hints database" "retry keys"
34066 Exim's retry hints are based on host name plus IP address, so if one address of
34067 a multi-homed host is broken, it will soon be skipped most of the time.
34068 See the next section for more detail about error handling.
34069
34070 .cindex "SMTP" "passed connection"
34071 .cindex "SMTP" "batching over TCP/IP"
34072 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34073 looks in the hints database for the transport to see if there are any queued
34074 messages waiting for the host to which it is connected. If it finds one, it
34075 creates a new Exim process using the &%-MC%& option (which can only be used by
34076 a process running as root or the Exim user) and passes the TCP/IP socket to it
34077 so that it can deliver another message using the same socket. The new process
34078 does only those deliveries that are routed to the connected host, and may in
34079 turn pass the socket on to a third process, and so on.
34080
34081 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34082 limit the number of messages sent down a single TCP/IP connection.
34083
34084 .cindex "asterisk" "after IP address"
34085 The second and subsequent messages delivered down an existing connection are
34086 identified in the main log by the addition of an asterisk after the closing
34087 square bracket of the IP address.
34088
34089
34090
34091
34092 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34093 .cindex "error" "in outgoing SMTP"
34094 .cindex "SMTP" "errors in outgoing"
34095 .cindex "host" "error"
34096 Three different kinds of error are recognized for outgoing SMTP: host errors,
34097 message errors, and recipient errors.
34098
34099 .vlist
34100 .vitem "&*Host errors*&"
34101 A host error is not associated with a particular message or with a
34102 particular recipient of a message. The host errors are:
34103
34104 .ilist
34105 Connection refused or timed out,
34106 .next
34107 Any error response code on connection,
34108 .next
34109 Any error response code to EHLO or HELO,
34110 .next
34111 Loss of connection at any time, except after &"."&,
34112 .next
34113 I/O errors at any time,
34114 .next
34115 Timeouts during the session, other than in response to MAIL, RCPT or
34116 the &"."& at the end of the data.
34117 .endlist ilist
34118
34119 For a host error, a permanent error response on connection, or in response to
34120 EHLO, causes all addresses routed to the host to be failed. Any other host
34121 error causes all addresses to be deferred, and retry data to be created for the
34122 host. It is not tried again, for any message, until its retry time arrives. If
34123 the current set of addresses are not all delivered in this run (to some
34124 alternative host), the message is added to the list of those waiting for this
34125 host, so if it is still undelivered when a subsequent successful delivery is
34126 made to the host, it will be sent down the same SMTP connection.
34127
34128 .vitem "&*Message errors*&"
34129 .cindex "message" "error"
34130 A message error is associated with a particular message when sent to a
34131 particular host, but not with a particular recipient of the message. The
34132 message errors are:
34133
34134 .ilist
34135 Any error response code to MAIL, DATA, or the &"."& that terminates
34136 the data,
34137 .next
34138 Timeout after MAIL,
34139 .next
34140 Timeout or loss of connection after the &"."& that terminates the data. A
34141 timeout after the DATA command itself is treated as a host error, as is loss of
34142 connection at any other time.
34143 .endlist ilist
34144
34145 For a message error, a permanent error response (5&'xx'&) causes all addresses
34146 to be failed, and a delivery error report to be returned to the sender. A
34147 temporary error response (4&'xx'&), or one of the timeouts, causes all
34148 addresses to be deferred. Retry data is not created for the host, but instead,
34149 a retry record for the combination of host plus message id is created. The
34150 message is not added to the list of those waiting for this host. This ensures
34151 that the failing message will not be sent to this host again until the retry
34152 time arrives. However, other messages that are routed to the host are not
34153 affected, so if it is some property of the message that is causing the error,
34154 it will not stop the delivery of other mail.
34155
34156 If the remote host specified support for the SIZE parameter in its response
34157 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34158 over-large message will cause a message error because the error arrives as a
34159 response to MAIL.
34160
34161 .vitem "&*Recipient errors*&"
34162 .cindex "recipient" "error"
34163 A recipient error is associated with a particular recipient of a message. The
34164 recipient errors are:
34165
34166 .ilist
34167 Any error response to RCPT,
34168 .next
34169 Timeout after RCPT.
34170 .endlist
34171
34172 For a recipient error, a permanent error response (5&'xx'&) causes the
34173 recipient address to be failed, and a bounce message to be returned to the
34174 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34175 address to be deferred, and routing retry data to be created for it. This is
34176 used to delay processing of the address in subsequent queue runs, until its
34177 routing retry time arrives. This applies to all messages, but because it
34178 operates only in queue runs, one attempt will be made to deliver a new message
34179 to the failing address before the delay starts to operate. This ensures that,
34180 if the failure is really related to the message rather than the recipient
34181 (&"message too big for this recipient"& is a possible example), other messages
34182 have a chance of getting delivered. If a delivery to the address does succeed,
34183 the retry information gets cleared, so all stuck messages get tried again, and
34184 the retry clock is reset.
34185
34186 The message is not added to the list of those waiting for this host. Use of the
34187 host for other messages is unaffected, and except in the case of a timeout,
34188 other recipients are processed independently, and may be successfully delivered
34189 in the current SMTP session. After a timeout it is of course impossible to
34190 proceed with the session, so all addresses get deferred. However, those other
34191 than the one that failed do not suffer any subsequent retry delays. Therefore,
34192 if one recipient is causing trouble, the others have a chance of getting
34193 through when a subsequent delivery attempt occurs before the failing
34194 recipient's retry time.
34195 .endlist
34196
34197 In all cases, if there are other hosts (or IP addresses) available for the
34198 current set of addresses (for example, from multiple MX records), they are
34199 tried in this run for any undelivered addresses, subject of course to their
34200 own retry data. In other words, recipient error retry data does not take effect
34201 until the next delivery attempt.
34202
34203 Some hosts have been observed to give temporary error responses to every
34204 MAIL command at certain times (&"insufficient space"& has been seen). It
34205 would be nice if such circumstances could be recognized, and defer data for the
34206 host itself created, but this is not possible within the current Exim design.
34207 What actually happens is that retry data for every (host, message) combination
34208 is created.
34209
34210 The reason that timeouts after MAIL and RCPT are treated specially is that
34211 these can sometimes arise as a result of the remote host's verification
34212 procedures. Exim makes this assumption, and treats them as if a temporary error
34213 response had been received. A timeout after &"."& is treated specially because
34214 it is known that some broken implementations fail to recognize the end of the
34215 message if the last character of the last line is a binary zero. Thus, it is
34216 helpful to treat this case as a message error.
34217
34218 Timeouts at other times are treated as host errors, assuming a problem with the
34219 host, or the connection to it. If a timeout after MAIL, RCPT,
34220 or &"."& is really a connection problem, the assumption is that at the next try
34221 the timeout is likely to occur at some other point in the dialogue, causing it
34222 then to be treated as a host error.
34223
34224 There is experimental evidence that some MTAs drop the connection after the
34225 terminating &"."& if they do not like the contents of the message for some
34226 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34227 should be given. That is why Exim treats this case as a message rather than a
34228 host error, in order not to delay other messages to the same host.
34229
34230
34231
34232
34233 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34234 .cindex "SMTP" "incoming over TCP/IP"
34235 .cindex "incoming SMTP over TCP/IP"
34236 .cindex "inetd"
34237 .cindex "daemon"
34238 Incoming SMTP messages can be accepted in one of two ways: by running a
34239 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34240 &_/etc/inetd.conf_& should be like this:
34241 .code
34242 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34243 .endd
34244 Exim distinguishes between this case and the case of a locally running user
34245 agent using the &%-bs%& option by checking whether or not the standard input is
34246 a socket. When it is, either the port must be privileged (less than 1024), or
34247 the caller must be root or the Exim user. If any other user passes a socket
34248 with an unprivileged port number, Exim prints a message on the standard error
34249 stream and exits with an error code.
34250
34251 By default, Exim does not make a log entry when a remote host connects or
34252 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34253 unexpected. It can be made to write such log entries by setting the
34254 &%smtp_connection%& log selector.
34255
34256 .cindex "carriage return"
34257 .cindex "linefeed"
34258 Commands from the remote host are supposed to be terminated by CR followed by
34259 LF. However, there are known to be hosts that do not send CR characters. In
34260 order to be able to interwork with such hosts, Exim treats LF on its own as a
34261 line terminator.
34262 Furthermore, because common code is used for receiving messages from all
34263 sources, a CR on its own is also interpreted as a line terminator. However, the
34264 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34265
34266 .cindex "EHLO" "invalid data"
34267 .cindex "HELO" "invalid data"
34268 One area that sometimes gives rise to problems concerns the EHLO or
34269 HELO commands. Some clients send syntactically invalid versions of these
34270 commands, which Exim rejects by default. (This is nothing to do with verifying
34271 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34272 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34273 match the broken hosts that send invalid commands.
34274
34275 .cindex "SIZE option on MAIL command"
34276 .cindex "MAIL" "SIZE option"
34277 The amount of disk space available is checked whenever SIZE is received on
34278 a MAIL command, independently of whether &%message_size_limit%& or
34279 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34280 false. A temporary error is given if there is not enough space. If
34281 &%check_spool_space%& is set, the check is for that amount of space plus the
34282 value given with SIZE, that is, it checks that the addition of the incoming
34283 message will not reduce the space below the threshold.
34284
34285 When a message is successfully received, Exim includes the local message id in
34286 its response to the final &"."& that terminates the data. If the remote host
34287 logs this text it can help with tracing what has happened to a message.
34288
34289 The Exim daemon can limit the number of simultaneous incoming connections it is
34290 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34291 number of simultaneous incoming connections from a single remote host (see the
34292 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34293 rejected using the SMTP temporary error code 421.
34294
34295 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34296 subprocess has finished, as this can get lost at busy times. Instead, it looks
34297 for completed subprocesses every time it wakes up. Provided there are other
34298 things happening (new incoming calls, starts of queue runs), completed
34299 processes will be noticed and tidied away. On very quiet systems you may
34300 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34301 it will be noticed when the daemon next wakes up.
34302
34303 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34304 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34305 high system load &-- for details see the &%smtp_accept_reserve%&,
34306 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34307 applies in both the daemon and &'inetd'& cases.
34308
34309 Exim normally starts a delivery process for each message received, though this
34310 can be varied by means of the &%-odq%& command line option and the
34311 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34312 number of simultaneously running delivery processes started in this way from
34313 SMTP input can be limited by the &%smtp_accept_queue%& and
34314 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34315 subsequently received messages are just put on the input queue without starting
34316 a delivery process.
34317
34318 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34319 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34320 started up from the &'inetd'& daemon, because in that case each connection is
34321 handled by an entirely independent Exim process. Control by load average is,
34322 however, available with &'inetd'&.
34323
34324 Exim can be configured to verify addresses in incoming SMTP commands as they
34325 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34326 to rewrite addresses at this time &-- before any syntax checking is done. See
34327 section &<<SECTrewriteS>>&.
34328
34329 Exim can also be configured to limit the rate at which a client host submits
34330 MAIL and RCPT commands in a single SMTP session. See the
34331 &%smtp_ratelimit_hosts%& option.
34332
34333
34334
34335 .section "Unrecognized SMTP commands" "SECID234"
34336 .cindex "SMTP" "unrecognized commands"
34337 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34338 commands during a single SMTP connection, it drops the connection after sending
34339 the error response to the last command. The default value for
34340 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34341 abuse that subvert web servers into making connections to SMTP ports; in these
34342 circumstances, a number of non-SMTP lines are sent first.
34343
34344
34345 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34346 .cindex "SMTP" "syntax errors"
34347 .cindex "SMTP" "protocol errors"
34348 A syntax error is detected if an SMTP command is recognized, but there is
34349 something syntactically wrong with its data, for example, a malformed email
34350 address in a RCPT command. Protocol errors include invalid command
34351 sequencing such as RCPT before MAIL. If Exim receives more than
34352 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34353 drops the connection after sending the error response to the last command. The
34354 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34355 broken clients that loop sending bad commands (yes, it has been seen).
34356
34357
34358
34359 .section "Use of non-mail SMTP commands" "SECID236"
34360 .cindex "SMTP" "non-mail commands"
34361 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34362 DATA. Exim counts such commands, and drops the connection if there are too
34363 many of them in a single SMTP session. This action catches some
34364 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34365 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34366 defines what &"too many"& means. Its default value is 10.
34367
34368 When a new message is expected, one occurrence of RSET is not counted. This
34369 allows a client to send one RSET between messages (this is not necessary,
34370 but some clients do it). Exim also allows one uncounted occurrence of HELO
34371 or EHLO, and one occurrence of STARTTLS between messages. After
34372 starting up a TLS session, another EHLO is expected, and so it too is not
34373 counted.
34374
34375 The first occurrence of AUTH in a connection, or immediately following
34376 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34377 RCPT, DATA, and QUIT are counted.
34378
34379 You can control which hosts are subject to the limit set by
34380 &%smtp_accept_max_nonmail%& by setting
34381 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34382 the limit apply to all hosts. This option means that you can exclude any
34383 specific badly-behaved hosts that you have to live with.
34384
34385
34386
34387
34388 .section "The VRFY and EXPN commands" "SECID237"
34389 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34390 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34391 appropriate) in order to decide whether the command should be accepted or not.
34392
34393 .cindex "VRFY" "processing"
34394 When no ACL is defined for VRFY, or if it rejects without
34395 setting an explicit response code, the command is accepted
34396 (with a 252 SMTP response code)
34397 in order to support awkward clients that do a VRFY before every RCPT.
34398 When VRFY is accepted, it runs exactly the same code as when Exim is
34399 called with the &%-bv%& option, and returns 250/451/550
34400 SMTP response codes.
34401
34402 .cindex "EXPN" "processing"
34403 If no ACL for EXPN is defined, the command is rejected.
34404 When EXPN is accepted, a single-level expansion of the address is done.
34405 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34406 than a verification (the &%-bv%& option). If an unqualified local part is given
34407 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34408 of VRFY and EXPN commands are logged on the main and reject logs, and
34409 VRFY verification failures are logged on the main log for consistency with
34410 RCPT failures.
34411
34412
34413
34414 .section "The ETRN command" "SECTETRN"
34415 .cindex "ETRN" "processing"
34416 RFC 1985 describes an SMTP command called ETRN that is designed to
34417 overcome the security problems of the TURN command (which has fallen into
34418 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34419 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34420 should be accepted or not. If no ACL is defined, the command is rejected.
34421
34422 The ETRN command is concerned with &"releasing"& messages that are awaiting
34423 delivery to certain hosts. As Exim does not organize its message queue by host,
34424 the only form of ETRN that is supported by default is the one where the
34425 text starts with the &"#"& prefix, in which case the remainder of the text is
34426 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34427 the &%-R%& option to happen, with the remainder of the ETRN text as its
34428 argument. For example,
34429 .code
34430 ETRN #brigadoon
34431 .endd
34432 runs the command
34433 .code
34434 exim -R brigadoon
34435 .endd
34436 which causes a delivery attempt on all messages with undelivered addresses
34437 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34438 default), Exim prevents the simultaneous execution of more than one queue run
34439 for the same argument string as a result of an ETRN command. This stops
34440 a misbehaving client from starting more than one queue runner at once.
34441
34442 .cindex "hints database" "ETRN serialization"
34443 Exim implements the serialization by means of a hints database in which a
34444 record is written whenever a process is started by ETRN, and deleted when
34445 the process completes. However, Exim does not keep the SMTP session waiting for
34446 the ETRN process to complete. Once ETRN is accepted, the client is sent
34447 a &"success"& return code. Obviously there is scope for hints records to get
34448 left lying around if there is a system or program crash. To guard against this,
34449 Exim ignores any records that are more than six hours old.
34450
34451 .oindex "&%smtp_etrn_command%&"
34452 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34453 used. This specifies a command that is run whenever ETRN is received,
34454 whatever the form of its argument. For
34455 example:
34456 .code
34457 smtp_etrn_command = /etc/etrn_command $domain \
34458                     $sender_host_address
34459 .endd
34460 .vindex "&$domain$&"
34461 The string is split up into arguments which are independently expanded. The
34462 expansion variable &$domain$& is set to the argument of the ETRN command,
34463 and no syntax checking is done on the contents of this argument. Exim does not
34464 wait for the command to complete, so its status code is not checked. Exim runs
34465 under its own uid and gid when receiving incoming SMTP, so it is not possible
34466 for it to change them before running the command.
34467
34468
34469
34470 .section "Incoming local SMTP" "SECID238"
34471 .cindex "SMTP" "local incoming"
34472 Some user agents use SMTP to pass messages to their local MTA using the
34473 standard input and output, as opposed to passing the envelope on the command
34474 line and writing the message to the standard input. This is supported by the
34475 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34476 messages over TCP/IP (including the use of ACLs), except that the envelope
34477 sender given in a MAIL command is ignored unless the caller is trusted. In
34478 an ACL you can detect this form of SMTP input by testing for an empty host
34479 identification. It is common to have this as the first line in the ACL that
34480 runs for RCPT commands:
34481 .code
34482 accept hosts = :
34483 .endd
34484 This accepts SMTP messages from local processes without doing any other tests.
34485
34486
34487
34488 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34489 .cindex "SMTP" "batched outgoing"
34490 .cindex "batched SMTP output"
34491 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34492 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34493 be output in BSMTP format. No SMTP responses are possible for this form of
34494 delivery. All it is doing is using SMTP commands as a way of transmitting the
34495 envelope along with the message.
34496
34497 The message is written to the file or pipe preceded by the SMTP commands
34498 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34499 the message that start with a dot have an extra dot added. The SMTP command
34500 HELO is not normally used. If it is required, the &%message_prefix%& option
34501 can be used to specify it.
34502
34503 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34504 one recipient address at a time by default. However, you can arrange for them
34505 to handle several addresses at once by setting the &%batch_max%& option. When
34506 this is done for BSMTP, messages may contain multiple RCPT commands. See
34507 chapter &<<CHAPbatching>>& for more details.
34508
34509 .vindex "&$host$&"
34510 When one or more addresses are routed to a BSMTP transport by a router that
34511 sets up a host list, the name of the first host on the list is available to the
34512 transport in the variable &$host$&. Here is an example of such a transport and
34513 router:
34514 .code
34515 begin routers
34516 route_append:
34517   driver = manualroute
34518   transport = smtp_appendfile
34519   route_list = domain.example  batch.host.example
34520
34521 begin transports
34522 smtp_appendfile:
34523   driver = appendfile
34524   directory = /var/bsmtp/$host
34525   batch_max = 1000
34526   use_bsmtp
34527   user = exim
34528 .endd
34529 This causes messages addressed to &'domain.example'& to be written in BSMTP
34530 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34531 message (unless there are more than 1000 recipients).
34532
34533
34534
34535 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34536 .cindex "SMTP" "batched incoming"
34537 .cindex "batched SMTP input"
34538 The &%-bS%& command line option causes Exim to accept one or more messages by
34539 reading SMTP on the standard input, but to generate no responses. If the caller
34540 is trusted, the senders in the MAIL commands are believed; otherwise the
34541 sender is always the caller of Exim. Unqualified senders and receivers are not
34542 rejected (there seems little point) but instead just get qualified. HELO
34543 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34544 as NOOP; QUIT quits.
34545
34546 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34547 ACL is run in the same way as for non-SMTP local input.
34548
34549 If an error is detected while reading a message, including a missing &"."& at
34550 the end, Exim gives up immediately. It writes details of the error to the
34551 standard output in a stylized way that the calling program should be able to
34552 make some use of automatically, for example:
34553 .code
34554 554 Unexpected end of file
34555 Transaction started in line 10
34556 Error detected in line 14
34557 .endd
34558 It writes a more verbose version, for human consumption, to the standard error
34559 file, for example:
34560 .code
34561 An error was detected while processing a file of BSMTP input.
34562 The error message was:
34563
34564 501 '>' missing at end of address
34565
34566 The SMTP transaction started in line 10.
34567 The error was detected in line 12.
34568 The SMTP command at fault was:
34569
34570 rcpt to:<malformed@in.com.plete
34571
34572 1 previous message was successfully processed.
34573 The rest of the batch was abandoned.
34574 .endd
34575 The return code from Exim is zero only if there were no errors. It is 1 if some
34576 messages were accepted before an error was detected, and 2 if no messages were
34577 accepted.
34578 .ecindex IIDsmtpproc1
34579 .ecindex IIDsmtpproc2
34580
34581
34582
34583 . ////////////////////////////////////////////////////////////////////////////
34584 . ////////////////////////////////////////////////////////////////////////////
34585
34586 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34587          "Customizing messages"
34588 When a message fails to be delivered, or remains on the queue for more than a
34589 configured amount of time, Exim sends a message to the original sender, or
34590 to an alternative configured address. The text of these messages is built into
34591 the code of Exim, but it is possible to change it, either by adding a single
34592 string, or by replacing each of the paragraphs by text supplied in a file.
34593
34594 The &'From:'& and &'To:'& header lines are automatically generated; you can
34595 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34596 option. Exim also adds the line
34597 .code
34598 Auto-Submitted: auto-generated
34599 .endd
34600 to all warning and bounce messages,
34601
34602
34603 .section "Customizing bounce messages" "SECID239"
34604 .cindex "customizing" "bounce message"
34605 .cindex "bounce message" "customizing"
34606 If &%bounce_message_text%& is set, its contents are included in the default
34607 message immediately after &"This message was created automatically by mail
34608 delivery software."& The string is not expanded. It is not used if
34609 &%bounce_message_file%& is set.
34610
34611 When &%bounce_message_file%& is set, it must point to a template file for
34612 constructing error messages. The file consists of a series of text items,
34613 separated by lines consisting of exactly four asterisks. If the file cannot be
34614 opened, default text is used and a message is written to the main and panic
34615 logs. If any text item in the file is empty, default text is used for that
34616 item.
34617
34618 .vindex "&$bounce_recipient$&"
34619 .vindex "&$bounce_return_size_limit$&"
34620 Each item of text that is read from the file is expanded, and there are two
34621 expansion variables which can be of use here: &$bounce_recipient$& is set to
34622 the recipient of an error message while it is being created, and
34623 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34624 option, rounded to a whole number.
34625
34626 The items must appear in the file in the following order:
34627
34628 .ilist
34629 The first item is included in the headers, and should include at least a
34630 &'Subject:'& header. Exim does not check the syntax of these headers.
34631 .next
34632 The second item forms the start of the error message. After it, Exim lists the
34633 failing addresses with their error messages.
34634 .next
34635 The third item is used to introduce any text from pipe transports that is to be
34636 returned to the sender. It is omitted if there is no such text.
34637 .next
34638 The fourth, fifth and sixth items will be ignored and may be empty.
34639 The fields exist for back-compatibility
34640 .endlist
34641
34642 The default state (&%bounce_message_file%& unset) is equivalent to the
34643 following file, in which the sixth item is empty. The &'Subject:'& and some
34644 other lines have been split in order to fit them on the page:
34645 .code
34646 Subject: Mail delivery failed
34647   ${if eq{$sender_address}{$bounce_recipient}
34648   {: returning message to sender}}
34649 ****
34650 This message was created automatically by mail delivery software.
34651
34652 A message ${if eq{$sender_address}{$bounce_recipient}
34653   {that you sent }{sent by
34654
34655 <$sender_address>
34656
34657 }}could not be delivered to all of its recipients.
34658 This is a permanent error. The following address(es) failed:
34659 ****
34660 The following text was generated during the delivery attempt(s):
34661 ****
34662 ------ This is a copy of the message, including all the headers.
34663   ------
34664 ****
34665 ------ The body of the message is $message_size characters long;
34666   only the first
34667 ------ $bounce_return_size_limit or so are included here.
34668 ****
34669 .endd
34670 .section "Customizing warning messages" "SECTcustwarn"
34671 .cindex "customizing" "warning message"
34672 .cindex "warning of delay" "customizing the message"
34673 The option &%warn_message_file%& can be pointed at a template file for use when
34674 warnings about message delays are created. In this case there are only three
34675 text sections:
34676
34677 .ilist
34678 The first item is included in the headers, and should include at least a
34679 &'Subject:'& header. Exim does not check the syntax of these headers.
34680 .next
34681 The second item forms the start of the warning message. After it, Exim lists
34682 the delayed addresses.
34683 .next
34684 The third item then ends the message.
34685 .endlist
34686
34687 The default state is equivalent to the following file, except that some lines
34688 have been split here, in order to fit them on the page:
34689 .code
34690 Subject: Warning: message $message_exim_id delayed
34691   $warn_message_delay
34692 ****
34693 This message was created automatically by mail delivery software.
34694
34695 A message ${if eq{$sender_address}{$warn_message_recipients}
34696 {that you sent }{sent by
34697
34698 <$sender_address>
34699
34700 }}has not been delivered to all of its recipients after
34701 more than $warn_message_delay on the queue on $primary_hostname.
34702
34703 The message identifier is:     $message_exim_id
34704 The subject of the message is: $h_subject
34705 The date of the message is:    $h_date
34706
34707 The following address(es) have not yet been delivered:
34708 ****
34709 No action is required on your part. Delivery attempts will
34710 continue for some time, and this warning may be repeated at
34711 intervals if the message remains undelivered. Eventually the
34712 mail delivery software will give up, and when that happens,
34713 the message will be returned to you.
34714 .endd
34715 .vindex "&$warn_message_delay$&"
34716 .vindex "&$warn_message_recipients$&"
34717 However, in the default state the subject and date lines are omitted if no
34718 appropriate headers exist. During the expansion of this file,
34719 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34720 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34721 of recipients for the warning message. There may be more than one if there are
34722 multiple addresses with different &%errors_to%& settings on the routers that
34723 handled them.
34724
34725
34726
34727
34728 . ////////////////////////////////////////////////////////////////////////////
34729 . ////////////////////////////////////////////////////////////////////////////
34730
34731 .chapter "Some common configuration settings" "CHAPcomconreq"
34732 This chapter discusses some configuration settings that seem to be fairly
34733 common. More examples and discussion can be found in the Exim book.
34734
34735
34736
34737 .section "Sending mail to a smart host" "SECID240"
34738 .cindex "smart host" "example router"
34739 If you want to send all mail for non-local domains to a &"smart host"&, you
34740 should replace the default &(dnslookup)& router with a router which does the
34741 routing explicitly:
34742 .code
34743 send_to_smart_host:
34744   driver = manualroute
34745   route_list = !+local_domains smart.host.name
34746   transport = remote_smtp
34747 .endd
34748 You can use the smart host's IP address instead of the name if you wish.
34749 If you are using Exim only to submit messages to a smart host, and not for
34750 receiving incoming messages, you can arrange for it to do the submission
34751 synchronously by setting the &%mua_wrapper%& option (see chapter
34752 &<<CHAPnonqueueing>>&).
34753
34754
34755
34756
34757 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34758 .cindex "mailing lists"
34759 Exim can be used to run simple mailing lists, but for large and/or complicated
34760 requirements, the use of additional specialized mailing list software such as
34761 Majordomo or Mailman is recommended.
34762
34763 The &(redirect)& router can be used to handle mailing lists where each list
34764 is maintained in a separate file, which can therefore be managed by an
34765 independent manager. The &%domains%& router option can be used to run these
34766 lists in a separate domain from normal mail. For example:
34767 .code
34768 lists:
34769   driver = redirect
34770   domains = lists.example
34771   file = /usr/lists/$local_part
34772   forbid_pipe
34773   forbid_file
34774   errors_to = $local_part-request@lists.example
34775   no_more
34776 .endd
34777 This router is skipped for domains other than &'lists.example'&. For addresses
34778 in that domain, it looks for a file that matches the local part. If there is no
34779 such file, the router declines, but because &%no_more%& is set, no subsequent
34780 routers are tried, and so the whole delivery fails.
34781
34782 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34783 expanded into a file name or a pipe delivery, which is usually inappropriate in
34784 a mailing list.
34785
34786 .oindex "&%errors_to%&"
34787 The &%errors_to%& option specifies that any delivery errors caused by addresses
34788 taken from a mailing list are to be sent to the given address rather than the
34789 original sender of the message. However, before acting on this, Exim verifies
34790 the error address, and ignores it if verification fails.
34791
34792 For example, using the configuration above, mail sent to
34793 &'dicts@lists.example'& is passed on to those addresses contained in
34794 &_/usr/lists/dicts_&, with error reports directed to
34795 &'dicts-request@lists.example'&, provided that this address can be verified.
34796 There could be a file called &_/usr/lists/dicts-request_& containing
34797 the address(es) of this particular list's manager(s), but other approaches,
34798 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34799 or &%local_part_suffix%& options) to handle addresses of the form
34800 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34801
34802
34803
34804 .section "Syntax errors in mailing lists" "SECID241"
34805 .cindex "mailing lists" "syntax errors in"
34806 If an entry in redirection data contains a syntax error, Exim normally defers
34807 delivery of the original address. That means that a syntax error in a mailing
34808 list holds up all deliveries to the list. This may not be appropriate when a
34809 list is being maintained automatically from data supplied by users, and the
34810 addresses are not rigorously checked.
34811
34812 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34813 entries that fail to parse, noting the incident in the log. If in addition
34814 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34815 whenever a broken address is skipped. It is usually appropriate to set
34816 &%syntax_errors_to%& to the same address as &%errors_to%&.
34817
34818
34819
34820 .section "Re-expansion of mailing lists" "SECID242"
34821 .cindex "mailing lists" "re-expansion of"
34822 Exim remembers every individual address to which a message has been delivered,
34823 in order to avoid duplication, but it normally stores only the original
34824 recipient addresses with a message. If all the deliveries to a mailing list
34825 cannot be done at the first attempt, the mailing list is re-expanded when the
34826 delivery is next tried. This means that alterations to the list are taken into
34827 account at each delivery attempt, so addresses that have been added to
34828 the list since the message arrived will therefore receive a copy of the
34829 message, even though it pre-dates their subscription.
34830
34831 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34832 on the &(redirect)& router. If this is done, any addresses generated by the
34833 router that fail to deliver at the first attempt are added to the message as
34834 &"top level"& addresses, and the parent address that generated them is marked
34835 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34836 subsequent delivery attempts. The disadvantage of this is that if any of the
34837 failing addresses are incorrect, correcting them in the file has no effect on
34838 pre-existing messages.
34839
34840 The original top-level address is remembered with each of the generated
34841 addresses, and is output in any log messages. However, any intermediate parent
34842 addresses are not recorded. This makes a difference to the log only if the
34843 &%all_parents%& selector is set, but for mailing lists there is normally only
34844 one level of expansion anyway.
34845
34846
34847
34848 .section "Closed mailing lists" "SECID243"
34849 .cindex "mailing lists" "closed"
34850 The examples so far have assumed open mailing lists, to which anybody may
34851 send mail. It is also possible to set up closed lists, where mail is accepted
34852 from specified senders only. This is done by making use of the generic
34853 &%senders%& option to restrict the router that handles the list.
34854
34855 The following example uses the same file as a list of recipients and as a list
34856 of permitted senders. It requires three routers:
34857 .code
34858 lists_request:
34859   driver = redirect
34860   domains = lists.example
34861   local_part_suffix = -request
34862   file = /usr/lists/$local_part$local_part_suffix
34863   no_more
34864
34865 lists_post:
34866   driver = redirect
34867   domains = lists.example
34868   senders = ${if exists {/usr/lists/$local_part}\
34869              {lsearch;/usr/lists/$local_part}{*}}
34870   file = /usr/lists/$local_part
34871   forbid_pipe
34872   forbid_file
34873   errors_to = $local_part-request@lists.example
34874   no_more
34875
34876 lists_closed:
34877   driver = redirect
34878   domains = lists.example
34879   allow_fail
34880   data = :fail: $local_part@lists.example is a closed mailing list
34881 .endd
34882 All three routers have the same &%domains%& setting, so for any other domains,
34883 they are all skipped. The first router runs only if the local part ends in
34884 &%-request%&. It handles messages to the list manager(s) by means of an open
34885 mailing list.
34886
34887 The second router runs only if the &%senders%& precondition is satisfied. It
34888 checks for the existence of a list that corresponds to the local part, and then
34889 checks that the sender is on the list by means of a linear search. It is
34890 necessary to check for the existence of the file before trying to search it,
34891 because otherwise Exim thinks there is a configuration error. If the file does
34892 not exist, the expansion of &%senders%& is *, which matches all senders. This
34893 means that the router runs, but because there is no list, declines, and
34894 &%no_more%& ensures that no further routers are run. The address fails with an
34895 &"unrouteable address"& error.
34896
34897 The third router runs only if the second router is skipped, which happens when
34898 a mailing list exists, but the sender is not on it. This router forcibly fails
34899 the address, giving a suitable error message.
34900
34901
34902
34903
34904 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34905 .cindex "VERP"
34906 .cindex "Variable Envelope Return Paths"
34907 .cindex "envelope sender"
34908 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34909 are a way of helping mailing list administrators discover which subscription
34910 address is the cause of a particular delivery failure. The idea is to encode
34911 the original recipient address in the outgoing envelope sender address, so that
34912 if the message is forwarded by another host and then subsequently bounces, the
34913 original recipient can be extracted from the recipient address of the bounce.
34914
34915 .oindex &%errors_to%&
34916 .oindex &%return_path%&
34917 Envelope sender addresses can be modified by Exim using two different
34918 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34919 list examples), or the &%return_path%& option on a transport. The second of
34920 these is effective only if the message is successfully delivered to another
34921 host; it is not used for errors detected on the local host (see the description
34922 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34923 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34924 .code
34925 verp_smtp:
34926   driver = smtp
34927   max_rcpt = 1
34928   return_path = \
34929     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34930       {$1-request+$local_part=$domain@your.dom.example}fail}
34931 .endd
34932 This has the effect of rewriting the return path (envelope sender) on outgoing
34933 SMTP messages, if the local part of the original return path ends in
34934 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34935 local part and domain of the recipient into the return path. Suppose, for
34936 example, that a message whose return path has been set to
34937 &'somelist-request@your.dom.example'& is sent to
34938 &'subscriber@other.dom.example'&. In the transport, the return path is
34939 rewritten as
34940 .code
34941 somelist-request+subscriber=other.dom.example@your.dom.example
34942 .endd
34943 .vindex "&$local_part$&"
34944 For this to work, you must tell Exim to send multiple copies of messages that
34945 have more than one recipient, so that each copy has just one recipient. This is
34946 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34947 might be sent to several different recipients in the same domain, in which case
34948 &$local_part$& is not available in the transport, because it is not unique.
34949
34950 Unless your host is doing nothing but mailing list deliveries, you should
34951 probably use a separate transport for the VERP deliveries, so as not to use
34952 extra resources in making one-per-recipient copies for other deliveries. This
34953 can easily be done by expanding the &%transport%& option in the router:
34954 .code
34955 dnslookup:
34956   driver = dnslookup
34957   domains = ! +local_domains
34958   transport = \
34959     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34960       {verp_smtp}{remote_smtp}}
34961   no_more
34962 .endd
34963 If you want to change the return path using &%errors_to%& in a router instead
34964 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34965 routers that handle mailing list addresses. This will ensure that all delivery
34966 errors, including those detected on the local host, are sent to the VERP
34967 address.
34968
34969 On a host that does no local deliveries and has no manual routing, only the
34970 &(dnslookup)& router needs to be changed. A special transport is not needed for
34971 SMTP deliveries. Every mailing list recipient has its own return path value,
34972 and so Exim must hand them to the transport one at a time. Here is an example
34973 of a &(dnslookup)& router that implements VERP:
34974 .code
34975 verp_dnslookup:
34976   driver = dnslookup
34977   domains = ! +local_domains
34978   transport = remote_smtp
34979   errors_to = \
34980     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34981      {$1-request+$local_part=$domain@your.dom.example}fail}
34982   no_more
34983 .endd
34984 Before you start sending out messages with VERPed return paths, you must also
34985 configure Exim to accept the bounce messages that come back to those paths.
34986 Typically this is done by setting a &%local_part_suffix%& option for a
34987 router, and using this to route the messages to wherever you want to handle
34988 them.
34989
34990 The overhead incurred in using VERP depends very much on the size of the
34991 message, the number of recipient addresses that resolve to the same remote
34992 host, and the speed of the connection over which the message is being sent. If
34993 a lot of addresses resolve to the same host and the connection is slow, sending
34994 a separate copy of the message for each address may take substantially longer
34995 than sending a single copy with many recipients (for which VERP cannot be
34996 used).
34997
34998
34999
35000
35001
35002
35003 .section "Virtual domains" "SECTvirtualdomains"
35004 .cindex "virtual domains"
35005 .cindex "domain" "virtual"
35006 The phrase &'virtual domain'& is unfortunately used with two rather different
35007 meanings:
35008
35009 .ilist
35010 A domain for which there are no real mailboxes; all valid local parts are
35011 aliases for other email addresses. Common examples are organizational
35012 top-level domains and &"vanity"& domains.
35013 .next
35014 One of a number of independent domains that are all handled by the same host,
35015 with mailboxes on that host, but where the mailbox owners do not necessarily
35016 have login accounts on that host.
35017 .endlist
35018
35019 The first usage is probably more common, and does seem more &"virtual"& than
35020 the second. This kind of domain can be handled in Exim with a straightforward
35021 aliasing router. One approach is to create a separate alias file for each
35022 virtual domain. Exim can test for the existence of the alias file to determine
35023 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35024 to a router of this form:
35025 .code
35026 virtual:
35027   driver = redirect
35028   domains = dsearch;/etc/mail/virtual
35029   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35030   no_more
35031 .endd
35032 The &%domains%& option specifies that the router is to be skipped, unless there
35033 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35034 domain that is being processed. When the router runs, it looks up the local
35035 part in the file to find a new address (or list of addresses). The &%no_more%&
35036 setting ensures that if the lookup fails (leading to &%data%& being an empty
35037 string), Exim gives up on the address without trying any subsequent routers.
35038
35039 This one router can handle all the virtual domains because the alias file names
35040 follow a fixed pattern. Permissions can be arranged so that appropriate people
35041 can edit the different alias files. A successful aliasing operation results in
35042 a new envelope recipient address, which is then routed from scratch.
35043
35044 The other kind of &"virtual"& domain can also be handled in a straightforward
35045 way. One approach is to create a file for each domain containing a list of
35046 valid local parts, and use it in a router like this:
35047 .code
35048 my_domains:
35049   driver = accept
35050   domains = dsearch;/etc/mail/domains
35051   local_parts = lsearch;/etc/mail/domains/$domain
35052   transport = my_mailboxes
35053 .endd
35054 The address is accepted if there is a file for the domain, and the local part
35055 can be found in the file. The &%domains%& option is used to check for the
35056 file's existence because &%domains%& is tested before the &%local_parts%&
35057 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35058 because that option is tested after &%local_parts%&. The transport is as
35059 follows:
35060 .code
35061 my_mailboxes:
35062   driver = appendfile
35063   file = /var/mail/$domain/$local_part
35064   user = mail
35065 .endd
35066 This uses a directory of mailboxes for each domain. The &%user%& setting is
35067 required, to specify which uid is to be used for writing to the mailboxes.
35068
35069 The configuration shown here is just one example of how you might support this
35070 requirement. There are many other ways this kind of configuration can be set
35071 up, for example, by using a database instead of separate files to hold all the
35072 information about the domains.
35073
35074
35075
35076 .section "Multiple user mailboxes" "SECTmulbox"
35077 .cindex "multiple mailboxes"
35078 .cindex "mailbox" "multiple"
35079 .cindex "local part" "prefix"
35080 .cindex "local part" "suffix"
35081 Heavy email users often want to operate with multiple mailboxes, into which
35082 incoming mail is automatically sorted. A popular way of handling this is to
35083 allow users to use multiple sender addresses, so that replies can easily be
35084 identified. Users are permitted to add prefixes or suffixes to their local
35085 parts for this purpose. The wildcard facility of the generic router options
35086 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35087 example, consider this router:
35088 .code
35089 userforward:
35090   driver = redirect
35091   check_local_user
35092   file = $home/.forward
35093   local_part_suffix = -*
35094   local_part_suffix_optional
35095   allow_filter
35096 .endd
35097 .vindex "&$local_part_suffix$&"
35098 It runs a user's &_.forward_& file for all local parts of the form
35099 &'username-*'&. Within the filter file the user can distinguish different
35100 cases by testing the variable &$local_part_suffix$&. For example:
35101 .code
35102 if $local_part_suffix contains -special then
35103 save /home/$local_part/Mail/special
35104 endif
35105 .endd
35106 If the filter file does not exist, or does not deal with such addresses, they
35107 fall through to subsequent routers, and, assuming no subsequent use of the
35108 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35109 control over which suffixes are valid.
35110
35111 Alternatively, a suffix can be used to trigger the use of a different
35112 &_.forward_& file &-- which is the way a similar facility is implemented in
35113 another MTA:
35114 .code
35115 userforward:
35116   driver = redirect
35117   check_local_user
35118   file = $home/.forward$local_part_suffix
35119   local_part_suffix = -*
35120   local_part_suffix_optional
35121   allow_filter
35122 .endd
35123 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35124 example, &_.forward-special_& is used. Once again, if the appropriate file
35125 does not exist, or does not deal with the address, it is passed on to
35126 subsequent routers, which could, if required, look for an unqualified
35127 &_.forward_& file to use as a default.
35128
35129
35130
35131 .section "Simplified vacation processing" "SECID244"
35132 .cindex "vacation processing"
35133 The traditional way of running the &'vacation'& program is for a user to set up
35134 a pipe command in a &_.forward_& file
35135 (see section &<<SECTspecitredli>>& for syntax details).
35136 This is prone to error by inexperienced users. There are two features of Exim
35137 that can be used to make this process simpler for users:
35138
35139 .ilist
35140 A local part prefix such as &"vacation-"& can be specified on a router which
35141 can cause the message to be delivered directly to the &'vacation'& program, or
35142 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35143 &_.forward_& file are then much simpler. For example:
35144 .code
35145 spqr, vacation-spqr
35146 .endd
35147 .next
35148 The &%require_files%& generic router option can be used to trigger a
35149 vacation delivery by checking for the existence of a certain file in the
35150 user's home directory. The &%unseen%& generic option should also be used, to
35151 ensure that the original delivery also proceeds. In this case, all the user has
35152 to do is to create a file called, say, &_.vacation_&, containing a vacation
35153 message.
35154 .endlist
35155
35156 Another advantage of both these methods is that they both work even when the
35157 use of arbitrary pipes by users is locked out.
35158
35159
35160
35161 .section "Taking copies of mail" "SECID245"
35162 .cindex "message" "copying every"
35163 Some installations have policies that require archive copies of all messages to
35164 be made. A single copy of each message can easily be taken by an appropriate
35165 command in a system filter, which could, for example, use a different file for
35166 each day's messages.
35167
35168 There is also a shadow transport mechanism that can be used to take copies of
35169 messages that are successfully delivered by local transports, one copy per
35170 delivery. This could be used, &'inter alia'&, to implement automatic
35171 notification of delivery by sites that insist on doing such things.
35172
35173
35174
35175 .section "Intermittently connected hosts" "SECID246"
35176 .cindex "intermittently connected hosts"
35177 It has become quite common (because it is cheaper) for hosts to connect to the
35178 Internet periodically rather than remain connected all the time. The normal
35179 arrangement is that mail for such hosts accumulates on a system that is
35180 permanently connected.
35181
35182 Exim was designed for use on permanently connected hosts, and so it is not
35183 particularly well-suited to use in an intermittently connected environment.
35184 Nevertheless there are some features that can be used.
35185
35186
35187 .section "Exim on the upstream server host" "SECID247"
35188 It is tempting to arrange for incoming mail for the intermittently connected
35189 host to remain on Exim's queue until the client connects. However, this
35190 approach does not scale very well. Two different kinds of waiting message are
35191 being mixed up in the same queue &-- those that cannot be delivered because of
35192 some temporary problem, and those that are waiting for their destination host
35193 to connect. This makes it hard to manage the queue, as well as wasting
35194 resources, because each queue runner scans the entire queue.
35195
35196 A better approach is to separate off those messages that are waiting for an
35197 intermittently connected host. This can be done by delivering these messages
35198 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35199 format, from where they are transmitted by other software when their
35200 destination connects. This makes it easy to collect all the mail for one host
35201 in a single directory, and to apply local timeout rules on a per-message basis
35202 if required.
35203
35204 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35205 you are doing this, you should configure Exim with a long retry period for the
35206 intermittent host. For example:
35207 .code
35208 cheshire.wonderland.fict.example    *   F,5d,24h
35209 .endd
35210 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35211 which messages it has queued up for that host. Once the intermittent host comes
35212 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35213 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35214 causes all the queued up messages to be delivered, often down a single SMTP
35215 connection. While the host remains connected, any new messages get delivered
35216 immediately.
35217
35218 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35219 issued with a different IP address each time it connects, Exim's retry
35220 mechanisms on the holding host get confused, because the IP address is normally
35221 used as part of the key string for holding retry information. This can be
35222 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35223 Since this has disadvantages for permanently connected hosts, it is best to
35224 arrange a separate transport for the intermittently connected ones.
35225
35226
35227
35228 .section "Exim on the intermittently connected client host" "SECID248"
35229 The value of &%smtp_accept_queue_per_connection%& should probably be
35230 increased, or even set to zero (that is, disabled) on the intermittently
35231 connected host, so that all incoming messages down a single connection get
35232 delivered immediately.
35233
35234 .cindex "SMTP" "passed connection"
35235 .cindex "SMTP" "multiple deliveries"
35236 .cindex "multiple SMTP deliveries"
35237 Mail waiting to be sent from an intermittently connected host will probably
35238 not have been routed, because without a connection DNS lookups are not
35239 possible. This means that if a normal queue run is done at connection time,
35240 each message is likely to be sent in a separate SMTP session. This can be
35241 avoided by starting the queue run with a command line option beginning with
35242 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35243 first pass, routing is done but no deliveries take place. The second pass is a
35244 normal queue run; since all the messages have been previously routed, those
35245 destined for the same host are likely to get sent as multiple deliveries in a
35246 single SMTP connection.
35247
35248
35249
35250 . ////////////////////////////////////////////////////////////////////////////
35251 . ////////////////////////////////////////////////////////////////////////////
35252
35253 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35254          "Exim as a non-queueing client"
35255 .cindex "client, non-queueing"
35256 .cindex "smart host" "suppressing queueing"
35257 On a personal computer, it is a common requirement for all
35258 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35259 configured to operate that way, for all the popular operating systems.
35260 However, there are some MUAs for Unix-like systems that cannot be so
35261 configured: they submit messages using the command line interface of
35262 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35263 messages this way.
35264
35265 If the personal computer runs continuously, there is no problem, because it can
35266 run a conventional MTA that handles delivery to the smart host, and deal with
35267 any delays via its queueing mechanism. However, if the computer does not run
35268 continuously or runs different operating systems at different times, queueing
35269 email is not desirable.
35270
35271 There is therefore a requirement for something that can provide the
35272 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35273 any queueing or retrying facilities. Furthermore, the delivery to the smart
35274 host should be synchronous, so that if it fails, the sending MUA is immediately
35275 informed. In other words, we want something that extends an MUA that submits
35276 to a local MTA via the command line so that it behaves like one that submits
35277 to a remote smart host using TCP/SMTP.
35278
35279 There are a number of applications (for example, there is one called &'ssmtp'&)
35280 that do this job. However, people have found them to be lacking in various
35281 ways. For instance, you might want to allow aliasing and forwarding to be done
35282 before sending a message to the smart host.
35283
35284 Exim already had the necessary infrastructure for doing this job. Just a few
35285 tweaks were needed to make it behave as required, though it is somewhat of an
35286 overkill to use a fully-featured MTA for this purpose.
35287
35288 .oindex "&%mua_wrapper%&"
35289 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35290 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35291 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35292 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35293 compatible router and transport configuration. Typically there will be just one
35294 router and one transport, sending everything to a smart host.
35295
35296 When run in MUA wrapping mode, the behaviour of Exim changes in the
35297 following ways:
35298
35299 .ilist
35300 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35301 In other words, the only way to submit messages is via the command line.
35302 .next
35303 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35304 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35305 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35306 does not finish until the delivery attempt is complete. If the delivery is
35307 successful, a zero return code is given.
35308 .next
35309 Address redirection is permitted, but the final routing for all addresses must
35310 be to the same remote transport, and to the same list of hosts. Furthermore,
35311 the return address (envelope sender) must be the same for all recipients, as
35312 must any added or deleted header lines. In other words, it must be possible to
35313 deliver the message in a single SMTP transaction, however many recipients there
35314 are.
35315 .next
35316 If these conditions are not met, or if routing any address results in a
35317 failure or defer status, or if Exim is unable to deliver all the recipients
35318 successfully to one of the smart hosts, delivery of the entire message fails.
35319 .next
35320 Because no queueing is allowed, all failures are treated as permanent; there
35321 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35322 smart host. Furthermore, because only a single yes/no response can be given to
35323 the caller, it is not possible to deliver to some recipients and not others. If
35324 there is an error (temporary or permanent) for any recipient, all are failed.
35325 .next
35326 If more than one smart host is listed, Exim will try another host after a
35327 connection failure or a timeout, in the normal way. However, if this kind of
35328 failure happens for all the hosts, the delivery fails.
35329 .next
35330 When delivery fails, an error message is written to the standard error stream
35331 (as well as to Exim's log), and Exim exits to the caller with a return code
35332 value 1. The message is expunged from Exim's spool files. No bounce messages
35333 are ever generated.
35334 .next
35335 No retry data is maintained, and any retry rules are ignored.
35336 .next
35337 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35338 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35339 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35340 .endlist
35341
35342 The overall effect is that Exim makes a single synchronous attempt to deliver
35343 the message, failing if there is any kind of problem. Because no local
35344 deliveries are done and no daemon can be run, Exim does not need root
35345 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35346 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35347 the advantages and disadvantages of running without root privilege.
35348
35349
35350
35351
35352 . ////////////////////////////////////////////////////////////////////////////
35353 . ////////////////////////////////////////////////////////////////////////////
35354
35355 .chapter "Log files" "CHAPlog"
35356 .scindex IIDloggen "log" "general description"
35357 .cindex "log" "types of"
35358 Exim writes three different logs, referred to as the main log, the reject log,
35359 and the panic log:
35360
35361 .ilist
35362 .cindex "main log"
35363 The main log records the arrival of each message and each delivery in a single
35364 line in each case. The format is as compact as possible, in an attempt to keep
35365 down the size of log files. Two-character flag sequences make it easy to pick
35366 out these lines. A number of other events are recorded in the main log. Some of
35367 them are optional, in which case the &%log_selector%& option controls whether
35368 they are included or not. A Perl script called &'eximstats'&, which does simple
35369 analysis of main log files, is provided in the Exim distribution (see section
35370 &<<SECTmailstat>>&).
35371 .next
35372 .cindex "reject log"
35373 The reject log records information from messages that are rejected as a result
35374 of a configuration option (that is, for policy reasons).
35375 The first line of each rejection is a copy of the line that is also written to
35376 the main log. Then, if the message's header has been read at the time the log
35377 is written, its contents are written to this log. Only the original header
35378 lines are available; header lines added by ACLs are not logged. You can use the
35379 reject log to check that your policy controls are working correctly; on a busy
35380 host this may be easier than scanning the main log for rejection messages. You
35381 can suppress the writing of the reject log by setting &%write_rejectlog%&
35382 false.
35383 .next
35384 .cindex "panic log"
35385 .cindex "system log"
35386 When certain serious errors occur, Exim writes entries to its panic log. If the
35387 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35388 are usually written to the main log as well, but can get lost amid the mass of
35389 other entries. The panic log should be empty under normal circumstances. It is
35390 therefore a good idea to check it (or to have a &'cron'& script check it)
35391 regularly, in order to become aware of any problems. When Exim cannot open its
35392 panic log, it tries as a last resort to write to the system log (syslog). This
35393 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35394 message itself is written at priority LOG_CRIT.
35395 .endlist
35396
35397 Every log line starts with a timestamp, in the format shown in the following
35398 example. Note that many of the examples shown in this chapter are line-wrapped.
35399 In the log file, this would be all on one line:
35400 .code
35401 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35402   by QUIT
35403 .endd
35404 By default, the timestamps are in the local timezone. There are two
35405 ways of changing this:
35406
35407 .ilist
35408 You can set the &%timezone%& option to a different time zone; in particular, if
35409 you set
35410 .code
35411 timezone = UTC
35412 .endd
35413 the timestamps will be in UTC (aka GMT).
35414 .next
35415 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35416 example:
35417 .code
35418 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35419 .endd
35420 .endlist
35421
35422 .cindex "log" "process ids in"
35423 .cindex "pid (process id)" "in log lines"
35424 Exim does not include its process id in log lines by default, but you can
35425 request that it does so by specifying the &`pid`& log selector (see section
35426 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35427 brackets, immediately after the time and date.
35428
35429
35430
35431
35432 .section "Where the logs are written" "SECTwhelogwri"
35433 .cindex "log" "destination"
35434 .cindex "log" "to file"
35435 .cindex "log" "to syslog"
35436 .cindex "syslog"
35437 The logs may be written to local files, or to syslog, or both. However, it
35438 should be noted that many syslog implementations use UDP as a transport, and
35439 are therefore unreliable in the sense that messages are not guaranteed to
35440 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35441 It has also been reported that on large log files (tens of megabytes) you may
35442 need to tweak syslog to prevent it syncing the file with each write &-- on
35443 Linux this has been seen to make syslog take 90% plus of CPU time.
35444
35445 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35446 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35447 configuration. This latter string is expanded, so it can contain, for example,
35448 references to the host name:
35449 .code
35450 log_file_path = /var/log/$primary_hostname/exim_%slog
35451 .endd
35452 It is generally advisable, however, to set the string in &_Local/Makefile_&
35453 rather than at run time, because then the setting is available right from the
35454 start of Exim's execution. Otherwise, if there's something it wants to log
35455 before it has read the configuration file (for example, an error in the
35456 configuration file) it will not use the path you want, and may not be able to
35457 log at all.
35458
35459 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35460 list, currently limited to at most two items. This is one option where the
35461 facility for changing a list separator may not be used. The list must always be
35462 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35463 otherwise the item must either be an absolute path, containing &`%s`& at the
35464 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35465 implying the use of a default path.
35466
35467 When Exim encounters an empty item in the list, it searches the list defined by
35468 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35469 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35470 mean &"use the path specified at build time"&. It no such item exists, log
35471 files are written in the &_log_& subdirectory of the spool directory. This is
35472 equivalent to the setting:
35473 .code
35474 log_file_path = $spool_directory/log/%slog
35475 .endd
35476 If you do not specify anything at build time or run time,
35477 or if you unset the option at run time (i.e. &`log_file_path = `&),
35478 that is where the logs are written.
35479
35480 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35481 are in use &-- see section &<<SECTdatlogfil>>& below.
35482
35483 Here are some examples of possible settings:
35484 .display
35485 &`LOG_FILE_PATH=syslog                    `& syslog only
35486 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35487 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35488 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35489 .endd
35490 If there are more than two paths in the list, the first is used and a panic
35491 error is logged.
35492
35493
35494
35495 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35496 .cindex "log" "cycling local files"
35497 .cindex "cycling logs"
35498 .cindex "&'exicyclog'&"
35499 .cindex "log" "local files; writing to"
35500 Some operating systems provide centralized and standardized methods for cycling
35501 log files. For those that do not, a utility script called &'exicyclog'& is
35502 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35503 main and reject logs each time it is called. The maximum number of old logs to
35504 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35505
35506 An Exim delivery process opens the main log when it first needs to write to it,
35507 and it keeps the file open in case subsequent entries are required &-- for
35508 example, if a number of different deliveries are being done for the same
35509 message. However, remote SMTP deliveries can take a long time, and this means
35510 that the file may be kept open long after it is renamed if &'exicyclog'& or
35511 something similar is being used to rename log files on a regular basis. To
35512 ensure that a switch of log files is noticed as soon as possible, Exim calls
35513 &[stat()]& on the main log's name before reusing an open file, and if the file
35514 does not exist, or its inode has changed, the old file is closed and Exim
35515 tries to open the main log from scratch. Thus, an old log file may remain open
35516 for quite some time, but no Exim processes should write to it once it has been
35517 renamed.
35518
35519
35520
35521 .section "Datestamped log files" "SECTdatlogfil"
35522 .cindex "log" "datestamped files"
35523 Instead of cycling the main and reject log files by renaming them
35524 periodically, some sites like to use files whose names contain a datestamp,
35525 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35526 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35527 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35528 point where the datestamp is required. For example:
35529 .code
35530 log_file_path = /var/spool/exim/log/%slog-%D
35531 log_file_path = /var/log/exim-%s-%D.log
35532 log_file_path = /var/spool/exim/log/%D-%slog
35533 log_file_path = /var/log/exim/%s.%M
35534 .endd
35535 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35536 examples of names generated by the above examples:
35537 .code
35538 /var/spool/exim/log/mainlog-20021225
35539 /var/log/exim-reject-20021225.log
35540 /var/spool/exim/log/20021225-mainlog
35541 /var/log/exim/main.200212
35542 .endd
35543 When this form of log file is specified, Exim automatically switches to new
35544 files at midnight. It does not make any attempt to compress old logs; you
35545 will need to write your own script if you require this. You should not
35546 run &'exicyclog'& with this form of logging.
35547
35548 The location of the panic log is also determined by &%log_file_path%&, but it
35549 is not datestamped, because rotation of the panic log does not make sense.
35550 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35551 the string. In addition, if it immediately follows a slash, a following
35552 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35553 character is removed. Thus, the four examples above would give these panic
35554 log names:
35555 .code
35556 /var/spool/exim/log/paniclog
35557 /var/log/exim-panic.log
35558 /var/spool/exim/log/paniclog
35559 /var/log/exim/panic
35560 .endd
35561
35562
35563 .section "Logging to syslog" "SECID249"
35564 .cindex "log" "syslog; writing to"
35565 The use of syslog does not change what Exim logs or the format of its messages,
35566 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35567 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35568 that, the same strings are written to syslog as to log files. The syslog
35569 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35570 by default, but you can change these by setting the &%syslog_facility%& and
35571 &%syslog_processname%& options, respectively. If Exim was compiled with
35572 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35573 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35574 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35575 the time and host name to each line.
35576 The three log streams are mapped onto syslog priorities as follows:
35577
35578 .ilist
35579 &'mainlog'& is mapped to LOG_INFO
35580 .next
35581 &'rejectlog'& is mapped to LOG_NOTICE
35582 .next
35583 &'paniclog'& is mapped to LOG_ALERT
35584 .endlist
35585
35586 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35587 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35588 these are routed by syslog to the same place. You can suppress this duplication
35589 by setting &%syslog_duplication%& false.
35590
35591 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35592 entries contain multiple lines when headers are included. To cope with both
35593 these cases, entries written to syslog are split into separate &[syslog()]&
35594 calls at each internal newline, and also after a maximum of
35595 870 data characters. (This allows for a total syslog line length of 1024, when
35596 additions such as timestamps are added.) If you are running a syslog
35597 replacement that can handle lines longer than the 1024 characters allowed by
35598 RFC 3164, you should set
35599 .code
35600 SYSLOG_LONG_LINES=yes
35601 .endd
35602 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35603 lines, but it still splits at internal newlines in &'reject'& log entries.
35604
35605 To make it easy to re-assemble split lines later, each component of a split
35606 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35607 where <&'n'&> is the component number and <&'m'&> is the total number of
35608 components in the entry. The / delimiter is used when the line was split
35609 because it was too long; if it was split because of an internal newline, the \
35610 delimiter is used. For example, supposing the length limit to be 50 instead of
35611 870, the following would be the result of a typical rejection message to
35612 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35613 name, and pid as added by syslog:
35614 .code
35615 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35616 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35617 [3/5]  when scanning for sender: missing or malformed lo
35618 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35619 [5/5] mple>)
35620 .endd
35621 The same error might cause the following lines to be written to &"rejectlog"&
35622 (LOG_NOTICE):
35623 .code
35624 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35625 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35626 [3/18] er when scanning for sender: missing or malformed
35627 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35628 [5\18] .example>)
35629 [6\18] Recipients: ph10@some.domain.cam.example
35630 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35631 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35632 [9\18]        id 16RdAL-0006pc-00
35633 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35634 [11\18] 09:43 +0100
35635 [12\18] F From: <>
35636 [13\18]   Subject: this is a test header
35637 [18\18]   X-something: this is another header
35638 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35639 [16\18] le>
35640 [17\18] B Bcc:
35641 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35642 .endd
35643 Log lines that are neither too long nor contain newlines are written to syslog
35644 without modification.
35645
35646 If only syslog is being used, the Exim monitor is unable to provide a log tail
35647 display, unless syslog is routing &'mainlog'& to a file on the local host and
35648 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35649 where it is.
35650
35651
35652
35653 .section "Log line flags" "SECID250"
35654 One line is written to the main log for each message received, and for each
35655 successful, unsuccessful, and delayed delivery. These lines can readily be
35656 picked out by the distinctive two-character flags that immediately follow the
35657 timestamp. The flags are:
35658 .display
35659 &`<=`&     message arrival
35660 &`(=`&     message fakereject
35661 &`=>`&     normal message delivery
35662 &`->`&     additional address in same delivery
35663 &`>>`&     cutthrough message delivery
35664 &`*>`&     delivery suppressed by &%-N%&
35665 &`**`&     delivery failed; address bounced
35666 &`==`&     delivery deferred; temporary problem
35667 .endd
35668
35669
35670 .section "Logging message reception" "SECID251"
35671 .cindex "log" "reception line"
35672 The format of the single-line entry in the main log that is written for every
35673 message received is shown in the basic example below, which is split over
35674 several lines in order to fit it on the page:
35675 .code
35676 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35677   H=mailer.fict.example [192.168.123.123] U=exim
35678   P=smtp S=5678 id=<incoming message id>
35679 .endd
35680 The address immediately following &"<="& is the envelope sender address. A
35681 bounce message is shown with the sender address &"<>"&, and if it is locally
35682 generated, this is followed by an item of the form
35683 .code
35684 R=<message id>
35685 .endd
35686 which is a reference to the message that caused the bounce to be sent.
35687
35688 .cindex "HELO"
35689 .cindex "EHLO"
35690 For messages from other hosts, the H and U fields identify the remote host and
35691 record the RFC 1413 identity of the user that sent the message, if one was
35692 received. The number given in square brackets is the IP address of the sending
35693 host. If there is a single, unparenthesized  host name in the H field, as
35694 above, it has been verified to correspond to the IP address (see the
35695 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35696 by the remote host in the SMTP HELO or EHLO command, and has not been
35697 verified. If verification yields a different name to that given for HELO or
35698 EHLO, the verified name appears first, followed by the HELO or EHLO
35699 name in parentheses.
35700
35701 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35702 without brackets, in the HELO or EHLO command, leading to entries in
35703 the log containing text like these examples:
35704 .code
35705 H=(10.21.32.43) [192.168.8.34]
35706 H=([10.21.32.43]) [192.168.8.34]
35707 .endd
35708 This can be confusing. Only the final address in square brackets can be relied
35709 on.
35710
35711 For locally generated messages (that is, messages not received over TCP/IP),
35712 the H field is omitted, and the U field contains the login name of the caller
35713 of Exim.
35714
35715 .cindex "authentication" "logging"
35716 .cindex "AUTH" "logging"
35717 For all messages, the P field specifies the protocol used to receive the
35718 message. This is the value that is stored in &$received_protocol$&. In the case
35719 of incoming SMTP messages, the value indicates whether or not any SMTP
35720 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35721 session was encrypted, there is an additional X field that records the cipher
35722 suite that was used.
35723
35724 .cindex log protocol
35725 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35726 hosts that have authenticated themselves using the SMTP AUTH command. The first
35727 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35728 there is an additional item A= followed by the name of the authenticator that
35729 was used. If an authenticated identification was set up by the authenticator's
35730 &%server_set_id%& option, this is logged too, separated by a colon from the
35731 authenticator name.
35732
35733 .cindex "size" "of message"
35734 The id field records the existing message id, if present. The size of the
35735 received message is given by the S field. When the message is delivered,
35736 headers may be removed or added, so that the size of delivered copies of the
35737 message may not correspond with this value (and indeed may be different to each
35738 other).
35739
35740 The &%log_selector%& option can be used to request the logging of additional
35741 data when a message is received. See section &<<SECTlogselector>>& below.
35742
35743
35744
35745 .section "Logging deliveries" "SECID252"
35746 .cindex "log" "delivery line"
35747 The format of the single-line entry in the main log that is written for every
35748 delivery is shown in one of the examples below, for local and remote
35749 deliveries, respectively. Each example has been split into multiple lines in order
35750 to fit it on the page:
35751 .code
35752 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35753   <marv@hitch.fict.example> R=localuser T=local_delivery
35754 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35755   monk@holistic.fict.example R=dnslookup T=remote_smtp
35756   H=holistic.fict.example [192.168.234.234]
35757 .endd
35758 For ordinary local deliveries, the original address is given in angle brackets
35759 after the final delivery address, which might be a pipe or a file. If
35760 intermediate address(es) exist between the original and the final address, the
35761 last of these is given in parentheses after the final address. The R and T
35762 fields record the router and transport that were used to process the address.
35763
35764 If SMTP AUTH was used for the delivery there is an additional item A=
35765 followed by the name of the authenticator that was used.
35766 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35767 option, this is logged too, separated by a colon from the authenticator name.
35768
35769 If a shadow transport was run after a successful local delivery, the log line
35770 for the successful delivery has an item added on the end, of the form
35771 .display
35772 &`ST=<`&&'shadow transport name'&&`>`&
35773 .endd
35774 If the shadow transport did not succeed, the error message is put in
35775 parentheses afterwards.
35776
35777 .cindex "asterisk" "after IP address"
35778 When more than one address is included in a single delivery (for example, two
35779 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35780 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35781 down a single SMTP connection, an asterisk follows the IP address in the log
35782 lines for the second and subsequent messages.
35783
35784 .cindex "delivery" "cutthrough; logging"
35785 .cindex "cutthrough" "logging"
35786 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35787 line precedes the reception line, since cutthrough waits for a possible
35788 rejection from the destination in case it can reject the sourced item.
35789
35790 The generation of a reply message by a filter file gets logged as a
35791 &"delivery"& to the addressee, preceded by &">"&.
35792
35793 The &%log_selector%& option can be used to request the logging of additional
35794 data when a message is delivered. See section &<<SECTlogselector>>& below.
35795
35796
35797 .section "Discarded deliveries" "SECID253"
35798 .cindex "discarded messages"
35799 .cindex "message" "discarded"
35800 .cindex "delivery" "discarded; logging"
35801 When a message is discarded as a result of the command &"seen finish"& being
35802 obeyed in a filter file which generates no deliveries, a log entry of the form
35803 .code
35804 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35805   <low.club@bridge.example> R=userforward
35806 .endd
35807 is written, to record why no deliveries are logged. When a message is discarded
35808 because it is aliased to &":blackhole:"& the log line is like this:
35809 .code
35810 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35811   <hole@nowhere.example> R=blackhole_router
35812 .endd
35813
35814
35815 .section "Deferred deliveries" "SECID254"
35816 When a delivery is deferred, a line of the following form is logged:
35817 .code
35818 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35819   R=dnslookup T=smtp defer (146): Connection refused
35820 .endd
35821 In the case of remote deliveries, the error is the one that was given for the
35822 last IP address that was tried. Details of individual SMTP failures are also
35823 written to the log, so the above line would be preceded by something like
35824 .code
35825 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35826   mail1.endrest.example [192.168.239.239]: Connection refused
35827 .endd
35828 When a deferred address is skipped because its retry time has not been reached,
35829 a message is written to the log, but this can be suppressed by setting an
35830 appropriate value in &%log_selector%&.
35831
35832
35833
35834 .section "Delivery failures" "SECID255"
35835 .cindex "delivery" "failure; logging"
35836 If a delivery fails because an address cannot be routed, a line of the
35837 following form is logged:
35838 .code
35839 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35840   <jim@trek99.example>: unknown mail domain
35841 .endd
35842 If a delivery fails at transport time, the router and transport are shown, and
35843 the response from the remote host is included, as in this example:
35844 .code
35845 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35846   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35847   after pipelined RCPT TO:<ace400@pb.example>: host
35848   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35849   <ace400@pb.example>...Addressee unknown
35850 .endd
35851 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35852 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35853 disabling PIPELINING. The log lines for all forms of delivery failure are
35854 flagged with &`**`&.
35855
35856
35857
35858 .section "Fake deliveries" "SECID256"
35859 .cindex "delivery" "fake; logging"
35860 If a delivery does not actually take place because the &%-N%& option has been
35861 used to suppress it, a normal delivery line is written to the log, except that
35862 &"=>"& is replaced by &"*>"&.
35863
35864
35865
35866 .section "Completion" "SECID257"
35867 A line of the form
35868 .code
35869 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35870 .endd
35871 is written to the main log when a message is about to be removed from the spool
35872 at the end of its processing.
35873
35874
35875
35876
35877 .section "Summary of Fields in Log Lines" "SECID258"
35878 .cindex "log" "summary of fields"
35879 A summary of the field identifiers that are used in log lines is shown in
35880 the following table:
35881 .display
35882 &`A   `&        authenticator name (and optional id and sender)
35883 &`C   `&        SMTP confirmation on delivery
35884 &`    `&        command list for &"no mail in SMTP session"&
35885 &`CV  `&        certificate verification status
35886 &`D   `&        duration of &"no mail in SMTP session"&
35887 &`DN  `&        distinguished name from peer certificate
35888 &`DS  `&        DNSSEC secured lookups
35889 &`DT  `&        on &`=>`& lines: time taken for a delivery
35890 &`F   `&        sender address (on delivery lines)
35891 &`H   `&        host name and IP address
35892 &`I   `&        local interface used
35893 &`K   `&        CHUNKING extension used
35894 &`id  `&        message id for incoming message
35895 &`P   `&        on &`<=`& lines: protocol used
35896 &`    `&        on &`=>`& and &`**`& lines: return path
35897 &`PRDR`&        PRDR extension used
35898 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
35899 &`Q   `&        alternate queue name
35900 &`QT  `&        on &`=>`& lines: time spent on queue so far
35901 &`    `&        on &"Completed"& lines: time spent on queue
35902 &`R   `&        on &`<=`& lines: reference for local bounce
35903 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35904 &`S   `&        size of message in bytes
35905 &`SNI `&        server name indication from TLS client hello
35906 &`ST  `&        shadow transport name
35907 &`T   `&        on &`<=`& lines: message subject (topic)
35908 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35909 &`U   `&        local user or RFC 1413 identity
35910 &`X   `&        TLS cipher suite
35911 .endd
35912
35913
35914 .section "Other log entries" "SECID259"
35915 Various other types of log entry are written from time to time. Most should be
35916 self-explanatory. Among the more common are:
35917
35918 .ilist
35919 .cindex "retry" "time not reached"
35920 &'retry time not reached'&&~&~An address previously suffered a temporary error
35921 during routing or local delivery, and the time to retry has not yet arrived.
35922 This message is not written to an individual message log file unless it happens
35923 during the first delivery attempt.
35924 .next
35925 &'retry time not reached for any host'&&~&~An address previously suffered
35926 temporary errors during remote delivery, and the retry time has not yet arrived
35927 for any of the hosts to which it is routed.
35928 .next
35929 .cindex "spool directory" "file locked"
35930 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35931 some other Exim process is already working on the message. This can be quite
35932 common if queue running processes are started at frequent intervals. The
35933 &'exiwhat'& utility script can be used to find out what Exim processes are
35934 doing.
35935 .next
35936 .cindex "error" "ignored"
35937 &'error ignored'&&~&~There are several circumstances that give rise to this
35938 message:
35939 .olist
35940 Exim failed to deliver a bounce message whose age was greater than
35941 &%ignore_bounce_errors_after%&. The bounce was discarded.
35942 .next
35943 A filter file set up a delivery using the &"noerror"& option, and the delivery
35944 failed. The delivery was discarded.
35945 .next
35946 A delivery set up by a router configured with
35947 . ==== As this is a nested list, any displays it contains must be indented
35948 . ==== as otherwise they are too far to the left.
35949 .code
35950     errors_to = <>
35951 .endd
35952 failed. The delivery was discarded.
35953 .endlist olist
35954 .endlist ilist
35955
35956
35957
35958
35959
35960 .section "Reducing or increasing what is logged" "SECTlogselector"
35961 .cindex "log" "selectors"
35962 By setting the &%log_selector%& global option, you can disable some of Exim's
35963 default logging, or you can request additional logging. The value of
35964 &%log_selector%& is made up of names preceded by plus or minus characters. For
35965 example:
35966 .code
35967 log_selector = +arguments -retry_defer
35968 .endd
35969 The list of optional log items is in the following table, with the default
35970 selection marked by asterisks:
35971 .display
35972 &` 8bitmime                   `&  received 8BITMIME status
35973 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35974 &` address_rewrite            `&  address rewriting
35975 &` all_parents                `&  all parents in => lines
35976 &` arguments                  `&  command line arguments
35977 &`*connection_reject          `&  connection rejections
35978 &`*delay_delivery             `&  immediate delivery delayed
35979 &` deliver_time               `&  time taken to perform delivery
35980 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35981 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35982 &` dnssec                     `&  DNSSEC secured lookups
35983 &`*etrn                       `&  ETRN commands
35984 &`*host_lookup_failed         `&  as it says
35985 &` ident_timeout              `&  timeout for ident connection
35986 &` incoming_interface         `&  local interface on <= and => lines
35987 &` incoming_port              `&  remote port on <= lines
35988 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35989 &` outgoing_interface         `&  local interface on => lines
35990 &` outgoing_port              `&  add remote port to => lines
35991 &`*queue_run                  `&  start and end queue runs
35992 &` queue_time                 `&  time on queue for one recipient
35993 &` queue_time_overall         `&  time on queue for whole message
35994 &` pid                        `&  Exim process id
35995 &` proxy                      `&  proxy address on <= and => lines
35996 &` received_recipients        `&  recipients on <= lines
35997 &` received_sender            `&  sender on <= lines
35998 &`*rejected_header            `&  header contents on reject log
35999 &`*retry_defer                `&  &"retry time not reached"&
36000 &` return_path_on_delivery    `&  put return path on => and ** lines
36001 &` sender_on_delivery         `&  add sender to => lines
36002 &`*sender_verify_fail         `&  sender verification failures
36003 &`*size_reject                `&  rejection because too big
36004 &`*skip_delivery              `&  delivery skipped in a queue run
36005 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36006 &` smtp_connection            `&  incoming SMTP connections
36007 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36008 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36009 &` smtp_no_mail               `&  session with no MAIL commands
36010 &` smtp_protocol_error        `&  SMTP protocol errors
36011 &` smtp_syntax_error          `&  SMTP syntax errors
36012 &` subject                    `&  contents of &'Subject:'& on <= lines
36013 &`*tls_certificate_verified   `&  certificate verification status
36014 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36015 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36016 &` tls_sni                    `&  TLS SNI on <= lines
36017 &` unknown_in_list            `&  DNS lookup failed in list match
36018
36019 &` all                        `&  all of the above
36020 .endd
36021 See also the &%slow_lookup_log%& main configuration option,
36022 section &<<SECID99>>&
36023
36024 More details on each of these items follows:
36025
36026 .ilist
36027 .cindex "8BITMIME"
36028 .cindex "log" "8BITMIME"
36029 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36030 which may help in tracking down interoperability issues with ancient MTAs
36031 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36032 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36033 &`7BIT`& and &`8BITMIME`& respectively.
36034 .next
36035 .cindex "&%warn%& ACL verb" "log when skipping"
36036 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36037 its conditions cannot be evaluated, a log line to this effect is written if
36038 this log selector is set.
36039 .next
36040 .cindex "log" "rewriting"
36041 .cindex "rewriting" "logging"
36042 &%address_rewrite%&: This applies both to global rewrites and per-transport
36043 rewrites, but not to rewrites in filters run as an unprivileged user (because
36044 such users cannot access the log).
36045 .next
36046 .cindex "log" "full parentage"
36047 &%all_parents%&: Normally only the original and final addresses are logged on
36048 delivery lines; with this selector, intermediate parents are given in
36049 parentheses between them.
36050 .next
36051 .cindex "log" "Exim arguments"
36052 .cindex "Exim arguments, logging"
36053 &%arguments%&: This causes Exim to write the arguments with which it was called
36054 to the main log, preceded by the current working directory. This is a debugging
36055 feature, added to make it easier to find out how certain MUAs call
36056 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36057 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36058 that are empty or that contain white space are quoted. Non-printing characters
36059 are shown as escape sequences. This facility cannot log unrecognized arguments,
36060 because the arguments are checked before the configuration file is read. The
36061 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36062 between the caller and Exim.
36063 .next
36064 .cindex "log" "connection rejections"
36065 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36066 connection is rejected, for whatever reason.
36067 .next
36068 .cindex "log" "delayed delivery"
36069 .cindex "delayed delivery, logging"
36070 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36071 started for an incoming message because the load is too high or too many
36072 messages were received on one connection. Logging does not occur if no delivery
36073 process is started because &%queue_only%& is set or &%-odq%& was used.
36074 .next
36075 .cindex "log" "delivery duration"
36076 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36077 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36078 .next
36079 .cindex "log" "message size on delivery"
36080 .cindex "size" "of message"
36081 &%delivery_size%&: For each delivery, the size of message delivered is added to
36082 the &"=>"& line, tagged with S=.
36083 .next
36084 .cindex "log" "dnslist defer"
36085 .cindex "DNS list" "logging defer"
36086 .cindex "black list (DNS)"
36087 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36088 DNS black list suffers a temporary error.
36089 .next
36090 .cindex log dnssec
36091 .cindex dnssec logging
36092 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36093 dns lookups gave secure results a tag of DS is added.
36094 For acceptance this covers the reverse and forward lookups for host name verification.
36095 It does not cover helo-name verification.
36096 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36097 .next
36098 .cindex "log" "ETRN commands"
36099 .cindex "ETRN" "logging"
36100 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36101 is run to determine whether or not it is actually accepted. An invalid ETRN
36102 command, or one received within a message transaction is not logged by this
36103 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36104 .next
36105 .cindex "log" "host lookup failure"
36106 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36107 any addresses, or when a lookup of an IP address fails to find a host name, a
36108 log line is written. This logging does not apply to direct DNS lookups when
36109 routing email addresses, but it does apply to &"byname"& lookups.
36110 .next
36111 .cindex "log" "ident timeout"
36112 .cindex "RFC 1413" "logging timeout"
36113 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36114 client's ident port times out.
36115 .next
36116 .cindex "log" "incoming interface"
36117 .cindex "log" "local interface"
36118 .cindex "log" "local address and port"
36119 .cindex "TCP/IP" "logging local address and port"
36120 .cindex "interface" "logging"
36121 &%incoming_interface%&: The interface on which a message was received is added
36122 to the &"<="& line as an IP address in square brackets, tagged by I= and
36123 followed by a colon and the port number. The local interface and port are also
36124 added to other SMTP log lines, for example &"SMTP connection from"&, to
36125 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36126 The latter can be disabled by turning off the &%outgoing_interface%& option.
36127 .next
36128 .cindex log "incoming proxy address"
36129 .cindex proxy "logging proxy address"
36130 .cindex "TCP/IP" "logging proxy address"
36131 &%proxy%&: The internal (closest to the system running Exim) IP address
36132 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36133 on a proxied connection
36134 or the &"=>"& line for a message delivered on a proxied connection..
36135 See &<<SECTproxyInbound>>& for more information.
36136 .next
36137 .cindex "log" "incoming remote port"
36138 .cindex "port" "logging remote"
36139 .cindex "TCP/IP" "logging incoming remote port"
36140 .vindex "&$sender_fullhost$&"
36141 .vindex "&$sender_rcvhost$&"
36142 &%incoming_port%&: The remote port number from which a message was received is
36143 added to log entries and &'Received:'& header lines, following the IP address
36144 in square brackets, and separated from it by a colon. This is implemented by
36145 changing the value that is put in the &$sender_fullhost$& and
36146 &$sender_rcvhost$& variables. Recording the remote port number has become more
36147 important with the widening use of NAT (see RFC 2505).
36148 .next
36149 .cindex "log" "dropped connection"
36150 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36151 connection is unexpectedly dropped.
36152 .next
36153 .cindex "log" "outgoing interface"
36154 .cindex "log" "local interface"
36155 .cindex "log" "local address and port"
36156 .cindex "TCP/IP" "logging local address and port"
36157 .cindex "interface" "logging"
36158 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36159 interface on which a message was sent is added to delivery lines as an I= tag
36160 followed by IP address in square brackets. You can disable this by turning
36161 off the &%outgoing_interface%& option.
36162 .next
36163 .cindex "log" "outgoing remote port"
36164 .cindex "port" "logging outgoint remote"
36165 .cindex "TCP/IP" "logging outgoing remote port"
36166 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36167 containing => tags) following the IP address.
36168 The local port is also added if &%incoming_interface%& and
36169 &%outgoing_interface%& are both enabled.
36170 This option is not included in the default setting, because for most ordinary
36171 configurations, the remote port number is always 25 (the SMTP port), and the
36172 local port is a random ephemeral port.
36173 .next
36174 .cindex "log" "process ids in"
36175 .cindex "pid (process id)" "in log lines"
36176 &%pid%&: The current process id is added to every log line, in square brackets,
36177 immediately after the time and date.
36178 .next
36179 .cindex "log" "queue run"
36180 .cindex "queue runner" "logging"
36181 &%queue_run%&: The start and end of every queue run are logged.
36182 .next
36183 .cindex "log" "queue time"
36184 &%queue_time%&: The amount of time the message has been in the queue on the
36185 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36186 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36187 includes reception time as well as the delivery time for the current address.
36188 This means that it may be longer than the difference between the arrival and
36189 delivery log line times, because the arrival log line is not written until the
36190 message has been successfully received.
36191 .next
36192 &%queue_time_overall%&: The amount of time the message has been in the queue on
36193 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36194 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36195 message, so it includes reception time as well as the total delivery time.
36196 .next
36197 .cindex "log" "recipients"
36198 &%received_recipients%&: The recipients of a message are listed in the main log
36199 as soon as the message is received. The list appears at the end of the log line
36200 that is written when a message is received, preceded by the word &"for"&. The
36201 addresses are listed after they have been qualified, but before any rewriting
36202 has taken place.
36203 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36204 in the list.
36205 .next
36206 .cindex "log" "sender reception"
36207 &%received_sender%&: The unrewritten original sender of a message is added to
36208 the end of the log line that records the message's arrival, after the word
36209 &"from"& (before the recipients if &%received_recipients%& is also set).
36210 .next
36211 .cindex "log" "header lines for rejection"
36212 &%rejected_header%&: If a message's header has been received at the time a
36213 rejection is written to the reject log, the complete header is added to the
36214 log. Header logging can be turned off individually for messages that are
36215 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36216 .next
36217 .cindex "log" "retry defer"
36218 &%retry_defer%&: A log line is written if a delivery is deferred because a
36219 retry time has not yet been reached. However, this &"retry time not reached"&
36220 message is always omitted from individual message logs after the first delivery
36221 attempt.
36222 .next
36223 .cindex "log" "return path"
36224 &%return_path_on_delivery%&: The return path that is being transmitted with
36225 the message is included in delivery and bounce lines, using the tag P=.
36226 This is omitted if no delivery actually happens, for example, if routing fails,
36227 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36228 .next
36229 .cindex "log" "sender on delivery"
36230 &%sender_on_delivery%&: The message's sender address is added to every delivery
36231 and bounce line, tagged by F= (for &"from"&).
36232 This is the original sender that was received with the message; it is not
36233 necessarily the same as the outgoing return path.
36234 .next
36235 .cindex "log" "sender verify failure"
36236 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36237 gives details of a sender verification failure is not written. Log lines for
36238 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36239 detail is lost.
36240 .next
36241 .cindex "log" "size rejection"
36242 &%size_reject%&: A log line is written whenever a message is rejected because
36243 it is too big.
36244 .next
36245 .cindex "log" "frozen messages; skipped"
36246 .cindex "frozen messages" "logging skipping"
36247 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36248 queue run because it is frozen or because another process is already delivering
36249 it.
36250 .cindex "&""spool file is locked""&"
36251 The message that is written is &"spool file is locked"&.
36252 .next
36253 .cindex "log" "smtp confirmation"
36254 .cindex "SMTP" "logging confirmation"
36255 .cindex "LMTP" "logging confirmation"
36256 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36257 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36258 A number of MTAs (including Exim) return an identifying string in this
36259 response.
36260 .next
36261 .cindex "log" "SMTP connections"
36262 .cindex "SMTP" "logging connections"
36263 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36264 established or closed, unless the connection is from a host that matches
36265 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36266 only when the closure is unexpected.) This applies to connections from local
36267 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36268 dropped in the middle of a message, a log line is always written, whether or
36269 not this selector is set, but otherwise nothing is written at the start and end
36270 of connections unless this selector is enabled.
36271
36272 For TCP/IP connections to an Exim daemon, the current number of connections is
36273 included in the log message for each new connection, but note that the count is
36274 reset if the daemon is restarted.
36275 Also, because connections are closed (and the closure is logged) in
36276 subprocesses, the count may not include connections that have been closed but
36277 whose termination the daemon has not yet noticed. Thus, while it is possible to
36278 match up the opening and closing of connections in the log, the value of the
36279 logged counts may not be entirely accurate.
36280 .next
36281 .cindex "log" "SMTP transaction; incomplete"
36282 .cindex "SMTP" "logging incomplete transactions"
36283 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36284 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36285 and the message sender plus any accepted recipients are included in the log
36286 line. This can provide evidence of dictionary attacks.
36287 .next
36288 .cindex "log" "non-MAIL SMTP sessions"
36289 .cindex "MAIL" "logging session without"
36290 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36291 connection terminates without having issued a MAIL command. This includes both
36292 the case when the connection is dropped, and the case when QUIT is used. It
36293 does not include cases where the connection is rejected right at the start (by
36294 an ACL, or because there are too many connections, or whatever). These cases
36295 already have their own log lines.
36296
36297 The log line that is written contains the identity of the client in the usual
36298 way, followed by D= and a time, which records the duration of the connection.
36299 If the connection was authenticated, this fact is logged exactly as it is for
36300 an incoming message, with an A= item. If the connection was encrypted, CV=,
36301 DN=, and X= items may appear as they do for an incoming message, controlled by
36302 the same logging options.
36303
36304 Finally, if any SMTP commands were issued during the connection, a C= item
36305 is added to the line, listing the commands that were used. For example,
36306 .code
36307 C=EHLO,QUIT
36308 .endd
36309 shows that the client issued QUIT straight after EHLO. If there were fewer
36310 than 20 commands, they are all listed. If there were more than 20 commands,
36311 the last 20 are listed, preceded by &"..."&. However, with the default
36312 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36313 have been aborted before 20 non-mail commands are processed.
36314 .next
36315 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36316 colon-separated, is appended to the A= item for a message arrival or delivery
36317 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36318 was accepted or used.
36319 .next
36320 .cindex "log" "SMTP protocol error"
36321 .cindex "SMTP" "logging protocol error"
36322 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36323 encountered. Exim does not have perfect detection of all protocol errors
36324 because of transmission delays and the use of pipelining. If PIPELINING has
36325 been advertised to a client, an Exim server assumes that the client will use
36326 it, and therefore it does not count &"expected"& errors (for example, RCPT
36327 received after rejecting MAIL) as protocol errors.
36328 .next
36329 .cindex "SMTP" "logging syntax errors"
36330 .cindex "SMTP" "syntax errors; logging"
36331 .cindex "SMTP" "unknown command; logging"
36332 .cindex "log" "unknown SMTP command"
36333 .cindex "log" "SMTP syntax error"
36334 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36335 encountered. An unrecognized command is treated as a syntax error. For an
36336 external connection, the host identity is given; for an internal connection
36337 using &%-bs%& the sender identification (normally the calling user) is given.
36338 .next
36339 .cindex "log" "subject"
36340 .cindex "subject, logging"
36341 &%subject%&: The subject of the message is added to the arrival log line,
36342 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36343 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36344 specifies whether characters with values greater than 127 should be logged
36345 unchanged, or whether they should be rendered as escape sequences.
36346 .next
36347 .cindex "log" "certificate verification"
36348 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36349 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36350 verified, and &`CV=no`& if not.
36351 .next
36352 .cindex "log" "TLS cipher"
36353 .cindex "TLS" "logging cipher"
36354 &%tls_cipher%&: When a message is sent or received over an encrypted
36355 connection, the cipher suite used is added to the log line, preceded by X=.
36356 .next
36357 .cindex "log" "TLS peer DN"
36358 .cindex "TLS" "logging peer DN"
36359 &%tls_peerdn%&: When a message is sent or received over an encrypted
36360 connection, and a certificate is supplied by the remote host, the peer DN is
36361 added to the log line, preceded by DN=.
36362 .next
36363 .cindex "log" "TLS SNI"
36364 .cindex "TLS" "logging SNI"
36365 &%tls_sni%&: When a message is received over an encrypted connection, and
36366 the remote host provided the Server Name Indication extension, the SNI is
36367 added to the log line, preceded by SNI=.
36368 .next
36369 .cindex "log" "DNS failure in list"
36370 &%unknown_in_list%&: This setting causes a log entry to be written when the
36371 result of a list match is failure because a DNS lookup failed.
36372 .endlist
36373
36374
36375 .section "Message log" "SECID260"
36376 .cindex "message" "log file for"
36377 .cindex "log" "message log; description of"
36378 .cindex "&_msglog_& directory"
36379 .oindex "&%preserve_message_logs%&"
36380 In addition to the general log files, Exim writes a log file for each message
36381 that it handles. The names of these per-message logs are the message ids, and
36382 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36383 message log contains copies of the log lines that apply to the message. This
36384 makes it easier to inspect the status of an individual message without having
36385 to search the main log. A message log is deleted when processing of the message
36386 is complete, unless &%preserve_message_logs%& is set, but this should be used
36387 only with great care because they can fill up your disk very quickly.
36388
36389 On a heavily loaded system, it may be desirable to disable the use of
36390 per-message logs, in order to reduce disk I/O. This can be done by setting the
36391 &%message_logs%& option false.
36392 .ecindex IIDloggen
36393
36394
36395
36396
36397 . ////////////////////////////////////////////////////////////////////////////
36398 . ////////////////////////////////////////////////////////////////////////////
36399
36400 .chapter "Exim utilities" "CHAPutils"
36401 .scindex IIDutils "utilities"
36402 A number of utility scripts and programs are supplied with Exim and are
36403 described in this chapter. There is also the Exim Monitor, which is covered in
36404 the next chapter. The utilities described here are:
36405
36406 .itable none 0 0 3  7* left  15* left  40* left
36407 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36408   "list what Exim processes are doing"
36409 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36410 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36411 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36412 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36413                                                 various criteria"
36414 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36415 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36416   "extract statistics from the log"
36417 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36418   "check address acceptance from given IP"
36419 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36420 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36421 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36422 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36423 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36424 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36425 .endtable
36426
36427 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36428 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36429 &url(http://duncanthrax.net/exilog/) for details.
36430
36431
36432
36433
36434 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36435 .cindex "&'exiwhat'&"
36436 .cindex "process, querying"
36437 .cindex "SIGUSR1"
36438 On operating systems that can restart a system call after receiving a signal
36439 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36440 a line describing what it is doing to the file &_exim-process.info_& in the
36441 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36442 processes it can find, having first emptied the file. It then waits for one
36443 second to allow the Exim processes to react before displaying the results. In
36444 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36445 send the signal to the Exim processes, so it is normally run as root.
36446
36447 &*Warning*&: This is not an efficient process. It is intended for occasional
36448 use by system administrators. It is not sensible, for example, to set up a
36449 script that sends SIGUSR1 signals to Exim processes at short intervals.
36450
36451
36452 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36453 varies in different operating systems. Not only are different options used,
36454 but the format of the output is different. For this reason, there are some
36455 system configuration options that configure exactly how &'exiwhat'& works. If
36456 it doesn't seem to be working for you, check the following compile-time
36457 options:
36458 .display
36459 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36460 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36461 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36462 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36463 .endd
36464 An example of typical output from &'exiwhat'& is
36465 .code
36466 164 daemon: -q1h, listening on port 25
36467 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36468 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36469   [10.19.42.42] (editor@ref.example)
36470 10592 handling incoming call from [192.168.243.242]
36471 10628 accepting a local non-SMTP message
36472 .endd
36473 The first number in the output line is the process number. The third line has
36474 been split here, in order to fit it on the page.
36475
36476
36477
36478 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36479 .cindex "&'exiqgrep'&"
36480 .cindex "queue" "grepping"
36481 This utility is a Perl script contributed by Matt Hubbard. It runs
36482 .code
36483 exim -bpu
36484 .endd
36485 or (in case &*-a*& switch is specified)
36486 .code
36487 exim -bp
36488 .endd
36489 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36490 contain alternate exim configuration the queue management might be using.
36491
36492 to obtain a queue listing, and then greps the output to select messages
36493 that match given criteria. The following selection options are available:
36494
36495 .vlist
36496 .vitem &*-f*&&~<&'regex'&>
36497 Match the sender address using a case-insensitive search. The field that is
36498 tested is enclosed in angle brackets, so you can test for bounce messages with
36499 .code
36500 exiqgrep -f '^<>$'
36501 .endd
36502 .vitem &*-r*&&~<&'regex'&>
36503 Match a recipient address using a case-insensitive search. The field that is
36504 tested is not enclosed in angle brackets.
36505
36506 .vitem &*-s*&&~<&'regex'&>
36507 Match against the size field.
36508
36509 .vitem &*-y*&&~<&'seconds'&>
36510 Match messages that are younger than the given time.
36511
36512 .vitem &*-o*&&~<&'seconds'&>
36513 Match messages that are older than the given time.
36514
36515 .vitem &*-z*&
36516 Match only frozen messages.
36517
36518 .vitem &*-x*&
36519 Match only non-frozen messages.
36520 .endlist
36521
36522 The following options control the format of the output:
36523
36524 .vlist
36525 .vitem &*-c*&
36526 Display only the count of matching messages.
36527
36528 .vitem &*-l*&
36529 Long format &-- display the full message information as output by Exim. This is
36530 the default.
36531
36532 .vitem &*-i*&
36533 Display message ids only.
36534
36535 .vitem &*-b*&
36536 Brief format &-- one line per message.
36537
36538 .vitem &*-R*&
36539 Display messages in reverse order.
36540
36541 .vitem &*-a*&
36542 Include delivered recipients in queue listing.
36543 .endlist
36544
36545 There is one more option, &%-h%&, which outputs a list of options.
36546
36547
36548
36549 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36550 .cindex "&'exiqsumm'&"
36551 .cindex "queue" "summary"
36552 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36553 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36554 running a command such as
36555 .code
36556 exim -bp | exiqsumm
36557 .endd
36558 The output consists of one line for each domain that has messages waiting for
36559 it, as in the following example:
36560 .code
36561 3   2322   74m   66m  msn.com.example
36562 .endd
36563 Each line lists the number of pending deliveries for a domain, their total
36564 volume, and the length of time that the oldest and the newest messages have
36565 been waiting. Note that the number of pending deliveries is greater than the
36566 number of messages when messages have more than one recipient.
36567
36568 A summary line is output at the end. By default the output is sorted on the
36569 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36570 the output to be sorted by oldest message and by count of messages,
36571 respectively. There are also three options that split the messages for each
36572 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36573 separates frozen messages, and &%-s%& separates messages according to their
36574 sender.
36575
36576 The output of &'exim -bp'& contains the original addresses in the message, so
36577 this also applies to the output from &'exiqsumm'&. No domains from addresses
36578 generated by aliasing or forwarding are included (unless the &%one_time%&
36579 option of the &(redirect)& router has been used to convert them into &"top
36580 level"& addresses).
36581
36582
36583
36584
36585 .section "Extracting specific information from the log (exigrep)" &&&
36586          "SECTextspeinf"
36587 .cindex "&'exigrep'&"
36588 .cindex "log" "extracts; grepping for"
36589 The &'exigrep'& utility is a Perl script that searches one or more main log
36590 files for entries that match a given pattern. When it finds a match, it
36591 extracts all the log entries for the relevant message, not just those that
36592 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36593 given message, or all mail for a given user, or for a given host, for example.
36594 The input files can be in Exim log format or syslog format.
36595 If a matching log line is not associated with a specific message, it is
36596 included in &'exigrep'&'s output without any additional lines. The usage is:
36597 .display
36598 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36599 .endd
36600 If no log file names are given on the command line, the standard input is read.
36601
36602 The &%-t%& argument specifies a number of seconds. It adds an additional
36603 condition for message selection. Messages that are complete are shown only if
36604 they spent more than <&'n'&> seconds on the queue.
36605
36606 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36607 makes it case-sensitive. This may give a performance improvement when searching
36608 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36609 option; with &%-I%& they do not. In both cases it is possible to change the
36610 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36611
36612 The &%-l%& option means &"literal"&, that is, treat all characters in the
36613 pattern as standing for themselves. Otherwise the pattern must be a Perl
36614 regular expression.
36615
36616 The &%-v%& option inverts the matching condition. That is, a line is selected
36617 if it does &'not'& match the pattern.
36618
36619 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36620 that are generated as a result/response to a message that &'exigrep'& matched
36621 normally.
36622
36623 Example of &%-M%&:
36624 user_a sends a message to user_b, which generates a bounce back to user_b. If
36625 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36626 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36627 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36628 when searching for &"user_a"& will show both messages since the bounce is
36629 &"related"& to or a &"result"& of the first message that was found by the
36630 search term.
36631
36632 If the location of a &'zcat'& command is known from the definition of
36633 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36634 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36635 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36636 autodetection of some well known compression extensions.
36637
36638
36639 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36640 .cindex "&'exipick'&"
36641 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36642 lists messages from the queue according to a variety of criteria. For details
36643 of &'exipick'&'s facilities, visit the web page at
36644 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36645 the &%--help%& option.
36646
36647
36648 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36649 .cindex "log" "cycling local files"
36650 .cindex "cycling logs"
36651 .cindex "&'exicyclog'&"
36652 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36653 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36654 you are using log files with datestamps in their names (see section
36655 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36656 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36657 There are two command line options for &'exicyclog'&:
36658 .ilist
36659 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36660 default that is set when Exim is built. The default default is 10.
36661 .next
36662 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36663 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36664 overriding the script's default, which is to find the setting from Exim's
36665 configuration.
36666 .endlist
36667
36668 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36669 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36670 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36671 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36672 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36673 logs are handled similarly.
36674
36675 If the limit is greater than 99, the script uses 3-digit numbers such as
36676 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36677 to one that is greater, or &'vice versa'&, you will have to fix the names of
36678 any existing log files.
36679
36680 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36681 the end are deleted. All files with numbers greater than 01 are compressed,
36682 using a compression command which is configured by the COMPRESS_COMMAND
36683 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36684 root &%crontab%& entry of the form
36685 .code
36686 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36687 .endd
36688 assuming you have used the name &"exim"& for the Exim user. You can run
36689 &'exicyclog'& as root if you wish, but there is no need.
36690
36691
36692
36693 .section "Mail statistics (eximstats)" "SECTmailstat"
36694 .cindex "statistics"
36695 .cindex "&'eximstats'&"
36696 A Perl script called &'eximstats'& is provided for extracting statistical
36697 information from log files. The output is either plain text, or HTML.
36698 Exim log files are also supported by the &'Lire'& system produced by the
36699 LogReport Foundation &url(http://www.logreport.org).
36700
36701 The &'eximstats'& script has been hacked about quite a bit over time. The
36702 latest version is the result of some extensive revision by Steve Campbell. A
36703 lot of information is given by default, but there are options for suppressing
36704 various parts of it. Following any options, the arguments to the script are a
36705 list of files, which should be main log files. For example:
36706 .code
36707 eximstats -nr /var/spool/exim/log/mainlog.01
36708 .endd
36709 By default, &'eximstats'& extracts information about the number and volume of
36710 messages received from or delivered to various hosts. The information is sorted
36711 both by message count and by volume, and the top fifty hosts in each category
36712 are listed on the standard output. Similar information, based on email
36713 addresses or domains instead of hosts can be requested by means of various
36714 options. For messages delivered and received locally, similar statistics are
36715 also produced per user.
36716
36717 The output also includes total counts and statistics about delivery errors, and
36718 histograms showing the number of messages received and deliveries made in each
36719 hour of the day. A delivery with more than one address in its envelope (for
36720 example, an SMTP transaction with more than one RCPT command) is counted
36721 as a single delivery by &'eximstats'&.
36722
36723 Though normally more deliveries than receipts are reported (as messages may
36724 have multiple recipients), it is possible for &'eximstats'& to report more
36725 messages received than delivered, even though the queue is empty at the start
36726 and end of the period in question. If an incoming message contains no valid
36727 recipients, no deliveries are recorded for it. A bounce message is handled as
36728 an entirely separate message.
36729
36730 &'eximstats'& always outputs a grand total summary giving the volume and number
36731 of messages received and deliveries made, and the number of hosts involved in
36732 each case. It also outputs the number of messages that were delayed (that is,
36733 not completely delivered at the first attempt), and the number that had at
36734 least one address that failed.
36735
36736 The remainder of the output is in sections that can be independently disabled
36737 or modified by various options. It consists of a summary of deliveries by
36738 transport, histograms of messages received and delivered per time interval
36739 (default per hour), information about the time messages spent on the queue,
36740 a list of relayed messages, lists of the top fifty sending hosts, local
36741 senders, destination hosts, and destination local users by count and by volume,
36742 and a list of delivery errors that occurred.
36743
36744 The relay information lists messages that were actually relayed, that is, they
36745 came from a remote host and were directly delivered to some other remote host,
36746 without being processed (for example, for aliasing or forwarding) locally.
36747
36748 There are quite a few options for &'eximstats'& to control exactly what it
36749 outputs. These are documented in the Perl script itself, and can be extracted
36750 by running the command &(perldoc)& on the script. For example:
36751 .code
36752 perldoc /usr/exim/bin/eximstats
36753 .endd
36754
36755 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36756 .cindex "&'exim_checkaccess'&"
36757 .cindex "policy control" "checking access"
36758 .cindex "checking access"
36759 The &%-bh%& command line argument allows you to run a fake SMTP session with
36760 debugging output, in order to check what Exim is doing when it is applying
36761 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36762 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36763 sometimes you just want to answer the question &"Does this address have
36764 access?"& without bothering with any further details.
36765
36766 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36767 two arguments, an IP address and an email address:
36768 .code
36769 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36770 .endd
36771 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36772 given email address would be accepted in a RCPT command in a TCP/IP
36773 connection from the host with the given IP address. The output of the utility
36774 is either the word &"accepted"&, or the SMTP error response, for example:
36775 .code
36776 Rejected:
36777 550 Relay not permitted
36778 .endd
36779 When running this test, the utility uses &`<>`& as the envelope sender address
36780 for the MAIL command, but you can change this by providing additional
36781 options. These are passed directly to the Exim command. For example, to specify
36782 that the test is to be run with the sender address &'himself@there.example'&
36783 you can use:
36784 .code
36785 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36786                  -f himself@there.example
36787 .endd
36788 Note that these additional Exim command line items must be given after the two
36789 mandatory arguments.
36790
36791 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36792 while running its checks. You can run checks that include callouts by using
36793 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36794
36795
36796
36797 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36798 .cindex "DBM" "building dbm files"
36799 .cindex "building DBM files"
36800 .cindex "&'exim_dbmbuild'&"
36801 .cindex "lower casing"
36802 .cindex "binary zero" "in lookup key"
36803 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36804 the format used by the &(lsearch)& lookup (see section
36805 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36806 names as keys and the remainder of the information as data. The lower-casing
36807 can be prevented by calling the program with the &%-nolc%& option.
36808
36809 A terminating zero is included as part of the key string. This is expected by
36810 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36811 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36812 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36813 files.
36814
36815 The program requires two arguments: the name of the input file (which can be a
36816 single hyphen to indicate the standard input), and the name of the output file.
36817 It creates the output under a temporary name, and then renames it if all went
36818 well.
36819
36820 .cindex "USE_DB"
36821 If the native DB interface is in use (USE_DB is set in a compile-time
36822 configuration file &-- this is common in free versions of Unix) the two file
36823 names must be different, because in this mode the Berkeley DB functions create
36824 a single output file using exactly the name given. For example,
36825 .code
36826 exim_dbmbuild /etc/aliases /etc/aliases.db
36827 .endd
36828 reads the system alias file and creates a DBM version of it in
36829 &_/etc/aliases.db_&.
36830
36831 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36832 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36833 environment, the suffixes are added to the second argument of
36834 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36835 when the Berkeley functions are used in compatibility mode (though this is not
36836 recommended), because in that case it adds a &_.db_& suffix to the file name.
36837
36838 If a duplicate key is encountered, the program outputs a warning, and when it
36839 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36840 option is used. By default, only the first of a set of duplicates is used &--
36841 this makes it compatible with &(lsearch)& lookups. There is an option
36842 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36843 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36844 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36845 return code is 2.
36846
36847
36848
36849
36850 .section "Finding individual retry times (exinext)" "SECTfinindret"
36851 .cindex "retry" "times"
36852 .cindex "&'exinext'&"
36853 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36854 fish specific information out of the retry database. Given a mail domain (or a
36855 complete address), it looks up the hosts for that domain, and outputs any retry
36856 information for the hosts or for the domain. At present, the retry information
36857 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36858 output. For example:
36859 .code
36860 $ exinext piglet@milne.fict.example
36861 kanga.milne.example:192.168.8.1 error 146: Connection refused
36862   first failed: 21-Feb-1996 14:57:34
36863   last tried:   21-Feb-1996 14:57:34
36864   next try at:  21-Feb-1996 15:02:34
36865 roo.milne.example:192.168.8.3 error 146: Connection refused
36866   first failed: 20-Jan-1996 13:12:08
36867   last tried:   21-Feb-1996 11:42:03
36868   next try at:  21-Feb-1996 19:42:03
36869   past final cutoff time
36870 .endd
36871 You can also give &'exinext'& a local part, without a domain, and it
36872 will give any retry information for that local part in your default domain.
36873 A message id can be used to obtain retry information pertaining to a specific
36874 message. This exists only when an attempt to deliver a message to a remote host
36875 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36876 &'exinext'& is not particularly efficient, but then it is not expected to be
36877 run very often.
36878
36879 The &'exinext'& utility calls Exim to find out information such as the location
36880 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36881 passed on to the &'exim'& commands. The first specifies an alternate Exim
36882 configuration file, and the second sets macros for use within the configuration
36883 file. These features are mainly to help in testing, but might also be useful in
36884 environments where more than one configuration file is in use.
36885
36886
36887
36888 .section "Hints database maintenance" "SECThindatmai"
36889 .cindex "hints database" "maintenance"
36890 .cindex "maintaining Exim's hints database"
36891 Three utility programs are provided for maintaining the DBM files that Exim
36892 uses to contain its delivery hint information. Each program requires two
36893 arguments. The first specifies the name of Exim's spool directory, and the
36894 second is the name of the database it is to operate on. These are as follows:
36895
36896 .ilist
36897 &'retry'&: the database of retry information
36898 .next
36899 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36900 for remote hosts
36901 .next
36902 &'callout'&: the callout cache
36903 .next
36904 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36905 .next
36906 &'misc'&: other hints data
36907 .endlist
36908
36909 The &'misc'& database is used for
36910
36911 .ilist
36912 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36913 .next
36914 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36915 &(smtp)& transport)
36916 .next
36917 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36918 in a transport)
36919 .endlist
36920
36921
36922
36923 .section "exim_dumpdb" "SECID261"
36924 .cindex "&'exim_dumpdb'&"
36925 The entire contents of a database are written to the standard output by the
36926 &'exim_dumpdb'& program, which has no options or arguments other than the
36927 spool and database names. For example, to dump the retry database:
36928 .code
36929 exim_dumpdb /var/spool/exim retry
36930 .endd
36931 Two lines of output are produced for each entry:
36932 .code
36933 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36934 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36935 .endd
36936 The first item on the first line is the key of the record. It starts with one
36937 of the letters R, or T, depending on whether it refers to a routing or
36938 transport retry. For a local delivery, the next part is the local address; for
36939 a remote delivery it is the name of the remote host, followed by its failing IP
36940 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36941 transport). If the remote port is not the standard one (port 25), it is added
36942 to the IP address. Then there follows an error code, an additional error code,
36943 and a textual description of the error.
36944
36945 The three times on the second line are the time of first failure, the time of
36946 the last delivery attempt, and the computed time for the next attempt. The line
36947 ends with an asterisk if the cutoff time for the last retry rule has been
36948 exceeded.
36949
36950 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36951 consists of a host name followed by a list of ids for messages that are or were
36952 waiting to be delivered to that host. If there are a very large number for any
36953 one host, continuation records, with a sequence number added to the host name,
36954 may be seen. The data in these records is often out of date, because a message
36955 may be routed to several alternative hosts, and Exim makes no effort to keep
36956 cross-references.
36957
36958
36959
36960 .section "exim_tidydb" "SECID262"
36961 .cindex "&'exim_tidydb'&"
36962 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36963 database. If run with no options, it removes all records that are more than 30
36964 days old. The age is calculated from the date and time that the record was last
36965 updated. Note that, in the case of the retry database, it is &'not'& the time
36966 since the first delivery failure. Information about a host that has been down
36967 for more than 30 days will remain in the database, provided that the record is
36968 updated sufficiently often.
36969
36970 The cutoff date can be altered by means of the &%-t%& option, which must be
36971 followed by a time. For example, to remove all records older than a week from
36972 the retry database:
36973 .code
36974 exim_tidydb -t 7d /var/spool/exim retry
36975 .endd
36976 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36977 message ids. In the former these appear as data in records keyed by host &--
36978 they were messages that were waiting for that host &-- and in the latter they
36979 are the keys for retry information for messages that have suffered certain
36980 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36981 message ids in database records are those of messages that are still on the
36982 queue. Message ids for messages that no longer exist are removed from
36983 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36984 For the &'retry'& database, records whose keys are non-existent message ids are
36985 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36986 whenever it removes information from the database.
36987
36988 Certain records are automatically removed by Exim when they are no longer
36989 needed, but others are not. For example, if all the MX hosts for a domain are
36990 down, a retry record is created for each one. If the primary MX host comes back
36991 first, its record is removed when Exim successfully delivers to it, but the
36992 records for the others remain because Exim has not tried to use those hosts.
36993
36994 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36995 hints databases. You should do this at a quiet time of day, because it requires
36996 a database to be locked (and therefore inaccessible to Exim) while it does its
36997 work. Removing records from a DBM file does not normally make the file smaller,
36998 but all the common DBM libraries are able to re-use the space that is released.
36999 After an initial phase of increasing in size, the databases normally reach a
37000 point at which they no longer get any bigger, as long as they are regularly
37001 tidied.
37002
37003 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37004 databases is likely to keep on increasing.
37005
37006
37007
37008
37009 .section "exim_fixdb" "SECID263"
37010 .cindex "&'exim_fixdb'&"
37011 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37012 Its main use is for testing Exim, but it might also be occasionally useful for
37013 getting round problems in a live system. It has no options, and its interface
37014 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37015 key of a database record can then be entered, and the data for that record is
37016 displayed.
37017
37018 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37019 except the &'retry'& database, that is the only operation that can be carried
37020 out. For the &'retry'& database, each field is output preceded by a number, and
37021 data for individual fields can be changed by typing the field number followed
37022 by new data, for example:
37023 .code
37024 > 4 951102:1000
37025 .endd
37026 resets the time of the next delivery attempt. Time values are given as a
37027 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37028 used as optional separators.
37029
37030
37031
37032
37033 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37034 .cindex "mailbox" "maintenance"
37035 .cindex "&'exim_lock'&"
37036 .cindex "locking mailboxes"
37037 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37038 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37039 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37040 a user agent while investigating a problem. The utility requires the name of
37041 the file as its first argument. If the locking is successful, the second
37042 argument is run as a command (using C's &[system()]& function); if there is no
37043 second argument, the value of the SHELL environment variable is used; if this
37044 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37045 is unlocked and the utility ends. The following options are available:
37046
37047 .vlist
37048 .vitem &%-fcntl%&
37049 Use &[fcntl()]& locking on the open mailbox.
37050
37051 .vitem &%-flock%&
37052 Use &[flock()]& locking on the open mailbox, provided the operating system
37053 supports it.
37054
37055 .vitem &%-interval%&
37056 This must be followed by a number, which is a number of seconds; it sets the
37057 interval to sleep between retries (default 3).
37058
37059 .vitem &%-lockfile%&
37060 Create a lock file before opening the mailbox.
37061
37062 .vitem &%-mbx%&
37063 Lock the mailbox using MBX rules.
37064
37065 .vitem &%-q%&
37066 Suppress verification output.
37067
37068 .vitem &%-retries%&
37069 This must be followed by a number; it sets the number of times to try to get
37070 the lock (default 10).
37071
37072 .vitem &%-restore_time%&
37073 This option causes &%exim_lock%& to restore the modified and read times to the
37074 locked file before exiting. This allows you to access a locked mailbox (for
37075 example, to take a backup copy) without disturbing the times that the user
37076 subsequently sees.
37077
37078 .vitem &%-timeout%&
37079 This must be followed by a number, which is a number of seconds; it sets a
37080 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37081 default), a non-blocking call is used.
37082
37083 .vitem &%-v%&
37084 Generate verbose output.
37085 .endlist
37086
37087 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37088 default is to create a lock file and also to use &[fcntl()]& locking on the
37089 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37090 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37091 requires that the directory containing the file be writeable. Locking by lock
37092 file does not last for ever; Exim assumes that a lock file is expired if it is
37093 more than 30 minutes old.
37094
37095 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37096 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37097 to be taken out on the open mailbox, and an exclusive lock on the file
37098 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37099 number of the mailbox file. When the locking is released, if an exclusive lock
37100 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37101
37102 The default output contains verification of the locking that takes place. The
37103 &%-v%& option causes some additional information to be given. The &%-q%& option
37104 suppresses all output except error messages.
37105
37106 A command such as
37107 .code
37108 exim_lock /var/spool/mail/spqr
37109 .endd
37110 runs an interactive shell while the file is locked, whereas
37111 .display
37112 &`exim_lock -q /var/spool/mail/spqr <<End`&
37113 <&'some commands'&>
37114 &`End`&
37115 .endd
37116 runs a specific non-interactive sequence of commands while the file is locked,
37117 suppressing all verification output. A single command can be run by a command
37118 such as
37119 .code
37120 exim_lock -q /var/spool/mail/spqr \
37121   "cp /var/spool/mail/spqr /some/where"
37122 .endd
37123 Note that if a command is supplied, it must be entirely contained within the
37124 second argument &-- hence the quotes.
37125 .ecindex IIDutils
37126
37127
37128 . ////////////////////////////////////////////////////////////////////////////
37129 . ////////////////////////////////////////////////////////////////////////////
37130
37131 .chapter "The Exim monitor" "CHAPeximon"
37132 .scindex IIDeximon "Exim monitor" "description"
37133 .cindex "X-windows"
37134 .cindex "&'eximon'&"
37135 .cindex "Local/eximon.conf"
37136 .cindex "&_exim_monitor/EDITME_&"
37137 The Exim monitor is an application which displays in an X window information
37138 about the state of Exim's queue and what Exim is doing. An admin user can
37139 perform certain operations on messages from this GUI interface; however all
37140 such facilities are also available from the command line, and indeed, the
37141 monitor itself makes use of the command line to perform any actions requested.
37142
37143
37144
37145 .section "Running the monitor" "SECID264"
37146 The monitor is started by running the script called &'eximon'&. This is a shell
37147 script that sets up a number of environment variables, and then runs the
37148 binary called &_eximon.bin_&. The default appearance of the monitor window can
37149 be changed by editing the &_Local/eximon.conf_& file created by editing
37150 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37151 parameters are for.
37152
37153 The parameters that get built into the &'eximon'& script can be overridden for
37154 a particular invocation by setting up environment variables of the same names,
37155 preceded by &`EXIMON_`&. For example, a shell command such as
37156 .code
37157 EXIMON_LOG_DEPTH=400 eximon
37158 .endd
37159 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37160 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37161 overrides the Exim log file configuration. This makes it possible to have
37162 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37163 syslog messages are routed to a file on the local host.
37164
37165 X resources can be used to change the appearance of the window in the normal
37166 way. For example, a resource setting of the form
37167 .code
37168 Eximon*background: gray94
37169 .endd
37170 changes the colour of the background to light grey rather than white. The
37171 stripcharts are drawn with both the data lines and the reference lines in
37172 black. This means that the reference lines are not visible when on top of the
37173 data. However, their colour can be changed by setting a resource called
37174 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37175 For example, if your X server is running Unix, you could set up lighter
37176 reference lines in the stripcharts by obeying
37177 .code
37178 xrdb -merge <<End
37179 Eximon*highlight: gray
37180 End
37181 .endd
37182 .cindex "admin user"
37183 In order to see the contents of messages on the queue, and to operate on them,
37184 &'eximon'& must either be run as root or by an admin user.
37185
37186 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37187 contain X11 resource parameters interpreted by the X11 library.  In addition,
37188 if the first parameter starts with the string "gdb" then it is removed and the
37189 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37190 versioned variants of gdb can be invoked).
37191
37192 The monitor's window is divided into three parts. The first contains one or
37193 more stripcharts and two action buttons, the second contains a &"tail"& of the
37194 main log file, and the third is a display of the queue of messages awaiting
37195 delivery, with two more action buttons. The following sections describe these
37196 different parts of the display.
37197
37198
37199
37200
37201 .section "The stripcharts" "SECID265"
37202 .cindex "stripchart"
37203 The first stripchart is always a count of messages on the queue. Its name can
37204 be configured by setting QUEUE_STRIPCHART_NAME in the
37205 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37206 configuration script by regular expression matches on log file entries, making
37207 it possible to display, for example, counts of messages delivered to certain
37208 hosts or using certain transports. The supplied defaults display counts of
37209 received and delivered messages, and of local and SMTP deliveries. The default
37210 period between stripchart updates is one minute; this can be adjusted by a
37211 parameter in the &_Local/eximon.conf_& file.
37212
37213 The stripchart displays rescale themselves automatically as the value they are
37214 displaying changes. There are always 10 horizontal lines in each chart; the
37215 title string indicates the value of each division when it is greater than one.
37216 For example, &"x2"& means that each division represents a value of 2.
37217
37218 It is also possible to have a stripchart which shows the percentage fullness of
37219 a particular disk partition, which is useful when local deliveries are confined
37220 to a single partition.
37221
37222 .cindex "&%statvfs%& function"
37223 This relies on the availability of the &[statvfs()]& function or equivalent in
37224 the operating system. Most, but not all versions of Unix that support Exim have
37225 this. For this particular stripchart, the top of the chart always represents
37226 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37227 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37228 &_Local/eximon.conf_& file.
37229
37230
37231
37232
37233 .section "Main action buttons" "SECID266"
37234 .cindex "size" "of monitor window"
37235 .cindex "Exim monitor" "window size"
37236 .cindex "window size"
37237 Below the stripcharts there is an action button for quitting the monitor. Next
37238 to this is another button marked &"Size"&. They are placed here so that
37239 shrinking the window to its default minimum size leaves just the queue count
37240 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37241 the window to expand to its maximum size, unless it is already at the maximum,
37242 in which case it is reduced to its minimum.
37243
37244 When expanding to the maximum, if the window cannot be fully seen where it
37245 currently is, it is moved back to where it was the last time it was at full
37246 size. When it is expanding from its minimum size, the old position is
37247 remembered, and next time it is reduced to the minimum it is moved back there.
37248
37249 The idea is that you can keep a reduced window just showing one or two
37250 stripcharts at a convenient place on your screen, easily expand it to show
37251 the full window when required, and just as easily put it back to what it was.
37252 The idea is copied from what the &'twm'& window manager does for its
37253 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37254 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37255
37256 Normally, the monitor starts up with the window at its full size, but it can be
37257 built so that it starts up with the window at its smallest size, by setting
37258 START_SMALL=yes in &_Local/eximon.conf_&.
37259
37260
37261
37262 .section "The log display" "SECID267"
37263 .cindex "log" "tail of; in monitor"
37264 The second section of the window is an area in which a display of the tail of
37265 the main log is maintained.
37266 To save space on the screen, the timestamp on each log line is shortened by
37267 removing the date and, if &%log_timezone%& is set, the timezone.
37268 The log tail is not available when the only destination for logging data is
37269 syslog, unless the syslog lines are routed to a local file whose name is passed
37270 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37271
37272 The log sub-window has a scroll bar at its lefthand side which can be used to
37273 move back to look at earlier text, and the up and down arrow keys also have a
37274 scrolling effect. The amount of log that is kept depends on the setting of
37275 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37276 to use. When this is full, the earlier 50% of data is discarded &-- this is
37277 much more efficient than throwing it away line by line. The sub-window also has
37278 a horizontal scroll bar for accessing the ends of long log lines. This is the
37279 only means of horizontal scrolling; the right and left arrow keys are not
37280 available. Text can be cut from this part of the window using the mouse in the
37281 normal way. The size of this subwindow is controlled by parameters in the
37282 configuration file &_Local/eximon.conf_&.
37283
37284 Searches of the text in the log window can be carried out by means of the ^R
37285 and ^S keystrokes, which default to a reverse and a forward search,
37286 respectively. The search covers only the text that is displayed in the window.
37287 It cannot go further back up the log.
37288
37289 The point from which the search starts is indicated by a caret marker. This is
37290 normally at the end of the text in the window, but can be positioned explicitly
37291 by pointing and clicking with the left mouse button, and is moved automatically
37292 by a successful search. If new text arrives in the window when it is scrolled
37293 back, the caret remains where it is, but if the window is not scrolled back,
37294 the caret is moved to the end of the new text.
37295
37296 Pressing ^R or ^S pops up a window into which the search text can be typed.
37297 There are buttons for selecting forward or reverse searching, for carrying out
37298 the search, and for cancelling. If the &"Search"& button is pressed, the search
37299 happens and the window remains so that further searches can be done. If the
37300 &"Return"& key is pressed, a single search is done and the window is closed. If
37301 ^C is typed the search is cancelled.
37302
37303 The searching facility is implemented using the facilities of the Athena text
37304 widget. By default this pops up a window containing both &"search"& and
37305 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37306 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37307 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37308 provided version of &%TextPop%& when the remaining parts of the text widget
37309 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37310 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37311 on these systems, at the expense of having unwanted items in the search popup
37312 window.
37313
37314
37315
37316 .section "The queue display" "SECID268"
37317 .cindex "queue" "display in monitor"
37318 The bottom section of the monitor window contains a list of all messages that
37319 are on the queue, which includes those currently being received or delivered,
37320 as well as those awaiting delivery. The size of this subwindow is controlled by
37321 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37322 at which it is updated is controlled by another parameter in the same file &--
37323 the default is 5 minutes, since queue scans can be quite expensive. However,
37324 there is an &"Update"& action button just above the display which can be used
37325 to force an update of the queue display at any time.
37326
37327 When a host is down for some time, a lot of pending mail can build up for it,
37328 and this can make it hard to deal with other messages on the queue. To help
37329 with this situation there is a button next to &"Update"& called &"Hide"&. If
37330 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37331 type anything in here and press &"Return"&, the text is added to a chain of
37332 such texts, and if every undelivered address in a message matches at least one
37333 of the texts, the message is not displayed.
37334
37335 If there is an address that does not match any of the texts, all the addresses
37336 are displayed as normal. The matching happens on the ends of addresses so, for
37337 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37338 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37339 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37340 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37341 a hide request is automatically cancelled after one hour.
37342
37343 While the dialogue box is displayed, you can't press any buttons or do anything
37344 else to the monitor window. For this reason, if you want to cut text from the
37345 queue display to use in the dialogue box, you have to do the cutting before
37346 pressing the &"Hide"& button.
37347
37348 The queue display contains, for each unhidden queued message, the length of
37349 time it has been on the queue, the size of the message, the message id, the
37350 message sender, and the first undelivered recipient, all on one line. If it is
37351 a bounce message, the sender is shown as &"<>"&. If there is more than one
37352 recipient to which the message has not yet been delivered, subsequent ones are
37353 listed on additional lines, up to a maximum configured number, following which
37354 an ellipsis is displayed. Recipients that have already received the message are
37355 not shown.
37356
37357 .cindex "frozen messages" "display"
37358 If a message is frozen, an asterisk is displayed at the left-hand side.
37359
37360 The queue display has a vertical scroll bar, and can also be scrolled by means
37361 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37362 The text searching facilities, as described above for the log window, are also
37363 available, but the caret is always moved to the end of the text when the queue
37364 display is updated.
37365
37366
37367
37368 .section "The queue menu" "SECID269"
37369 .cindex "queue" "menu in monitor"
37370 If the &%shift%& key is held down and the left button is clicked when the mouse
37371 pointer is over the text for any message, an action menu pops up, and the first
37372 line of the queue display for the message is highlighted. This does not affect
37373 any selected text.
37374
37375 If you want to use some other event for popping up the menu, you can set the
37376 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37377 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37378 value set in this parameter is a standard X event description. For example, to
37379 run eximon using &%ctrl%& rather than &%shift%& you could use
37380 .code
37381 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37382 .endd
37383 The title of the menu is the message id, and it contains entries which act as
37384 follows:
37385
37386 .ilist
37387 &'message log'&: The contents of the message log for the message are displayed
37388 in a new text window.
37389 .next
37390 &'headers'&: Information from the spool file that contains the envelope
37391 information and headers is displayed in a new text window. See chapter
37392 &<<CHAPspool>>& for a description of the format of spool files.
37393 .next
37394 &'body'&: The contents of the spool file containing the body of the message are
37395 displayed in a new text window. There is a default limit of 20,000 bytes to the
37396 amount of data displayed. This can be changed by setting the BODY_MAX
37397 option at compile time, or the EXIMON_BODY_MAX option at run time.
37398 .next
37399 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37400 delivery of the message. This causes an automatic thaw if the message is
37401 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37402 a new text window. The delivery is run in a separate process, to avoid holding
37403 up the monitor while the delivery proceeds.
37404 .next
37405 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37406 that the message be frozen.
37407 .next
37408 .cindex "thawing messages"
37409 .cindex "unfreezing messages"
37410 .cindex "frozen messages" "thawing"
37411 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37412 that the message be thawed.
37413 .next
37414 .cindex "delivery" "forcing failure"
37415 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37416 that Exim gives up trying to deliver the message. A bounce message is generated
37417 for any remaining undelivered addresses.
37418 .next
37419 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37420 that the message be deleted from the system without generating a bounce
37421 message.
37422 .next
37423 &'add recipient'&: A dialog box is displayed into which a recipient address can
37424 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37425 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37426 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37427 causes a call to Exim to be made using the &%-Mar%& option to request that an
37428 additional recipient be added to the message, unless the entry box is empty, in
37429 which case no action is taken.
37430 .next
37431 &'mark delivered'&: A dialog box is displayed into which a recipient address
37432 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37433 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37434 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37435 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37436 recipient address as already delivered, unless the entry box is empty, in which
37437 case no action is taken.
37438 .next
37439 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37440 mark all recipient addresses as already delivered.
37441 .next
37442 &'edit sender'&: A dialog box is displayed initialized with the current
37443 sender's address. Pressing RETURN causes a call to Exim to be made using the
37444 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37445 in which case no action is taken. If you want to set an empty sender (as in
37446 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37447 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37448 the address is qualified with that domain.
37449 .endlist
37450
37451 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37452 other cases when a call to Exim is made, if there is any output from Exim (in
37453 particular, if the command fails) a window containing the command and the
37454 output is displayed. Otherwise, the results of the action are normally apparent
37455 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37456 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37457 if no output is generated.
37458
37459 The queue display is automatically updated for actions such as freezing and
37460 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37461 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37462 force an update of the display after one of these actions.
37463
37464 In any text window that is displayed as result of a menu action, the normal
37465 cut-and-paste facility is available, and searching can be carried out using ^R
37466 and ^S, as described above for the log tail window.
37467 .ecindex IIDeximon
37468
37469
37470
37471
37472
37473 . ////////////////////////////////////////////////////////////////////////////
37474 . ////////////////////////////////////////////////////////////////////////////
37475
37476 .chapter "Security considerations" "CHAPsecurity"
37477 .scindex IIDsecurcon "security" "discussion of"
37478 This chapter discusses a number of issues concerned with security, some of
37479 which are also covered in other parts of this manual.
37480
37481 For reasons that this author does not understand, some people have promoted
37482 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37483 existence of this chapter in the documentation. However, the intent of the
37484 chapter is simply to describe the way Exim works in relation to certain
37485 security concerns, not to make any specific claims about the effectiveness of
37486 its security as compared with other MTAs.
37487
37488 What follows is a description of the way Exim is supposed to be. Best efforts
37489 have been made to try to ensure that the code agrees with the theory, but an
37490 absence of bugs can never be guaranteed. Any that are reported will get fixed
37491 as soon as possible.
37492
37493
37494 .section "Building a more &""hardened""& Exim" "SECID286"
37495 .cindex "security" "build-time features"
37496 There are a number of build-time options that can be set in &_Local/Makefile_&
37497 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37498 Exim administrator who does not have the root password, or by someone who has
37499 penetrated the Exim (but not the root) account. These options are as follows:
37500
37501 .ilist
37502 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37503 start of any file names used with the &%-C%& option. When it is set, these file
37504 names are also not allowed to contain the sequence &"/../"&. (However, if the
37505 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37506 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37507 default setting for &%ALT_CONFIG_PREFIX%&.
37508
37509 If the permitted configuration files are confined to a directory to
37510 which only root has access, this guards against someone who has broken
37511 into the Exim account from running a privileged Exim with an arbitrary
37512 configuration file, and using it to break into other accounts.
37513 .next
37514
37515 If a non-trusted configuration file (i.e. not the default configuration file
37516 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37517 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37518 the next item), then root privilege is retained only if the caller of Exim is
37519 root. This locks out the possibility of testing a configuration using &%-C%&
37520 right through message reception and delivery, even if the caller is root. The
37521 reception works, but by that time, Exim is running as the Exim user, so when
37522 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37523 privilege to be lost. However, root can test reception and delivery using two
37524 separate commands.
37525
37526 .next
37527 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37528 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37529 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37530 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37531 the restrictive side.  Requiring build-time selection of safe macros is onerous
37532 but this option is intended solely as a transition mechanism to permit
37533 previously-working configurations to continue to work after release 4.73.
37534 .next
37535 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37536 is disabled.
37537 .next
37538 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37539 never to be used for any deliveries. This is like the &%never_users%& runtime
37540 option, but it cannot be overridden; the runtime option adds additional users
37541 to the list. The default setting is &"root"&; this prevents a non-root user who
37542 is permitted to modify the runtime file from using Exim as a way to get root.
37543 .endlist
37544
37545
37546
37547 .section "Root privilege" "SECID270"
37548 .cindex "setuid"
37549 .cindex "root privilege"
37550 The Exim binary is normally setuid to root, which means that it gains root
37551 privilege (runs as root) when it starts execution. In some special cases (for
37552 example, when the daemon is not in use and there are no local deliveries), it
37553 may be possible to run Exim setuid to some user other than root. This is
37554 discussed in the next section. However, in most installations, root privilege
37555 is required for two things:
37556
37557 .ilist
37558 To set up a socket connected to the standard SMTP port (25) when initialising
37559 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37560 not required.
37561 .next
37562 To be able to change uid and gid in order to read users' &_.forward_& files and
37563 perform local deliveries as the receiving user or as specified in the
37564 configuration.
37565 .endlist
37566
37567 It is not necessary to be root to do any of the other things Exim does, such as
37568 receiving messages and delivering them externally over SMTP, and it is
37569 obviously more secure if Exim does not run as root except when necessary.
37570 For this reason, a user and group for Exim to use must be defined in
37571 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37572 group"&. Their values can be changed by the run time configuration, though this
37573 is not recommended. Often a user called &'exim'& is used, but some sites use
37574 &'mail'& or another user name altogether.
37575
37576 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37577 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37578 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37579
37580 After a new Exim process has interpreted its command line options, it changes
37581 uid and gid in the following cases:
37582
37583 .ilist
37584 .oindex "&%-C%&"
37585 .oindex "&%-D%&"
37586 If the &%-C%& option is used to specify an alternate configuration file, or if
37587 the &%-D%& option is used to define macro values for the configuration, and the
37588 calling process is not running as root, the uid and gid are changed to those of
37589 the calling process.
37590 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37591 option may not be used at all.
37592 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37593 can be supplied if the calling process is running as root, the Exim run-time
37594 user or CONFIGURE_OWNER, if defined.
37595 .next
37596 .oindex "&%-be%&"
37597 .oindex "&%-bf%&"
37598 .oindex "&%-bF%&"
37599 If the expansion test option (&%-be%&) or one of the filter testing options
37600 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37601 calling process.
37602 .next
37603 If the process is not a daemon process or a queue runner process or a delivery
37604 process or a process for testing address routing (started with &%-bt%&), the
37605 uid and gid are changed to the Exim user and group. This means that Exim always
37606 runs under its own uid and gid when receiving messages. This also applies when
37607 testing address verification
37608 .oindex "&%-bv%&"
37609 .oindex "&%-bh%&"
37610 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37611 option).
37612 .next
37613 For a daemon, queue runner, delivery, or address testing process, the uid
37614 remains as root at this stage, but the gid is changed to the Exim group.
37615 .endlist
37616
37617 The processes that initially retain root privilege behave as follows:
37618
37619 .ilist
37620 A daemon process changes the gid to the Exim group and the uid to the Exim
37621 user after setting up one or more listening sockets. The &[initgroups()]&
37622 function is called, so that if the Exim user is in any additional groups, they
37623 will be used during message reception.
37624 .next
37625 A queue runner process retains root privilege throughout its execution. Its
37626 job is to fork a controlled sequence of delivery processes.
37627 .next
37628 A delivery process retains root privilege throughout most of its execution,
37629 but any actual deliveries (that is, the transports themselves) are run in
37630 subprocesses which always change to a non-root uid and gid. For local
37631 deliveries this is typically the uid and gid of the owner of the mailbox; for
37632 remote deliveries, the Exim uid and gid are used. Once all the delivery
37633 subprocesses have been run, a delivery process changes to the Exim uid and gid
37634 while doing post-delivery tidying up such as updating the retry database and
37635 generating bounce and warning messages.
37636
37637 While the recipient addresses in a message are being routed, the delivery
37638 process runs as root. However, if a user's filter file has to be processed,
37639 this is done in a subprocess that runs under the individual user's uid and
37640 gid. A system filter is run as root unless &%system_filter_user%& is set.
37641 .next
37642 A process that is testing addresses (the &%-bt%& option) runs as root so that
37643 the routing is done in the same environment as a message delivery.
37644 .endlist
37645
37646
37647
37648
37649 .section "Running Exim without privilege" "SECTrunexiwitpri"
37650 .cindex "privilege, running without"
37651 .cindex "unprivileged running"
37652 .cindex "root privilege" "running without"
37653 Some installations like to run Exim in an unprivileged state for more of its
37654 operation, for added security. Support for this mode of operation is provided
37655 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37656 gid are changed to the Exim user and group at the start of a delivery process
37657 (and also queue runner and address testing processes). This means that address
37658 routing is no longer run as root, and the deliveries themselves cannot change
37659 to any other uid.
37660
37661 .cindex SIGHUP
37662 .cindex "daemon" "restarting"
37663 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37664 that the daemon can still be started in the usual way, and it can respond
37665 correctly to SIGHUP because the re-invocation regains root privilege.
37666
37667 An alternative approach is to make Exim setuid to the Exim user and also setgid
37668 to the Exim group. If you do this, the daemon must be started from a root
37669 process. (Calling Exim from a root process makes it behave in the way it does
37670 when it is setuid root.) However, the daemon cannot restart itself after a
37671 SIGHUP signal because it cannot regain privilege.
37672
37673 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37674 stops Exim from trying to re-invoke itself to do a delivery after a message has
37675 been received. Such a re-invocation is a waste of resources because it has no
37676 effect.
37677
37678 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37679 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37680 to the Exim user seems a clean approach, but there is one complication:
37681
37682 In this style of operation, Exim is running with the real uid and gid set to
37683 those of the calling process, and the effective uid/gid set to Exim's values.
37684 Ideally, any association with the calling process' uid/gid should be dropped,
37685 that is, the real uid/gid should be reset to the effective values so as to
37686 discard any privileges that the caller may have. While some operating systems
37687 have a function that permits this action for a non-root effective uid, quite a
37688 number of them do not. Because of this lack of standardization, Exim does not
37689 address this problem at this time.
37690
37691 For this reason, the recommended approach for &"mostly unprivileged"& running
37692 is to keep the Exim binary setuid to root, and to set
37693 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37694 be used in the most straightforward way.
37695
37696 If you configure Exim not to run delivery processes as root, there are a
37697 number of restrictions on what you can do:
37698
37699 .ilist
37700 You can deliver only as the Exim user/group. You should  explicitly use the
37701 &%user%& and &%group%& options to override routers or local transports that
37702 normally deliver as the recipient. This makes sure that configurations that
37703 work in this mode function the same way in normal mode. Any implicit or
37704 explicit specification of another user causes an error.
37705 .next
37706 Use of &_.forward_& files is severely restricted, such that it is usually
37707 not worthwhile to include them in the configuration.
37708 .next
37709 Users who wish to use &_.forward_& would have to make their home directory and
37710 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37711 and their equivalents in Exim filters, cannot be used. While they could be
37712 enabled in the Exim user's name, that would be insecure and not very useful.
37713 .next
37714 Unless the local user mailboxes are all owned by the Exim user (possible in
37715 some POP3 or IMAP-only environments):
37716
37717 .olist
37718 They must be owned by the Exim group and be writeable by that group. This
37719 implies you must set &%mode%& in the appendfile configuration, as well as the
37720 mode of the mailbox files themselves.
37721 .next
37722 You must set &%no_check_owner%&, since most or all of the files will not be
37723 owned by the Exim user.
37724 .next
37725 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37726 on a newly created mailbox when unprivileged. This also implies that new
37727 mailboxes need to be created manually.
37728 .endlist olist
37729 .endlist ilist
37730
37731
37732 These restrictions severely restrict what can be done in local deliveries.
37733 However, there are no restrictions on remote deliveries. If you are running a
37734 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37735 gives more security at essentially no cost.
37736
37737 If you are using the &%mua_wrapper%& facility (see chapter
37738 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37739
37740
37741
37742
37743 .section "Delivering to local files" "SECID271"
37744 Full details of the checks applied by &(appendfile)& before it writes to a file
37745 are given in chapter &<<CHAPappendfile>>&.
37746
37747
37748
37749 .section "Running local commands" "SECTsecconslocalcmds"
37750 .cindex "security" "local commands"
37751 .cindex "security" "command injection attacks"
37752 There are a number of ways in which an administrator can configure Exim to run
37753 commands based upon received, untrustworthy, data. Further, in some
37754 configurations a user who can control a &_.forward_& file can also arrange to
37755 run commands. Configuration to check includes, but is not limited to:
37756
37757 .ilist
37758 Use of &%use_shell%& in the pipe transport: various forms of shell command
37759 injection may be possible with this option present. It is dangerous and should
37760 be used only with considerable caution. Consider constraints which whitelist
37761 allowed characters in a variable which is to be used in a pipe transport that
37762 has &%use_shell%& enabled.
37763 .next
37764 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37765 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37766 &_.forward_& files in a redirect router. If Exim is running on a central mail
37767 hub to which ordinary users do not have shell access, but home directories are
37768 NFS mounted (for instance) then administrators should review the list of these
37769 forbid options available, and should bear in mind that the options that may
37770 need forbidding can change as new features are added between releases.
37771 .next
37772 The &%${run...}%& expansion item does not use a shell by default, but
37773 administrators can configure use of &_/bin/sh_& as part of the command.
37774 Such invocations should be viewed with prejudicial suspicion.
37775 .next
37776 Administrators who use embedded Perl are advised to explore how Perl's
37777 taint checking might apply to their usage.
37778 .next
37779 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37780 administrators are well advised to view its use with suspicion, in case (for
37781 instance) it allows a local-part to contain embedded Exim directives.
37782 .next
37783 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37784 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37785 each can reference arbitrary lists and files, rather than just being a list
37786 of opaque strings.
37787 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37788 real-world security vulnerabilities caused by its use with untrustworthy data
37789 injected in, for SQL injection attacks.
37790 Consider the use of the &%inlisti%& expansion condition instead.
37791 .endlist
37792
37793
37794
37795
37796 .section "Trust in configuration data" "SECTsecconfdata"
37797 .cindex "security" "data sources"
37798 .cindex "security" "regular expressions"
37799 .cindex "regular expressions" "security"
37800 .cindex "PCRE" "security"
37801 If configuration data for Exim can come from untrustworthy sources, there
37802 are some issues to be aware of:
37803
37804 .ilist
37805 Use of &%${expand...}%& may provide a path for shell injection attacks.
37806 .next
37807 Letting untrusted data provide a regular expression is unwise.
37808 .next
37809 Using &%${match...}%& to apply a fixed regular expression against untrusted
37810 data may result in pathological behaviour within PCRE.  Be aware of what
37811 "backtracking" means and consider options for being more strict with a regular
37812 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37813 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37814 possessive quantifiers or just not using regular expressions against untrusted
37815 data.
37816 .next
37817 It can be important to correctly use &%${quote:...}%&,
37818 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37819 items to ensure that data is correctly constructed.
37820 .next
37821 Some lookups might return multiple results, even though normal usage is only
37822 expected to yield one result.
37823 .endlist
37824
37825
37826
37827
37828 .section "IPv4 source routing" "SECID272"
37829 .cindex "source routing" "in IP packets"
37830 .cindex "IP source routing"
37831 Many operating systems suppress IP source-routed packets in the kernel, but
37832 some cannot be made to do this, so Exim does its own check. It logs incoming
37833 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37834 IPv6. No special checking is currently done.
37835
37836
37837
37838 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37839 Support for these SMTP commands is disabled by default. If required, they can
37840 be enabled by defining suitable ACLs.
37841
37842
37843
37844
37845 .section "Privileged users" "SECID274"
37846 .cindex "trusted users"
37847 .cindex "admin user"
37848 .cindex "privileged user"
37849 .cindex "user" "trusted"
37850 .cindex "user" "admin"
37851 Exim recognizes two sets of users with special privileges. Trusted users are
37852 able to submit new messages to Exim locally, but supply their own sender
37853 addresses and information about a sending host. For other users submitting
37854 local messages, Exim sets up the sender address from the uid, and doesn't
37855 permit a remote host to be specified.
37856
37857 .oindex "&%-f%&"
37858 However, an untrusted user is permitted to use the &%-f%& command line option
37859 in the special form &%-f <>%& to indicate that a delivery failure for the
37860 message should not cause an error report. This affects the message's envelope,
37861 but it does not affect the &'Sender:'& header. Untrusted users may also be
37862 permitted to use specific forms of address with the &%-f%& option by setting
37863 the &%untrusted_set_sender%& option.
37864
37865 Trusted users are used to run processes that receive mail messages from some
37866 other mail domain and pass them on to Exim for delivery either locally, or over
37867 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37868 as any user listed in the &%trusted_users%& configuration option, or under any
37869 group listed in the &%trusted_groups%& option.
37870
37871 Admin users are permitted to do things to the messages on Exim's queue. They
37872 can freeze or thaw messages, cause them to be returned to their senders, remove
37873 them entirely, or modify them in various ways. In addition, admin users can run
37874 the Exim monitor and see all the information it is capable of providing, which
37875 includes the contents of files on the spool.
37876
37877 .oindex "&%-M%&"
37878 .oindex "&%-q%&"
37879 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37880 delivery of messages on its queue is restricted to admin users. This
37881 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37882 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37883 queue is also restricted to admin users. This restriction can be relaxed by
37884 setting &%no_queue_list_requires_admin%&.
37885
37886 Exim recognizes an admin user if the calling process is running as root or as
37887 the Exim user or if any of the groups associated with the calling process is
37888 the Exim group. It is not necessary actually to be running under the Exim
37889 group. However, if admin users who are not root or the Exim user are to access
37890 the contents of files on the spool via the Exim monitor (which runs
37891 unprivileged), Exim must be built to allow group read access to its spool
37892 files.
37893
37894
37895
37896 .section "Spool files" "SECID275"
37897 .cindex "spool directory" "files"
37898 Exim's spool directory and everything it contains is owned by the Exim user and
37899 set to the Exim group. The mode for spool files is defined in the
37900 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37901 any user who is a member of the Exim group can access these files.
37902
37903
37904
37905 .section "Use of argv[0]" "SECID276"
37906 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37907 of specific strings, Exim assumes certain options. For example, calling Exim
37908 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37909 to calling it with the option &%-bS%&. There are no security implications in
37910 this.
37911
37912
37913
37914 .section "Use of %f formatting" "SECID277"
37915 The only use made of &"%f"& by Exim is in formatting load average values. These
37916 are actually stored in integer variables as 1000 times the load average.
37917 Consequently, their range is limited and so therefore is the length of the
37918 converted output.
37919
37920
37921
37922 .section "Embedded Exim path" "SECID278"
37923 Exim uses its own path name, which is embedded in the code, only when it needs
37924 to re-exec in order to regain root privilege. Therefore, it is not root when it
37925 does so. If some bug allowed the path to get overwritten, it would lead to an
37926 arbitrary program's being run as exim, not as root.
37927
37928
37929
37930 .section "Dynamic module directory" "SECTdynmoddir"
37931 Any dynamically loadable modules must be installed into the directory
37932 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37933 loading it.
37934
37935
37936 .section "Use of sprintf()" "SECID279"
37937 .cindex "&[sprintf()]&"
37938 A large number of occurrences of &"sprintf"& in the code are actually calls to
37939 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37940 The intermediate formatting is done into a large fixed buffer by a function
37941 that runs through the format string itself, and checks the length of each
37942 conversion before performing it, thus preventing buffer overruns.
37943
37944 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37945 the output buffer is known to be sufficiently long to contain the converted
37946 string.
37947
37948
37949
37950 .section "Use of debug_printf() and log_write()" "SECID280"
37951 Arbitrary strings are passed to both these functions, but they do their
37952 formatting by calling the function &'string_vformat()'&, which runs through
37953 the format string itself, and checks the length of each conversion.
37954
37955
37956
37957 .section "Use of strcat() and strcpy()" "SECID281"
37958 These are used only in cases where the output buffer is known to be large
37959 enough to hold the result.
37960 .ecindex IIDsecurcon
37961
37962
37963
37964
37965 . ////////////////////////////////////////////////////////////////////////////
37966 . ////////////////////////////////////////////////////////////////////////////
37967
37968 .chapter "Format of spool files" "CHAPspool"
37969 .scindex IIDforspo1 "format" "spool files"
37970 .scindex IIDforspo2 "spool directory" "format of files"
37971 .scindex IIDforspo3 "spool files" "format of"
37972 .cindex "spool files" "editing"
37973 A message on Exim's queue consists of two files, whose names are the message id
37974 followed by -D and -H, respectively. The data portion of the message is kept in
37975 the -D file on its own. The message's envelope, status, and headers are all
37976 kept in the -H file, whose format is described in this chapter. Each of these
37977 two files contains the final component of its own name as its first line. This
37978 is insurance against disk crashes where the directory is lost but the files
37979 themselves are recoverable.
37980
37981 Some people are tempted into editing -D files in order to modify messages. You
37982 need to be extremely careful if you do this; it is not recommended and you are
37983 on your own if you do it. Here are some of the pitfalls:
37984
37985 .ilist
37986 You must ensure that Exim does not try to deliver the message while you are
37987 fiddling with it. The safest way is to take out a write lock on the -D file,
37988 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37989 place, the lock will be retained. If you write a new file and rename it, the
37990 lock will be lost at the instant of rename.
37991 .next
37992 .vindex "&$body_linecount$&"
37993 If you change the number of lines in the file, the value of
37994 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
37995 cause incomplete transmission of messages or undeliverable messages.
37996 .next
37997 If the message is in MIME format, you must take care not to break it.
37998 .next
37999 If the message is cryptographically signed, any change will invalidate the
38000 signature.
38001 .endlist
38002 All in all, modifying -D files is fraught with danger.
38003
38004 Files whose names end with -J may also be seen in the &_input_& directory (or
38005 its subdirectories when &%split_spool_directory%& is set). These are journal
38006 files, used to record addresses to which the message has been delivered during
38007 the course of a delivery attempt. If there are still undelivered recipients at
38008 the end, the -H file is updated, and the -J file is deleted. If, however, there
38009 is some kind of crash (for example, a power outage) before this happens, the -J
38010 file remains in existence. When Exim next processes the message, it notices the
38011 -J file and uses it to update the -H file before starting the next delivery
38012 attempt.
38013
38014 .section "Format of the -H file" "SECID282"
38015 .cindex "uid (user id)" "in spool file"
38016 .cindex "gid (group id)" "in spool file"
38017 The second line of the -H file contains the login name for the uid of the
38018 process that called Exim to read the message, followed by the numerical uid and
38019 gid. For a locally generated message, this is normally the user who sent the
38020 message. For a message received over TCP/IP via the daemon, it is
38021 normally the Exim user.
38022
38023 The third line of the file contains the address of the message's sender as
38024 transmitted in the envelope, contained in angle brackets. The sender address is
38025 empty for bounce messages. For incoming SMTP mail, the sender address is given
38026 in the MAIL command. For locally generated mail, the sender address is
38027 created by Exim from the login name of the current user and the configured
38028 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38029 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38030 &"<>"& or an address that matches &%untrusted_set_senders%&.
38031
38032 The fourth line contains two numbers. The first is the time that the message
38033 was received, in the conventional Unix form &-- the number of seconds since the
38034 start of the epoch. The second number is a count of the number of messages
38035 warning of delayed delivery that have been sent to the sender.
38036
38037 There follow a number of lines starting with a hyphen. These can appear in any
38038 order, and are omitted when not relevant:
38039
38040 .vlist
38041 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38042 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38043 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38044 recognized, to provide backward compatibility. In the old format, a line of
38045 this form is present for every ACL variable that is not empty. The number
38046 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38047 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38048 the data string for the variable. The string itself starts at the beginning of
38049 the next line, and is followed by a newline character. It may contain internal
38050 newlines.
38051
38052 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38053 A line of this form is present for every ACL connection variable that is
38054 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38055 The length is the length of the data string for the variable. The string itself
38056 starts at the beginning of the next line, and is followed by a newline
38057 character. It may contain internal newlines.
38058
38059 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38060 A line of this form is present for every ACL message variable that is defined.
38061 Note that there is a space between &%-aclm%& and the rest of the name. The
38062 length is the length of the data string for the variable. The string itself
38063 starts at the beginning of the next line, and is followed by a newline
38064 character. It may contain internal newlines.
38065
38066 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38067 This is present if, when the message was received over SMTP, the value of
38068 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38069
38070 .vitem &%-allow_unqualified_recipient%&
38071 This is present if unqualified recipient addresses are permitted in header
38072 lines (to stop such addresses from being qualified if rewriting occurs at
38073 transport time). Local messages that were input using &%-bnq%& and remote
38074 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38075
38076 .vitem &%-allow_unqualified_sender%&
38077 This is present if unqualified sender addresses are permitted in header lines
38078 (to stop such addresses from being qualified if rewriting occurs at transport
38079 time). Local messages that were input using &%-bnq%& and remote messages from
38080 hosts that match &%sender_unqualified_hosts%& set this flag.
38081
38082 .vitem "&%-auth_id%&&~<&'text'&>"
38083 The id information for a message received on an authenticated SMTP connection
38084 &-- the value of the &$authenticated_id$& variable.
38085
38086 .vitem "&%-auth_sender%&&~<&'address'&>"
38087 The address of an authenticated sender &-- the value of the
38088 &$authenticated_sender$& variable.
38089
38090 .vitem "&%-body_linecount%&&~<&'number'&>"
38091 This records the number of lines in the body of the message, and is always
38092 present.
38093
38094 .vitem "&%-body_zerocount%&&~<&'number'&>"
38095 This records the number of binary zero bytes in the body of the message, and is
38096 present if the number is greater than zero.
38097
38098 .vitem &%-deliver_firsttime%&
38099 This is written when a new message is first added to the spool. When the spool
38100 file is updated after a deferral, it is omitted.
38101
38102 .vitem "&%-frozen%&&~<&'time'&>"
38103 .cindex "frozen messages" "spool data"
38104 The message is frozen, and the freezing happened at <&'time'&>.
38105
38106 .vitem "&%-helo_name%&&~<&'text'&>"
38107 This records the host name as specified by a remote host in a HELO or EHLO
38108 command.
38109
38110 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38111 This records the IP address of the host from which the message was received and
38112 the remote port number that was used. It is omitted for locally generated
38113 messages.
38114
38115 .vitem "&%-host_auth%&&~<&'text'&>"
38116 If the message was received on an authenticated SMTP connection, this records
38117 the name of the authenticator &-- the value of the
38118 &$sender_host_authenticated$& variable.
38119
38120 .vitem &%-host_lookup_failed%&
38121 This is present if an attempt to look up the sending host's name from its IP
38122 address failed. It corresponds to the &$host_lookup_failed$& variable.
38123
38124 .vitem "&%-host_name%&&~<&'text'&>"
38125 .cindex "reverse DNS lookup"
38126 .cindex "DNS" "reverse lookup"
38127 This records the name of the remote host from which the message was received,
38128 if the host name was looked up from the IP address when the message was being
38129 received. It is not present if no reverse lookup was done.
38130
38131 .vitem "&%-ident%&&~<&'text'&>"
38132 For locally submitted messages, this records the login of the originating user,
38133 unless it was a trusted user and the &%-oMt%& option was used to specify an
38134 ident value. For messages received over TCP/IP, this records the ident string
38135 supplied by the remote host, if any.
38136
38137 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38138 This records the IP address of the local interface and the port number through
38139 which a message was received from a remote host. It is omitted for locally
38140 generated messages.
38141
38142 .vitem &%-local%&
38143 The message is from a local sender.
38144
38145 .vitem &%-localerror%&
38146 The message is a locally-generated bounce message.
38147
38148 .vitem "&%-local_scan%&&~<&'string'&>"
38149 This records the data string that was returned by the &[local_scan()]& function
38150 when the message was received &-- the value of the &$local_scan_data$&
38151 variable. It is omitted if no data was returned.
38152
38153 .vitem &%-manual_thaw%&
38154 The message was frozen but has been thawed manually, that is, by an explicit
38155 Exim command rather than via the auto-thaw process.
38156
38157 .vitem &%-N%&
38158 A testing delivery process was started using the &%-N%& option to suppress any
38159 actual deliveries, but delivery was deferred. At any further delivery attempts,
38160 &%-N%& is assumed.
38161
38162 .vitem &%-received_protocol%&
38163 This records the value of the &$received_protocol$& variable, which contains
38164 the name of the protocol by which the message was received.
38165
38166 .vitem &%-sender_set_untrusted%&
38167 The envelope sender of this message was set by an untrusted local caller (used
38168 to ensure that the caller is displayed in queue listings).
38169
38170 .vitem "&%-spam_score_int%&&~<&'number'&>"
38171 If a message was scanned by SpamAssassin, this is present. It records the value
38172 of &$spam_score_int$&.
38173
38174 .vitem &%-tls_certificate_verified%&
38175 A TLS certificate was received from the client that sent this message, and the
38176 certificate was verified by the server.
38177
38178 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38179 When the message was received over an encrypted connection, this records the
38180 name of the cipher suite that was used.
38181
38182 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38183 When the message was received over an encrypted connection, and a certificate
38184 was received from the client, this records the Distinguished Name from that
38185 certificate.
38186 .endlist
38187
38188 Following the options there is a list of those addresses to which the message
38189 is not to be delivered. This set of addresses is initialized from the command
38190 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38191 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38192 the address is added to this set. The addresses are kept internally as a
38193 balanced binary tree, and it is a representation of that tree which is written
38194 to the spool file. If an address is expanded via an alias or forward file, the
38195 original address is added to the tree when deliveries to all its child
38196 addresses are complete.
38197
38198 If the tree is empty, there is a single line in the spool file containing just
38199 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38200 Y or N, followed by an address. The address is the value for the node of the
38201 tree, and the letters indicate whether the node has a left branch and/or a
38202 right branch attached to it, respectively. If branches exist, they immediately
38203 follow. Here is an example of a three-node tree:
38204 .code
38205 YY darcy@austen.fict.example
38206 NN alice@wonderland.fict.example
38207 NN editor@thesaurus.ref.example
38208 .endd
38209 After the non-recipients tree, there is a list of the message's recipients.
38210 This is a simple list, preceded by a count. It includes all the original
38211 recipients of the message, including those to whom the message has already been
38212 delivered. In the simplest case, the list contains one address per line. For
38213 example:
38214 .code
38215 4
38216 editor@thesaurus.ref.example
38217 darcy@austen.fict.example
38218 rdo@foundation
38219 alice@wonderland.fict.example
38220 .endd
38221 However, when a child address has been added to the top-level addresses as a
38222 result of the use of the &%one_time%& option on a &(redirect)& router, each
38223 line is of the following form:
38224 .display
38225 <&'top-level address'&> <&'errors_to address'&> &&&
38226   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38227 .endd
38228 The 01 flag bit indicates the presence of the three other fields that follow
38229 the top-level address. Other bits may be used in future to support additional
38230 fields. The <&'parent number'&> is the offset in the recipients list of the
38231 original parent of the &"one time"& address. The first two fields are the
38232 envelope sender that is associated with this address and its length. If the
38233 length is zero, there is no special envelope sender (there are then two space
38234 characters in the line). A non-empty field can arise from a &(redirect)& router
38235 that has an &%errors_to%& setting.
38236
38237
38238 A blank line separates the envelope and status information from the headers
38239 which follow. A header may occupy several lines of the file, and to save effort
38240 when reading it in, each header is preceded by a number and an identifying
38241 character. The number is the number of characters in the header, including any
38242 embedded newlines and the terminating newline. The character is one of the
38243 following:
38244
38245 .table2 50pt
38246 .row <&'blank'&>         "header in which Exim has no special interest"
38247 .row &`B`&               "&'Bcc:'& header"
38248 .row &`C`&               "&'Cc:'& header"
38249 .row &`F`&               "&'From:'& header"
38250 .row &`I`&               "&'Message-id:'& header"
38251 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38252 .row &`R`&               "&'Reply-To:'& header"
38253 .row &`S`&               "&'Sender:'& header"
38254 .row &`T`&               "&'To:'& header"
38255 .row &`*`&               "replaced or deleted header"
38256 .endtable
38257
38258 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38259 purposes. They are not transmitted when the message is delivered. Here is a
38260 typical set of headers:
38261 .code
38262 111P Received: by hobbit.fict.example with local (Exim 4.00)
38263 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38264 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38265 038* X-rewrote-sender: bb@hobbit.fict.example
38266 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38267 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38268 099* To: alice@wonderland.fict.example, rdo@foundation,
38269 darcy@austen.fict.example, editor@thesaurus.ref.example
38270 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38271 darcy@austen.fict.example, editor@thesaurus.ref.example
38272 038  Date: Fri, 11 May 2001 10:28:59 +0100
38273 .endd
38274 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38275 &'To:'& header have been rewritten, the last one because routing expanded the
38276 unqualified domain &'foundation'&.
38277 .ecindex IIDforspo1
38278 .ecindex IIDforspo2
38279 .ecindex IIDforspo3
38280
38281 . ////////////////////////////////////////////////////////////////////////////
38282 . ////////////////////////////////////////////////////////////////////////////
38283
38284 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38285          "DKIM Support"
38286 .cindex "DKIM"
38287
38288 DKIM is a mechanism by which messages sent by some entity can be provably
38289 linked to a domain which that entity controls.  It permits reputation to
38290 be tracked on a per-domain basis, rather than merely upon source IP address.
38291 DKIM is documented in RFC 4871.
38292
38293 DKIM support is compiled into Exim by default if TLS support is present.
38294 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38295
38296 Exim's DKIM implementation allows for
38297 .olist
38298 Signing outgoing messages: This function is implemented in the SMTP transport.
38299 It can co-exist with all other Exim features
38300 (including transport filters)
38301 except cutthrough delivery.
38302 .next
38303 Verifying signatures in incoming messages: This is implemented by an additional
38304 ACL (acl_smtp_dkim), which can be called several times per message, with
38305 different signature contexts.
38306 .endlist
38307
38308 In typical Exim style, the verification implementation does not include any
38309 default "policy". Instead it enables you to build your own policy using
38310 Exim's standard controls.
38311
38312 Please note that verification of DKIM signatures in incoming mail is turned
38313 on by default for logging purposes. For each signature in incoming email,
38314 exim will log a line displaying the most important signature details, and the
38315 signature status. Here is an example (with line-breaks added for clarity):
38316 .code
38317 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38318     d=facebookmail.com s=q1-2009b
38319     c=relaxed/relaxed a=rsa-sha1
38320     i=@facebookmail.com t=1252484542 [verification succeeded]
38321 .endd
38322 You might want to turn off DKIM verification processing entirely for internal
38323 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38324 control modifier. This should typically be done in the RCPT ACL, at points
38325 where you accept mail from relay sources (internal hosts or authenticated
38326 senders).
38327
38328
38329 .section "Signing outgoing messages" "SECDKIMSIGN"
38330 .cindex "DKIM" "signing"
38331
38332 Signing is enabled by setting private options on the SMTP transport.
38333 These options take (expandable) strings as arguments.
38334
38335 .option dkim_domain smtp string&!! unset
38336 MANDATORY:
38337 The domain you want to sign with. The result of this expanded
38338 option is put into the &%$dkim_domain%& expansion variable.
38339 If it is empty after expansion, DKIM signing is not done.
38340
38341 .option dkim_selector smtp string&!! unset
38342 MANDATORY:
38343 This sets the key selector string. You can use the &%$dkim_domain%& expansion
38344 variable to look up a matching selector. The result is put in the expansion
38345 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38346 option along with &%$dkim_domain%&.
38347
38348 .option dkim_private_key smtp string&!! unset
38349 MANDATORY:
38350 This sets the private key to use. You can use the &%$dkim_domain%& and
38351 &%$dkim_selector%& expansion variables to determine the private key to use.
38352 The result can either
38353 .ilist
38354 be a valid RSA private key in ASCII armor, including line breaks.
38355 .next
38356 start with a slash, in which case it is treated as a file that contains
38357 the private key.
38358 .next
38359 be "0", "false" or the empty string, in which case the message will not
38360 be signed. This case will not result in an error, even if &%dkim_strict%&
38361 is set.
38362 .endlist
38363
38364 .option dkim_canon smtp string&!! unset
38365 OPTIONAL:
38366 This option sets the canonicalization method used when signing a message.
38367 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38368 The option defaults to "relaxed" when unset. Note: the current implementation
38369 only supports using the same canonicalization method for both headers and body.
38370
38371 .option dkim_strict smtp string&!! unset
38372 OPTIONAL:
38373 This  option  defines  how  Exim  behaves  when  signing a message that
38374 should be signed fails for some reason.  When the expansion evaluates to
38375 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38376 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38377 variables here.
38378
38379 .option dkim_sign_headers smtp string&!! unset
38380 OPTIONAL:
38381 When set, this option must expand to (or be specified as) a colon-separated
38382 list of header names. Headers with these names will be included in the message
38383 signature. When unspecified, the header names recommended in RFC4871 will be
38384 used.
38385
38386
38387 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38388 .cindex "DKIM" "verification"
38389
38390 Verification of DKIM signatures in SMTP incoming email is implemented via the
38391 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38392 syntactically(!) correct signature in the incoming message.
38393 A missing ACL definition defaults to accept.
38394 If any ACL call does not accept, the message is not accepted.
38395 If a cutthrough delivery was in progress for the message it is
38396 summarily dropped (having wasted the transmission effort).
38397
38398 To evaluate the signature in the ACL a large number of expansion variables
38399 containing the signature status and its details are set up during the
38400 runtime of the ACL.
38401
38402 Calling the ACL only for existing signatures is not sufficient to build
38403 more advanced policies. For that reason, the global option
38404 &%dkim_verify_signers%&, and a global expansion variable
38405 &%$dkim_signers%& exist.
38406
38407 The global option &%dkim_verify_signers%& can be set to a colon-separated
38408 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38409 called. It is expanded when the message has been received. At this point,
38410 the expansion variable &%$dkim_signers%& already contains a colon-separated
38411 list of signer domains and identities for the message. When
38412 &%dkim_verify_signers%& is not specified in the main configuration,
38413 it defaults as:
38414 .code
38415 dkim_verify_signers = $dkim_signers
38416 .endd
38417 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38418 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38419 call the ACL for known domains or identities. This would be achieved as follows:
38420 .code
38421 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38422 .endd
38423 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38424 and "ebay.com", plus all domains and identities that have signatures in the message.
38425 You can also be more creative in constructing your policy. For example:
38426 .code
38427 dkim_verify_signers = $sender_address_domain:$dkim_signers
38428 .endd
38429
38430 If a domain or identity is listed several times in the (expanded) value of
38431 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38432
38433
38434 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38435 available (from most to least important):
38436
38437
38438 .vlist
38439 .vitem &%$dkim_cur_signer%&
38440 The signer that is being evaluated in this ACL run. This can be a domain or
38441 an identity. This is one of the list items from the expanded main option
38442 &%dkim_verify_signers%& (see above).
38443
38444 .vitem &%$dkim_verify_status%&
38445 A string describing the general status of the signature. One of
38446 .ilist
38447 &%none%&: There is no signature in the message for the current domain or
38448 identity (as reflected by &%$dkim_cur_signer%&).
38449 .next
38450 &%invalid%&: The signature could not be verified due to a processing error.
38451 More detail is available in &%$dkim_verify_reason%&.
38452 .next
38453 &%fail%&: Verification of the signature failed.  More detail is
38454 available in &%$dkim_verify_reason%&.
38455 .next
38456 &%pass%&: The signature passed verification. It is valid.
38457 .endlist
38458
38459 .vitem &%$dkim_verify_reason%&
38460 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38461 "fail" or "invalid". One of
38462 .ilist
38463 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38464 key for the domain could not be retrieved. This may be a temporary problem.
38465 .next
38466 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38467 record for the domain is syntactically invalid.
38468 .next
38469 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38470 body hash does not match the one specified in the signature header. This
38471 means that the message body was modified in transit.
38472 .next
38473 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38474 could not be verified. This may mean that headers were modified,
38475 re-written or otherwise changed in a way which is incompatible with
38476 DKIM verification. It may of course also mean that the signature is forged.
38477 .endlist
38478
38479 .vitem &%$dkim_domain%&
38480 The signing domain. IMPORTANT: This variable is only populated if there is
38481 an actual signature in the message for the current domain or identity (as
38482 reflected by &%$dkim_cur_signer%&).
38483
38484 .vitem &%$dkim_identity%&
38485 The signing identity, if present. IMPORTANT: This variable is only populated
38486 if there is an actual signature in the message for the current domain or
38487 identity (as reflected by &%$dkim_cur_signer%&).
38488
38489 .vitem &%$dkim_selector%&
38490 The key record selector string.
38491
38492 .vitem &%$dkim_algo%&
38493 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38494
38495 .vitem &%$dkim_canon_body%&
38496 The body canonicalization method. One of 'relaxed' or 'simple'.
38497
38498 .vitem &%dkim_canon_headers%&
38499 The header canonicalization method. One of 'relaxed' or 'simple'.
38500
38501 .vitem &%$dkim_copiedheaders%&
38502 A transcript of headers and their values which are included in the signature
38503 (copied from the 'z=' tag of the signature).
38504 .new
38505 Note that RFC6376 requires that verification fail if the From: header is
38506 not included in the signature.  Exim does not enforce this; sites wishing
38507 strict enforcement should code the check explicitly.
38508 .wen
38509
38510 .vitem &%$dkim_bodylength%&
38511 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38512 limit was set by the signer, "9999999999999" is returned. This makes sure
38513 that this variable always expands to an integer value.
38514
38515 .vitem &%$dkim_created%&
38516 UNIX timestamp reflecting the date and time when the signature was created.
38517 When this was not specified by the signer, "0" is returned.
38518
38519 .vitem &%$dkim_expires%&
38520 UNIX timestamp reflecting the date and time when the signer wants the
38521 signature to be treated as "expired". When this was not specified by the
38522 signer, "9999999999999" is returned. This makes it possible to do useful
38523 integer size comparisons against this value.
38524
38525 .vitem &%$dkim_headernames%&
38526 A colon-separated list of names of headers included in the signature.
38527
38528 .vitem &%$dkim_key_testing%&
38529 "1" if the key record has the "testing" flag set, "0" if not.
38530
38531 .vitem &%$dkim_key_nosubdomains%&
38532 "1" if the key record forbids subdomaining, "0" otherwise.
38533
38534 .vitem &%$dkim_key_srvtype%&
38535 Service type (tag s=) from the key record. Defaults to "*" if not specified
38536 in the key record.
38537
38538 .vitem &%$dkim_key_granularity%&
38539 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38540 in the key record.
38541
38542 .vitem &%$dkim_key_notes%&
38543 Notes from the key record (tag n=).
38544
38545 .vitem &%$dkim_key_length%&
38546 Number of bits in the key.
38547 .endlist
38548
38549 In addition, two ACL conditions are provided:
38550
38551 .vlist
38552 .vitem &%dkim_signers%&
38553 ACL condition that checks a colon-separated list of domains or identities
38554 for a match against the domain or identity that the ACL is currently verifying
38555 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38556 verb to a group of domains or identities. For example:
38557
38558 .code
38559 # Warn when Mail purportedly from GMail has no gmail signature
38560 warn log_message = GMail sender without gmail.com DKIM signature
38561      sender_domains = gmail.com
38562      dkim_signers = gmail.com
38563      dkim_status = none
38564 .endd
38565
38566 .new
38567 Note that the above does not check for a total lack of DKIM signing;
38568 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38569 .wen
38570
38571 .vitem &%dkim_status%&
38572 ACL condition that checks a colon-separated list of possible DKIM verification
38573 results against the actual result of verification. This is typically used
38574 to restrict an ACL verb to a list of verification outcomes, for example:
38575
38576 .code
38577 deny message = Mail from Paypal with invalid/missing signature
38578      sender_domains = paypal.com:paypal.de
38579      dkim_signers = paypal.com:paypal.de
38580      dkim_status = none:invalid:fail
38581 .endd
38582
38583 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38584 see the documentation of the &%$dkim_verify_status%& expansion variable above
38585 for more information of what they mean.
38586 .endlist
38587
38588 . ////////////////////////////////////////////////////////////////////////////
38589 . ////////////////////////////////////////////////////////////////////////////
38590
38591 .chapter "Proxies" "CHAPproxies" &&&
38592          "Proxy support"
38593 .cindex "proxy support"
38594 .cindex "proxy" "access via"
38595
38596 A proxy is an intermediate system through which communication is passed.
38597 Proxies may provide a security, availability or load-distribution function.
38598
38599
38600 .section "Inbound proxies" SECTproxyInbound
38601 .cindex proxy inbound
38602 .cindex proxy "server side"
38603 .cindex proxy "Proxy protocol"
38604 .cindex "Proxy protocol" proxy
38605
38606 Exim has support for receiving inbound SMTP connections via a proxy
38607 that uses &"Proxy Protocol"& to speak to it.
38608 To include this support, include &"SUPPORT_PROXY=yes"&
38609 in Local/Makefile.
38610
38611 It was built on specifications from:
38612 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
38613 That URL was revised in May 2014 to version 2 spec:
38614 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
38615
38616 The purpose of this facility is so that an application load balancer,
38617 such as HAProxy, can sit in front of several Exim servers
38618 to distribute load.
38619 Exim uses the local protocol communication with the proxy to obtain
38620 the remote SMTP system IP address and port information.
38621 There is no logging if a host passes or
38622 fails Proxy Protocol negotiation, but it can easily be determined and
38623 recorded in an ACL (example is below).
38624
38625 Use of a proxy is enabled by setting the &%hosts_proxy%&
38626 main configuration option to a hostlist; connections from these
38627 hosts will use Proxy Protocol.
38628
38629 .new
38630 The following expansion variables are usable
38631 (&"internal"& and &"external"& here refer to the interfaces
38632 of the proxy):
38633 .display
38634 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38635 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38636 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38637 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38638 &'proxy_session        '& boolean: SMTP connection via proxy
38639 .endd
38640 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38641 there was a protocol error.
38642 .wen
38643
38644 Since the real connections are all coming from the proxy, and the
38645 per host connection tracking is done before Proxy Protocol is
38646 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38647 handle all of the parallel volume you expect per inbound proxy.
38648 With the option set so high, you lose the ability
38649 to protect your server from many connections from one IP.
38650 In order to prevent your server from overload, you
38651 need to add a per connection ratelimit to your connect ACL.
38652 A possible solution is:
38653 .display
38654   # Set max number of connections per host
38655   LIMIT   = 5
38656   # Or do some kind of IP lookup in a flat file or database
38657   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38658
38659   defer   message        = Too many connections from this IP right now
38660           ratelimit      = LIMIT / 5s / per_conn / strict
38661 .endd
38662
38663
38664
38665 .section "Outbound proxies" SECTproxySOCKS
38666 .cindex proxy outbound
38667 .cindex proxy "client side"
38668 .cindex proxy SOCKS
38669 .cindex SOCKS proxy
38670 Exim has support for sending outbound SMTP via a proxy
38671 using a protocol called SOCKS5 (defined by RFC1928).
38672 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38673 Local/Makefile.
38674
38675 Use of a proxy is enabled by setting the &%socks_proxy%& option
38676 on an smtp transport.
38677 The option value is expanded and should then be a list
38678 (colon-separated by default) of proxy specifiers.
38679 Each proxy specifier is a list
38680 (space-separated by default) where the initial element
38681 is an IP address and any subsequent elements are options.
38682
38683 Options are a string <name>=<value>.
38684 The list of options is in the following table:
38685 .display
38686 &'auth   '& authentication method
38687 &'name   '& authentication username
38688 &'pass   '& authentication password
38689 &'port   '& tcp port
38690 &'tmo    '& connection timeout
38691 &'pri    '& priority
38692 &'weight '& selection bias
38693 .endd
38694
38695 More details on each of these options follows:
38696
38697 .ilist
38698 .cindex authentication "to proxy"
38699 .cindex proxy authentication
38700 &%auth%&: Either &"none"& (default) or &"name"&.
38701 Using &"name"& selects username/password authentication per RFC 1929
38702 for access to the proxy.
38703 Default is &"none"&.
38704 .next
38705 &%name%&: sets the username for the &"name"& authentication method.
38706 Default is empty.
38707 .next
38708 &%pass%&: sets the password for the &"name"& authentication method.
38709 Default is empty.
38710 .next
38711 &%port%&: the TCP port number to use for the connection to the proxy.
38712 Default is 1080.
38713 .next
38714 &%tmo%&: sets a connection timeout in seconds for this proxy.
38715 Default is 5.
38716 .next
38717 &%pri%&: specifies a priority for the proxy within the list,
38718 higher values being tried first.
38719 The default priority is 1.
38720 .next
38721 &%weight%&: specifies a selection bias.
38722 Within a priority set servers are queried in a random fashion,
38723 weighted by this value.
38724 The default value for selection bias is 1.
38725 .endlist
38726
38727 Proxies from the list are tried according to their priority
38728 and weight settings until one responds.  The timeout for the
38729 overall connection applies to the set of proxied attempts.
38730
38731 .section Logging SECTproxyLog
38732 To log the (local) IP of a proxy in the incoming or delivery logline,
38733 add &"+proxy"& to the &%log_selector%& option.
38734 This will add a component tagged with &"PRX="& to the line.
38735
38736 . ////////////////////////////////////////////////////////////////////////////
38737 . ////////////////////////////////////////////////////////////////////////////
38738
38739 .chapter "Internationalisation" "CHAPi18n" &&&
38740          "Internationalisation""
38741 .cindex internationalisation "email address"
38742 .cindex EAI
38743 .cindex i18n
38744 .cindex UTF-8 "mail name handling"
38745
38746 Exim has support for Internationalised mail names.
38747 To include this it must be built with SUPPORT_I18N and the libidn library.
38748 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38749
38750 .new
38751 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
38752 instead of it) then IDNA2008 is supported; this adds an extra library
38753 requirement, upon libidn2.
38754 .wen
38755
38756 .section "MTA operations" SECTi18nMTA
38757 .cindex SMTPUTF8 "ESMTP option"
38758 The main configuration option &%smtputf8_advertise_hosts%& specifies
38759 a host list.  If this matches the sending host and
38760 accept_8bitmime is true (the default) then the ESMTP option
38761 SMTPUTF8 will be advertised.
38762
38763 If the sender specifies the SMTPUTF8 option on a MAIL command
38764 international handling for the message is enabled and
38765 the expansion variable &$message_smtputf8$& will have value TRUE.
38766
38767 The option &%allow_utf8_domains%& is set to true for this
38768 message. All DNS lookups are converted to a-label form
38769 whatever the setting of &%allow_utf8_domains%&
38770 when Exim is built with SUPPORT_I18N.
38771
38772 Both localparts and domain are maintained as the original
38773 UTF-8 form internally; any comparison or regular-expression use will
38774 require appropriate care.  Filenames created, eg. by
38775 the appendfile transport, will have UTF-8 names.
38776
38777 HELO names sent by the smtp transport will have any UTF-8
38778 components expanded to a-label form,
38779 and any certificate name checks will be done using the a-label
38780 form of the name.
38781
38782 .cindex log protocol
38783 .cindex SMTPUTF8 logging
38784 Log lines and Received-by: header lines will acquire a "utf8"
38785 prefix on the protocol element, eg. utf8esmtp.
38786
38787 The following expansion operators can be used:
38788 .code
38789 ${utf8_domain_to_alabel:str}
38790 ${utf8_domain_from_alabel:str}
38791 ${utf8_localpart_to_alabel:str}
38792 ${utf8_localpart_from_alabel:str}
38793 .endd
38794
38795 ACLs may use the following modifier:
38796 .display
38797 control = utf8_downconvert
38798 control = utf8_downconvert/<value>
38799 .endd
38800 This sets a flag requiring that addresses are converted to
38801 a-label form before smtp delivery, for use in a
38802 Message Submission Agent context.
38803 If a value is appended it may be:
38804 .display
38805 &`1  `& (default) mandatory downconversion
38806 &`0  `& no downconversion
38807 &`-1 `& if SMTPUTF8 not supported by destination host
38808 .endd
38809
38810 If mua_wrapper is set, the utf8_downconvert control
38811 is initially set to -1.
38812
38813
38814 There is no explicit support for VRFY and EXPN.
38815 Configurations supporting these should inspect
38816 &$smtp_command_argument$& for an SMTPUTF8 argument.
38817
38818 There is no support for LMTP on Unix sockets.
38819 Using the "lmtp" protocol option on an smtp transport,
38820 for LMTP over TCP, should work as expected.
38821
38822 There is no support for DSN unitext handling,
38823 and no provision for converting logging from or to UTF-8.
38824
38825
38826
38827 .section "MDA operations" SECTi18nMDA
38828 To aid in constructing names suitable for IMAP folders
38829 the following expansion operator can be used:
38830 .code
38831 ${imapfolder {<string>} {<sep>} {<specials>}}
38832 .endd
38833
38834 The string is converted from the charset specified by
38835 the "headers charset" command (in a filter file)
38836 or &%headers_charset%& main configuration option (otherwise),
38837 to the
38838 modified UTF-7 encoding specified by RFC 2060,
38839 with the following exception: All occurences of <sep>
38840 (which has to be a single character)
38841 are replaced with periods ("."), and all periods and slashes that are not
38842 <sep> and are not in the <specials> string are BASE64 encoded.
38843
38844 The third argument can be omitted, defaulting to an empty string.
38845 The second argument can be omitted, defaulting to "/".
38846
38847 This is the encoding used by Courier for Maildir names on disk, and followed
38848 by many other IMAP servers.
38849
38850 Examples:
38851 .display
38852 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38853 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38854 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38855 .endd
38856
38857 Note that the source charset setting is vital, and also that characters
38858 must be representable in UTF-16.
38859
38860
38861 . ////////////////////////////////////////////////////////////////////////////
38862 . ////////////////////////////////////////////////////////////////////////////
38863
38864 .chapter "Events" "CHAPevents" &&&
38865          "Events"
38866 .cindex events
38867
38868 The events mechanism in Exim can be used to intercept processing at a number
38869 of points.  It was originally invented to give a way to do customised logging
38870 actions (for example, to a database) but can also be used to modify some
38871 processing actions.
38872
38873 Most installations will never need to use Events.
38874 The support can be left out of a build by defining DISABLE_EVENT=yes
38875 in &_Local/Makefile_&.
38876
38877 There are two major classes of events: main and transport.
38878 The main configuration option &%event_action%& controls reception events;
38879 a transport option &%event_action%& controls delivery events.
38880
38881 Both options are a string which is expanded when the event fires.
38882 An example might look like:
38883 .cindex logging custom
38884 .code
38885 event_action = ${if eq {msg:delivery}{$event_name} \
38886 {${lookup pgsql {SELECT * FROM record_Delivery( \
38887     '${quote_pgsql:$sender_address_domain}',\
38888     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38889     '${quote_pgsql:$domain}', \
38890     '${quote_pgsql:${lc:$local_part}}', \
38891     '${quote_pgsql:$host_address}', \
38892     '${quote_pgsql:${lc:$host}}', \
38893     '${quote_pgsql:$message_exim_id}')}} \
38894 } {}}
38895 .endd
38896
38897 Events have names which correspond to the point in process at which they fire.
38898 The name is placed in the variable &$event_name$& and the event action
38899 expansion must check this, as it will be called for every possible event type.
38900
38901 The current list of events is:
38902 .display
38903 &`msg:complete           after    main       `& per message
38904 &`msg:delivery           after    transport  `& per recipient
38905 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38906 &`msg:rcpt:defer         after    transport  `& per recipient
38907 &`msg:host:defer         after    transport  `& per attempt
38908 &`msg:fail:delivery      after    main       `& per recipient
38909 &`msg:fail:internal      after    main       `& per recipient
38910 &`tcp:connect            before   transport  `& per connection
38911 &`tcp:close              after    transport  `& per connection
38912 &`tls:cert               before   both       `& per certificate in verification chain
38913 &`smtp:connect           after    transport  `& per connection
38914 .endd
38915 New event types may be added in future.
38916
38917 The event name is a colon-separated list, defining the type of
38918 event in a tree of possibilities.  It may be used as a list
38919 or just matched on as a whole.  There will be no spaces in the name.
38920
38921 The second column in the table above describes whether the event fires
38922 before or after the action is associates with.  Those which fire before
38923 can be used to affect that action (more on this below).
38924
38925 An additional variable, &$event_data$&, is filled with information varying
38926 with the event type:
38927 .display
38928 &`msg:delivery         `& smtp confirmation message
38929 &`msg:rcpt:host:defer  `& error string
38930 &`msg:rcpt:defer       `& error string
38931 &`msg:host:defer       `& error string
38932 &`tls:cert             `& verification chain depth
38933 &`smtp:connect         `& smtp banner
38934 .endd
38935
38936 The :defer events populate one extra variable: &$event_defer_errno$&.
38937
38938 For complex operations an ACL expansion can be used in &%event_action%&
38939 however due to the multiple contexts that Exim operates in during
38940 the course of its processing:
38941 .ilist
38942 variables set in transport events will not be visible outside that
38943 transport call
38944 .next
38945 acl_m variables in a server context are lost on a new connection,
38946 and after smtp helo/ehlo/mail/starttls/rset commands
38947 .endlist
38948 Using an ACL expansion with the logwrite modifier can be
38949 a useful way of writing to the main log.
38950
38951 The expansion of the event_action option should normally
38952 return an empty string.  Should it return anything else the
38953 following will be forced:
38954 .display
38955 &`msg:delivery     `&  (ignored)
38956 &`msg:host:defer   `&  (ignored)
38957 &`msg:fail:delivery`&  (ignored)
38958 &`tcp:connect      `&  do not connect
38959 &`tcp:close        `&  (ignored)
38960 &`tls:cert         `&  refuse verification
38961 &`smtp:connect     `&  close connection
38962 .endd
38963 No other use is made of the result string.
38964
38965 For a tcp:connect event, if the connection is being made to a proxy
38966 then the address and port variables will be that of the proxy and not
38967 the target system.
38968
38969 For tls:cert events, if GnuTLS is in use this will trigger only per
38970 chain element received on the connection.
38971 For OpenSSL it will trigger for every chain element including those
38972 loaded locally.
38973
38974 . ////////////////////////////////////////////////////////////////////////////
38975 . ////////////////////////////////////////////////////////////////////////////
38976
38977 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38978          "Adding drivers or lookups"
38979 .cindex "adding drivers"
38980 .cindex "new drivers, adding"
38981 .cindex "drivers" "adding new"
38982 The following actions have to be taken in order to add a new router, transport,
38983 authenticator, or lookup type to Exim:
38984
38985 .olist
38986 Choose a name for the driver or lookup type that does not conflict with any
38987 existing name; I will use &"newdriver"& in what follows.
38988 .next
38989 Add to &_src/EDITME_& the line:
38990 .display
38991 <&'type'&>&`_NEWDRIVER=yes`&
38992 .endd
38993 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38994 code is not to be included in the binary by default, comment this line out. You
38995 should also add any relevant comments about the driver or lookup type.
38996 .next
38997 Add to &_src/config.h.defaults_& the line:
38998 .code
38999 #define <type>_NEWDRIVER
39000 .endd
39001 .next
39002 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
39003 and create a table entry as is done for all the other drivers and lookup types.
39004 .next
39005 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
39006 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
39007 Add your &`NEWDRIVER`& to that list.
39008 As long as the dynamic module would be named &_newdriver.so_&, you can use the
39009 simple form that most lookups have.
39010 .next
39011 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
39012 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
39013 driver or lookup type and add it to the definition of OBJ.
39014 .next
39015 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
39016 &_src_&.
39017 .next
39018 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
39019 as for other drivers and lookups.
39020 .endlist
39021
39022 Then all you need to do is write the code! A good way to start is to make a
39023 proforma by copying an existing module of the same type, globally changing all
39024 occurrences of the name, and cutting out most of the code. Note that any
39025 options you create must be listed in alphabetical order, because the tables are
39026 searched using a binary chop procedure.
39027
39028 There is a &_README_& file in each of the sub-directories of &_src_& describing
39029 the interface that is expected.
39030
39031
39032
39033
39034 . ////////////////////////////////////////////////////////////////////////////
39035 . ////////////////////////////////////////////////////////////////////////////
39036
39037 . /////////////////////////////////////////////////////////////////////////////
39038 . These lines are processing instructions for the Simple DocBook Processor that
39039 . Philip Hazel has developed as a less cumbersome way of making PostScript and
39040 . PDFs than using xmlto and fop. They will be ignored by all other XML
39041 . processors.
39042 . /////////////////////////////////////////////////////////////////////////////
39043
39044 .literal xml
39045 <?sdop
39046   format="newpage"
39047   foot_right_recto="&chaptertitle;"
39048   foot_right_verso="&chaptertitle;"
39049 ?>
39050 .literal off
39051
39052 .makeindex "Options index"   "option"
39053 .makeindex "Variables index" "variable"
39054 .makeindex "Concept index"   "concept"
39055
39056
39057 . /////////////////////////////////////////////////////////////////////////////
39058 . /////////////////////////////////////////////////////////////////////////////