Debug: "kill" option on ACL control=debug. Bug 1831
[exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.87"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2016
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database" "deferred deliveries"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default is set at build time). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 For a trusted user, there is never any check on the contents of the &'From:'&
2631 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2632 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2633
2634 Trusted users may also specify a host name, host address, interface address,
2635 protocol name, ident value, and authentication data when submitting a message
2636 locally. Thus, they are able to insert messages into Exim's queue locally that
2637 have the characteristics of messages received from a remote host. Untrusted
2638 users may in some circumstances use &%-f%&, but can never set the other values
2639 that are available to trusted users.
2640 .next
2641 .cindex "user" "admin definition of"
2642 .cindex "admin user" "definition of"
2643 The admin users are root, the Exim user, and any user that is a member of the
2644 Exim group or of any group listed in the &%admin_groups%& configuration option.
2645 The current group does not have to be one of these groups.
2646
2647 Admin users are permitted to list the queue, and to carry out certain
2648 operations on messages, for example, to force delivery failures. It is also
2649 necessary to be an admin user in order to see the full information provided by
2650 the Exim monitor, and full debugging output.
2651
2652 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2653 Exim to attempt delivery of messages on its queue is restricted to admin users.
2654 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2655 option false (that is, specifying &%no_prod_requires_admin%&).
2656
2657 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2658 is restricted to admin users unless &%queue_list_requires_admin%& is set
2659 false.
2660 .endlist
2661
2662
2663 &*Warning*&: If you configure your system so that admin users are able to
2664 edit Exim's configuration file, you are giving those users an easy way of
2665 getting root. There is further discussion of this issue at the start of chapter
2666 &<<CHAPconf>>&.
2667
2668
2669
2670
2671 .section "Command line options" "SECID39"
2672 Exim's command line options are described in alphabetical order below. If none
2673 of the options that specifies a specific action (such as starting the daemon or
2674 a queue runner, or testing an address, or receiving a message in a specific
2675 format, or listing the queue) are present, and there is at least one argument
2676 on the command line, &%-bm%& (accept a local message on the standard input,
2677 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2678 outputs a brief message about itself and exits.
2679
2680 . ////////////////////////////////////////////////////////////////////////////
2681 . Insert a stylized XML comment here, to identify the start of the command line
2682 . options. This is for the benefit of the Perl script that automatically
2683 . creates a man page for the options.
2684 . ////////////////////////////////////////////////////////////////////////////
2685
2686 .literal xml
2687 <!-- === Start of command line options === -->
2688 .literal off
2689
2690
2691 .vlist
2692 .vitem &%--%&
2693 .oindex "--"
2694 .cindex "options" "command line; terminating"
2695 This is a pseudo-option whose only purpose is to terminate the options and
2696 therefore to cause subsequent command line items to be treated as arguments
2697 rather than options, even if they begin with hyphens.
2698
2699 .vitem &%--help%&
2700 .oindex "&%--help%&"
2701 This option causes Exim to output a few sentences stating what it is.
2702 The same output is generated if the Exim binary is called with no options and
2703 no arguments.
2704
2705 .vitem &%--version%&
2706 .oindex "&%--version%&"
2707 This option is an alias for &%-bV%& and causes version information to be
2708 displayed.
2709
2710 .vitem &%-Ac%& &&&
2711        &%-Am%&
2712 .oindex "&%-Ac%&"
2713 .oindex "&%-Am%&"
2714 These options are used by Sendmail for selecting configuration files and are
2715 ignored by Exim.
2716
2717 .vitem &%-B%&<&'type'&>
2718 .oindex "&%-B%&"
2719 .cindex "8-bit characters"
2720 .cindex "Sendmail compatibility" "8-bit characters"
2721 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2722 clean; it ignores this option.
2723
2724 .vitem &%-bd%&
2725 .oindex "&%-bd%&"
2726 .cindex "daemon"
2727 .cindex "SMTP" "listener"
2728 .cindex "queue runner"
2729 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2730 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2731 that the daemon should also initiate periodic queue runs.
2732
2733 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2734 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2735 disconnect from the controlling terminal. When running this way, it can be
2736 stopped by pressing ctrl-C.
2737
2738 By default, Exim listens for incoming connections to the standard SMTP port on
2739 all the host's running interfaces. However, it is possible to listen on other
2740 ports, on multiple ports, and only on specific interfaces. Chapter
2741 &<<CHAPinterfaces>>& contains a description of the options that control this.
2742
2743 When a listening daemon
2744 .cindex "daemon" "process id (pid)"
2745 .cindex "pid (process id)" "of daemon"
2746 is started without the use of &%-oX%& (that is, without overriding the normal
2747 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2748 in Exim's spool directory. This location can be overridden by setting
2749 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2750 running as root.
2751
2752 When &%-oX%& is used on the command line to start a listening daemon, the
2753 process id is not written to the normal pid file path. However, &%-oP%& can be
2754 used to specify a path on the command line if a pid file is required.
2755
2756 The SIGHUP signal
2757 .cindex "SIGHUP"
2758 .cindex "daemon" "restarting"
2759 can be used to cause the daemon to re-execute itself. This should be done
2760 whenever Exim's configuration file, or any file that is incorporated into it by
2761 means of the &%.include%& facility, is changed, and also whenever a new version
2762 of Exim is installed. It is not necessary to do this when other files that are
2763 referenced from the configuration (for example, alias files) are changed,
2764 because these are reread each time they are used.
2765
2766 .vitem &%-bdf%&
2767 .oindex "&%-bdf%&"
2768 This option has the same effect as &%-bd%& except that it never disconnects
2769 from the controlling terminal, even when no debugging is specified.
2770
2771 .vitem &%-be%&
2772 .oindex "&%-be%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 Run Exim in expansion testing mode. Exim discards its root privilege, to
2776 prevent ordinary users from using this mode to read otherwise inaccessible
2777 files. If no arguments are given, Exim runs interactively, prompting for lines
2778 of data. Otherwise, it processes each argument in turn.
2779
2780 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2781 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2782 used without command line arguments. If successful, it uses the &[readline()]&
2783 function, which provides extensive line-editing facilities, for reading the
2784 test data. A line history is supported.
2785
2786 Long expansion expressions can be split over several lines by using backslash
2787 continuations. As in Exim's run time configuration, white space at the start of
2788 continuation lines is ignored. Each argument or data line is passed through the
2789 string expansion mechanism, and the result is output. Variable values from the
2790 configuration file (for example, &$qualify_domain$&) are available, but no
2791 message-specific values (such as &$message_exim_id$&) are set, because no message
2792 is being processed (but see &%-bem%& and &%-Mset%&).
2793
2794 &*Note*&: If you use this mechanism to test lookups, and you change the data
2795 files or databases you are using, you must exit and restart Exim before trying
2796 the same lookup again. Otherwise, because each Exim process caches the results
2797 of lookups, you will just get the same result as before.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 . // Keep :help first, then the rest in alphabetical order
2977 .vitem &%-bI:help%&
2978 .oindex "&%-bI:help%&"
2979 .cindex "querying exim information"
2980 We shall provide various options starting &`-bI:`& for querying Exim for
2981 information.  The output of many of these will be intended for machine
2982 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2983 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2984 options shall cause Exim to exit after producing the requested output.
2985
2986 .vitem &%-bI:dscp%&
2987 .oindex "&%-bI:dscp%&"
2988 .cindex "DSCP" "values"
2989 This option causes Exim to emit an alphabetically sorted list of all
2990 recognised DSCP names.
2991
2992 .vitem &%-bI:sieve%&
2993 .oindex "&%-bI:sieve%&"
2994 .cindex "Sieve filter" "capabilities"
2995 This option causes Exim to emit an alphabetically sorted list of all supported
2996 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2997 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2998 &`SIEVE`& capability response line.  As the precise list may depend upon
2999 compile-time build options, which this option will adapt to, this is the only
3000 way to guarantee a correct response.
3001
3002 .vitem &%-bm%&
3003 .oindex "&%-bm%&"
3004 .cindex "local message reception"
3005 This option runs an Exim receiving process that accepts an incoming,
3006 locally-generated message on the standard input. The recipients are given as the
3007 command arguments (except when &%-t%& is also present &-- see below). Each
3008 argument can be a comma-separated list of RFC 2822 addresses. This is the
3009 default option for selecting the overall action of an Exim call; it is assumed
3010 if no other conflicting option is present.
3011
3012 If any addresses in the message are unqualified (have no domain), they are
3013 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3014 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3015 suppressing this for special cases.
3016
3017 Policy checks on the contents of local messages can be enforced by means of
3018 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3019
3020 .cindex "return code" "for &%-bm%&"
3021 The return code is zero if the message is successfully accepted. Otherwise, the
3022 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3023
3024 The format
3025 .cindex "message" "format"
3026 .cindex "format" "message"
3027 .cindex "&""From""& line"
3028 .cindex "UUCP" "&""From""& line"
3029 .cindex "Sendmail compatibility" "&""From""& line"
3030 of the message must be as defined in RFC 2822, except that, for
3031 compatibility with Sendmail and Smail, a line in one of the forms
3032 .code
3033 From sender Fri Jan  5 12:55 GMT 1997
3034 From sender Fri, 5 Jan 97 12:55:01
3035 .endd
3036 (with the weekday optional, and possibly with additional text after the date)
3037 is permitted to appear at the start of the message. There appears to be no
3038 authoritative specification of the format of this line. Exim recognizes it by
3039 matching against the regular expression defined by the &%uucp_from_pattern%&
3040 option, which can be changed if necessary.
3041
3042 .oindex "&%-f%&" "overriding &""From""& line"
3043 The specified sender is treated as if it were given as the argument to the
3044 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3045 preference to the address taken from the message. The caller of Exim must be a
3046 trusted user for the sender of a message to be set in this way.
3047
3048 .vitem &%-bmalware%&&~<&'filename'&>
3049 .oindex "&%-bmalware%&"
3050 .cindex "testing", "malware"
3051 .cindex "malware scan test"
3052 This debugging option causes Exim to scan the given file or directory
3053 (depending on the used scanner interface),
3054 using the malware scanning framework.  The option of &%av_scanner%& influences
3055 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3056 the expansion should have defaults which apply to this invocation.  ACLs are
3057 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3058 will never be populated and &%-bmalware%& will fail.
3059
3060 Exim will have changed working directory before resolving the filename, so
3061 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3062 user when it tries to open the file, rather than as the invoking user.
3063 This option requires admin privileges.
3064
3065 The &%-bmalware%& option will not be extended to be more generally useful,
3066 there are better tools for file-scanning.  This option exists to help
3067 administrators verify their Exim and AV scanner configuration.
3068
3069 .vitem &%-bnq%&
3070 .oindex "&%-bnq%&"
3071 .cindex "address qualification, suppressing"
3072 By default, Exim automatically qualifies unqualified addresses (those
3073 without domains) that appear in messages that are submitted locally (that
3074 is, not over TCP/IP). This qualification applies both to addresses in
3075 envelopes, and addresses in header lines. Sender addresses are qualified using
3076 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3077 defaults to the value of &%qualify_domain%&).
3078
3079 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3080 being used to re-submit messages that originally came from remote hosts after
3081 content scanning, you probably do not want to qualify unqualified addresses in
3082 header lines. (Such lines will be present only if you have not enabled a header
3083 syntax check in the appropriate ACL.)
3084
3085 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3086 messages that originate on the local host. When this is used, unqualified
3087 addresses in the envelope provoke errors (causing message rejection) and
3088 unqualified addresses in header lines are left alone.
3089
3090
3091 .vitem &%-bP%&
3092 .oindex "&%-bP%&"
3093 .cindex "configuration options" "extracting"
3094 .cindex "options" "configuration &-- extracting"
3095 If this option is given with no arguments, it causes the values of all Exim's
3096 main configuration options to be written to the standard output. The values
3097 of one or more specific options can be requested by giving their names as
3098 arguments, for example:
3099 .code
3100 exim -bP qualify_domain hold_domains
3101 .endd
3102 .cindex "hiding configuration option values"
3103 .cindex "configuration options" "hiding value of"
3104 .cindex "options" "hiding value of"
3105 However, any option setting that is preceded by the word &"hide"& in the
3106 configuration file is not shown in full, except to an admin user. For other
3107 users, the output is as in this example:
3108 .code
3109 mysql_servers = <value not displayable>
3110 .endd
3111 If &%config%& is given as an argument, the config is
3112 output, as it was parsed, any include file resolved, any comment removed.
3113
3114 If &%config_file%& is given as an argument, the name of the run time
3115 configuration file is output. (&%configure_file%& works too, for
3116 backward compatibility.)
3117 If a list of configuration files was supplied, the value that is output here
3118 is the name of the file that was actually used.
3119
3120 .cindex "options" "hiding name of"
3121 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3122 name will not be output.
3123
3124 .cindex "daemon" "process id (pid)"
3125 .cindex "pid (process id)" "of daemon"
3126 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3127 directories where log files and daemon pid files are written are output,
3128 respectively. If these values are unset, log files are written in a
3129 sub-directory of the spool directory called &%log%&, and the pid file is
3130 written directly into the spool directory.
3131
3132 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3133 .code
3134 exim -bP +local_domains
3135 .endd
3136 it searches for a matching named list of any type (domain, host, address, or
3137 local part) and outputs what it finds.
3138
3139 .cindex "options" "router &-- extracting"
3140 .cindex "options" "transport &-- extracting"
3141 .cindex "options" "authenticator &-- extracting"
3142 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3143 followed by the name of an appropriate driver instance, the option settings for
3144 that driver are output. For example:
3145 .code
3146 exim -bP transport local_delivery
3147 .endd
3148 The generic driver options are output first, followed by the driver's private
3149 options. A list of the names of drivers of a particular type can be obtained by
3150 using one of the words &%router_list%&, &%transport_list%&, or
3151 &%authenticator_list%&, and a complete list of all drivers with their option
3152 settings can be obtained by using &%routers%&, &%transports%&, or
3153 &%authenticators%&.
3154
3155 .cindex "environment"
3156 If &%environment%& is given as an argument, the set of environment
3157 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3158 variables.
3159
3160 .cindex "options" "macro &-- extracting"
3161 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3162 are available, similarly to the drivers.  Because macros are sometimes used
3163 for storing passwords, this option is restricted.
3164 The output format is one item per line.
3165
3166 .vitem &%-bp%&
3167 .oindex "&%-bp%&"
3168 .cindex "queue" "listing messages on"
3169 .cindex "listing" "messages on the queue"
3170 This option requests a listing of the contents of the mail queue on the
3171 standard output. If the &%-bp%& option is followed by a list of message ids,
3172 just those messages are listed. By default, this option can be used only by an
3173 admin user. However, the &%queue_list_requires_admin%& option can be set false
3174 to allow any user to see the queue.
3175
3176 Each message on the queue is displayed as in the following example:
3177 .code
3178 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3179           red.king@looking-glass.fict.example
3180           <other addresses>
3181 .endd
3182 .cindex "message" "size in queue listing"
3183 .cindex "size" "of message"
3184 The first line contains the length of time the message has been on the queue
3185 (in this case 25 minutes), the size of the message (2.9K), the unique local
3186 identifier for the message, and the message sender, as contained in the
3187 envelope. For bounce messages, the sender address is empty, and appears as
3188 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3189 the default sender address, the user's login name is shown in parentheses
3190 before the sender address.
3191
3192 .cindex "frozen messages" "in queue listing"
3193 If the message is frozen (attempts to deliver it are suspended) then the text
3194 &"*** frozen ***"& is displayed at the end of this line.
3195
3196 The recipients of the message (taken from the envelope, not the headers) are
3197 displayed on subsequent lines. Those addresses to which the message has already
3198 been delivered are marked with the letter D. If an original address gets
3199 expanded into several addresses via an alias or forward file, the original is
3200 displayed with a D only when deliveries for all of its child addresses are
3201 complete.
3202
3203
3204 .vitem &%-bpa%&
3205 .oindex "&%-bpa%&"
3206 This option operates like &%-bp%&, but in addition it shows delivered addresses
3207 that were generated from the original top level address(es) in each message by
3208 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3209 of just &"D"&.
3210
3211
3212 .vitem &%-bpc%&
3213 .oindex "&%-bpc%&"
3214 .cindex "queue" "count of messages on"
3215 This option counts the number of messages on the queue, and writes the total
3216 to the standard output. It is restricted to admin users, unless
3217 &%queue_list_requires_admin%& is set false.
3218
3219
3220 .vitem &%-bpr%&
3221 .oindex "&%-bpr%&"
3222 This option operates like &%-bp%&, but the output is not sorted into
3223 chronological order of message arrival. This can speed it up when there are
3224 lots of messages on the queue, and is particularly useful if the output is
3225 going to be post-processed in a way that doesn't need the sorting.
3226
3227 .vitem &%-bpra%&
3228 .oindex "&%-bpra%&"
3229 This option is a combination of &%-bpr%& and &%-bpa%&.
3230
3231 .vitem &%-bpru%&
3232 .oindex "&%-bpru%&"
3233 This option is a combination of &%-bpr%& and &%-bpu%&.
3234
3235
3236 .vitem &%-bpu%&
3237 .oindex "&%-bpu%&"
3238 This option operates like &%-bp%& but shows only undelivered top-level
3239 addresses for each message displayed. Addresses generated by aliasing or
3240 forwarding are not shown, unless the message was deferred after processing by a
3241 router with the &%one_time%& option set.
3242
3243
3244 .vitem &%-brt%&
3245 .oindex "&%-brt%&"
3246 .cindex "testing" "retry configuration"
3247 .cindex "retry" "configuration testing"
3248 This option is for testing retry rules, and it must be followed by up to three
3249 arguments. It causes Exim to look for a retry rule that matches the values
3250 and to write it to the standard output. For example:
3251 .code
3252 exim -brt bach.comp.mus.example
3253 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3254 .endd
3255 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3256 argument, which is required, can be a complete address in the form
3257 &'local_part@domain'&, or it can be just a domain name. If the second argument
3258 contains a dot, it is interpreted as an optional second domain name; if no
3259 retry rule is found for the first argument, the second is tried. This ties in
3260 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3261 rule is found that matches the host, one that matches the mail domain is
3262 sought. Finally, an argument that is the name of a specific delivery error, as
3263 used in setting up retry rules, can be given. For example:
3264 .code
3265 exim -brt haydn.comp.mus.example quota_3d
3266 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3267 .endd
3268
3269 .vitem &%-brw%&
3270 .oindex "&%-brw%&"
3271 .cindex "testing" "rewriting"
3272 .cindex "rewriting" "testing"
3273 This option is for testing address rewriting rules, and it must be followed by
3274 a single argument, consisting of either a local part without a domain, or a
3275 complete address with a fully qualified domain. Exim outputs how this address
3276 would be rewritten for each possible place it might appear. See chapter
3277 &<<CHAPrewrite>>& for further details.
3278
3279 .vitem &%-bS%&
3280 .oindex "&%-bS%&"
3281 .cindex "SMTP" "batched incoming"
3282 .cindex "batched SMTP input"
3283 This option is used for batched SMTP input, which is an alternative interface
3284 for non-interactive local message submission. A number of messages can be
3285 submitted in a single run. However, despite its name, this is not really SMTP
3286 input. Exim reads each message's envelope from SMTP commands on the standard
3287 input, but generates no responses. If the caller is trusted, or
3288 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3289 believed; otherwise the sender is always the caller of Exim.
3290
3291 The message itself is read from the standard input, in SMTP format (leading
3292 dots doubled), terminated by a line containing just a single dot. An error is
3293 provoked if the terminating dot is missing. A further message may then follow.
3294
3295 As for other local message submissions, the contents of incoming batch SMTP
3296 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3297 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3298 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3299
3300 Some other SMTP commands are recognized in the input. HELO and EHLO act
3301 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3302 QUIT quits, ignoring the rest of the standard input.
3303
3304 .cindex "return code" "for &%-bS%&"
3305 If any error is encountered, reports are written to the standard output and
3306 error streams, and Exim gives up immediately. The return code is 0 if no error
3307 was detected; it is 1 if one or more messages were accepted before the error
3308 was detected; otherwise it is 2.
3309
3310 More details of input using batched SMTP are given in section
3311 &<<SECTincomingbatchedSMTP>>&.
3312
3313 .vitem &%-bs%&
3314 .oindex "&%-bs%&"
3315 .cindex "SMTP" "local input"
3316 .cindex "local SMTP input"
3317 This option causes Exim to accept one or more messages by reading SMTP commands
3318 on the standard input, and producing SMTP replies on the standard output. SMTP
3319 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3320 Some user agents use this interface as a way of passing locally-generated
3321 messages to the MTA.
3322
3323 In
3324 .cindex "sender" "source of"
3325 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3326 set, the senders of messages are taken from the SMTP MAIL commands.
3327 Otherwise the content of these commands is ignored and the sender is set up as
3328 the calling user. Unqualified addresses are automatically qualified using
3329 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3330 &%-bnq%& option is used.
3331
3332 .cindex "inetd"
3333 The
3334 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3335 using a listening daemon. Exim can distinguish the two cases by checking
3336 whether the standard input is a TCP/IP socket. When Exim is called from
3337 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3338 above concerning senders and qualification do not apply. In this situation,
3339 Exim behaves in exactly the same way as it does when receiving a message via
3340 the listening daemon.
3341
3342 .vitem &%-bt%&
3343 .oindex "&%-bt%&"
3344 .cindex "testing" "addresses"
3345 .cindex "address" "testing"
3346 This option runs Exim in address testing mode, in which each argument is taken
3347 as a recipient address to be tested for deliverability. The results are
3348 written to the standard output. If a test fails, and the caller is not an admin
3349 user, no details of the failure are output, because these might contain
3350 sensitive information such as usernames and passwords for database lookups.
3351
3352 If no arguments are given, Exim runs in an interactive manner, prompting with a
3353 right angle bracket for addresses to be tested.
3354
3355 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3356 &[readline()]& function, because it is running as &'root'& and there are
3357 security issues.
3358
3359 Each address is handled as if it were the recipient address of a message
3360 (compare the &%-bv%& option). It is passed to the routers and the result is
3361 written to the standard output. However, any router that has
3362 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3363 genuine routing tests if your first router passes everything to a scanner
3364 program.
3365
3366 .cindex "return code" "for &%-bt%&"
3367 The return code is 2 if any address failed outright; it is 1 if no address
3368 failed outright but at least one could not be resolved for some reason. Return
3369 code 0 is given only when all addresses succeed.
3370
3371 .cindex "duplicate addresses"
3372 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3373 addresses after routing is complete, so that only one delivery takes place.
3374 This does not happen when testing with &%-bt%&; the full results of routing are
3375 always shown.
3376
3377 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3378 routers in the configuration makes any tests on the sender address of a
3379 message,
3380 .oindex "&%-f%&" "for address testing"
3381 you can use the &%-f%& option to set an appropriate sender when running
3382 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3383 default qualifying domain. However, if you have set up (for example) routers
3384 whose behaviour depends on the contents of an incoming message, you cannot test
3385 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3386 doing such tests.
3387
3388 .vitem &%-bV%&
3389 .oindex "&%-bV%&"
3390 .cindex "version number of Exim"
3391 This option causes Exim to write the current version number, compilation
3392 number, and compilation date of the &'exim'& binary to the standard output.
3393 It also lists the DBM library that is being used, the optional modules (such as
3394 specific lookup types), the drivers that are included in the binary, and the
3395 name of the run time configuration file that is in use.
3396
3397 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3398 configuration file. However, this is a static check only. It cannot check
3399 values that are to be expanded. For example, although a misspelt ACL verb is
3400 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3401 alone to discover (for example) all the typos in the configuration; some
3402 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3403 dynamic testing facilities.
3404
3405 .vitem &%-bv%&
3406 .oindex "&%-bv%&"
3407 .cindex "verifying address" "using &%-bv%&"
3408 .cindex "address" "verification"
3409 This option runs Exim in address verification mode, in which each argument is
3410 taken as a recipient address to be verified by the routers. (This does
3411 not involve any verification callouts). During normal operation, verification
3412 happens mostly as a consequence processing a &%verify%& condition in an ACL
3413 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3414 including callouts, see the &%-bh%& and &%-bhc%& options.
3415
3416 If verification fails, and the caller is not an admin user, no details of the
3417 failure are output, because these might contain sensitive information such as
3418 usernames and passwords for database lookups.
3419
3420 If no arguments are given, Exim runs in an interactive manner, prompting with a
3421 right angle bracket for addresses to be verified.
3422
3423 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3424 &[readline()]& function, because it is running as &'exim'& and there are
3425 security issues.
3426
3427 Verification differs from address testing (the &%-bt%& option) in that routers
3428 that have &%no_verify%& set are skipped, and if the address is accepted by a
3429 router that has &%fail_verify%& set, verification fails. The address is
3430 verified as a recipient if &%-bv%& is used; to test verification for a sender
3431 address, &%-bvs%& should be used.
3432
3433 If the &%-v%& option is not set, the output consists of a single line for each
3434 address, stating whether it was verified or not, and giving a reason in the
3435 latter case. Without &%-v%&, generating more than one address by redirection
3436 causes verification to end successfully, without considering the generated
3437 addresses. However, if just one address is generated, processing continues,
3438 and the generated address must verify successfully for the overall verification
3439 to succeed.
3440
3441 When &%-v%& is set, more details are given of how the address has been handled,
3442 and in the case of address redirection, all the generated addresses are also
3443 considered. Verification may succeed for some and fail for others.
3444
3445 The
3446 .cindex "return code" "for &%-bv%&"
3447 return code is 2 if any address failed outright; it is 1 if no address
3448 failed outright but at least one could not be resolved for some reason. Return
3449 code 0 is given only when all addresses succeed.
3450
3451 If any of the routers in the configuration makes any tests on the sender
3452 address of a message, you should use the &%-f%& option to set an appropriate
3453 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3454 calling user at the default qualifying domain.
3455
3456 .vitem &%-bvs%&
3457 .oindex "&%-bvs%&"
3458 This option acts like &%-bv%&, but verifies the address as a sender rather
3459 than a recipient address. This affects any rewriting and qualification that
3460 might happen.
3461
3462 .vitem &%-bw%&
3463 .oindex "&%-bw%&"
3464 .cindex "daemon"
3465 .cindex "inetd"
3466 .cindex "inetd" "wait mode"
3467 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3468 similarly to the &%-bd%& option.  All port specifications on the command-line
3469 and in the configuration file are ignored.  Queue-running may not be specified.
3470
3471 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3472 listening for connections.  This permits the system to start up and have
3473 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3474 each port only when the first connection is received.
3475
3476 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3477 which the daemon will exit, which should cause inetd to listen once more.
3478
3479 .vitem &%-C%&&~<&'filelist'&>
3480 .oindex "&%-C%&"
3481 .cindex "configuration file" "alternate"
3482 .cindex "CONFIGURE_FILE"
3483 .cindex "alternate configuration file"
3484 This option causes Exim to find the run time configuration file from the given
3485 list instead of from the list specified by the CONFIGURE_FILE
3486 compile-time setting. Usually, the list will consist of just a single file
3487 name, but it can be a colon-separated list of names. In this case, the first
3488 file that exists is used. Failure to open an existing file stops Exim from
3489 proceeding any further along the list, and an error is generated.
3490
3491 When this option is used by a caller other than root, and the list is different
3492 from the compiled-in list, Exim gives up its root privilege immediately, and
3493 runs with the real and effective uid and gid set to those of the caller.
3494 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3495 file contains a list of full pathnames, one per line, for configuration files
3496 which are trusted. Root privilege is retained for any configuration file so
3497 listed, as long as the caller is the Exim user (or the user specified in the
3498 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3499 not writeable by inappropriate users or groups.
3500
3501 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3502 configuration using &%-C%& right through message reception and delivery,
3503 even if the caller is root. The reception works, but by that time, Exim is
3504 running as the Exim user, so when it re-executes to regain privilege for the
3505 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3506 test reception and delivery using two separate commands (one to put a message
3507 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3508
3509 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3510 prefix string with which any file named in a &%-C%& command line option
3511 must start. In addition, the file name must not contain the sequence &`/../`&.
3512 However, if the value of the &%-C%& option is identical to the value of
3513 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3514 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3515 unset, any file name can be used with &%-C%&.
3516
3517 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3518 to a directory to which only root has access. This prevents someone who has
3519 broken into the Exim account from running a privileged Exim with an arbitrary
3520 configuration file.
3521
3522 The &%-C%& facility is useful for ensuring that configuration files are
3523 syntactically correct, but cannot be used for test deliveries, unless the
3524 caller is privileged, or unless it is an exotic configuration that does not
3525 require privilege. No check is made on the owner or group of the files
3526 specified by this option.
3527
3528
3529 .vitem &%-D%&<&'macro'&>=<&'value'&>
3530 .oindex "&%-D%&"
3531 .cindex "macro" "setting on command line"
3532 This option can be used to override macro definitions in the configuration file
3533 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3534 unprivileged caller, it causes Exim to give up its root privilege.
3535 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3536 completely disabled, and its use causes an immediate error exit.
3537
3538 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3539 colon-separated list of macros which are considered safe and, if &%-D%& only
3540 supplies macros from this list, and the values are acceptable, then Exim will
3541 not give up root privilege if the caller is root, the Exim run-time user, or
3542 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3543 to be removed in the future.  Acceptable values for the macros satisfy the
3544 regexp: &`^[A-Za-z0-9_/.-]*$`&
3545
3546 The entire option (including equals sign if present) must all be within one
3547 command line item. &%-D%& can be used to set the value of a macro to the empty
3548 string, in which case the equals sign is optional. These two commands are
3549 synonymous:
3550 .code
3551 exim -DABC  ...
3552 exim -DABC= ...
3553 .endd
3554 To include spaces in a macro definition item, quotes must be used. If you use
3555 quotes, spaces are permitted around the macro name and the equals sign. For
3556 example:
3557 .code
3558 exim '-D ABC = something' ...
3559 .endd
3560 &%-D%& may be repeated up to 10 times on a command line.
3561 Only macro names up to 22 letters long can be set.
3562
3563
3564 .vitem &%-d%&<&'debug&~options'&>
3565 .oindex "&%-d%&"
3566 .cindex "debugging" "list of selectors"
3567 .cindex "debugging" "&%-d%& option"
3568 This option causes debugging information to be written to the standard
3569 error stream. It is restricted to admin users because debugging output may show
3570 database queries that contain password information. Also, the details of users'
3571 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3572 writes an error message to the standard error stream and exits with a non-zero
3573 return code.
3574
3575 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3576 standard debugging data is output. This can be reduced, or increased to include
3577 some more rarely needed information, by directly following &%-d%& with a string
3578 made up of names preceded by plus or minus characters. These add or remove sets
3579 of debugging data, respectively. For example, &%-d+filter%& adds filter
3580 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3581 no spaces are allowed in the debug setting. The available debugging categories
3582 are:
3583 .display
3584 &`acl            `& ACL interpretation
3585 &`auth           `& authenticators
3586 &`deliver        `& general delivery logic
3587 &`dns            `& DNS lookups (see also resolver)
3588 &`dnsbl          `& DNS black list (aka RBL) code
3589 &`exec           `& arguments for &[execv()]& calls
3590 &`expand         `& detailed debugging for string expansions
3591 &`filter         `& filter handling
3592 &`hints_lookup   `& hints data lookups
3593 &`host_lookup    `& all types of name-to-IP address handling
3594 &`ident          `& ident lookup
3595 &`interface      `& lists of local interfaces
3596 &`lists          `& matching things in lists
3597 &`load           `& system load checks
3598 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3599                     &<<CHAPlocalscan>>&)
3600 &`lookup         `& general lookup code and all lookups
3601 &`memory         `& memory handling
3602 &`pid            `& add pid to debug output lines
3603 &`process_info   `& setting info for the process log
3604 &`queue_run      `& queue runs
3605 &`receive        `& general message reception logic
3606 &`resolver       `& turn on the DNS resolver's debugging output
3607 &`retry          `& retry handling
3608 &`rewrite        `& address rewriting
3609 &`route          `& address routing
3610 &`timestamp      `& add timestamp to debug output lines
3611 &`tls            `& TLS logic
3612 &`transport      `& transports
3613 &`uid            `& changes of uid/gid and looking up uid/gid
3614 &`verify         `& address verification logic
3615 &`all            `& almost all of the above (see below), and also &%-v%&
3616 .endd
3617 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3618 for &`-all`&. The reason for this is that &`+all`& is something that people
3619 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3620 is included, an awful lot of output that is very rarely of interest is
3621 generated, so it now has to be explicitly requested. However, &`-all`& does
3622 turn everything off.
3623
3624 .cindex "resolver, debugging output"
3625 .cindex "DNS resolver, debugging output"
3626 The &`resolver`& option produces output only if the DNS resolver was compiled
3627 with DEBUG enabled. This is not the case in some operating systems. Also,
3628 unfortunately, debugging output from the DNS resolver is written to stdout
3629 rather than stderr.
3630
3631 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3632 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3633 However, the &`pid`& selector is forced when debugging is turned on for a
3634 daemon, which then passes it on to any re-executed Exims. Exim also
3635 automatically adds the pid to debug lines when several remote deliveries are
3636 run in parallel.
3637
3638 The &`timestamp`& selector causes the current time to be inserted at the start
3639 of all debug output lines. This can be useful when trying to track down delays
3640 in processing.
3641
3642 If the &%debug_print%& option is set in any driver, it produces output whenever
3643 any debugging is selected, or if &%-v%& is used.
3644
3645 .vitem &%-dd%&<&'debug&~options'&>
3646 .oindex "&%-dd%&"
3647 This option behaves exactly like &%-d%& except when used on a command that
3648 starts a daemon process. In that case, debugging is turned off for the
3649 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3650 behaviour of the daemon without creating as much output as full debugging does.
3651
3652 .vitem &%-dropcr%&
3653 .oindex "&%-dropcr%&"
3654 This is an obsolete option that is now a no-op. It used to affect the way Exim
3655 handled CR and LF characters in incoming messages. What happens now is
3656 described in section &<<SECTlineendings>>&.
3657
3658 .vitem &%-E%&
3659 .oindex "&%-E%&"
3660 .cindex "bounce message" "generating"
3661 This option specifies that an incoming message is a locally-generated delivery
3662 failure report. It is used internally by Exim when handling delivery failures
3663 and is not intended for external use. Its only effect is to stop Exim
3664 generating certain messages to the postmaster, as otherwise message cascades
3665 could occur in some situations. As part of the same option, a message id may
3666 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3667 new message contains the id, following &"R="&, as a cross-reference.
3668
3669 .vitem &%-e%&&'x'&
3670 .oindex "&%-e%&&'x'&"
3671 There are a number of Sendmail options starting with &%-oe%& which seem to be
3672 called by various programs without the leading &%o%& in the option. For
3673 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3674 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3675
3676 .vitem &%-F%&&~<&'string'&>
3677 .oindex "&%-F%&"
3678 .cindex "sender" "name"
3679 .cindex "name" "of sender"
3680 This option sets the sender's full name for use when a locally-generated
3681 message is being accepted. In the absence of this option, the user's &'gecos'&
3682 entry from the password data is used. As users are generally permitted to alter
3683 their &'gecos'& entries, no security considerations are involved. White space
3684 between &%-F%& and the <&'string'&> is optional.
3685
3686 .vitem &%-f%&&~<&'address'&>
3687 .oindex "&%-f%&"
3688 .cindex "sender" "address"
3689 .cindex "address" "sender"
3690 .cindex "trusted users"
3691 .cindex "envelope sender"
3692 .cindex "user" "trusted"
3693 This option sets the address of the envelope sender of a locally-generated
3694 message (also known as the return path). The option can normally be used only
3695 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3696 users to use it.
3697
3698 Processes running as root or the Exim user are always trusted. Other
3699 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3700 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3701 of a local message is set to the caller's login name at the default qualify
3702 domain.
3703
3704 There is one exception to the restriction on the use of &%-f%&: an empty sender
3705 can be specified by any user, trusted or not, to create a message that can
3706 never provoke a bounce. An empty sender can be specified either as an empty
3707 string, or as a pair of angle brackets with nothing between them, as in these
3708 examples of shell commands:
3709 .code
3710 exim -f '<>' user@domain
3711 exim -f "" user@domain
3712 .endd
3713 In addition, the use of &%-f%& is not restricted when testing a filter file
3714 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3715 &%-bv%& options.
3716
3717 Allowing untrusted users to change the sender address does not of itself make
3718 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3719 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3720 though this can be overridden by setting &%no_local_from_check%&.
3721
3722 White
3723 .cindex "&""From""& line"
3724 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3725 given as two arguments or one combined argument). The sender of a
3726 locally-generated message can also be set (when permitted) by an initial
3727 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3728 if &%-f%& is also present, it overrides &"From&~"&.
3729
3730 .vitem &%-G%&
3731 .oindex "&%-G%&"
3732 .cindex "submission fixups, suppressing (command-line)"
3733 This option is equivalent to an ACL applying:
3734 .code
3735 control = suppress_local_fixups
3736 .endd
3737 for every message received.  Note that Sendmail will complain about such
3738 bad formatting, where Exim silently just does not fix it up.  This may change
3739 in future.
3740
3741 As this affects audit information, the caller must be a trusted user to use
3742 this option.
3743
3744 .vitem &%-h%&&~<&'number'&>
3745 .oindex "&%-h%&"
3746 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3747 This option is accepted for compatibility with Sendmail, but has no effect. (In
3748 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3749 headers.)
3750
3751 .vitem &%-i%&
3752 .oindex "&%-i%&"
3753 .cindex "Solaris" "&'mail'& command"
3754 .cindex "dot" "in incoming non-SMTP message"
3755 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3756 line by itself should not terminate an incoming, non-SMTP message. I can find
3757 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3758 command in Solaris 2.4 uses it. See also &%-ti%&.
3759
3760 .vitem &%-L%&&~<&'tag'&>
3761 .oindex "&%-L%&"
3762 .cindex "syslog" "process name; set with flag"
3763 This option is equivalent to setting &%syslog_processname%& in the config
3764 file and setting &%log_file_path%& to &`syslog`&.
3765 Its use is restricted to administrators.  The configuration file has to be
3766 read and parsed, to determine access rights, before this is set and takes
3767 effect, so early configuration file errors will not honour this flag.
3768
3769 The tag should not be longer than 32 characters.
3770
3771 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3772 .oindex "&%-M%&"
3773 .cindex "forcing delivery"
3774 .cindex "delivery" "forcing attempt"
3775 .cindex "frozen messages" "forcing delivery"
3776 This option requests Exim to run a delivery attempt on each message in turn. If
3777 any of the messages are frozen, they are automatically thawed before the
3778 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3779 and &%hold_domains%& are ignored.
3780
3781 Retry
3782 .cindex "hints database" "overriding retry hints"
3783 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3784 the normal retry time has not yet been reached. This option requires the caller
3785 to be an admin user. However, there is an option called &%prod_requires_admin%&
3786 which can be set false to relax this restriction (and also the same requirement
3787 for the &%-q%&, &%-R%&, and &%-S%& options).
3788
3789 The deliveries happen synchronously, that is, the original Exim process does
3790 not terminate until all the delivery attempts have finished. No output is
3791 produced unless there is a serious error. If you want to see what is happening,
3792 use the &%-v%& option as well, or inspect Exim's main log.
3793
3794 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3795 .oindex "&%-Mar%&"
3796 .cindex "message" "adding recipients"
3797 .cindex "recipient" "adding"
3798 This option requests Exim to add the addresses to the list of recipients of the
3799 message (&"ar"& for &"add recipients"&). The first argument must be a message
3800 id, and the remaining ones must be email addresses. However, if the message is
3801 active (in the middle of a delivery attempt), it is not altered. This option
3802 can be used only by an admin user.
3803
3804 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3805         &~<&'message&~id'&>"
3806 .oindex "&%-MC%&"
3807 .cindex "SMTP" "passed connection"
3808 .cindex "SMTP" "multiple deliveries"
3809 .cindex "multiple SMTP deliveries"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim to invoke another instance of itself to deliver a waiting message using
3812 an existing SMTP connection, which is passed as the standard input. Details are
3813 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3814 must be root or the Exim user in order to use it.
3815
3816 .vitem &%-MCA%&
3817 .oindex "&%-MCA%&"
3818 This option is not intended for use by external callers. It is used internally
3819 by Exim in conjunction with the &%-MC%& option. It signifies that the
3820 connection to the remote host has been authenticated.
3821
3822 .vitem &%-MCD%&
3823 .oindex "&%-MCD%&"
3824 This option is not intended for use by external callers. It is used internally
3825 by Exim in conjunction with the &%-MC%& option. It signifies that the
3826 remote host supports the ESMTP &_DSN_& extension.
3827
3828 .vitem &%-MCP%&
3829 .oindex "&%-MCP%&"
3830 This option is not intended for use by external callers. It is used internally
3831 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3832 which Exim is connected supports pipelining.
3833
3834 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3835 .oindex "&%-MCQ%&"
3836 This option is not intended for use by external callers. It is used internally
3837 by Exim in conjunction with the &%-MC%& option when the original delivery was
3838 started by a queue runner. It passes on the process id of the queue runner,
3839 together with the file descriptor number of an open pipe. Closure of the pipe
3840 signals the final completion of the sequence of processes that are passing
3841 messages through the same SMTP connection.
3842
3843 .vitem &%-MCS%&
3844 .oindex "&%-MCS%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3847 SMTP SIZE option should be used on messages delivered down the existing
3848 connection.
3849
3850 .vitem &%-MCT%&
3851 .oindex "&%-MCT%&"
3852 This option is not intended for use by external callers. It is used internally
3853 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3854 host to which Exim is connected supports TLS encryption.
3855
3856 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3857 .oindex "&%-Mc%&"
3858 .cindex "hints database" "not overridden by &%-Mc%&"
3859 .cindex "delivery" "manually started &-- not forced"
3860 This option requests Exim to run a delivery attempt on each message in turn,
3861 but unlike the &%-M%& option, it does check for retry hints, and respects any
3862 that are found. This option is not very useful to external callers. It is
3863 provided mainly for internal use by Exim when it needs to re-invoke itself in
3864 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3865 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3866 respects retry times and other options such as &%hold_domains%& that are
3867 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3868 If you want to run a specific delivery as if in a queue run, you should use
3869 &%-q%& with a message id argument. A distinction between queue run deliveries
3870 and other deliveries is made in one or two places.
3871
3872 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3873 .oindex "&%-Mes%&"
3874 .cindex "message" "changing sender"
3875 .cindex "sender" "changing"
3876 This option requests Exim to change the sender address in the message to the
3877 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3878 &"edit sender"&). There must be exactly two arguments. The first argument must
3879 be a message id, and the second one an email address. However, if the message
3880 is active (in the middle of a delivery attempt), its status is not altered.
3881 This option can be used only by an admin user.
3882
3883 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3884 .oindex "&%-Mf%&"
3885 .cindex "freezing messages"
3886 .cindex "message" "manually freezing"
3887 This option requests Exim to mark each listed message as &"frozen"&. This
3888 prevents any delivery attempts taking place until the message is &"thawed"&,
3889 either manually or as a result of the &%auto_thaw%& configuration option.
3890 However, if any of the messages are active (in the middle of a delivery
3891 attempt), their status is not altered. This option can be used only by an admin
3892 user.
3893
3894 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3895 .oindex "&%-Mg%&"
3896 .cindex "giving up on messages"
3897 .cindex "message" "abandoning delivery attempts"
3898 .cindex "delivery" "abandoning further attempts"
3899 This option requests Exim to give up trying to deliver the listed messages,
3900 including any that are frozen. However, if any of the messages are active,
3901 their status is not altered. For non-bounce messages, a delivery error message
3902 is sent to the sender, containing the text &"cancelled by administrator"&.
3903 Bounce messages are just discarded. This option can be used only by an admin
3904 user.
3905
3906 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3907 .oindex "&%-Mmad%&"
3908 .cindex "delivery" "cancelling all"
3909 This option requests Exim to mark all the recipient addresses in the messages
3910 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3911 message is active (in the middle of a delivery attempt), its status is not
3912 altered. This option can be used only by an admin user.
3913
3914 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3915 .oindex "&%-Mmd%&"
3916 .cindex "delivery" "cancelling by address"
3917 .cindex "recipient" "removing"
3918 .cindex "removing recipients"
3919 This option requests Exim to mark the given addresses as already delivered
3920 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3921 the remaining ones must be email addresses. These are matched to recipient
3922 addresses in the message in a case-sensitive manner. If the message is active
3923 (in the middle of a delivery attempt), its status is not altered. This option
3924 can be used only by an admin user.
3925
3926 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3927 .oindex "&%-Mrm%&"
3928 .cindex "removing messages"
3929 .cindex "abandoning mail"
3930 .cindex "message" "manually discarding"
3931 This option requests Exim to remove the given messages from the queue. No
3932 bounce messages are sent; each message is simply forgotten. However, if any of
3933 the messages are active, their status is not altered. This option can be used
3934 only by an admin user or by the user who originally caused the message to be
3935 placed on the queue.
3936
3937 .vitem &%-Mset%&&~<&'message&~id'&>
3938 .oindex "&%-Mset%&
3939 .cindex "testing" "string expansion"
3940 .cindex "expansion" "testing"
3941 This option is useful only in conjunction with &%-be%& (that is, when testing
3942 string expansions). Exim loads the given message from its spool before doing
3943 the test expansions, thus setting message-specific variables such as
3944 &$message_size$& and the header variables. The &$recipients$& variable is made
3945 available. This feature is provided to make it easier to test expansions that
3946 make use of these variables. However, this option can be used only by an admin
3947 user. See also &%-bem%&.
3948
3949 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3950 .oindex "&%-Mt%&"
3951 .cindex "thawing messages"
3952 .cindex "unfreezing messages"
3953 .cindex "frozen messages" "thawing"
3954 .cindex "message" "thawing frozen"
3955 This option requests Exim to &"thaw"& any of the listed messages that are
3956 &"frozen"&, so that delivery attempts can resume. However, if any of the
3957 messages are active, their status is not altered. This option can be used only
3958 by an admin user.
3959
3960 .vitem &%-Mvb%&&~<&'message&~id'&>
3961 .oindex "&%-Mvb%&"
3962 .cindex "listing" "message body"
3963 .cindex "message" "listing body of"
3964 This option causes the contents of the message body (-D) spool file to be
3965 written to the standard output. This option can be used only by an admin user.
3966
3967 .vitem &%-Mvc%&&~<&'message&~id'&>
3968 .oindex "&%-Mvc%&"
3969 .cindex "message" "listing in RFC 2822 format"
3970 .cindex "listing" "message in RFC 2822 format"
3971 This option causes a copy of the complete message (header lines plus body) to
3972 be written to the standard output in RFC 2822 format. This option can be used
3973 only by an admin user.
3974
3975 .vitem &%-Mvh%&&~<&'message&~id'&>
3976 .oindex "&%-Mvh%&"
3977 .cindex "listing" "message headers"
3978 .cindex "header lines" "listing"
3979 .cindex "message" "listing header lines"
3980 This option causes the contents of the message headers (-H) spool file to be
3981 written to the standard output. This option can be used only by an admin user.
3982
3983 .vitem &%-Mvl%&&~<&'message&~id'&>
3984 .oindex "&%-Mvl%&"
3985 .cindex "listing" "message log"
3986 .cindex "message" "listing message log"
3987 This option causes the contents of the message log spool file to be written to
3988 the standard output. This option can be used only by an admin user.
3989
3990 .vitem &%-m%&
3991 .oindex "&%-m%&"
3992 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3993 treats it that way too.
3994
3995 .vitem &%-N%&
3996 .oindex "&%-N%&"
3997 .cindex "debugging" "&%-N%& option"
3998 .cindex "debugging" "suppressing delivery"
3999 This is a debugging option that inhibits delivery of a message at the transport
4000 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4001 it just doesn't actually transport the message, but instead behaves as if it
4002 had successfully done so. However, it does not make any updates to the retry
4003 database, and the log entries for deliveries are flagged with &"*>"& rather
4004 than &"=>"&.
4005
4006 Because &%-N%& discards any message to which it applies, only root or the Exim
4007 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4008 words, an ordinary user can use it only when supplying an incoming message to
4009 which it will apply. Although transportation never fails when &%-N%& is set, an
4010 address may be deferred because of a configuration problem on a transport, or a
4011 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4012 the message, and applies to any subsequent delivery attempts that may happen
4013 for that message.
4014
4015 .vitem &%-n%&
4016 .oindex "&%-n%&"
4017 This option is interpreted by Sendmail to mean &"no aliasing"&.
4018 For normal modes of operation, it is ignored by Exim.
4019 When combined with &%-bP%& it makes the output more terse (suppresses
4020 option names, environment values and config pretty printing).
4021
4022 .vitem &%-O%&&~<&'data'&>
4023 .oindex "&%-O%&"
4024 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4025 Exim.
4026
4027 .vitem &%-oA%&&~<&'file&~name'&>
4028 .oindex "&%-oA%&"
4029 .cindex "Sendmail compatibility" "&%-oA%& option"
4030 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4031 alternative alias file name. Exim handles &%-bi%& differently; see the
4032 description above.
4033
4034 .vitem &%-oB%&&~<&'n'&>
4035 .oindex "&%-oB%&"
4036 .cindex "SMTP" "passed connection"
4037 .cindex "SMTP" "multiple deliveries"
4038 .cindex "multiple SMTP deliveries"
4039 This is a debugging option which limits the maximum number of messages that can
4040 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4041 transport. If <&'n'&> is omitted, the limit is set to 1.
4042
4043 .vitem &%-odb%&
4044 .oindex "&%-odb%&"
4045 .cindex "background delivery"
4046 .cindex "delivery" "in the background"
4047 This option applies to all modes in which Exim accepts incoming messages,
4048 including the listening daemon. It requests &"background"& delivery of such
4049 messages, which means that the accepting process automatically starts a
4050 delivery process for each message received, but does not wait for the delivery
4051 processes to finish.
4052
4053 When all the messages have been received, the reception process exits,
4054 leaving the delivery processes to finish in their own time. The standard output
4055 and error streams are closed at the start of each delivery process.
4056 This is the default action if none of the &%-od%& options are present.
4057
4058 If one of the queueing options in the configuration file
4059 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4060 overrides it if &%queue_only_override%& is set true, which is the default
4061 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4062
4063 .vitem &%-odf%&
4064 .oindex "&%-odf%&"
4065 .cindex "foreground delivery"
4066 .cindex "delivery" "in the foreground"
4067 This option requests &"foreground"& (synchronous) delivery when Exim has
4068 accepted a locally-generated message. (For the daemon it is exactly the same as
4069 &%-odb%&.) A delivery process is automatically started to deliver the message,
4070 and Exim waits for it to complete before proceeding.
4071
4072 The original Exim reception process does not finish until the delivery
4073 process for the final message has ended. The standard error stream is left open
4074 during deliveries.
4075
4076 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4077 false and one of the queueing options in the configuration file is in effect.
4078
4079 If there is a temporary delivery error during foreground delivery, the
4080 message is left on the queue for later delivery, and the original reception
4081 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4082 restricted configuration that never queues messages.
4083
4084
4085 .vitem &%-odi%&
4086 .oindex "&%-odi%&"
4087 This option is synonymous with &%-odf%&. It is provided for compatibility with
4088 Sendmail.
4089
4090 .vitem &%-odq%&
4091 .oindex "&%-odq%&"
4092 .cindex "non-immediate delivery"
4093 .cindex "delivery" "suppressing immediate"
4094 .cindex "queueing incoming messages"
4095 This option applies to all modes in which Exim accepts incoming messages,
4096 including the listening daemon. It specifies that the accepting process should
4097 not automatically start a delivery process for each message received. Messages
4098 are placed on the queue, and remain there until a subsequent queue runner
4099 process encounters them. There are several configuration options (such as
4100 &%queue_only%&) that can be used to queue incoming messages under certain
4101 conditions. This option overrides all of them and also &%-odqs%&. It always
4102 forces queueing.
4103
4104 .vitem &%-odqs%&
4105 .oindex "&%-odqs%&"
4106 .cindex "SMTP" "delaying delivery"
4107 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4108 However, like &%-odb%& and &%-odi%&, this option has no effect if
4109 &%queue_only_override%& is false and one of the queueing options in the
4110 configuration file is in effect.
4111
4112 When &%-odqs%& does operate, a delivery process is started for each incoming
4113 message, in the background by default, but in the foreground if &%-odi%& is
4114 also present. The recipient addresses are routed, and local deliveries are done
4115 in the normal way. However, if any SMTP deliveries are required, they are not
4116 done at this time, so the message remains on the queue until a subsequent queue
4117 runner process encounters it. Because routing was done, Exim knows which
4118 messages are waiting for which hosts, and so a number of messages for the same
4119 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4120 configuration option has the same effect for specific domains. See also the
4121 &%-qq%& option.
4122
4123 .vitem &%-oee%&
4124 .oindex "&%-oee%&"
4125 .cindex "error" "reporting"
4126 If an error is detected while a non-SMTP message is being received (for
4127 example, a malformed address), the error is reported to the sender in a mail
4128 message.
4129
4130 .cindex "return code" "for &%-oee%&"
4131 Provided
4132 this error message is successfully sent, the Exim receiving process
4133 exits with a return code of zero. If not, the return code is 2 if the problem
4134 is that the original message has no recipients, or 1 for any other error.
4135 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4136
4137 .vitem &%-oem%&
4138 .oindex "&%-oem%&"
4139 .cindex "error" "reporting"
4140 .cindex "return code" "for &%-oem%&"
4141 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4142 return code, whether or not the error message was successfully sent.
4143 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4144
4145 .vitem &%-oep%&
4146 .oindex "&%-oep%&"
4147 .cindex "error" "reporting"
4148 If an error is detected while a non-SMTP message is being received, the
4149 error is reported by writing a message to the standard error file (stderr).
4150 .cindex "return code" "for &%-oep%&"
4151 The return code is 1 for all errors.
4152
4153 .vitem &%-oeq%&
4154 .oindex "&%-oeq%&"
4155 .cindex "error" "reporting"
4156 This option is supported for compatibility with Sendmail, but has the same
4157 effect as &%-oep%&.
4158
4159 .vitem &%-oew%&
4160 .oindex "&%-oew%&"
4161 .cindex "error" "reporting"
4162 This option is supported for compatibility with Sendmail, but has the same
4163 effect as &%-oem%&.
4164
4165 .vitem &%-oi%&
4166 .oindex "&%-oi%&"
4167 .cindex "dot" "in incoming non-SMTP message"
4168 This option, which has the same effect as &%-i%&, specifies that a dot on a
4169 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4170 single dot does terminate, though Exim does no special processing for other
4171 lines that start with a dot. This option is set by default if Exim is called as
4172 &'rmail'&. See also &%-ti%&.
4173
4174 .vitem &%-oitrue%&
4175 .oindex "&%-oitrue%&"
4176 This option is treated as synonymous with &%-oi%&.
4177
4178 .vitem &%-oMa%&&~<&'host&~address'&>
4179 .oindex "&%-oMa%&"
4180 .cindex "sender" "host address, specifying for local message"
4181 A number of options starting with &%-oM%& can be used to set values associated
4182 with remote hosts on locally-submitted messages (that is, messages not received
4183 over TCP/IP). These options can be used by any caller in conjunction with the
4184 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4185 other circumstances, they are ignored unless the caller is trusted.
4186
4187 The &%-oMa%& option sets the sender host address. This may include a port
4188 number at the end, after a full stop (period). For example:
4189 .code
4190 exim -bs -oMa 10.9.8.7.1234
4191 .endd
4192 An alternative syntax is to enclose the IP address in square brackets,
4193 followed by a colon and the port number:
4194 .code
4195 exim -bs -oMa [10.9.8.7]:1234
4196 .endd
4197 The IP address is placed in the &$sender_host_address$& variable, and the
4198 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4199 are present on the command line, the sender host IP address is taken from
4200 whichever one is last.
4201
4202 .vitem &%-oMaa%&&~<&'name'&>
4203 .oindex "&%-oMaa%&"
4204 .cindex "authentication" "name, specifying for local message"
4205 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4206 option sets the value of &$sender_host_authenticated$& (the authenticator
4207 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4208 This option can be used with &%-bh%& and &%-bs%& to set up an
4209 authenticated SMTP session without actually using the SMTP AUTH command.
4210
4211 .vitem &%-oMai%&&~<&'string'&>
4212 .oindex "&%-oMai%&"
4213 .cindex "authentication" "id, specifying for local message"
4214 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4215 option sets the value of &$authenticated_id$& (the id that was authenticated).
4216 This overrides the default value (the caller's login id, except with &%-bh%&,
4217 where there is no default) for messages from local sources. See chapter
4218 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4219
4220 .vitem &%-oMas%&&~<&'address'&>
4221 .oindex "&%-oMas%&"
4222 .cindex "authentication" "sender, specifying for local message"
4223 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4224 option sets the authenticated sender value in &$authenticated_sender$&. It
4225 overrides the sender address that is created from the caller's login id for
4226 messages from local sources, except when &%-bh%& is used, when there is no
4227 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4228 specified on a MAIL command overrides this value. See chapter
4229 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4230
4231 .vitem &%-oMi%&&~<&'interface&~address'&>
4232 .oindex "&%-oMi%&"
4233 .cindex "interface" "address, specifying for local message"
4234 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4235 option sets the IP interface address value. A port number may be included,
4236 using the same syntax as for &%-oMa%&. The interface address is placed in
4237 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4238
4239 .vitem &%-oMm%&&~<&'message&~reference'&>
4240 .oindex "&%-oMm%&"
4241 .cindex "message reference" "message reference, specifying for local message"
4242 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4243 option sets the message reference, e.g. message-id, and is logged during
4244 delivery. This is useful when some kind of audit trail is required to tie
4245 messages together. The format of the message reference is checked and will
4246 abort if the format is invalid. The option will only be accepted if exim is
4247 running in trusted mode, not as any regular user.
4248
4249 The best example of a message reference is when Exim sends a bounce message.
4250 The message reference is the message-id of the original message for which Exim
4251 is sending the bounce.
4252
4253 .vitem &%-oMr%&&~<&'protocol&~name'&>
4254 .oindex "&%-oMr%&"
4255 .cindex "protocol, specifying for local message"
4256 .vindex "&$received_protocol$&"
4257 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4258 option sets the received protocol value that is stored in
4259 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4260 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4261 SMTP protocol names (see the description of &$received_protocol$& in section
4262 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4263 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4264 be set by &%-oMr%&.
4265
4266 .vitem &%-oMs%&&~<&'host&~name'&>
4267 .oindex "&%-oMs%&"
4268 .cindex "sender" "host name, specifying for local message"
4269 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4270 option sets the sender host name in &$sender_host_name$&. When this option is
4271 present, Exim does not attempt to look up a host name from an IP address; it
4272 uses the name it is given.
4273
4274 .vitem &%-oMt%&&~<&'ident&~string'&>
4275 .oindex "&%-oMt%&"
4276 .cindex "sender" "ident string, specifying for local message"
4277 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4278 option sets the sender ident value in &$sender_ident$&. The default setting for
4279 local callers is the login id of the calling process, except when &%-bh%& is
4280 used, when there is no default.
4281
4282 .vitem &%-om%&
4283 .oindex "&%-om%&"
4284 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4285 In Sendmail, this option means &"me too"&, indicating that the sender of a
4286 message should receive a copy of the message if the sender appears in an alias
4287 expansion. Exim always does this, so the option does nothing.
4288
4289 .vitem &%-oo%&
4290 .oindex "&%-oo%&"
4291 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4292 This option is ignored. In Sendmail it specifies &"old style headers"&,
4293 whatever that means.
4294
4295 .vitem &%-oP%&&~<&'path'&>
4296 .oindex "&%-oP%&"
4297 .cindex "pid (process id)" "of daemon"
4298 .cindex "daemon" "process id (pid)"
4299 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4300 value. The option specifies the file to which the process id of the daemon is
4301 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4302 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4303 because in those cases, the normal pid file is not used.
4304
4305 .vitem &%-or%&&~<&'time'&>
4306 .oindex "&%-or%&"
4307 .cindex "timeout" "for non-SMTP input"
4308 This option sets a timeout value for incoming non-SMTP messages. If it is not
4309 set, Exim will wait forever for the standard input. The value can also be set
4310 by the &%receive_timeout%& option. The format used for specifying times is
4311 described in section &<<SECTtimeformat>>&.
4312
4313 .vitem &%-os%&&~<&'time'&>
4314 .oindex "&%-os%&"
4315 .cindex "timeout" "for SMTP input"
4316 .cindex "SMTP" "input timeout"
4317 This option sets a timeout value for incoming SMTP messages. The timeout
4318 applies to each SMTP command and block of data. The value can also be set by
4319 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4320 for specifying times is described in section &<<SECTtimeformat>>&.
4321
4322 .vitem &%-ov%&
4323 .oindex "&%-ov%&"
4324 This option has exactly the same effect as &%-v%&.
4325
4326 .vitem &%-oX%&&~<&'number&~or&~string'&>
4327 .oindex "&%-oX%&"
4328 .cindex "TCP/IP" "setting listening ports"
4329 .cindex "TCP/IP" "setting listening interfaces"
4330 .cindex "port" "receiving TCP/IP"
4331 This option is relevant only when the &%-bd%& (start listening daemon) option
4332 is also given. It controls which ports and interfaces the daemon uses. Details
4333 of the syntax, and how it interacts with configuration file options, are given
4334 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4335 file is written unless &%-oP%& is also present to specify a pid file name.
4336
4337 .vitem &%-pd%&
4338 .oindex "&%-pd%&"
4339 .cindex "Perl" "starting the interpreter"
4340 This option applies when an embedded Perl interpreter is linked with Exim (see
4341 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4342 option, forcing the starting of the interpreter to be delayed until it is
4343 needed.
4344
4345 .vitem &%-ps%&
4346 .oindex "&%-ps%&"
4347 .cindex "Perl" "starting the interpreter"
4348 This option applies when an embedded Perl interpreter is linked with Exim (see
4349 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4350 option, forcing the starting of the interpreter to occur as soon as Exim is
4351 started.
4352
4353 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4354 .oindex "&%-p%&"
4355 For compatibility with Sendmail, this option is equivalent to
4356 .display
4357 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4358 .endd
4359 It sets the incoming protocol and host name (for trusted callers). The
4360 host name and its colon can be omitted when only the protocol is to be set.
4361 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4362 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4363 or &`s`& using this option (but that does not seem a real limitation).
4364
4365 .vitem &%-q%&
4366 .oindex "&%-q%&"
4367 .cindex "queue runner" "starting manually"
4368 This option is normally restricted to admin users. However, there is a
4369 configuration option called &%prod_requires_admin%& which can be set false to
4370 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4371 and &%-S%& options).
4372
4373 .cindex "queue runner" "description of operation"
4374 The &%-q%& option starts one queue runner process. This scans the queue of
4375 waiting messages, and runs a delivery process for each one in turn. It waits
4376 for each delivery process to finish before starting the next one. A delivery
4377 process may not actually do any deliveries if the retry times for the addresses
4378 have not been reached. Use &%-qf%& (see below) if you want to override this.
4379
4380 If
4381 .cindex "SMTP" "passed connection"
4382 .cindex "SMTP" "multiple deliveries"
4383 .cindex "multiple SMTP deliveries"
4384 the delivery process spawns other processes to deliver other messages down
4385 passed SMTP connections, the queue runner waits for these to finish before
4386 proceeding.
4387
4388 When all the queued messages have been considered, the original queue runner
4389 process terminates. In other words, a single pass is made over the waiting
4390 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4391 this to be repeated periodically.
4392
4393 Exim processes the waiting messages in an unpredictable order. It isn't very
4394 random, but it is likely to be different each time, which is all that matters.
4395 If one particular message screws up a remote MTA, other messages to the same
4396 MTA have a chance of getting through if they get tried first.
4397
4398 It is possible to cause the messages to be processed in lexical message id
4399 order, which is essentially the order in which they arrived, by setting the
4400 &%queue_run_in_order%& option, but this is not recommended for normal use.
4401
4402 .vitem &%-q%&<&'qflags'&>
4403 The &%-q%& option may be followed by one or more flag letters that change its
4404 behaviour. They are all optional, but if more than one is present, they must
4405 appear in the correct order. Each flag is described in a separate item below.
4406
4407 .vitem &%-qq...%&
4408 .oindex "&%-qq%&"
4409 .cindex "queue" "double scanning"
4410 .cindex "queue" "routing"
4411 .cindex "routing" "whole queue before delivery"
4412 An option starting with &%-qq%& requests a two-stage queue run. In the first
4413 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4414 every domain. Addresses are routed, local deliveries happen, but no remote
4415 transports are run.
4416
4417 .cindex "hints database" "remembering routing"
4418 The hints database that remembers which messages are waiting for specific hosts
4419 is updated, as if delivery to those hosts had been deferred. After this is
4420 complete, a second, normal queue scan happens, with routing and delivery taking
4421 place as normal. Messages that are routed to the same host should mostly be
4422 delivered down a single SMTP
4423 .cindex "SMTP" "passed connection"
4424 .cindex "SMTP" "multiple deliveries"
4425 .cindex "multiple SMTP deliveries"
4426 connection because of the hints that were set up during the first queue scan.
4427 This option may be useful for hosts that are connected to the Internet
4428 intermittently.
4429
4430 .vitem &%-q[q]i...%&
4431 .oindex "&%-qi%&"
4432 .cindex "queue" "initial delivery"
4433 If the &'i'& flag is present, the queue runner runs delivery processes only for
4434 those messages that haven't previously been tried. (&'i'& stands for &"initial
4435 delivery"&.) This can be helpful if you are putting messages on the queue using
4436 &%-odq%& and want a queue runner just to process the new messages.
4437
4438 .vitem &%-q[q][i]f...%&
4439 .oindex "&%-qf%&"
4440 .cindex "queue" "forcing delivery"
4441 .cindex "delivery" "forcing in queue run"
4442 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4443 message, whereas without &'f'& only those non-frozen addresses that have passed
4444 their retry times are tried.
4445
4446 .vitem &%-q[q][i]ff...%&
4447 .oindex "&%-qff%&"
4448 .cindex "frozen messages" "forcing delivery"
4449 If &'ff'& is present, a delivery attempt is forced for every message, whether
4450 frozen or not.
4451
4452 .vitem &%-q[q][i][f[f]]l%&
4453 .oindex "&%-ql%&"
4454 .cindex "queue" "local deliveries only"
4455 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4456 be done. If a message requires any remote deliveries, it remains on the queue
4457 for later delivery.
4458
4459 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4460 .cindex "queue" "delivering specific messages"
4461 When scanning the queue, Exim can be made to skip over messages whose ids are
4462 lexically less than a given value by following the &%-q%& option with a
4463 starting message id. For example:
4464 .code
4465 exim -q 0t5C6f-0000c8-00
4466 .endd
4467 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4468 second message id is given, messages whose ids are lexically greater than it
4469 are also skipped. If the same id is given twice, for example,
4470 .code
4471 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4472 .endd
4473 just one delivery process is started, for that message. This differs from
4474 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4475 that it counts as a delivery from a queue run. Note that the selection
4476 mechanism does not affect the order in which the messages are scanned. There
4477 are also other ways of selecting specific sets of messages for delivery in a
4478 queue run &-- see &%-R%& and &%-S%&.
4479
4480 .vitem &%-q%&<&'qflags'&><&'time'&>
4481 .cindex "queue runner" "starting periodically"
4482 .cindex "periodic queue running"
4483 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4484 starting a queue runner process at intervals specified by the given time value
4485 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4486 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4487 single daemon process handles both functions. A common way of starting up a
4488 combined daemon at system boot time is to use a command such as
4489 .code
4490 /usr/exim/bin/exim -bd -q30m
4491 .endd
4492 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4493 process every 30 minutes.
4494
4495 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4496 pid file is written unless one is explicitly requested by the &%-oP%& option.
4497
4498 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4499 .oindex "&%-qR%&"
4500 This option is synonymous with &%-R%&. It is provided for Sendmail
4501 compatibility.
4502
4503 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4504 .oindex "&%-qS%&"
4505 This option is synonymous with &%-S%&.
4506
4507 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4508 .oindex "&%-R%&"
4509 .cindex "queue runner" "for specific recipients"
4510 .cindex "delivery" "to given domain"
4511 .cindex "domain" "delivery to"
4512 The <&'rsflags'&> may be empty, in which case the white space before the string
4513 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4514 which are the possible values for <&'rsflags'&>. White space is required if
4515 <&'rsflags'&> is not empty.
4516
4517 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4518 perform a single queue run, except that, when scanning the messages on the
4519 queue, Exim processes only those that have at least one undelivered recipient
4520 address containing the given string, which is checked in a case-independent
4521 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4522 regular expression; otherwise it is a literal string.
4523
4524 If you want to do periodic queue runs for messages with specific recipients,
4525 you can combine &%-R%& with &%-q%& and a time value. For example:
4526 .code
4527 exim -q25m -R @special.domain.example
4528 .endd
4529 This example does a queue run for messages with recipients in the given domain
4530 every 25 minutes. Any additional flags that are specified with &%-q%& are
4531 applied to each queue run.
4532
4533 Once a message is selected for delivery by this mechanism, all its addresses
4534 are processed. For the first selected message, Exim overrides any retry
4535 information and forces a delivery attempt for each undelivered address. This
4536 means that if delivery of any address in the first message is successful, any
4537 existing retry information is deleted, and so delivery attempts for that
4538 address in subsequently selected messages (which are processed without forcing)
4539 will run. However, if delivery of any address does not succeed, the retry
4540 information is updated, and in subsequently selected messages, the failing
4541 address will be skipped.
4542
4543 .cindex "frozen messages" "forcing delivery"
4544 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4545 all selected messages, not just the first; frozen messages are included when
4546 &'ff'& is present.
4547
4548 The &%-R%& option makes it straightforward to initiate delivery of all messages
4549 to a given domain after a host has been down for some time. When the SMTP
4550 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4551 effect is to run Exim with the &%-R%& option, but it can be configured to run
4552 an arbitrary command instead.
4553
4554 .vitem &%-r%&
4555 .oindex "&%-r%&"
4556 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4557
4558 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4559 .oindex "&%-S%&"
4560 .cindex "delivery" "from given sender"
4561 .cindex "queue runner" "for specific senders"
4562 This option acts like &%-R%& except that it checks the string against each
4563 message's sender instead of against the recipients. If &%-R%& is also set, both
4564 conditions must be met for a message to be selected. If either of the options
4565 has &'f'& or &'ff'& in its flags, the associated action is taken.
4566
4567 .vitem &%-Tqt%&&~<&'times'&>
4568 .oindex "&%-Tqt%&"
4569 This is an option that is exclusively for use by the Exim testing suite. It is not
4570 recognized when Exim is run normally. It allows for the setting up of explicit
4571 &"queue times"& so that various warning/retry features can be tested.
4572
4573 .vitem &%-t%&
4574 .oindex "&%-t%&"
4575 .cindex "recipient" "extracting from header lines"
4576 .cindex "&'Bcc:'& header line"
4577 .cindex "&'Cc:'& header line"
4578 .cindex "&'To:'& header line"
4579 When Exim is receiving a locally-generated, non-SMTP message on its standard
4580 input, the &%-t%& option causes the recipients of the message to be obtained
4581 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4582 from the command arguments. The addresses are extracted before any rewriting
4583 takes place and the &'Bcc:'& header line, if present, is then removed.
4584
4585 .cindex "Sendmail compatibility" "&%-t%& option"
4586 If the command has any arguments, they specify addresses to which the message
4587 is &'not'& to be delivered. That is, the argument addresses are removed from
4588 the recipients list obtained from the headers. This is compatible with Smail 3
4589 and in accordance with the documented behaviour of several versions of
4590 Sendmail, as described in man pages on a number of operating systems (e.g.
4591 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4592 argument addresses to those obtained from the headers, and the O'Reilly
4593 Sendmail book documents it that way. Exim can be made to add argument addresses
4594 instead of subtracting them by setting the option
4595 &%extract_addresses_remove_arguments%& false.
4596
4597 .cindex "&%Resent-%& header lines" "with &%-t%&"
4598 If there are any &%Resent-%& header lines in the message, Exim extracts
4599 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4600 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4601 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4602 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4603
4604 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4605 message is resent several times). The RFC also specifies that they should be
4606 added at the front of the message, and separated by &'Received:'& lines. It is
4607 not at all clear how &%-t%& should operate in the present of multiple sets,
4608 nor indeed exactly what constitutes a &"set"&.
4609 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4610 are often added at the end of the header, and if a message is resent more than
4611 once, it is common for the original set of &%Resent-%& headers to be renamed as
4612 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4613
4614 .vitem &%-ti%&
4615 .oindex "&%-ti%&"
4616 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4617 compatibility with Sendmail.
4618
4619 .vitem &%-tls-on-connect%&
4620 .oindex "&%-tls-on-connect%&"
4621 .cindex "TLS" "use without STARTTLS"
4622 .cindex "TLS" "automatic start"
4623 This option is available when Exim is compiled with TLS support. It forces all
4624 incoming SMTP connections to behave as if the incoming port is listed in the
4625 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4626 &<<CHAPTLS>>& for further details.
4627
4628
4629 .vitem &%-U%&
4630 .oindex "&%-U%&"
4631 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4632 Sendmail uses this option for &"initial message submission"&, and its
4633 documentation states that in future releases, it may complain about
4634 syntactically invalid messages rather than fixing them when this flag is not
4635 set. Exim ignores this option.
4636
4637 .vitem &%-v%&
4638 .oindex "&%-v%&"
4639 This option causes Exim to write information to the standard error stream,
4640 describing what it is doing. In particular, it shows the log lines for
4641 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4642 dialogue is shown. Some of the log lines shown may not actually be written to
4643 the log if the setting of &%log_selector%& discards them. Any relevant
4644 selectors are shown with each log line. If none are shown, the logging is
4645 unconditional.
4646
4647 .vitem &%-x%&
4648 .oindex "&%-x%&"
4649 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4650 National Language Support extended characters in the body of the mail item"&).
4651 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4652 this option.
4653
4654 .vitem &%-X%&&~<&'logfile'&>
4655 .oindex "&%-X%&"
4656 This option is interpreted by Sendmail to cause debug information to be sent
4657 to the named file.  It is ignored by Exim.
4658
4659 .vitem &%-z%&&~<&'log-line'&>
4660 .oindex "&%-z%&"
4661 This option writes its argument to Exim's logfile.
4662 Use is restricted to administrators; the intent is for operational notes.
4663 Quotes should be used to maintain a multi-word item as a single argument,
4664 under most shells.
4665 .endlist
4666
4667 .ecindex IIDclo1
4668 .ecindex IIDclo2
4669
4670
4671 . ////////////////////////////////////////////////////////////////////////////
4672 . Insert a stylized DocBook comment here, to identify the end of the command
4673 . line options. This is for the benefit of the Perl script that automatically
4674 . creates a man page for the options.
4675 . ////////////////////////////////////////////////////////////////////////////
4676
4677 .literal xml
4678 <!-- === End of command line options === -->
4679 .literal off
4680
4681
4682
4683
4684
4685 . ////////////////////////////////////////////////////////////////////////////
4686 . ////////////////////////////////////////////////////////////////////////////
4687
4688
4689 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4690          "The runtime configuration file"
4691
4692 .cindex "run time configuration"
4693 .cindex "configuration file" "general description"
4694 .cindex "CONFIGURE_FILE"
4695 .cindex "configuration file" "errors in"
4696 .cindex "error" "in configuration file"
4697 .cindex "return code" "for bad configuration"
4698 Exim uses a single run time configuration file that is read whenever an Exim
4699 binary is executed. Note that in normal operation, this happens frequently,
4700 because Exim is designed to operate in a distributed manner, without central
4701 control.
4702
4703 If a syntax error is detected while reading the configuration file, Exim
4704 writes a message on the standard error, and exits with a non-zero return code.
4705 The message is also written to the panic log. &*Note*&: Only simple syntax
4706 errors can be detected at this time. The values of any expanded options are
4707 not checked until the expansion happens, even when the expansion does not
4708 actually alter the string.
4709
4710 The name of the configuration file is compiled into the binary for security
4711 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4712 most configurations, this specifies a single file. However, it is permitted to
4713 give a colon-separated list of file names, in which case Exim uses the first
4714 existing file in the list.
4715
4716 .cindex "EXIM_USER"
4717 .cindex "EXIM_GROUP"
4718 .cindex "CONFIGURE_OWNER"
4719 .cindex "CONFIGURE_GROUP"
4720 .cindex "configuration file" "ownership"
4721 .cindex "ownership" "configuration file"
4722 The run time configuration file must be owned by root or by the user that is
4723 specified at compile time by the CONFIGURE_OWNER option (if set). The
4724 configuration file must not be world-writeable, or group-writeable unless its
4725 group is the root group or the one specified at compile time by the
4726 CONFIGURE_GROUP option.
4727
4728 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4729 to root, anybody who is able to edit the run time configuration file has an
4730 easy way to run commands as root. If you specify a user or group in the
4731 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4732 who are members of that group will trivially be able to obtain root privileges.
4733
4734 Up to Exim version 4.72, the run time configuration file was also permitted to
4735 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4736 since it offered a simple privilege escalation for any attacker who managed to
4737 compromise the Exim user account.
4738
4739 A default configuration file, which will work correctly in simple situations,
4740 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4741 defines just one file name, the installation process copies the default
4742 configuration to a new file of that name if it did not previously exist. If
4743 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4744 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4745 configuration.
4746
4747
4748
4749 .section "Using a different configuration file" "SECID40"
4750 .cindex "configuration file" "alternate"
4751 A one-off alternate configuration can be specified by the &%-C%& command line
4752 option, which may specify a single file or a list of files. However, when
4753 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4754 unless the argument for &%-C%& is identical to the built-in value from
4755 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4756 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4757 is useful mainly for checking the syntax of configuration files before
4758 installing them. No owner or group checks are done on a configuration file
4759 specified by &%-C%&, if root privilege has been dropped.
4760
4761 Even the Exim user is not trusted to specify an arbitrary configuration file
4762 with the &%-C%& option to be used with root privileges, unless that file is
4763 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4764 testing a configuration using &%-C%& right through message reception and
4765 delivery, even if the caller is root. The reception works, but by that time,
4766 Exim is running as the Exim user, so when it re-execs to regain privilege for
4767 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4768 can test reception and delivery using two separate commands (one to put a
4769 message on the queue, using &%-odq%&, and another to do the delivery, using
4770 &%-M%&).
4771
4772 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4773 prefix string with which any file named in a &%-C%& command line option must
4774 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4775 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4776 name can be used with &%-C%&.
4777
4778 One-off changes to a configuration can be specified by the &%-D%& command line
4779 option, which defines and overrides values for macros used inside the
4780 configuration file. However, like &%-C%&, the use of this option by a
4781 non-privileged user causes Exim to discard its root privilege.
4782 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4783 completely disabled, and its use causes an immediate error exit.
4784
4785 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4786 to declare certain macro names trusted, such that root privilege will not
4787 necessarily be discarded.
4788 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4789 considered safe and, if &%-D%& only supplies macros from this list, and the
4790 values are acceptable, then Exim will not give up root privilege if the caller
4791 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4792 transition mechanism and is expected to be removed in the future.  Acceptable
4793 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4794
4795 Some sites may wish to use the same Exim binary on different machines that
4796 share a file system, but to use different configuration files on each machine.
4797 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4798 looks for a file whose name is the configuration file name followed by a dot
4799 and the machine's node name, as obtained from the &[uname()]& function. If this
4800 file does not exist, the standard name is tried. This processing occurs for
4801 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4802
4803 In some esoteric situations different versions of Exim may be run under
4804 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4805 help with this. See the comments in &_src/EDITME_& for details.
4806
4807
4808
4809 .section "Configuration file format" "SECTconffilfor"
4810 .cindex "configuration file" "format of"
4811 .cindex "format" "configuration file"
4812 Exim's configuration file is divided into a number of different parts. General
4813 option settings must always appear at the start of the file. The other parts
4814 are all optional, and may appear in any order. Each part other than the first
4815 is introduced by the word &"begin"& followed by at least one literal
4816 space, and the name of the part. The optional parts are:
4817
4818 .ilist
4819 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4820 &<<CHAPACL>>&).
4821 .next
4822 .cindex "AUTH" "configuration"
4823 &'authenticators'&: Configuration settings for the authenticator drivers. These
4824 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4825 .next
4826 &'routers'&: Configuration settings for the router drivers. Routers process
4827 addresses and determine how the message is to be delivered (see chapters
4828 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4829 .next
4830 &'transports'&: Configuration settings for the transport drivers. Transports
4831 define mechanisms for copying messages to destinations (see chapters
4832 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4833 .next
4834 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4835 If there is no retry section, or if it is empty (that is, no retry rules are
4836 defined), Exim will not retry deliveries. In this situation, temporary errors
4837 are treated the same as permanent errors. Retry rules are discussed in chapter
4838 &<<CHAPretry>>&.
4839 .next
4840 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4841 when new addresses are generated during delivery. Rewriting is discussed in
4842 chapter &<<CHAPrewrite>>&.
4843 .next
4844 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4845 want to use this feature, you must set
4846 .code
4847 LOCAL_SCAN_HAS_OPTIONS=yes
4848 .endd
4849 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4850 facility are given in chapter &<<CHAPlocalscan>>&.
4851 .endlist
4852
4853 .cindex "configuration file" "leading white space in"
4854 .cindex "configuration file" "trailing white space in"
4855 .cindex "white space" "in configuration file"
4856 Leading and trailing white space in configuration lines is always ignored.
4857
4858 Blank lines in the file, and lines starting with a # character (ignoring
4859 leading white space) are treated as comments and are ignored. &*Note*&: A
4860 # character other than at the beginning of a line is not treated specially,
4861 and does not introduce a comment.
4862
4863 Any non-comment line can be continued by ending it with a backslash. Note that
4864 the general rule for white space means that trailing white space after the
4865 backslash and leading white space at the start of continuation
4866 lines is ignored. Comment lines beginning with # (but not empty lines) may
4867 appear in the middle of a sequence of continuation lines.
4868
4869 A convenient way to create a configuration file is to start from the
4870 default, which is supplied in &_src/configure.default_&, and add, delete, or
4871 change settings as required.
4872
4873 The ACLs, retry rules, and rewriting rules have their own syntax which is
4874 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4875 respectively. The other parts of the configuration file have some syntactic
4876 items in common, and these are described below, from section &<<SECTcos>>&
4877 onwards. Before that, the inclusion, macro, and conditional facilities are
4878 described.
4879
4880
4881
4882 .section "File inclusions in the configuration file" "SECID41"
4883 .cindex "inclusions in configuration file"
4884 .cindex "configuration file" "including other files"
4885 .cindex "&`.include`& in configuration file"
4886 .cindex "&`.include_if_exists`& in configuration file"
4887 You can include other files inside Exim's run time configuration file by
4888 using this syntax:
4889 .display
4890 &`.include`& <&'file name'&>
4891 &`.include_if_exists`& <&'file name'&>
4892 .endd
4893 on a line by itself. Double quotes round the file name are optional. If you use
4894 the first form, a configuration error occurs if the file does not exist; the
4895 second form does nothing for non-existent files. In all cases, an absolute file
4896 name is required.
4897
4898 Includes may be nested to any depth, but remember that Exim reads its
4899 configuration file often, so it is a good idea to keep them to a minimum.
4900 If you change the contents of an included file, you must HUP the daemon,
4901 because an included file is read only when the configuration itself is read.
4902
4903 The processing of inclusions happens early, at a physical line level, so, like
4904 comment lines, an inclusion can be used in the middle of an option setting,
4905 for example:
4906 .code
4907 hosts_lookup = a.b.c \
4908                .include /some/file
4909 .endd
4910 Include processing happens after macro processing (see below). Its effect is to
4911 process the lines of the included file as if they occurred inline where the
4912 inclusion appears.
4913
4914
4915
4916 .section "Macros in the configuration file" "SECTmacrodefs"
4917 .cindex "macro" "description of"
4918 .cindex "configuration file" "macros"
4919 If a line in the main part of the configuration (that is, before the first
4920 &"begin"& line) begins with an upper case letter, it is taken as a macro
4921 definition, and must be of the form
4922 .display
4923 <&'name'&> = <&'rest of line'&>
4924 .endd
4925 The name must consist of letters, digits, and underscores, and need not all be
4926 in upper case, though that is recommended. The rest of the line, including any
4927 continuations, is the replacement text, and has leading and trailing white
4928 space removed. Quotes are not removed. The replacement text can never end with
4929 a backslash character, but this doesn't seem to be a serious limitation.
4930
4931 Macros may also be defined between router, transport, authenticator, or ACL
4932 definitions. They may not, however, be defined within an individual driver or
4933 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4934
4935 .section "Macro substitution" "SECID42"
4936 Once a macro is defined, all subsequent lines in the file (and any included
4937 files) are scanned for the macro name; if there are several macros, the line is
4938 scanned for each in turn, in the order in which the macros are defined. The
4939 replacement text is not re-scanned for the current macro, though it is scanned
4940 for subsequently defined macros. For this reason, a macro name may not contain
4941 the name of a previously defined macro as a substring. You could, for example,
4942 define
4943 .display
4944 &`ABCD_XYZ = `&<&'something'&>
4945 &`ABCD = `&<&'something else'&>
4946 .endd
4947 but putting the definitions in the opposite order would provoke a configuration
4948 error. Macro expansion is applied to individual physical lines from the file,
4949 before checking for line continuation or file inclusion (see above). If a line
4950 consists solely of a macro name, and the expansion of the macro is empty, the
4951 line is ignored. A macro at the start of a line may turn the line into a
4952 comment line or a &`.include`& line.
4953
4954
4955 .section "Redefining macros" "SECID43"
4956 Once defined, the value of a macro can be redefined later in the configuration
4957 (or in an included file). Redefinition is specified by using &'=='& instead of
4958 &'='&. For example:
4959 .code
4960 MAC =  initial value
4961 ...
4962 MAC == updated value
4963 .endd
4964 Redefinition does not alter the order in which the macros are applied to the
4965 subsequent lines of the configuration file. It is still the same order in which
4966 the macros were originally defined. All that changes is the macro's value.
4967 Redefinition makes it possible to accumulate values. For example:
4968 .code
4969 MAC =  initial value
4970 ...
4971 MAC == MAC and something added
4972 .endd
4973 This can be helpful in situations where the configuration file is built
4974 from a number of other files.
4975
4976 .section "Overriding macro values" "SECID44"
4977 The values set for macros in the configuration file can be overridden by the
4978 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4979 used, unless called by root or the Exim user. A definition on the command line
4980 using the &%-D%& option causes all definitions and redefinitions within the
4981 file to be ignored.
4982
4983
4984
4985 .section "Example of macro usage" "SECID45"
4986 As an example of macro usage, consider a configuration where aliases are looked
4987 up in a MySQL database. It helps to keep the file less cluttered if long
4988 strings such as SQL statements are defined separately as macros, for example:
4989 .code
4990 ALIAS_QUERY = select mailbox from user where \
4991               login='${quote_mysql:$local_part}';
4992 .endd
4993 This can then be used in a &(redirect)& router setting like this:
4994 .code
4995 data = ${lookup mysql{ALIAS_QUERY}}
4996 .endd
4997 In earlier versions of Exim macros were sometimes used for domain, host, or
4998 address lists. In Exim 4 these are handled better by named lists &-- see
4999 section &<<SECTnamedlists>>&.
5000
5001
5002 .section "Conditional skips in the configuration file" "SECID46"
5003 .cindex "configuration file" "conditional skips"
5004 .cindex "&`.ifdef`&"
5005 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5006 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5007 portions of the configuration file. The processing happens whenever the file is
5008 read (that is, when an Exim binary starts to run).
5009
5010 The implementation is very simple. Instances of the first four directives must
5011 be followed by text that includes the names of one or macros. The condition
5012 that is tested is whether or not any macro substitution has taken place in the
5013 line. Thus:
5014 .code
5015 .ifdef AAA
5016 message_size_limit = 50M
5017 .else
5018 message_size_limit = 100M
5019 .endif
5020 .endd
5021 sets a message size limit of 50M if the macro &`AAA`& is defined
5022 (or &`A`& or &`AA`&), and 100M
5023 otherwise. If there is more than one macro named on the line, the condition
5024 is true if any of them are defined. That is, it is an &"or"& condition. To
5025 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5026
5027 Although you can use a macro expansion to generate one of these directives,
5028 it is not very useful, because the condition &"there was a macro substitution
5029 in this line"& will always be true.
5030
5031 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5032 to clarify complicated nestings.
5033
5034
5035
5036 .section "Common option syntax" "SECTcos"
5037 .cindex "common option syntax"
5038 .cindex "syntax of common options"
5039 .cindex "configuration file" "common option syntax"
5040 For the main set of options, driver options, and &[local_scan()]& options,
5041 each setting is on a line by itself, and starts with a name consisting of
5042 lower-case letters and underscores. Many options require a data value, and in
5043 these cases the name must be followed by an equals sign (with optional white
5044 space) and then the value. For example:
5045 .code
5046 qualify_domain = mydomain.example.com
5047 .endd
5048 .cindex "hiding configuration option values"
5049 .cindex "configuration options" "hiding value of"
5050 .cindex "options" "hiding value of"
5051 Some option settings may contain sensitive data, for example, passwords for
5052 accessing databases. To stop non-admin users from using the &%-bP%& command
5053 line option to read these values, you can precede the option settings with the
5054 word &"hide"&. For example:
5055 .code
5056 hide mysql_servers = localhost/users/admin/secret-password
5057 .endd
5058 For non-admin users, such options are displayed like this:
5059 .code
5060 mysql_servers = <value not displayable>
5061 .endd
5062 If &"hide"& is used on a driver option, it hides the value of that option on
5063 all instances of the same driver.
5064
5065 The following sections describe the syntax used for the different data types
5066 that are found in option settings.
5067
5068
5069 .section "Boolean options" "SECID47"
5070 .cindex "format" "boolean"
5071 .cindex "boolean configuration values"
5072 .oindex "&%no_%&&'xxx'&"
5073 .oindex "&%not_%&&'xxx'&"
5074 Options whose type is given as boolean are on/off switches. There are two
5075 different ways of specifying such options: with and without a data value. If
5076 the option name is specified on its own without data, the switch is turned on;
5077 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5078 boolean options may be followed by an equals sign and one of the words
5079 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5080 the following two settings have exactly the same effect:
5081 .code
5082 queue_only
5083 queue_only = true
5084 .endd
5085 The following two lines also have the same (opposite) effect:
5086 .code
5087 no_queue_only
5088 queue_only = false
5089 .endd
5090 You can use whichever syntax you prefer.
5091
5092
5093
5094
5095 .section "Integer values" "SECID48"
5096 .cindex "integer configuration values"
5097 .cindex "format" "integer"
5098 If an option's type is given as &"integer"&, the value can be given in decimal,
5099 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5100 number is assumed. Otherwise, it is treated as an octal number unless it starts
5101 with the characters &"0x"&, in which case the remainder is interpreted as a
5102 hexadecimal number.
5103
5104 If an integer value is followed by the letter K, it is multiplied by 1024; if
5105 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5106 of integer option settings are output, values which are an exact multiple of
5107 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5108 and M. The printing style is independent of the actual input format that was
5109 used.
5110
5111
5112 .section "Octal integer values" "SECID49"
5113 .cindex "integer format"
5114 .cindex "format" "octal integer"
5115 If an option's type is given as &"octal integer"&, its value is always
5116 interpreted as an octal number, whether or not it starts with the digit zero.
5117 Such options are always output in octal.
5118
5119
5120 .section "Fixed point numbers" "SECID50"
5121 .cindex "fixed point configuration values"
5122 .cindex "format" "fixed point"
5123 If an option's type is given as &"fixed-point"&, its value must be a decimal
5124 integer, optionally followed by a decimal point and up to three further digits.
5125
5126
5127
5128 .section "Time intervals" "SECTtimeformat"
5129 .cindex "time interval" "specifying in configuration"
5130 .cindex "format" "time interval"
5131 A time interval is specified as a sequence of numbers, each followed by one of
5132 the following letters, with no intervening white space:
5133
5134 .table2 30pt
5135 .irow &%s%& seconds
5136 .irow &%m%& minutes
5137 .irow &%h%& hours
5138 .irow &%d%& days
5139 .irow &%w%& weeks
5140 .endtable
5141
5142 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5143 intervals are output in the same format. Exim does not restrict the values; it
5144 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5145
5146
5147
5148 .section "String values" "SECTstrings"
5149 .cindex "string" "format of configuration values"
5150 .cindex "format" "string"
5151 If an option's type is specified as &"string"&, the value can be specified with
5152 or without double-quotes. If it does not start with a double-quote, the value
5153 consists of the remainder of the line plus any continuation lines, starting at
5154 the first character after any leading white space, with trailing white space
5155 removed, and with no interpretation of the characters in the string. Because
5156 Exim removes comment lines (those beginning with #) at an early stage, they can
5157 appear in the middle of a multi-line string. The following two settings are
5158 therefore equivalent:
5159 .code
5160 trusted_users = uucp:mail
5161 trusted_users = uucp:\
5162                 # This comment line is ignored
5163                 mail
5164 .endd
5165 .cindex "string" "quoted"
5166 .cindex "escape characters in quoted strings"
5167 If a string does start with a double-quote, it must end with a closing
5168 double-quote, and any backslash characters other than those used for line
5169 continuation are interpreted as escape characters, as follows:
5170
5171 .table2 100pt
5172 .irow &`\\`&                     "single backslash"
5173 .irow &`\n`&                     "newline"
5174 .irow &`\r`&                     "carriage return"
5175 .irow &`\t`&                     "tab"
5176 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5177 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5178                                    character"
5179 .endtable
5180
5181 If a backslash is followed by some other character, including a double-quote
5182 character, that character replaces the pair.
5183
5184 Quoting is necessary only if you want to make use of the backslash escapes to
5185 insert special characters, or if you need to specify a value with leading or
5186 trailing spaces. These cases are rare, so quoting is almost never needed in
5187 current versions of Exim. In versions of Exim before 3.14, quoting was required
5188 in order to continue lines, so you may come across older configuration files
5189 and examples that apparently quote unnecessarily.
5190
5191
5192 .section "Expanded strings" "SECID51"
5193 .cindex "expansion" "definition of"
5194 Some strings in the configuration file are subjected to &'string expansion'&,
5195 by which means various parts of the string may be changed according to the
5196 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5197 is as just described; in particular, the handling of backslashes in quoted
5198 strings is done as part of the input process, before expansion takes place.
5199 However, backslash is also an escape character for the expander, so any
5200 backslashes that are required for that reason must be doubled if they are
5201 within a quoted configuration string.
5202
5203
5204 .section "User and group names" "SECID52"
5205 .cindex "user name" "format of"
5206 .cindex "format" "user name"
5207 .cindex "groups" "name format"
5208 .cindex "format" "group name"
5209 User and group names are specified as strings, using the syntax described
5210 above, but the strings are interpreted specially. A user or group name must
5211 either consist entirely of digits, or be a name that can be looked up using the
5212 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5213
5214
5215 .section "List construction" "SECTlistconstruct"
5216 .cindex "list" "syntax of in configuration"
5217 .cindex "format" "list item in configuration"
5218 .cindex "string" "list, definition of"
5219 The data for some configuration options is a list of items, with colon as the
5220 default separator. Many of these options are shown with type &"string list"& in
5221 the descriptions later in this document. Others are listed as &"domain list"&,
5222 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5223 are all the same; however, those other than &"string list"& are subject to
5224 particular kinds of interpretation, as described in chapter
5225 &<<CHAPdomhosaddlists>>&.
5226
5227 In all these cases, the entire list is treated as a single string as far as the
5228 input syntax is concerned. The &%trusted_users%& setting in section
5229 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5230 in a list, it must be entered as two colons. Leading and trailing white space
5231 on each item in a list is ignored. This makes it possible to include items that
5232 start with a colon, and in particular, certain forms of IPv6 address. For
5233 example, the list
5234 .code
5235 local_interfaces = 127.0.0.1 : ::::1
5236 .endd
5237 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5238
5239 &*Note*&: Although leading and trailing white space is ignored in individual
5240 list items, it is not ignored when parsing the list. The space after the first
5241 colon in the example above is necessary. If it were not there, the list would
5242 be interpreted as the two items 127.0.0.1:: and 1.
5243
5244 .section "Changing list separators" "SECTlistsepchange"
5245 .cindex "list separator" "changing"
5246 .cindex "IPv6" "addresses in lists"
5247 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5248 introduced to allow the separator character to be changed. If a list begins
5249 with a left angle bracket, followed by any punctuation character, that
5250 character is used instead of colon as the list separator. For example, the list
5251 above can be rewritten to use a semicolon separator like this:
5252 .code
5253 local_interfaces = <; 127.0.0.1 ; ::1
5254 .endd
5255 This facility applies to all lists, with the exception of the list in
5256 &%log_file_path%&. It is recommended that the use of non-colon separators be
5257 confined to circumstances where they really are needed.
5258
5259 .cindex "list separator" "newline as"
5260 .cindex "newline" "as list separator"
5261 It is also possible to use newline and other control characters (those with
5262 code values less than 32, plus DEL) as separators in lists. Such separators
5263 must be provided literally at the time the list is processed. For options that
5264 are string-expanded, you can write the separator using a normal escape
5265 sequence. This will be processed by the expander before the string is
5266 interpreted as a list. For example, if a newline-separated list of domains is
5267 generated by a lookup, you can process it directly by a line such as this:
5268 .code
5269 domains = <\n ${lookup mysql{.....}}
5270 .endd
5271 This avoids having to change the list separator in such data. You are unlikely
5272 to want to use a control character as a separator in an option that is not
5273 expanded, because the value is literal text. However, it can be done by giving
5274 the value in quotes. For example:
5275 .code
5276 local_interfaces = "<\n 127.0.0.1 \n ::1"
5277 .endd
5278 Unlike printing character separators, which can be included in list items by
5279 doubling, it is not possible to include a control character as data when it is
5280 set as the separator. Two such characters in succession are interpreted as
5281 enclosing an empty list item.
5282
5283
5284
5285 .section "Empty items in lists" "SECTempitelis"
5286 .cindex "list" "empty item in"
5287 An empty item at the end of a list is always ignored. In other words, trailing
5288 separator characters are ignored. Thus, the list in
5289 .code
5290 senders = user@domain :
5291 .endd
5292 contains only a single item. If you want to include an empty string as one item
5293 in a list, it must not be the last item. For example, this list contains three
5294 items, the second of which is empty:
5295 .code
5296 senders = user1@domain : : user2@domain
5297 .endd
5298 &*Note*&: There must be white space between the two colons, as otherwise they
5299 are interpreted as representing a single colon data character (and the list
5300 would then contain just one item). If you want to specify a list that contains
5301 just one, empty item, you can do it as in this example:
5302 .code
5303 senders = :
5304 .endd
5305 In this case, the first item is empty, and the second is discarded because it
5306 is at the end of the list.
5307
5308
5309
5310
5311 .section "Format of driver configurations" "SECTfordricon"
5312 .cindex "drivers" "configuration format"
5313 There are separate parts in the configuration for defining routers, transports,
5314 and authenticators. In each part, you are defining a number of driver
5315 instances, each with its own set of options. Each driver instance is defined by
5316 a sequence of lines like this:
5317 .display
5318 <&'instance name'&>:
5319   <&'option'&>
5320   ...
5321   <&'option'&>
5322 .endd
5323 In the following example, the instance name is &(localuser)&, and it is
5324 followed by three options settings:
5325 .code
5326 localuser:
5327   driver = accept
5328   check_local_user
5329   transport = local_delivery
5330 .endd
5331 For each driver instance, you specify which Exim code module it uses &-- by the
5332 setting of the &%driver%& option &-- and (optionally) some configuration
5333 settings. For example, in the case of transports, if you want a transport to
5334 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5335 a local file you would use the &(appendfile)& driver. Each of the drivers is
5336 described in detail in its own separate chapter later in this manual.
5337
5338 You can have several routers, transports, or authenticators that are based on
5339 the same underlying driver (each must have a different instance name).
5340
5341 The order in which routers are defined is important, because addresses are
5342 passed to individual routers one by one, in order. The order in which
5343 transports are defined does not matter at all. The order in which
5344 authenticators are defined is used only when Exim, as a client, is searching
5345 them to find one that matches an authentication mechanism offered by the
5346 server.
5347
5348 .cindex "generic options"
5349 .cindex "options" "generic &-- definition of"
5350 Within a driver instance definition, there are two kinds of option: &'generic'&
5351 and &'private'&. The generic options are those that apply to all drivers of the
5352 same type (that is, all routers, all transports or all authenticators). The
5353 &%driver%& option is a generic option that must appear in every definition.
5354 .cindex "private options"
5355 The private options are special for each driver, and none need appear, because
5356 they all have default values.
5357
5358 The options may appear in any order, except that the &%driver%& option must
5359 precede any private options, since these depend on the particular driver. For
5360 this reason, it is recommended that &%driver%& always be the first option.
5361
5362 Driver instance names, which are used for reference in log entries and
5363 elsewhere, can be any sequence of letters, digits, and underscores (starting
5364 with a letter) and must be unique among drivers of the same type. A router and
5365 a transport (for example) can each have the same name, but no two router
5366 instances can have the same name. The name of a driver instance should not be
5367 confused with the name of the underlying driver module. For example, the
5368 configuration lines:
5369 .code
5370 remote_smtp:
5371   driver = smtp
5372 .endd
5373 create an instance of the &(smtp)& transport driver whose name is
5374 &(remote_smtp)&. The same driver code can be used more than once, with
5375 different instance names and different option settings each time. A second
5376 instance of the &(smtp)& transport, with different options, might be defined
5377 thus:
5378 .code
5379 special_smtp:
5380   driver = smtp
5381   port = 1234
5382   command_timeout = 10s
5383 .endd
5384 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5385 these transport instances from routers, and these names would appear in log
5386 lines.
5387
5388 Comment lines may be present in the middle of driver specifications. The full
5389 list of option settings for any particular driver instance, including all the
5390 defaulted values, can be extracted by making use of the &%-bP%& command line
5391 option.
5392
5393
5394
5395
5396
5397
5398 . ////////////////////////////////////////////////////////////////////////////
5399 . ////////////////////////////////////////////////////////////////////////////
5400
5401 .chapter "The default configuration file" "CHAPdefconfil"
5402 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5403 .cindex "default" "configuration file &""walk through""&"
5404 The default configuration file supplied with Exim as &_src/configure.default_&
5405 is sufficient for a host with simple mail requirements. As an introduction to
5406 the way Exim is configured, this chapter &"walks through"& the default
5407 configuration, giving brief explanations of the settings. Detailed descriptions
5408 of the options are given in subsequent chapters. The default configuration file
5409 itself contains extensive comments about ways you might want to modify the
5410 initial settings. However, note that there are many options that are not
5411 mentioned at all in the default configuration.
5412
5413
5414
5415 .section "Main configuration settings" "SECTdefconfmain"
5416 The main (global) configuration option settings must always come first in the
5417 file. The first thing you'll see in the file, after some initial comments, is
5418 the line
5419 .code
5420 # primary_hostname =
5421 .endd
5422 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5423 to know the official, fully qualified name of your host, and this is where you
5424 can specify it. However, in most cases you do not need to set this option. When
5425 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5426
5427 The first three non-comment configuration lines are as follows:
5428 .code
5429 domainlist local_domains    = @
5430 domainlist relay_to_domains =
5431 hostlist   relay_from_hosts = 127.0.0.1
5432 .endd
5433 These are not, in fact, option settings. They are definitions of two named
5434 domain lists and one named host list. Exim allows you to give names to lists of
5435 domains, hosts, and email addresses, in order to make it easier to manage the
5436 configuration file (see section &<<SECTnamedlists>>&).
5437
5438 The first line defines a domain list called &'local_domains'&; this is used
5439 later in the configuration to identify domains that are to be delivered
5440 on the local host.
5441
5442 .cindex "@ in a domain list"
5443 There is just one item in this list, the string &"@"&. This is a special form
5444 of entry which means &"the name of the local host"&. Thus, if the local host is
5445 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5446 be delivered locally. Because the local host's name is referenced indirectly,
5447 the same configuration file can be used on different hosts.
5448
5449 The second line defines a domain list called &'relay_to_domains'&, but the
5450 list itself is empty. Later in the configuration we will come to the part that
5451 controls mail relaying through the local host; it allows relaying to any
5452 domains in this list. By default, therefore, no relaying on the basis of a mail
5453 domain is permitted.
5454
5455 The third line defines a host list called &'relay_from_hosts'&. This list is
5456 used later in the configuration to permit relaying from any host or IP address
5457 that matches the list. The default contains just the IP address of the IPv4
5458 loopback interface, which means that processes on the local host are able to
5459 submit mail for relaying by sending it over TCP/IP to that interface. No other
5460 hosts are permitted to submit messages for relaying.
5461
5462 Just to be sure there's no misunderstanding: at this point in the configuration
5463 we aren't actually setting up any controls. We are just defining some domains
5464 and hosts that will be used in the controls that are specified later.
5465
5466 The next two configuration lines are genuine option settings:
5467 .code
5468 acl_smtp_rcpt = acl_check_rcpt
5469 acl_smtp_data = acl_check_data
5470 .endd
5471 These options specify &'Access Control Lists'& (ACLs) that are to be used
5472 during an incoming SMTP session for every recipient of a message (every RCPT
5473 command), and after the contents of the message have been received,
5474 respectively. The names of the lists are &'acl_check_rcpt'& and
5475 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5476 section of the configuration. The RCPT ACL controls which recipients are
5477 accepted for an incoming message &-- if a configuration does not provide an ACL
5478 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5479 contents of a message to be checked.
5480
5481 Two commented-out option settings are next:
5482 .code
5483 # av_scanner = clamd:/tmp/clamd
5484 # spamd_address = 127.0.0.1 783
5485 .endd
5486 These are example settings that can be used when Exim is compiled with the
5487 content-scanning extension. The first specifies the interface to the virus
5488 scanner, and the second specifies the interface to SpamAssassin. Further
5489 details are given in chapter &<<CHAPexiscan>>&.
5490
5491 Three more commented-out option settings follow:
5492 .code
5493 # tls_advertise_hosts = *
5494 # tls_certificate = /etc/ssl/exim.crt
5495 # tls_privatekey = /etc/ssl/exim.pem
5496 .endd
5497 These are example settings that can be used when Exim is compiled with
5498 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5499 first one specifies the list of clients that are allowed to use TLS when
5500 connecting to this server; in this case the wildcard means all clients. The
5501 other options specify where Exim should find its TLS certificate and private
5502 key, which together prove the server's identity to any clients that connect.
5503 More details are given in chapter &<<CHAPTLS>>&.
5504
5505 Another two commented-out option settings follow:
5506 .code
5507 # daemon_smtp_ports = 25 : 465 : 587
5508 # tls_on_connect_ports = 465
5509 .endd
5510 .cindex "port" "465 and 587"
5511 .cindex "port" "for message submission"
5512 .cindex "message" "submission, ports for"
5513 .cindex "ssmtp protocol"
5514 .cindex "smtps protocol"
5515 .cindex "SMTP" "ssmtp protocol"
5516 .cindex "SMTP" "smtps protocol"
5517 These options provide better support for roaming users who wish to use this
5518 server for message submission. They are not much use unless you have turned on
5519 TLS (as described in the previous paragraph) and authentication (about which
5520 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5521 on end-user networks, so RFC 4409 specifies that message submission should use
5522 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5523 configured to use port 587 correctly, so these settings also enable the
5524 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5525 &<<SECTsupobssmt>>&).
5526
5527 Two more commented-out options settings follow:
5528 .code
5529 # qualify_domain =
5530 # qualify_recipient =
5531 .endd
5532 The first of these specifies a domain that Exim uses when it constructs a
5533 complete email address from a local login name. This is often needed when Exim
5534 receives a message from a local process. If you do not set &%qualify_domain%&,
5535 the value of &%primary_hostname%& is used. If you set both of these options,
5536 you can have different qualification domains for sender and recipient
5537 addresses. If you set only the first one, its value is used in both cases.
5538
5539 .cindex "domain literal" "recognizing format"
5540 The following line must be uncommented if you want Exim to recognize
5541 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5542 (an IP address within square brackets) instead of a named domain.
5543 .code
5544 # allow_domain_literals
5545 .endd
5546 The RFCs still require this form, but many people think that in the modern
5547 Internet it makes little sense to permit mail to be sent to specific hosts by
5548 quoting their IP addresses. This ancient format has been used by people who
5549 try to abuse hosts by using them for unwanted relaying. However, some
5550 people believe there are circumstances (for example, messages addressed to
5551 &'postmaster'&) where domain literals are still useful.
5552
5553 The next configuration line is a kind of trigger guard:
5554 .code
5555 never_users = root
5556 .endd
5557 It specifies that no delivery must ever be run as the root user. The normal
5558 convention is to set up &'root'& as an alias for the system administrator. This
5559 setting is a guard against slips in the configuration.
5560 The list of users specified by &%never_users%& is not, however, the complete
5561 list; the build-time configuration in &_Local/Makefile_& has an option called
5562 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5563 contents of &%never_users%& are added to this list. By default
5564 FIXED_NEVER_USERS also specifies root.
5565
5566 When a remote host connects to Exim in order to send mail, the only information
5567 Exim has about the host's identity is its IP address. The next configuration
5568 line,
5569 .code
5570 host_lookup = *
5571 .endd
5572 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5573 in order to get a host name. This improves the quality of the logging
5574 information, but if you feel it is too expensive, you can remove it entirely,
5575 or restrict the lookup to hosts on &"nearby"& networks.
5576 Note that it is not always possible to find a host name from an IP address,
5577 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5578 unreachable.
5579
5580 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5581 1413 (hence their names):
5582 .code
5583 rfc1413_hosts = *
5584 rfc1413_query_timeout = 0s
5585 .endd
5586 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5587 Few hosts offer RFC1413 service these days; calls have to be
5588 terminated by a timeout and this needlessly delays the startup
5589 of an incoming SMTP connection.
5590 If you have hosts for which you trust RFC1413 and need this
5591 information, you can change this.
5592
5593 This line enables an efficiency SMTP option.  It is negotiated by clients
5594 and not expected to cause problems but can be disabled if needed.
5595 .code
5596 prdr_enable = true
5597 .endd
5598
5599 When Exim receives messages over SMTP connections, it expects all addresses to
5600 be fully qualified with a domain, as required by the SMTP definition. However,
5601 if you are running a server to which simple clients submit messages, you may
5602 find that they send unqualified addresses. The two commented-out options:
5603 .code
5604 # sender_unqualified_hosts =
5605 # recipient_unqualified_hosts =
5606 .endd
5607 show how you can specify hosts that are permitted to send unqualified sender
5608 and recipient addresses, respectively.
5609
5610 The &%log_selector%& option is used to increase the detail of logging
5611 over the default:
5612 .code
5613 log_selector = +smtp_protocol_error +smtp_syntax_error \
5614                +tls_certificate_verified
5615 .endd
5616
5617 The &%percent_hack_domains%& option is also commented out:
5618 .code
5619 # percent_hack_domains =
5620 .endd
5621 It provides a list of domains for which the &"percent hack"& is to operate.
5622 This is an almost obsolete form of explicit email routing. If you do not know
5623 anything about it, you can safely ignore this topic.
5624
5625 The next two settings in the main part of the default configuration are
5626 concerned with messages that have been &"frozen"& on Exim's queue. When a
5627 message is frozen, Exim no longer continues to try to deliver it. Freezing
5628 occurs when a bounce message encounters a permanent failure because the sender
5629 address of the original message that caused the bounce is invalid, so the
5630 bounce cannot be delivered. This is probably the most common case, but there
5631 are also other conditions that cause freezing, and frozen messages are not
5632 always bounce messages.
5633 .code
5634 ignore_bounce_errors_after = 2d
5635 timeout_frozen_after = 7d
5636 .endd
5637 The first of these options specifies that failing bounce messages are to be
5638 discarded after 2 days on the queue. The second specifies that any frozen
5639 message (whether a bounce message or not) is to be timed out (and discarded)
5640 after a week. In this configuration, the first setting ensures that no failing
5641 bounce message ever lasts a week.
5642
5643 Exim queues it's messages in a spool directory. If you expect to have
5644 large queues, you may consider using this option. It splits the spool
5645 directory into subdirectories to avoid file system degradation from
5646 many files in a single directory, resulting in better performance.
5647 Manual manipulation of queued messages becomes more complex (though fortunately
5648 not often needed).
5649 .code
5650 # split_spool_directory = true
5651 .endd
5652
5653 In an ideal world everybody follows the standards. For non-ASCII
5654 messages RFC 2047 is a standard, allowing a maximum line length of 76
5655 characters. Exim adheres that standard and won't process messages which
5656 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5657 In particular, the Exim maintainers have had multiple reports of
5658 problems from Russian administrators of issues until they disable this
5659 check, because of some popular, yet buggy, mail composition software.
5660 .code
5661 # check_rfc2047_length = false
5662 .endd
5663
5664 If you need to be strictly RFC compliant you may wish to disable the
5665 8BITMIME advertisement. Use this, if you exchange mails with systems
5666 that are not 8-bit clean.
5667 .code
5668 # accept_8bitmime = false
5669 .endd
5670
5671 Libraries you use may depend on specific environment settings.  This
5672 imposes a security risk (e.g. PATH). There are two lists:
5673 &%keep_environment%& for the variables to import as they are, and
5674 &%add_environment%& for variables we want to set to a fixed value.
5675 Note that TZ is handled separately, by the $%timezone%$ runtime
5676 option and by the TIMEZONE_DEFAULT buildtime option.
5677 .code
5678 # keep_environment = ^LDAP
5679 # add_environment = PATH=/usr/bin::/bin
5680 .endd
5681
5682
5683 .section "ACL configuration" "SECID54"
5684 .cindex "default" "ACLs"
5685 .cindex "&ACL;" "default configuration"
5686 In the default configuration, the ACL section follows the main configuration.
5687 It starts with the line
5688 .code
5689 begin acl
5690 .endd
5691 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5692 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5693 and &%acl_smtp_data%& above.
5694
5695 .cindex "RCPT" "ACL for"
5696 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5697 RCPT command specifies one of the message's recipients. The ACL statements
5698 are considered in order, until the recipient address is either accepted or
5699 rejected. The RCPT command is then accepted or rejected, according to the
5700 result of the ACL processing.
5701 .code
5702 acl_check_rcpt:
5703 .endd
5704 This line, consisting of a name terminated by a colon, marks the start of the
5705 ACL, and names it.
5706 .code
5707 accept  hosts = :
5708 .endd
5709 This ACL statement accepts the recipient if the sending host matches the list.
5710 But what does that strange list mean? It doesn't actually contain any host
5711 names or IP addresses. The presence of the colon puts an empty item in the
5712 list; Exim matches this only if the incoming message did not come from a remote
5713 host, because in that case, the remote hostname is empty. The colon is
5714 important. Without it, the list itself is empty, and can never match anything.
5715
5716 What this statement is doing is to accept unconditionally all recipients in
5717 messages that are submitted by SMTP from local processes using the standard
5718 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5719 manner.
5720 .code
5721 deny    message       = Restricted characters in address
5722         domains       = +local_domains
5723         local_parts   = ^[.] : ^.*[@%!/|]
5724
5725 deny    message       = Restricted characters in address
5726         domains       = !+local_domains
5727         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5728 .endd
5729 These statements are concerned with local parts that contain any of the
5730 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5731 Although these characters are entirely legal in local parts (in the case of
5732 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5733 in Internet mail addresses.
5734
5735 The first three have in the past been associated with explicitly routed
5736 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5737 option). Addresses containing these characters are regularly tried by spammers
5738 in an attempt to bypass relaying restrictions, and also by open relay testing
5739 programs. Unless you really need them it is safest to reject these characters
5740 at this early stage. This configuration is heavy-handed in rejecting these
5741 characters for all messages it accepts from remote hosts. This is a deliberate
5742 policy of being as safe as possible.
5743
5744 The first rule above is stricter, and is applied to messages that are addressed
5745 to one of the local domains handled by this host. This is implemented by the
5746 first condition, which restricts it to domains that are listed in the
5747 &'local_domains'& domain list. The &"+"& character is used to indicate a
5748 reference to a named list. In this configuration, there is just one domain in
5749 &'local_domains'&, but in general there may be many.
5750
5751 The second condition on the first statement uses two regular expressions to
5752 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5753 or &"|"&. If you have local accounts that include these characters, you will
5754 have to modify this rule.
5755
5756 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5757 allows them because they have been encountered in practice. (Consider the
5758 common convention of local parts constructed as
5759 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5760 the author of Exim, who has no second initial.) However, a local part starting
5761 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5762 file name (for example, for a mailing list). This is also true for local parts
5763 that contain slashes. A pipe symbol can also be troublesome if the local part
5764 is incorporated unthinkingly into a shell command line.
5765
5766 The second rule above applies to all other domains, and is less strict. This
5767 allows your own users to send outgoing messages to sites that use slashes
5768 and vertical bars in their local parts. It blocks local parts that begin
5769 with a dot, slash, or vertical bar, but allows these characters within the
5770 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5771 and &"!"& is blocked, as before. The motivation here is to prevent your users
5772 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5773 .code
5774 accept  local_parts   = postmaster
5775         domains       = +local_domains
5776 .endd
5777 This statement, which has two conditions, accepts an incoming address if the
5778 local part is &'postmaster'& and the domain is one of those listed in the
5779 &'local_domains'& domain list. The &"+"& character is used to indicate a
5780 reference to a named list. In this configuration, there is just one domain in
5781 &'local_domains'&, but in general there may be many.
5782
5783 The presence of this statement means that mail to postmaster is never blocked
5784 by any of the subsequent tests. This can be helpful while sorting out problems
5785 in cases where the subsequent tests are incorrectly denying access.
5786 .code
5787 require verify        = sender
5788 .endd
5789 This statement requires the sender address to be verified before any subsequent
5790 ACL statement can be used. If verification fails, the incoming recipient
5791 address is refused. Verification consists of trying to route the address, to
5792 see if a bounce message could be delivered to it. In the case of remote
5793 addresses, basic verification checks only the domain, but &'callouts'& can be
5794 used for more verification if required. Section &<<SECTaddressverification>>&
5795 discusses the details of address verification.
5796 .code
5797 accept  hosts         = +relay_from_hosts
5798         control       = submission
5799 .endd
5800 This statement accepts the address if the message is coming from one of the
5801 hosts that are defined as being allowed to relay through this host. Recipient
5802 verification is omitted here, because in many cases the clients are dumb MUAs
5803 that do not cope well with SMTP error responses. For the same reason, the
5804 second line specifies &"submission mode"& for messages that are accepted. This
5805 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5806 messages that are deficient in some way, for example, because they lack a
5807 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5808 probably add recipient verification here, and disable submission mode.
5809 .code
5810 accept  authenticated = *
5811         control       = submission
5812 .endd
5813 This statement accepts the address if the client host has authenticated itself.
5814 Submission mode is again specified, on the grounds that such messages are most
5815 likely to come from MUAs. The default configuration does not define any
5816 authenticators, though it does include some nearly complete commented-out
5817 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5818 fact authenticate until you complete the authenticator definitions.
5819 .code
5820 require message = relay not permitted
5821         domains = +local_domains : +relay_to_domains
5822 .endd
5823 This statement rejects the address if its domain is neither a local domain nor
5824 one of the domains for which this host is a relay.
5825 .code
5826 require verify = recipient
5827 .endd
5828 This statement requires the recipient address to be verified; if verification
5829 fails, the address is rejected.
5830 .code
5831 # deny    message     = rejected because $sender_host_address \
5832 #                       is in a black list at $dnslist_domain\n\
5833 #                       $dnslist_text
5834 #         dnslists    = black.list.example
5835 #
5836 # warn    dnslists    = black.list.example
5837 #         add_header  = X-Warning: $sender_host_address is in \
5838 #                       a black list at $dnslist_domain
5839 #         log_message = found in $dnslist_domain
5840 .endd
5841 These commented-out lines are examples of how you could configure Exim to check
5842 sending hosts against a DNS black list. The first statement rejects messages
5843 from blacklisted hosts, whereas the second just inserts a warning header
5844 line.
5845 .code
5846 # require verify = csa
5847 .endd
5848 This commented-out line is an example of how you could turn on client SMTP
5849 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5850 records.
5851 .code
5852 accept
5853 .endd
5854 The final statement in the first ACL unconditionally accepts any recipient
5855 address that has successfully passed all the previous tests.
5856 .code
5857 acl_check_data:
5858 .endd
5859 This line marks the start of the second ACL, and names it. Most of the contents
5860 of this ACL are commented out:
5861 .code
5862 # deny    malware   = *
5863 #         message   = This message contains a virus \
5864 #                     ($malware_name).
5865 .endd
5866 These lines are examples of how to arrange for messages to be scanned for
5867 viruses when Exim has been compiled with the content-scanning extension, and a
5868 suitable virus scanner is installed. If the message is found to contain a
5869 virus, it is rejected with the given custom error message.
5870 .code
5871 # warn    spam      = nobody
5872 #         message   = X-Spam_score: $spam_score\n\
5873 #                     X-Spam_score_int: $spam_score_int\n\
5874 #                     X-Spam_bar: $spam_bar\n\
5875 #                     X-Spam_report: $spam_report
5876 .endd
5877 These lines are an example of how to arrange for messages to be scanned by
5878 SpamAssassin when Exim has been compiled with the content-scanning extension,
5879 and SpamAssassin has been installed. The SpamAssassin check is run with
5880 &`nobody`& as its user parameter, and the results are added to the message as a
5881 series of extra header line. In this case, the message is not rejected,
5882 whatever the spam score.
5883 .code
5884 accept
5885 .endd
5886 This final line in the DATA ACL accepts the message unconditionally.
5887
5888
5889 .section "Router configuration" "SECID55"
5890 .cindex "default" "routers"
5891 .cindex "routers" "default"
5892 The router configuration comes next in the default configuration, introduced
5893 by the line
5894 .code
5895 begin routers
5896 .endd
5897 Routers are the modules in Exim that make decisions about where to send
5898 messages. An address is passed to each router in turn, until it is either
5899 accepted, or failed. This means that the order in which you define the routers
5900 matters. Each router is fully described in its own chapter later in this
5901 manual. Here we give only brief overviews.
5902 .code
5903 # domain_literal:
5904 #   driver = ipliteral
5905 #   domains = !+local_domains
5906 #   transport = remote_smtp
5907 .endd
5908 .cindex "domain literal" "default router"
5909 This router is commented out because the majority of sites do not want to
5910 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5911 you uncomment this router, you also need to uncomment the setting of
5912 &%allow_domain_literals%& in the main part of the configuration.
5913 .code
5914 dnslookup:
5915   driver = dnslookup
5916   domains = ! +local_domains
5917   transport = remote_smtp
5918   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5919   no_more
5920 .endd
5921 The first uncommented router handles addresses that do not involve any local
5922 domains. This is specified by the line
5923 .code
5924 domains = ! +local_domains
5925 .endd
5926 The &%domains%& option lists the domains to which this router applies, but the
5927 exclamation mark is a negation sign, so the router is used only for domains
5928 that are not in the domain list called &'local_domains'& (which was defined at
5929 the start of the configuration). The plus sign before &'local_domains'&
5930 indicates that it is referring to a named list. Addresses in other domains are
5931 passed on to the following routers.
5932
5933 The name of the router driver is &(dnslookup)&,
5934 and is specified by the &%driver%& option. Do not be confused by the fact that
5935 the name of this router instance is the same as the name of the driver. The
5936 instance name is arbitrary, but the name set in the &%driver%& option must be
5937 one of the driver modules that is in the Exim binary.
5938
5939 The &(dnslookup)& router routes addresses by looking up their domains in the
5940 DNS in order to obtain a list of hosts to which the address is routed. If the
5941 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5942 specified by the &%transport%& option. If the router does not find the domain
5943 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5944 the address fails and is bounced.
5945
5946 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5947 be entirely ignored. This option is present because a number of cases have been
5948 encountered where MX records in the DNS point to host names
5949 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5950 Completely ignoring these IP addresses causes Exim to fail to route the
5951 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5952 continue to try to deliver the message periodically until the address timed
5953 out.
5954 .code
5955 system_aliases:
5956   driver = redirect
5957   allow_fail
5958   allow_defer
5959   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5960 # user = exim
5961   file_transport = address_file
5962   pipe_transport = address_pipe
5963 .endd
5964 Control reaches this and subsequent routers only for addresses in the local
5965 domains. This router checks to see whether the local part is defined as an
5966 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5967 data that it looks up from that file. If no data is found for the local part,
5968 the value of the &%data%& option is empty, causing the address to be passed to
5969 the next router.
5970
5971 &_/etc/aliases_& is a conventional name for the system aliases file that is
5972 often used. That is why it is referenced by from the default configuration
5973 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5974 &_Local/Makefile_& before building Exim.
5975 .code
5976 userforward:
5977   driver = redirect
5978   check_local_user
5979 # local_part_suffix = +* : -*
5980 # local_part_suffix_optional
5981   file = $home/.forward
5982 # allow_filter
5983   no_verify
5984   no_expn
5985   check_ancestor
5986   file_transport = address_file
5987   pipe_transport = address_pipe
5988   reply_transport = address_reply
5989 .endd
5990 This is the most complicated router in the default configuration. It is another
5991 redirection router, but this time it is looking for forwarding data set up by
5992 individual users. The &%check_local_user%& setting specifies a check that the
5993 local part of the address is the login name of a local user. If it is not, the
5994 router is skipped. The two commented options that follow &%check_local_user%&,
5995 namely:
5996 .code
5997 # local_part_suffix = +* : -*
5998 # local_part_suffix_optional
5999 .endd
6000 .vindex "&$local_part_suffix$&"
6001 show how you can specify the recognition of local part suffixes. If the first
6002 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6003 by any sequence of characters, is removed from the local part and placed in the
6004 variable &$local_part_suffix$&. The second suffix option specifies that the
6005 presence of a suffix in the local part is optional. When a suffix is present,
6006 the check for a local login uses the local part with the suffix removed.
6007
6008 When a local user account is found, the file called &_.forward_& in the user's
6009 home directory is consulted. If it does not exist, or is empty, the router
6010 declines. Otherwise, the contents of &_.forward_& are interpreted as
6011 redirection data (see chapter &<<CHAPredirect>>& for more details).
6012
6013 .cindex "Sieve filter" "enabling in default router"
6014 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6015 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6016 is commented out by default), the contents of the file are interpreted as a set
6017 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6018 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6019 separate document entitled &'Exim's interfaces to mail filtering'&.
6020
6021 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6022 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6023 There are two reasons for doing this:
6024
6025 .olist
6026 Whether or not a local user has a &_.forward_& file is not really relevant when
6027 checking an address for validity; it makes sense not to waste resources doing
6028 unnecessary work.
6029 .next
6030 More importantly, when Exim is verifying addresses or handling an EXPN
6031 command during an SMTP session, it is running as the Exim user, not as root.
6032 The group is the Exim group, and no additional groups are set up.
6033 It may therefore not be possible for Exim to read users' &_.forward_& files at
6034 this time.
6035 .endlist
6036
6037 The setting of &%check_ancestor%& prevents the router from generating a new
6038 address that is the same as any previous address that was redirected. (This
6039 works round a problem concerning a bad interaction between aliasing and
6040 forwarding &-- see section &<<SECTredlocmai>>&).
6041
6042 The final three option settings specify the transports that are to be used when
6043 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6044 auto-reply, respectively. For example, if a &_.forward_& file contains
6045 .code
6046 a.nother@elsewhere.example, /home/spqr/archive
6047 .endd
6048 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6049 transport.
6050 .code
6051 localuser:
6052   driver = accept
6053   check_local_user
6054 # local_part_suffix = +* : -*
6055 # local_part_suffix_optional
6056   transport = local_delivery
6057 .endd
6058 The final router sets up delivery into local mailboxes, provided that the local
6059 part is the name of a local login, by accepting the address and assigning it to
6060 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6061 routers, so the address is bounced. The commented suffix settings fulfil the
6062 same purpose as they do for the &(userforward)& router.
6063
6064
6065 .section "Transport configuration" "SECID56"
6066 .cindex "default" "transports"
6067 .cindex "transports" "default"
6068 Transports define mechanisms for actually delivering messages. They operate
6069 only when referenced from routers, so the order in which they are defined does
6070 not matter. The transports section of the configuration starts with
6071 .code
6072 begin transports
6073 .endd
6074 One remote transport and four local transports are defined.
6075 .code
6076 remote_smtp:
6077   driver = smtp
6078   hosts_try_prdr = *
6079 .endd
6080 This transport is used for delivering messages over SMTP connections.
6081 The list of remote hosts comes from the router.
6082 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6083 It is negotiated between client and server
6084 and not expected to cause problems but can be disabled if needed.
6085 All other options are defaulted.
6086 .code
6087 local_delivery:
6088   driver = appendfile
6089   file = /var/mail/$local_part
6090   delivery_date_add
6091   envelope_to_add
6092   return_path_add
6093 # group = mail
6094 # mode = 0660
6095 .endd
6096 This &(appendfile)& transport is used for local delivery to user mailboxes in
6097 traditional BSD mailbox format. By default it runs under the uid and gid of the
6098 local user, which requires the sticky bit to be set on the &_/var/mail_&
6099 directory. Some systems use the alternative approach of running mail deliveries
6100 under a particular group instead of using the sticky bit. The commented options
6101 show how this can be done.
6102
6103 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6104 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6105 similarly-named options above.
6106 .code
6107 address_pipe:
6108   driver = pipe
6109   return_output
6110 .endd
6111 This transport is used for handling deliveries to pipes that are generated by
6112 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6113 option specifies that any output on stdout or stderr generated by the pipe is to
6114 be returned to the sender.
6115 .code
6116 address_file:
6117   driver = appendfile
6118   delivery_date_add
6119   envelope_to_add
6120   return_path_add
6121 .endd
6122 This transport is used for handling deliveries to files that are generated by
6123 redirection. The name of the file is not specified in this instance of
6124 &(appendfile)&, because it comes from the &(redirect)& router.
6125 .code
6126 address_reply:
6127   driver = autoreply
6128 .endd
6129 This transport is used for handling automatic replies generated by users'
6130 filter files.
6131
6132
6133
6134 .section "Default retry rule" "SECID57"
6135 .cindex "retry" "default rule"
6136 .cindex "default" "retry rule"
6137 The retry section of the configuration file contains rules which affect the way
6138 Exim retries deliveries that cannot be completed at the first attempt. It is
6139 introduced by the line
6140 .code
6141 begin retry
6142 .endd
6143 In the default configuration, there is just one rule, which applies to all
6144 errors:
6145 .code
6146 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6147 .endd
6148 This causes any temporarily failing address to be retried every 15 minutes for
6149 2 hours, then at intervals starting at one hour and increasing by a factor of
6150 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6151 is not delivered after 4 days of temporary failure, it is bounced. The time is
6152 measured from first failure, not from the time the message was received.
6153
6154 If the retry section is removed from the configuration, or is empty (that is,
6155 if no retry rules are defined), Exim will not retry deliveries. This turns
6156 temporary errors into permanent errors.
6157
6158
6159 .section "Rewriting configuration" "SECID58"
6160 The rewriting section of the configuration, introduced by
6161 .code
6162 begin rewrite
6163 .endd
6164 contains rules for rewriting addresses in messages as they arrive. There are no
6165 rewriting rules in the default configuration file.
6166
6167
6168
6169 .section "Authenticators configuration" "SECTdefconfauth"
6170 .cindex "AUTH" "configuration"
6171 The authenticators section of the configuration, introduced by
6172 .code
6173 begin authenticators
6174 .endd
6175 defines mechanisms for the use of the SMTP AUTH command. The default
6176 configuration file contains two commented-out example authenticators
6177 which support plaintext username/password authentication using the
6178 standard PLAIN mechanism and the traditional but non-standard LOGIN
6179 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6180 to support most MUA software.
6181
6182 The example PLAIN authenticator looks like this:
6183 .code
6184 #PLAIN:
6185 #  driver                  = plaintext
6186 #  server_set_id           = $auth2
6187 #  server_prompts          = :
6188 #  server_condition        = Authentication is not yet configured
6189 #  server_advertise_condition = ${if def:tls_in_cipher }
6190 .endd
6191 And the example LOGIN authenticator looks like this:
6192 .code
6193 #LOGIN:
6194 #  driver                  = plaintext
6195 #  server_set_id           = $auth1
6196 #  server_prompts          = <| Username: | Password:
6197 #  server_condition        = Authentication is not yet configured
6198 #  server_advertise_condition = ${if def:tls_in_cipher }
6199 .endd
6200
6201 The &%server_set_id%& option makes Exim remember the authenticated username
6202 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6203 &%server_prompts%& option configures the &(plaintext)& authenticator so
6204 that it implements the details of the specific authentication mechanism,
6205 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6206 when Exim offers authentication to clients; in the examples, this is only
6207 when TLS or SSL has been started, so to enable the authenticators you also
6208 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6209
6210 The &%server_condition%& setting defines how to verify that the username and
6211 password are correct. In the examples it just produces an error message.
6212 To make the authenticators work, you can use a string expansion
6213 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6214
6215 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6216 usercode and password are in different positions.
6217 Chapter &<<CHAPplaintext>>& covers both.
6218
6219 .ecindex IIDconfiwal
6220
6221
6222
6223 . ////////////////////////////////////////////////////////////////////////////
6224 . ////////////////////////////////////////////////////////////////////////////
6225
6226 .chapter "Regular expressions" "CHAPregexp"
6227
6228 .cindex "regular expressions" "library"
6229 .cindex "PCRE"
6230 Exim supports the use of regular expressions in many of its options. It
6231 uses the PCRE regular expression library; this provides regular expression
6232 matching that is compatible with Perl 5. The syntax and semantics of
6233 regular expressions is discussed in many Perl reference books, and also in
6234 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6235 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6236
6237 The documentation for the syntax and semantics of the regular expressions that
6238 are supported by PCRE is included in the PCRE distribution, and no further
6239 description is included here. The PCRE functions are called from Exim using
6240 the default option settings (that is, with no PCRE options set), except that
6241 the PCRE_CASELESS option is set when the matching is required to be
6242 case-insensitive.
6243
6244 In most cases, when a regular expression is required in an Exim configuration,
6245 it has to start with a circumflex, in order to distinguish it from plain text
6246 or an &"ends with"& wildcard. In this example of a configuration setting, the
6247 second item in the colon-separated list is a regular expression.
6248 .code
6249 domains = a.b.c : ^\\d{3} : *.y.z : ...
6250 .endd
6251 The doubling of the backslash is required because of string expansion that
6252 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6253 of this issue, and a way of avoiding the need for doubling backslashes. The
6254 regular expression that is eventually used in this example contains just one
6255 backslash. The circumflex is included in the regular expression, and has the
6256 normal effect of &"anchoring"& it to the start of the string that is being
6257 matched.
6258
6259 There are, however, two cases where a circumflex is not required for the
6260 recognition of a regular expression: these are the &%match%& condition in a
6261 string expansion, and the &%matches%& condition in an Exim filter file. In
6262 these cases, the relevant string is always treated as a regular expression; if
6263 it does not start with a circumflex, the expression is not anchored, and can
6264 match anywhere in the subject string.
6265
6266 In all cases, if you want a regular expression to match at the end of a string,
6267 you must code the $ metacharacter to indicate this. For example:
6268 .code
6269 domains = ^\\d{3}\\.example
6270 .endd
6271 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6272 You need to use:
6273 .code
6274 domains = ^\\d{3}\\.example\$
6275 .endd
6276 if you want &'example'& to be the top-level domain. The backslash before the
6277 $ is needed because string expansion also interprets dollar characters.
6278
6279
6280
6281 . ////////////////////////////////////////////////////////////////////////////
6282 . ////////////////////////////////////////////////////////////////////////////
6283
6284 .chapter "File and database lookups" "CHAPfdlookup"
6285 .scindex IIDfidalo1 "file" "lookups"
6286 .scindex IIDfidalo2 "database" "lookups"
6287 .cindex "lookup" "description of"
6288 Exim can be configured to look up data in files or databases as it processes
6289 messages. Two different kinds of syntax are used:
6290
6291 .olist
6292 A string that is to be expanded may contain explicit lookup requests. These
6293 cause parts of the string to be replaced by data that is obtained from the
6294 lookup. Lookups of this type are conditional expansion items. Different results
6295 can be defined for the cases of lookup success and failure. See chapter
6296 &<<CHAPexpand>>&, where string expansions are described in detail.
6297 The key for the lookup is specified as part of the string expansion.
6298 .next
6299 Lists of domains, hosts, and email addresses can contain lookup requests as a
6300 way of avoiding excessively long linear lists. In this case, the data that is
6301 returned by the lookup is often (but not always) discarded; whether the lookup
6302 succeeds or fails is what really counts. These kinds of list are described in
6303 chapter &<<CHAPdomhosaddlists>>&.
6304 The key for the lookup is given by the context in which the list is expanded.
6305 .endlist
6306
6307 String expansions, lists, and lookups interact with each other in such a way
6308 that there is no order in which to describe any one of them that does not
6309 involve references to the others. Each of these three chapters makes more sense
6310 if you have read the other two first. If you are reading this for the first
6311 time, be aware that some of it will make a lot more sense after you have read
6312 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6313
6314 .section "Examples of different lookup syntax" "SECID60"
6315 It is easy to confuse the two different kinds of lookup, especially as the
6316 lists that may contain the second kind are always expanded before being
6317 processed as lists. Therefore, they may also contain lookups of the first kind.
6318 Be careful to distinguish between the following two examples:
6319 .code
6320 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6321 domains = lsearch;/some/file
6322 .endd
6323 The first uses a string expansion, the result of which must be a domain list.
6324 No strings have been specified for a successful or a failing lookup; the
6325 defaults in this case are the looked-up data and an empty string, respectively.
6326 The expansion takes place before the string is processed as a list, and the
6327 file that is searched could contain lines like this:
6328 .code
6329 192.168.3.4: domain1:domain2:...
6330 192.168.1.9: domain3:domain4:...
6331 .endd
6332 When the lookup succeeds, the result of the expansion is a list of domains (and
6333 possibly other types of item that are allowed in domain lists).
6334
6335 In the second example, the lookup is a single item in a domain list. It causes
6336 Exim to use a lookup to see if the domain that is being processed can be found
6337 in the file. The file could contains lines like this:
6338 .code
6339 domain1:
6340 domain2:
6341 .endd
6342 Any data that follows the keys is not relevant when checking that the domain
6343 matches the list item.
6344
6345 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6346 Consider a file containing lines like this:
6347 .code
6348 192.168.5.6: lsearch;/another/file
6349 .endd
6350 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6351 first &%domains%& setting above generates the second setting, which therefore
6352 causes a second lookup to occur.
6353
6354 The rest of this chapter describes the different lookup types that are
6355 available. Any of them can be used in any part of the configuration where a
6356 lookup is permitted.
6357
6358
6359 .section "Lookup types" "SECID61"
6360 .cindex "lookup" "types of"
6361 .cindex "single-key lookup" "definition of"
6362 Two different types of data lookup are implemented:
6363
6364 .ilist
6365 The &'single-key'& type requires the specification of a file in which to look,
6366 and a single key to search for. The key must be a non-empty string for the
6367 lookup to succeed. The lookup type determines how the file is searched.
6368 .next
6369 .cindex "query-style lookup" "definition of"
6370 The &'query-style'& type accepts a generalized database query. No particular
6371 key value is assumed by Exim for query-style lookups. You can use whichever
6372 Exim variables you need to construct the database query.
6373 .endlist
6374
6375 The code for each lookup type is in a separate source file that is included in
6376 the binary of Exim only if the corresponding compile-time option is set. The
6377 default settings in &_src/EDITME_& are:
6378 .code
6379 LOOKUP_DBM=yes
6380 LOOKUP_LSEARCH=yes
6381 .endd
6382 which means that only linear searching and DBM lookups are included by default.
6383 For some types of lookup (e.g. SQL databases), you need to install appropriate
6384 libraries and header files before building Exim.
6385
6386
6387
6388
6389 .section "Single-key lookup types" "SECTsinglekeylookups"
6390 .cindex "lookup" "single-key types"
6391 .cindex "single-key lookup" "list of types"
6392 The following single-key lookup types are implemented:
6393
6394 .ilist
6395 .cindex "cdb" "description of"
6396 .cindex "lookup" "cdb"
6397 .cindex "binary zero" "in lookup key"
6398 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6399 string without a terminating binary zero. The cdb format is designed for
6400 indexed files that are read frequently and never updated, except by total
6401 re-creation. As such, it is particularly suitable for large files containing
6402 aliases or other indexed data referenced by an MTA. Information about cdb can
6403 be found in several places:
6404 .display
6405 &url(http://www.pobox.com/~djb/cdb.html)
6406 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6407 &url(http://packages.debian.org/stable/utils/freecdb.html)
6408 .endd
6409 A cdb distribution is not needed in order to build Exim with cdb support,
6410 because the code for reading cdb files is included directly in Exim itself.
6411 However, no means of building or testing cdb files is provided with Exim, so
6412 you need to obtain a cdb distribution in order to do this.
6413 .next
6414 .cindex "DBM" "lookup type"
6415 .cindex "lookup" "dbm"
6416 .cindex "binary zero" "in lookup key"
6417 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6418 DBM file by looking up the record with the given key. A terminating binary
6419 zero is included in the key that is passed to the DBM library. See section
6420 &<<SECTdb>>& for a discussion of DBM libraries.
6421
6422 .cindex "Berkeley DB library" "file format"
6423 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6424 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6425 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6426 the DB_UNKNOWN option. This enables it to handle any of the types of database
6427 that the library supports, and can be useful for accessing DBM files created by
6428 other applications. (For earlier DB versions, DB_HASH is always used.)
6429 .next
6430 .cindex "lookup" "dbmjz"
6431 .cindex "lookup" "dbm &-- embedded NULs"
6432 .cindex "sasldb2"
6433 .cindex "dbmjz lookup type"
6434 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6435 interpreted as an Exim list; the elements of the list are joined together with
6436 ASCII NUL characters to form the lookup key.  An example usage would be to
6437 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6438 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6439 &(cram_md5)& authenticator.
6440 .next
6441 .cindex "lookup" "dbmnz"
6442 .cindex "lookup" "dbm &-- terminating zero"
6443 .cindex "binary zero" "in lookup key"
6444 .cindex "Courier"
6445 .cindex "&_/etc/userdbshadow.dat_&"
6446 .cindex "dbmnz lookup type"
6447 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6448 is not included in the key that is passed to the DBM library. You may need this
6449 if you want to look up data in files that are created by or shared with some
6450 other application that does not use terminating zeros. For example, you need to
6451 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6452 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6453 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6454 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6455 .next
6456 .cindex "lookup" "dsearch"
6457 .cindex "dsearch lookup type"
6458 &(dsearch)&: The given file must be a directory; this is searched for an entry
6459 whose name is the key by calling the &[lstat()]& function. The key may not
6460 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6461 the lookup is the name of the entry, which may be a file, directory,
6462 symbolic link, or any other kind of directory entry. An example of how this
6463 lookup can be used to support virtual domains is given in section
6464 &<<SECTvirtualdomains>>&.
6465 .next
6466 .cindex "lookup" "iplsearch"
6467 .cindex "iplsearch lookup type"
6468 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6469 terminated by a colon or white space or the end of the line. The keys in the
6470 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6471 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6472 being interpreted as a key terminator. For example:
6473 .code
6474 1.2.3.4:           data for 1.2.3.4
6475 192.168.0.0/16:    data for 192.168.0.0/16
6476 "abcd::cdab":      data for abcd::cdab
6477 "abcd:abcd::/32"   data for abcd:abcd::/32
6478 .endd
6479 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6480 file is searched linearly, using the CIDR masks where present, until a matching
6481 key is found. The first key that matches is used; there is no attempt to find a
6482 &"best"& match. Apart from the way the keys are matched, the processing for
6483 &(iplsearch)& is the same as for &(lsearch)&.
6484
6485 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6486 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6487 lookup types support only literal keys.
6488
6489 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6490 the implicit key is the host's IP address rather than its name (see section
6491 &<<SECThoslispatsikey>>&).
6492 .next
6493 .cindex "linear search"
6494 .cindex "lookup" "lsearch"
6495 .cindex "lsearch lookup type"
6496 .cindex "case sensitivity" "in lsearch lookup"
6497 &(lsearch)&: The given file is a text file that is searched linearly for a
6498 line beginning with the search key, terminated by a colon or white space or the
6499 end of the line. The search is case-insensitive; that is, upper and lower case
6500 letters are treated as the same. The first occurrence of the key that is found
6501 in the file is used.
6502
6503 White space between the key and the colon is permitted. The remainder of the
6504 line, with leading and trailing white space removed, is the data. This can be
6505 continued onto subsequent lines by starting them with any amount of white
6506 space, but only a single space character is included in the data at such a
6507 junction. If the data begins with a colon, the key must be terminated by a
6508 colon, for example:
6509 .code
6510 baduser:  :fail:
6511 .endd
6512 Empty lines and lines beginning with # are ignored, even if they occur in the
6513 middle of an item. This is the traditional textual format of alias files. Note
6514 that the keys in an &(lsearch)& file are literal strings. There is no
6515 wildcarding of any kind.
6516
6517 .cindex "lookup" "lsearch &-- colons in keys"
6518 .cindex "white space" "in lsearch key"
6519 In most &(lsearch)& files, keys are not required to contain colons or #
6520 characters, or white space. However, if you need this feature, it is available.
6521 If a key begins with a doublequote character, it is terminated only by a
6522 matching quote (or end of line), and the normal escaping rules apply to its
6523 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6524 quoted keys (exactly as for unquoted keys). There is no special handling of
6525 quotes for the data part of an &(lsearch)& line.
6526
6527 .next
6528 .cindex "NIS lookup type"
6529 .cindex "lookup" "NIS"
6530 .cindex "binary zero" "in lookup key"
6531 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6532 the given key, without a terminating binary zero. There is a variant called
6533 &(nis0)& which does include the terminating binary zero in the key. This is
6534 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6535 aliases; the full map names must be used.
6536
6537 .next
6538 .cindex "wildlsearch lookup type"
6539 .cindex "lookup" "wildlsearch"
6540 .cindex "nwildlsearch lookup type"
6541 .cindex "lookup" "nwildlsearch"
6542 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6543 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6544 the file may be wildcarded. The difference between these two lookup types is
6545 that for &(wildlsearch)&, each key in the file is string-expanded before being
6546 used, whereas for &(nwildlsearch)&, no expansion takes place.
6547
6548 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6549 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6550 file that are regular expressions can be made case-sensitive by the use of
6551 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6552
6553 . ==== As this is a nested list, any displays it contains must be indented
6554 . ==== as otherwise they are too far to the left.
6555
6556 .olist
6557 The string may begin with an asterisk to mean &"ends with"&. For example:
6558 .code
6559     *.a.b.c       data for anything.a.b.c
6560     *fish         data for anythingfish
6561 .endd
6562 .next
6563 The string may begin with a circumflex to indicate a regular expression. For
6564 example, for &(wildlsearch)&:
6565 .code
6566     ^\N\d+\.a\.b\N    data for <digits>.a.b
6567 .endd
6568 Note the use of &`\N`& to disable expansion of the contents of the regular
6569 expression. If you are using &(nwildlsearch)&, where the keys are not
6570 string-expanded, the equivalent entry is:
6571 .code
6572     ^\d+\.a\.b        data for <digits>.a.b
6573 .endd
6574 The case-insensitive flag is set at the start of compiling the regular
6575 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6576 For example, to make the entire pattern case-sensitive:
6577 .code
6578     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6579 .endd
6580
6581 If the regular expression contains white space or colon characters, you must
6582 either quote it (see &(lsearch)& above), or represent these characters in other
6583 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6584 colon. This may be easier than quoting, because if you quote, you have to
6585 escape all the backslashes inside the quotes.
6586
6587 &*Note*&: It is not possible to capture substrings in a regular expression
6588 match for later use, because the results of all lookups are cached. If a lookup
6589 is repeated, the result is taken from the cache, and no actual pattern matching
6590 takes place. The values of all the numeric variables are unset after a
6591 &((n)wildlsearch)& match.
6592
6593 .next
6594 Although I cannot see it being of much use, the general matching function that
6595 is used to implement &((n)wildlsearch)& means that the string may begin with a
6596 lookup name terminated by a semicolon, and followed by lookup data. For
6597 example:
6598 .code
6599     cdb;/some/file  data for keys that match the file
6600 .endd
6601 The data that is obtained from the nested lookup is discarded.
6602 .endlist olist
6603
6604 Keys that do not match any of these patterns are interpreted literally. The
6605 continuation rules for the data are the same as for &(lsearch)&, and keys may
6606 be followed by optional colons.
6607
6608 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6609 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6610 lookup types support only literal keys.
6611 .endlist ilist
6612
6613
6614 .section "Query-style lookup types" "SECTquerystylelookups"
6615 .cindex "lookup" "query-style types"
6616 .cindex "query-style lookup" "list of types"
6617 The supported query-style lookup types are listed below. Further details about
6618 many of them are given in later sections.
6619
6620 .ilist
6621 .cindex "DNS" "as a lookup type"
6622 .cindex "lookup" "DNS"
6623 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6624 are given in the supplied query. The resulting data is the contents of the
6625 records. See section &<<SECTdnsdb>>&.
6626 .next
6627 .cindex "InterBase lookup type"
6628 .cindex "lookup" "InterBase"
6629 &(ibase)&: This does a lookup in an InterBase database.
6630 .next
6631 .cindex "LDAP" "lookup type"
6632 .cindex "lookup" "LDAP"
6633 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6634 returns attributes from a single entry. There is a variant called &(ldapm)&
6635 that permits values from multiple entries to be returned. A third variant
6636 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6637 any attribute values. See section &<<SECTldap>>&.
6638 .next
6639 .cindex "MySQL" "lookup type"
6640 .cindex "lookup" "MySQL"
6641 &(mysql)&: The format of the query is an SQL statement that is passed to a
6642 MySQL database. See section &<<SECTsql>>&.
6643 .next
6644 .cindex "NIS+ lookup type"
6645 .cindex "lookup" "NIS+"
6646 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6647 the field to be returned. See section &<<SECTnisplus>>&.
6648 .next
6649 .cindex "Oracle" "lookup type"
6650 .cindex "lookup" "Oracle"
6651 &(oracle)&: The format of the query is an SQL statement that is passed to an
6652 Oracle database. See section &<<SECTsql>>&.
6653 .next
6654 .cindex "lookup" "passwd"
6655 .cindex "passwd lookup type"
6656 .cindex "&_/etc/passwd_&"
6657 &(passwd)& is a query-style lookup with queries that are just user names. The
6658 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6659 success, the result string is the same as you would get from an &(lsearch)&
6660 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6661 password value. For example:
6662 .code
6663 *:42:42:King Rat:/home/kr:/bin/bash
6664 .endd
6665 .next
6666 .cindex "PostgreSQL lookup type"
6667 .cindex "lookup" "PostgreSQL"
6668 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6669 PostgreSQL database. See section &<<SECTsql>>&.
6670
6671 .next
6672 .cindex "Redis lookup type"
6673 .cindex lookup Redis
6674 &(redis)&: The format of the query is an SQL statement that is passed to a
6675 Redis database. See section &<<SECTsql>>&.
6676
6677 .next
6678 .cindex "sqlite lookup type"
6679 .cindex "lookup" "sqlite"
6680 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6681 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6682
6683 .next
6684 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6685 not likely to be useful in normal operation.
6686 .next
6687 .cindex "whoson lookup type"
6688 .cindex "lookup" "whoson"
6689 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6690 allows a server to check whether a particular (dynamically allocated) IP
6691 address is currently allocated to a known (trusted) user and, optionally, to
6692 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6693 at one time for &"POP before SMTP"& authentication, but that approach has been
6694 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6695 &"POP before SMTP"& checking using ACL statements such as
6696 .code
6697 require condition = \
6698   ${lookup whoson {$sender_host_address}{yes}{no}}
6699 .endd
6700 The query consists of a single IP address. The value returned is the name of
6701 the authenticated user, which is stored in the variable &$value$&. However, in
6702 this example, the data in &$value$& is not used; the result of the lookup is
6703 one of the fixed strings &"yes"& or &"no"&.
6704 .endlist
6705
6706
6707
6708 .section "Temporary errors in lookups" "SECID63"
6709 .cindex "lookup" "temporary error in"
6710 Lookup functions can return temporary error codes if the lookup cannot be
6711 completed. For example, an SQL or LDAP database might be unavailable. For this
6712 reason, it is not advisable to use a lookup that might do this for critical
6713 options such as a list of local domains.
6714
6715 When a lookup cannot be completed in a router or transport, delivery
6716 of the message (to the relevant address) is deferred, as for any other
6717 temporary error. In other circumstances Exim may assume the lookup has failed,
6718 or may give up altogether.
6719
6720
6721
6722 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6723 .cindex "wildcard lookups"
6724 .cindex "lookup" "default values"
6725 .cindex "lookup" "wildcard"
6726 .cindex "lookup" "* added to type"
6727 .cindex "default" "in single-key lookups"
6728 In this context, a &"default value"& is a value specified by the administrator
6729 that is to be used if a lookup fails.
6730
6731 &*Note:*& This section applies only to single-key lookups. For query-style
6732 lookups, the facilities of the query language must be used. An attempt to
6733 specify a default for a query-style lookup provokes an error.
6734
6735 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6736 and the initial lookup fails, the key &"*"& is looked up in the file to
6737 provide a default value. See also the section on partial matching below.
6738
6739 .cindex "*@ with single-key lookup"
6740 .cindex "lookup" "*@ added to type"
6741 .cindex "alias file" "per-domain default"
6742 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6743 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6744 character, a second lookup is done with everything before the last @ replaced
6745 by *. This makes it possible to provide per-domain defaults in alias files
6746 that include the domains in the keys. If the second lookup fails (or doesn't
6747 take place because there is no @ in the key), &"*"& is looked up.
6748 For example, a &(redirect)& router might contain:
6749 .code
6750 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6751 .endd
6752 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6753 looks up these keys, in this order:
6754 .code
6755 jane@eyre.example
6756 *@eyre.example
6757 *
6758 .endd
6759 The data is taken from whichever key it finds first. &*Note*&: In an
6760 &(lsearch)& file, this does not mean the first of these keys in the file. A
6761 complete scan is done for each key, and only if it is not found at all does
6762 Exim move on to try the next key.
6763
6764
6765
6766 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6767 .cindex "partial matching"
6768 .cindex "wildcard lookups"
6769 .cindex "lookup" "partial matching"
6770 .cindex "lookup" "wildcard"
6771 .cindex "asterisk" "in search type"
6772 The normal operation of a single-key lookup is to search the file for an exact
6773 match with the given key. However, in a number of situations where domains are
6774 being looked up, it is useful to be able to do partial matching. In this case,
6775 information in the file that has a key starting with &"*."& is matched by any
6776 domain that ends with the components that follow the full stop. For example, if
6777 a key in a DBM file is
6778 .code
6779 *.dates.fict.example
6780 .endd
6781 then when partial matching is enabled this is matched by (amongst others)
6782 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6783 by &'dates.fict.example'&, if that does not appear as a separate key in the
6784 file.
6785
6786 &*Note*&: Partial matching is not available for query-style lookups. It is
6787 also not available for any lookup items in address lists (see section
6788 &<<SECTaddresslist>>&).
6789
6790 Partial matching is implemented by doing a series of separate lookups using
6791 keys constructed by modifying the original subject key. This means that it can
6792 be used with any of the single-key lookup types, provided that
6793 partial matching keys
6794 beginning with a special prefix (default &"*."&) are included in the data file.
6795 Keys in the file that do not begin with the prefix are matched only by
6796 unmodified subject keys when partial matching is in use.
6797
6798 Partial matching is requested by adding the string &"partial-"& to the front of
6799 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6800 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6801 is added at the start of the subject key, and it is looked up again. If that
6802 fails, further lookups are tried with dot-separated components removed from the
6803 start of the subject key, one-by-one, and &"*."& added on the front of what
6804 remains.
6805
6806 A minimum number of two non-* components are required. This can be adjusted
6807 by including a number before the hyphen in the search type. For example,
6808 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6809 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6810 subject key is &'2250.dates.fict.example'& then the following keys are looked
6811 up when the minimum number of non-* components is two:
6812 .code
6813 2250.dates.fict.example
6814 *.2250.dates.fict.example
6815 *.dates.fict.example
6816 *.fict.example
6817 .endd
6818 As soon as one key in the sequence is successfully looked up, the lookup
6819 finishes.
6820
6821 .cindex "lookup" "partial matching &-- changing prefix"
6822 .cindex "prefix" "for partial matching"
6823 The use of &"*."& as the partial matching prefix is a default that can be
6824 changed. The motivation for this feature is to allow Exim to operate with file
6825 formats that are used by other MTAs. A different prefix can be supplied in
6826 parentheses instead of the hyphen after &"partial"&. For example:
6827 .code
6828 domains = partial(.)lsearch;/some/file
6829 .endd
6830 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6831 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6832 components is unchanged). The prefix may consist of any punctuation characters
6833 other than a closing parenthesis. It may be empty, for example:
6834 .code
6835 domains = partial1()cdb;/some/file
6836 .endd
6837 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6838 &`a.b.c`&, &`b.c`&, and &`c`&.
6839
6840 If &"partial0"& is specified, what happens at the end (when the lookup with
6841 just one non-wild component has failed, and the original key is shortened right
6842 down to the null string) depends on the prefix:
6843
6844 .ilist
6845 If the prefix has zero length, the whole lookup fails.
6846 .next
6847 If the prefix has length 1, a lookup for just the prefix is done. For
6848 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6849 .next
6850 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6851 remainder is looked up. With the default prefix, therefore, the final lookup is
6852 for &"*"& on its own.
6853 .next
6854 Otherwise, the whole prefix is looked up.
6855 .endlist
6856
6857
6858 If the search type ends in &"*"& or &"*@"& (see section
6859 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6860 this implies happens after all partial lookups have failed. If &"partial0"& is
6861 specified, adding &"*"& to the search type has no effect with the default
6862 prefix, because the &"*"& key is already included in the sequence of partial
6863 lookups. However, there might be a use for lookup types such as
6864 &"partial0(.)lsearch*"&.
6865
6866 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6867 in domain lists and the like. Partial matching works only in terms of
6868 dot-separated components; a key such as &`*fict.example`&
6869 in a database file is useless, because the asterisk in a partial matching
6870 subject key is always followed by a dot.
6871
6872
6873
6874
6875 .section "Lookup caching" "SECID64"
6876 .cindex "lookup" "caching"
6877 .cindex "caching" "lookup data"
6878 Exim caches all lookup results in order to avoid needless repetition of
6879 lookups. However, because (apart from the daemon) Exim operates as a collection
6880 of independent, short-lived processes, this caching applies only within a
6881 single Exim process. There is no inter-process lookup caching facility.
6882
6883 For single-key lookups, Exim keeps the relevant files open in case there is
6884 another lookup that needs them. In some types of configuration this can lead to
6885 many files being kept open for messages with many recipients. To avoid hitting
6886 the operating system limit on the number of simultaneously open files, Exim
6887 closes the least recently used file when it needs to open more files than its
6888 own internal limit, which can be changed via the &%lookup_open_max%& option.
6889
6890 The single-key lookup files are closed and the lookup caches are flushed at
6891 strategic points during delivery &-- for example, after all routing is
6892 complete.
6893
6894
6895
6896
6897 .section "Quoting lookup data" "SECID65"
6898 .cindex "lookup" "quoting"
6899 .cindex "quoting" "in lookups"
6900 When data from an incoming message is included in a query-style lookup, there
6901 is the possibility of special characters in the data messing up the syntax of
6902 the query. For example, a NIS+ query that contains
6903 .code
6904 [name=$local_part]
6905 .endd
6906 will be broken if the local part happens to contain a closing square bracket.
6907 For NIS+, data can be enclosed in double quotes like this:
6908 .code
6909 [name="$local_part"]
6910 .endd
6911 but this still leaves the problem of a double quote in the data. The rule for
6912 NIS+ is that double quotes must be doubled. Other lookup types have different
6913 rules, and to cope with the differing requirements, an expansion operator
6914 of the following form is provided:
6915 .code
6916 ${quote_<lookup-type>:<string>}
6917 .endd
6918 For example, the safest way to write the NIS+ query is
6919 .code
6920 [name="${quote_nisplus:$local_part}"]
6921 .endd
6922 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6923 operator can be used for all lookup types, but has no effect for single-key
6924 lookups, since no quoting is ever needed in their key strings.
6925
6926
6927
6928
6929 .section "More about dnsdb" "SECTdnsdb"
6930 .cindex "dnsdb lookup"
6931 .cindex "lookup" "dnsdb"
6932 .cindex "DNS" "as a lookup type"
6933 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6934 of a record type and a domain name, separated by an equals sign. For example,
6935 an expansion string could contain:
6936 .code
6937 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6938 .endd
6939 If the lookup succeeds, the result is placed in &$value$&, which in this case
6940 is used on its own as the result. If the lookup does not succeed, the
6941 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6942 &<<SECTforexpfai>>& for an explanation of what this means.
6943
6944 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6945 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6946 If no type is given, TXT is assumed.
6947
6948 For any record type, if multiple records are found, the data is returned as a
6949 concatenation, with newline as the default separator. The order, of course,
6950 depends on the DNS resolver. You can specify a different separator character
6951 between multiple records by putting a right angle-bracket followed immediately
6952 by the new separator at the start of the query. For example:
6953 .code
6954 ${lookup dnsdb{>: a=host1.example}}
6955 .endd
6956 It is permitted to specify a space as the separator character. Further
6957 white space is ignored.
6958 For lookup types that return multiple fields per record,
6959 an alternate field separator can be specified using a comma after the main
6960 separator character, followed immediately by the field separator.
6961
6962 .cindex "PTR record" "in &(dnsdb)& lookup"
6963 When the type is PTR,
6964 the data can be an IP address, written as normal; inversion and the addition of
6965 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6966 .code
6967 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6968 .endd
6969 If the data for a PTR record is not a syntactically valid IP address, it is not
6970 altered and nothing is added.
6971
6972 .cindex "MX record" "in &(dnsdb)& lookup"
6973 .cindex "SRV record" "in &(dnsdb)& lookup"
6974 For an MX lookup, both the preference value and the host name are returned for
6975 each record, separated by a space. For an SRV lookup, the priority, weight,
6976 port, and host name are returned for each record, separated by spaces.
6977 The field separator can be modified as above.
6978
6979 .cindex "TXT record" "in &(dnsdb)& lookup"
6980 .cindex "SPF record" "in &(dnsdb)& lookup"
6981 For TXT records with multiple items of data, only the first item is returned,
6982 unless a field separator is specified.
6983 To concatenate items without a separator, use a semicolon instead.
6984 For SPF records the
6985 default behaviour is to concatenate multiple items without using a separator.
6986 .code
6987 ${lookup dnsdb{>\n,: txt=a.b.example}}
6988 ${lookup dnsdb{>\n; txt=a.b.example}}
6989 ${lookup dnsdb{spf=example.org}}
6990 .endd
6991 It is permitted to specify a space as the separator character. Further
6992 white space is ignored.
6993
6994 .cindex "SOA record" "in &(dnsdb)& lookup"
6995 For an SOA lookup, while no result is obtained the lookup is redone with
6996 successively more leading components dropped from the given domain.
6997 Only the primary-nameserver field is returned unless a field separator is
6998 specified.
6999 .code
7000 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7001 .endd
7002
7003 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7004 .cindex "dnsdb modifiers"
7005 .cindex "modifiers" "dnsdb"
7006 .cindex "options" "dnsdb"
7007 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7008 each followed by a comma,
7009 that may appear before the record type.
7010
7011 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7012 temporary DNS error for any of them, the behaviour is controlled by
7013 a defer-option modifier.
7014 The possible keywords are
7015 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7016 With &"strict"& behaviour, any temporary DNS error causes the
7017 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7018 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7019 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7020 error causes the whole lookup to defer only if none of the other lookups
7021 succeed. The default is &"lax"&, so the following lookups are equivalent:
7022 .code
7023 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7024 ${lookup dnsdb{a=one.host.com:two.host.com}}
7025 .endd
7026 Thus, in the default case, as long as at least one of the DNS lookups
7027 yields some data, the lookup succeeds.
7028
7029 .cindex "DNSSEC" "dns lookup"
7030 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7031 The possible keywords are
7032 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7033 With &"strict"& or &"lax"& DNSSEC information is requested
7034 with the lookup.
7035 With &"strict"& a response from the DNS resolver that
7036 is not labelled as authenticated data
7037 is treated as equivalent to a temporary DNS error.
7038 The default is &"never"&.
7039
7040 See also the &$lookup_dnssec_authenticated$& variable.
7041
7042 .cindex timeout "dns lookup"
7043 .cindex "DNS" timeout
7044 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7045 The form is &"retrans_VAL"& where VAL is an Exim time specification
7046 (e.g. &"5s"&).
7047 The default value is set by the main configuration option &%dns_retrans%&.
7048
7049 Retries for the dnsdb lookup can be controlled by a retry modifier.
7050 The form if &"retry_VAL"& where VAL is an integer.
7051 The default count is set by the main configuration option &%dns_retry%&.
7052
7053 .cindex cacheing "of dns lookup"
7054 .cindex TTL "of dns lookup"
7055 .cindex DNS TTL
7056 Dnsdb lookup results are cached within a single process (and its children).
7057 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7058 value of the set of returned DNS records.
7059
7060
7061 .section "Pseudo dnsdb record types" "SECID66"
7062 .cindex "MX record" "in &(dnsdb)& lookup"
7063 By default, both the preference value and the host name are returned for
7064 each MX record, separated by a space. If you want only host names, you can use
7065 the pseudo-type MXH:
7066 .code
7067 ${lookup dnsdb{mxh=a.b.example}}
7068 .endd
7069 In this case, the preference values are omitted, and just the host names are
7070 returned.
7071
7072 .cindex "name server for enclosing domain"
7073 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7074 records on the given domain, but if none are found, it removes the first
7075 component of the domain name, and tries again. This process continues until NS
7076 records are found or there are no more components left (or there is a DNS
7077 error). In other words, it may return the name servers for a top-level domain,
7078 but it never returns the root name servers. If there are no NS records for the
7079 top-level domain, the lookup fails. Consider these examples:
7080 .code
7081 ${lookup dnsdb{zns=xxx.quercite.com}}
7082 ${lookup dnsdb{zns=xxx.edu}}
7083 .endd
7084 Assuming that in each case there are no NS records for the full domain name,
7085 the first returns the name servers for &%quercite.com%&, and the second returns
7086 the name servers for &%edu%&.
7087
7088 You should be careful about how you use this lookup because, unless the
7089 top-level domain does not exist, the lookup always returns some host names. The
7090 sort of use to which this might be put is for seeing if the name servers for a
7091 given domain are on a blacklist. You can probably assume that the name servers
7092 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7093 such a list.
7094
7095 .cindex "CSA" "in &(dnsdb)& lookup"
7096 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7097 records according to the CSA rules, which are described in section
7098 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7099 not sufficient because of the extra parent domain search behaviour of CSA. The
7100 result of a successful lookup such as:
7101 .code
7102 ${lookup dnsdb {csa=$sender_helo_name}}
7103 .endd
7104 has two space-separated fields: an authorization code and a target host name.
7105 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7106 authorization required but absent, or &"?"& for unknown.
7107
7108 .cindex "A+" "in &(dnsdb)& lookup"
7109 The pseudo-type A+ performs an AAAA
7110 and then an A lookup.  All results are returned; defer processing
7111 (see below) is handled separately for each lookup.  Example:
7112 .code
7113 ${lookup dnsdb {>; a+=$sender_helo_name}}
7114 .endd
7115
7116
7117 .section "Multiple dnsdb lookups" "SECID67"
7118 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7119 However, you can specify a list of domains or IP addresses in a single
7120 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7121 the default separator, but with the ability to change this. For example:
7122 .code
7123 ${lookup dnsdb{one.domain.com:two.domain.com}}
7124 ${lookup dnsdb{a=one.host.com:two.host.com}}
7125 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7126 .endd
7127 In order to retain backwards compatibility, there is one special case: if
7128 the lookup type is PTR and no change of separator is specified, Exim looks
7129 to see if the rest of the string is precisely one IPv6 address. In this
7130 case, it does not treat it as a list.
7131
7132 The data from each lookup is concatenated, with newline separators by default,
7133 in the same way that multiple DNS records for a single item are handled. A
7134 different separator can be specified, as described above.
7135
7136
7137
7138
7139 .section "More about LDAP" "SECTldap"
7140 .cindex "LDAP" "lookup, more about"
7141 .cindex "lookup" "LDAP"
7142 .cindex "Solaris" "LDAP"
7143 The original LDAP implementation came from the University of Michigan; this has
7144 become &"Open LDAP"&, and there are now two different releases. Another
7145 implementation comes from Netscape, and Solaris 7 and subsequent releases
7146 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7147 the lookup function level, their error handling is different. For this reason
7148 it is necessary to set a compile-time variable when building Exim with LDAP, to
7149 indicate which LDAP library is in use. One of the following should appear in
7150 your &_Local/Makefile_&:
7151 .code
7152 LDAP_LIB_TYPE=UMICHIGAN
7153 LDAP_LIB_TYPE=OPENLDAP1
7154 LDAP_LIB_TYPE=OPENLDAP2
7155 LDAP_LIB_TYPE=NETSCAPE
7156 LDAP_LIB_TYPE=SOLARIS
7157 .endd
7158 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7159 same interface as the University of Michigan version.
7160
7161 There are three LDAP lookup types in Exim. These behave slightly differently in
7162 the way they handle the results of a query:
7163
7164 .ilist
7165 &(ldap)& requires the result to contain just one entry; if there are more, it
7166 gives an error.
7167 .next
7168 &(ldapdn)& also requires the result to contain just one entry, but it is the
7169 Distinguished Name that is returned rather than any attribute values.
7170 .next
7171 &(ldapm)& permits the result to contain more than one entry; the attributes
7172 from all of them are returned.
7173 .endlist
7174
7175
7176 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7177 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7178 the data returned by a successful lookup is described in the next section.
7179 First we explain how LDAP queries are coded.
7180
7181
7182 .section "Format of LDAP queries" "SECTforldaque"
7183 .cindex "LDAP" "query format"
7184 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7185 the configuration of a &(redirect)& router one might have this setting:
7186 .code
7187 data = ${lookup ldap \
7188   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7189   c=UK?mailbox?base?}}
7190 .endd
7191 .cindex "LDAP" "with TLS"
7192 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7193 secure (encrypted) LDAP connections. The second of these ensures that an
7194 encrypted TLS connection is used.
7195
7196 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7197 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7198 See the &%ldap_start_tls%& option.
7199
7200 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7201 controlled. Every part of the TLS configuration can be configured by settings in
7202 &_exim.conf_&. Depending on the version of the client libraries installed on
7203 your system, some of the initialization may have required setting options in
7204 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7205 certificates. This revealed a nuance where the current UID that exim was
7206 running as could affect which config files it read. With Exim 4.83, these
7207 methods become optional, only taking effect if not specifically set in
7208 &_exim.conf_&.
7209
7210
7211 .section "LDAP quoting" "SECID68"
7212 .cindex "LDAP" "quoting"
7213 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7214 and the second because the LDAP query is represented as a URL. Furthermore,
7215 within an LDAP query, two different kinds of quoting are required. For this
7216 reason, there are two different LDAP-specific quoting operators.
7217
7218 The &%quote_ldap%& operator is designed for use on strings that are part of
7219 filter specifications. Conceptually, it first does the following conversions on
7220 the string:
7221 .code
7222 *   =>   \2A
7223 (   =>   \28
7224 )   =>   \29
7225 \   =>   \5C
7226 .endd
7227 in accordance with RFC 2254. The resulting string is then quoted according
7228 to the rules for URLs, that is, all non-alphanumeric characters except
7229 .code
7230 ! $ ' - . _ ( ) * +
7231 .endd
7232 are converted to their hex values, preceded by a percent sign. For example:
7233 .code
7234 ${quote_ldap: a(bc)*, a<yz>; }
7235 .endd
7236 yields
7237 .code
7238 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7239 .endd
7240 Removing the URL quoting, this is (with a leading and a trailing space):
7241 .code
7242 a\28bc\29\2A, a<yz>;
7243 .endd
7244 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7245 base DN specifications in queries. Conceptually, it first converts the string
7246 by inserting a backslash in front of any of the following characters:
7247 .code
7248 , + " \ < > ;
7249 .endd
7250 It also inserts a backslash before any leading spaces or # characters, and
7251 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7252 is then quoted according to the rules for URLs. For example:
7253 .code
7254 ${quote_ldap_dn: a(bc)*, a<yz>; }
7255 .endd
7256 yields
7257 .code
7258 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7259 .endd
7260 Removing the URL quoting, this is (with a trailing space):
7261 .code
7262 \ a(bc)*\, a\<yz\>\;\
7263 .endd
7264 There are some further comments about quoting in the section on LDAP
7265 authentication below.
7266
7267
7268 .section "LDAP connections" "SECID69"
7269 .cindex "LDAP" "connections"
7270 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7271 is in use, via a Unix domain socket. The example given above does not specify
7272 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7273 by starting it with
7274 .code
7275 ldap://<hostname>:<port>/...
7276 .endd
7277 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7278 used. When no server is specified in a query, a list of default servers is
7279 taken from the &%ldap_default_servers%& configuration option. This supplies a
7280 colon-separated list of servers which are tried in turn until one successfully
7281 handles a query, or there is a serious error. Successful handling either
7282 returns the requested data, or indicates that it does not exist. Serious errors
7283 are syntactical, or multiple values when only a single value is expected.
7284 Errors which cause the next server to be tried are connection failures, bind
7285 failures, and timeouts.
7286
7287 For each server name in the list, a port number can be given. The standard way
7288 of specifying a host and port is to use a colon separator (RFC 1738). Because
7289 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7290 doubled. For example
7291 .code
7292 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7293 .endd
7294 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7295 to the LDAP library with no server name, and the library's default (normally
7296 the local host) is used.
7297
7298 If you are using the OpenLDAP library, you can connect to an LDAP server using
7299 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7300 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7301 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7302 not available.
7303
7304 For this type of connection, instead of a host name for the server, a pathname
7305 for the socket is required, and the port number is not relevant. The pathname
7306 can be specified either as an item in &%ldap_default_servers%&, or inline in
7307 the query. In the former case, you can have settings such as
7308 .code
7309 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7310 .endd
7311 When the pathname is given in the query, you have to escape the slashes as
7312 &`%2F`& to fit in with the LDAP URL syntax. For example:
7313 .code
7314 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7315 .endd
7316 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7317 a pathname, it uses the Unix domain socket code, even if the query actually
7318 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7319 socket connection. This behaviour means that you can use a setting of
7320 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7321 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7322 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7323 backup host.
7324
7325 If an explicit &`ldapi`& type is given in a query when a host name is
7326 specified, an error is diagnosed. However, if there are more items in
7327 &%ldap_default_servers%&, they are tried. In other words:
7328
7329 .ilist
7330 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7331 interface.
7332 .next
7333 Using &`ldapi`& with a host name causes an error.
7334 .endlist
7335
7336
7337 Using &`ldapi`& with no host or path in the query, and no setting of
7338 &%ldap_default_servers%&, does whatever the library does by default.
7339
7340
7341
7342 .section "LDAP authentication and control information" "SECID70"
7343 .cindex "LDAP" "authentication"
7344 The LDAP URL syntax provides no way of passing authentication and other control
7345 information to the server. To make this possible, the URL in an LDAP query may
7346 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7347 spaces. If a value contains spaces it must be enclosed in double quotes, and
7348 when double quotes are used, backslash is interpreted in the usual way inside
7349 them. The following names are recognized:
7350 .display
7351 &`DEREFERENCE`&  set the dereferencing parameter
7352 &`NETTIME    `&  set a timeout for a network operation
7353 &`USER       `&  set the DN, for authenticating the LDAP bind
7354 &`PASS       `&  set the password, likewise
7355 &`REFERRALS  `&  set the referrals parameter
7356 &`SERVERS    `&  set alternate server list for this query only
7357 &`SIZE       `&  set the limit for the number of entries returned
7358 &`TIME       `&  set the maximum waiting time for a query
7359 .endd
7360 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7361 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7362 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7363 library from trying to follow referrals issued by the LDAP server.
7364
7365 .cindex LDAP timeout
7366 .cindex timeout "LDAP lookup"
7367 The name CONNECT is an obsolete name for NETTIME, retained for
7368 backwards compatibility. This timeout (specified as a number of seconds) is
7369 enforced from the client end for operations that can be carried out over a
7370 network. Specifically, it applies to network connections and calls to the
7371 &'ldap_result()'& function. If the value is greater than zero, it is used if
7372 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7373 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7374 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7375 Netscape SDK; for OpenLDAP no action is taken.
7376
7377 The TIME parameter (also a number of seconds) is passed to the server to
7378 set a server-side limit on the time taken to complete a search.
7379
7380 The SERVERS parameter allows you to specify an alternate list of ldap servers
7381 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7382 default list of ldap servers, and a single lookup can specify a single ldap
7383 server to use.  But when you need to do a lookup with a list of servers that is
7384 different than the default list (maybe different order, maybe a completely
7385 different set of servers), the SERVERS parameter allows you to specify this
7386 alternate list (colon-separated).
7387
7388 Here is an example of an LDAP query in an Exim lookup that uses some of these
7389 values. This is a single line, folded to fit on the page:
7390 .code
7391 ${lookup ldap
7392   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7393   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7394   {$value}fail}
7395 .endd
7396 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7397 any of the auxiliary data. Exim configuration settings that include lookups
7398 which contain password information should be preceded by &"hide"& to prevent
7399 non-admin users from using the &%-bP%& option to see their values.
7400
7401 The auxiliary data items may be given in any order. The default is no
7402 connection timeout (the system timeout is used), no user or password, no limit
7403 on the number of entries returned, and no time limit on queries.
7404
7405 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7406 removes any URL quoting that it may contain before passing it LDAP. Apparently
7407 some libraries do this for themselves, but some do not. Removing the URL
7408 quoting has two advantages:
7409
7410 .ilist
7411 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7412 DNs as with DNs inside actual queries.
7413 .next
7414 It permits spaces inside USER= DNs.
7415 .endlist
7416
7417 For example, a setting such as
7418 .code
7419 USER=cn=${quote_ldap_dn:$1}
7420 .endd
7421 should work even if &$1$& contains spaces.
7422
7423 Expanded data for the PASS= value should be quoted using the &%quote%&
7424 expansion operator, rather than the LDAP quote operators. The only reason this
7425 field needs quoting is to ensure that it conforms to the Exim syntax, which
7426 does not allow unquoted spaces. For example:
7427 .code
7428 PASS=${quote:$3}
7429 .endd
7430 The LDAP authentication mechanism can be used to check passwords as part of
7431 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7432 &<<CHAPexpand>>&.
7433
7434
7435
7436 .section "Format of data returned by LDAP" "SECID71"
7437 .cindex "LDAP" "returned data formats"
7438 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7439 as a sequence of values, for example
7440 .code
7441 cn=manager,o=University of Cambridge,c=UK
7442 .endd
7443 The &(ldap)& lookup type generates an error if more than one entry matches the
7444 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7445 the result between the data from different entries. It is possible for multiple
7446 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7447 you know that whatever values are returned all came from a single entry in the
7448 directory.
7449
7450 In the common case where you specify a single attribute in your LDAP query, the
7451 result is not quoted, and does not contain the attribute name. If the attribute
7452 has multiple values, they are separated by commas. Any comma that is
7453 part of an attribute's value is doubled.
7454
7455 If you specify multiple attributes, the result contains space-separated, quoted
7456 strings, each preceded by the attribute name and an equals sign. Within the
7457 quotes, the quote character, backslash, and newline are escaped with
7458 backslashes, and commas are used to separate multiple values for the attribute.
7459 Any commas in attribute values are doubled
7460 (permitting treatment of the values as a comma-separated list).
7461 Apart from the escaping, the string within quotes takes the same form as the
7462 output when a single attribute is requested. Specifying no attributes is the
7463 same as specifying all of an entry's attributes.
7464
7465 Here are some examples of the output format. The first line of each pair is an
7466 LDAP query, and the second is the data that is returned. The attribute called
7467 &%attr1%& has two values, one of them with an embedded comma, whereas
7468 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7469 (they have SUP &%attr%& in their schema definitions).
7470
7471 .code
7472 ldap:///o=base?attr1?sub?(uid=fred)
7473 value1.1,value1,,2
7474
7475 ldap:///o=base?attr2?sub?(uid=fred)
7476 value two
7477
7478 ldap:///o=base?attr?sub?(uid=fred)
7479 value1.1,value1,,2,value two
7480
7481 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7482 attr1="value1.1,value1,,2" attr2="value two"
7483
7484 ldap:///o=base??sub?(uid=fred)
7485 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7486 .endd
7487 You can
7488 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7489 results of LDAP lookups.
7490 The &%extract%& operator in string expansions can be used to pick out
7491 individual fields from data that consists of &'key'&=&'value'& pairs.
7492 The &%listextract%& operator should be used to pick out individual values
7493 of attributes, even when only a single value is expected.
7494 The doubling of embedded commas allows you to use the returned data as a
7495 comma separated list (using the "<," syntax for changing the input list separator).
7496
7497
7498
7499
7500 .section "More about NIS+" "SECTnisplus"
7501 .cindex "NIS+ lookup type"
7502 .cindex "lookup" "NIS+"
7503 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7504 and field name. If this is given, the result of a successful query is the
7505 contents of the named field; otherwise the result consists of a concatenation
7506 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7507 values containing spaces are quoted. For example, the query
7508 .code
7509 [name=mg1456],passwd.org_dir
7510 .endd
7511 might return the string
7512 .code
7513 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7514 home=/home/mg1456 shell=/bin/bash shadow=""
7515 .endd
7516 (split over two lines here to fit on the page), whereas
7517 .code
7518 [name=mg1456],passwd.org_dir:gcos
7519 .endd
7520 would just return
7521 .code
7522 Martin Guerre
7523 .endd
7524 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7525 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7526 operator is to double any quote characters within the text.
7527
7528
7529
7530 .section "SQL lookups" "SECTsql"
7531 .cindex "SQL lookup types"
7532 .cindex "MySQL" "lookup type"
7533 .cindex "PostgreSQL lookup type"
7534 .cindex "lookup" "MySQL"
7535 .cindex "lookup" "PostgreSQL"
7536 .cindex "Oracle" "lookup type"
7537 .cindex "lookup" "Oracle"
7538 .cindex "InterBase lookup type"
7539 .cindex "lookup" "InterBase"
7540 .cindex "Redis lookup type"
7541 .cindex lookup Redis
7542 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7543 and SQLite
7544 databases. Queries for these databases contain SQL statements, so an example
7545 might be
7546 .code
7547 ${lookup mysql{select mailbox from users where id='userx'}\
7548   {$value}fail}
7549 .endd
7550 If the result of the query contains more than one field, the data for each
7551 field in the row is returned, preceded by its name, so the result of
7552 .code
7553 ${lookup pgsql{select home,name from users where id='userx'}\
7554   {$value}}
7555 .endd
7556 might be
7557 .code
7558 home=/home/userx name="Mister X"
7559 .endd
7560 Empty values and values containing spaces are double quoted, with embedded
7561 quotes escaped by a backslash. If the result of the query contains just one
7562 field, the value is passed back verbatim, without a field name, for example:
7563 .code
7564 Mister X
7565 .endd
7566 If the result of the query yields more than one row, it is all concatenated,
7567 with a newline between the data for each row.
7568
7569
7570 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7571 .cindex "MySQL" "lookup type"
7572 .cindex "PostgreSQL lookup type"
7573 .cindex "lookup" "MySQL"
7574 .cindex "lookup" "PostgreSQL"
7575 .cindex "Oracle" "lookup type"
7576 .cindex "lookup" "Oracle"
7577 .cindex "InterBase lookup type"
7578 .cindex "lookup" "InterBase"
7579 .cindex "Redis lookup type"
7580 .cindex lookup Redis
7581 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7582 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7583 or &%redis_servers%&
7584 option (as appropriate) must be set to a colon-separated list of server
7585 information.
7586 (For MySQL and PostgreSQL, the global option need not be set if all
7587 queries contain their own server information &-- see section
7588 &<<SECTspeserque>>&.)
7589 For all but Redis
7590 each item in the list is a slash-separated list of four
7591 items: host name, database name, user name, and password. In the case of
7592 Oracle, the host name field is used for the &"service name"&, and the database
7593 name field is not used and should be empty. For example:
7594 .code
7595 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7596 .endd
7597 Because password data is sensitive, you should always precede the setting with
7598 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7599 option. Here is an example where two MySQL servers are listed:
7600 .code
7601 hide mysql_servers = localhost/users/root/secret:\
7602                      otherhost/users/root/othersecret
7603 .endd
7604 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7605 because this is a colon-separated list, the colon has to be doubled. For each
7606 query, these parameter groups are tried in order until a connection is made and
7607 a query is successfully processed. The result of a query may be that no data is
7608 found, but that is still a successful query. In other words, the list of
7609 servers provides a backup facility, not a list of different places to look.
7610
7611 For Redis the global option need not be specified if all queries contain their
7612 own server information &-- see section &<<SECTspeserque>>&.
7613 If specified, the option must be set to a colon-separated list of server
7614 information.
7615 Each item in the list is a slash-separated list of three items:
7616 host, database number, and password.
7617 .olist
7618 The host is required and may be either an IPv4 address and optional
7619 port number (separated by a colon, which needs doubling due to the
7620 higher-level list), or a Unix socket pathname enclosed in parentheses
7621 .next
7622 The database number is optional; if present that number is selected in the backend
7623 .next
7624 The password is optional; if present it is used to authenticate to the backend
7625 .endlist
7626
7627 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7628 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7629 respectively, and the characters single-quote, double-quote, and backslash
7630 itself are escaped with backslashes.
7631
7632 The &%quote_redis%& expansion operator
7633 escapes whitespace and backslash characters with a backslash.
7634
7635 .section "Specifying the server in the query" "SECTspeserque"
7636 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7637 it is possible to specify a list of servers with an individual query. This is
7638 done by starting the query with
7639 .display
7640 &`servers=`&&'server1:server2:server3:...'&&`;`&
7641 .endd
7642 Each item in the list may take one of two forms:
7643 .olist
7644 If it contains no slashes it is assumed to be just a host name. The appropriate
7645 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7646 of the same name, and the remaining parameters (database, user, password) are
7647 taken from there.
7648 .next
7649 If it contains any slashes, it is taken as a complete parameter set.
7650 .endlist
7651 The list of servers is used in exactly the same way as the global list.
7652 Once a connection to a server has happened and a query has been
7653 successfully executed, processing of the lookup ceases.
7654
7655 This feature is intended for use in master/slave situations where updates
7656 are occurring and you want to update the master rather than a slave. If the
7657 master is in the list as a backup for reading, you might have a global setting
7658 like this:
7659 .code
7660 mysql_servers = slave1/db/name/pw:\
7661                 slave2/db/name/pw:\
7662                 master/db/name/pw
7663 .endd
7664 In an updating lookup, you could then write:
7665 .code
7666 ${lookup mysql{servers=master; UPDATE ...} }
7667 .endd
7668 That query would then be sent only to the master server. If, on the other hand,
7669 the master is not to be used for reading, and so is not present in the global
7670 option, you can still update it by a query of this form:
7671 .code
7672 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7673 .endd
7674
7675
7676 .section "Special MySQL features" "SECID73"
7677 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7678 causes a connection to the server on the local host by means of a Unix domain
7679 socket. An alternate socket can be specified in parentheses.
7680 An option group name for MySQL option files can be specified in square brackets;
7681 the default value is &"exim"&.
7682 The full syntax of each item in &%mysql_servers%& is:
7683 .display
7684 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7685   <&'database'&>/<&'user'&>/<&'password'&>
7686 .endd
7687 Any of the four sub-parts of the first field can be omitted. For normal use on
7688 the local host it can be left blank or set to just &"localhost"&.
7689
7690 No database need be supplied &-- but if it is absent here, it must be given in
7691 the queries.
7692
7693 If a MySQL query is issued that does not request any data (an insert, update,
7694 or delete command), the result of the lookup is the number of rows affected.
7695
7696 &*Warning*&: This can be misleading. If an update does not actually change
7697 anything (for example, setting a field to the value it already has), the result
7698 is zero because no rows are affected.
7699
7700
7701 .section "Special PostgreSQL features" "SECID74"
7702 PostgreSQL lookups can also use Unix domain socket connections to the database.
7703 This is usually faster and costs less CPU time than a TCP/IP connection.
7704 However it can be used only if the mail server runs on the same machine as the
7705 database server. A configuration line for PostgreSQL via Unix domain sockets
7706 looks like this:
7707 .code
7708 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7709 .endd
7710 In other words, instead of supplying a host name, a path to the socket is
7711 given. The path name is enclosed in parentheses so that its slashes aren't
7712 visually confused with the delimiters for the other server parameters.
7713
7714 If a PostgreSQL query is issued that does not request any data (an insert,
7715 update, or delete command), the result of the lookup is the number of rows
7716 affected.
7717
7718 .section "More about SQLite" "SECTsqlite"
7719 .cindex "lookup" "SQLite"
7720 .cindex "sqlite lookup type"
7721 SQLite is different to the other SQL lookups because a file name is required in
7722 addition to the SQL query. An SQLite database is a single file, and there is no
7723 daemon as in the other SQL databases. The interface to Exim requires the name
7724 of the file, as an absolute path, to be given at the start of the query. It is
7725 separated from the query by white space. This means that the path name cannot
7726 contain white space. Here is a lookup expansion example:
7727 .code
7728 ${lookup sqlite {/some/thing/sqlitedb \
7729   select name from aliases where id='userx';}}
7730 .endd
7731 In a list, the syntax is similar. For example:
7732 .code
7733 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7734    select * from relays where ip='$sender_host_address';
7735 .endd
7736 The only character affected by the &%quote_sqlite%& operator is a single
7737 quote, which it doubles.
7738
7739 .cindex timeout SQLite
7740 .cindex sqlite "lookup timeout"
7741 The SQLite library handles multiple simultaneous accesses to the database
7742 internally. Multiple readers are permitted, but only one process can
7743 update at once. Attempts to access the database while it is being updated
7744 are rejected after a timeout period, during which the SQLite library
7745 waits for the lock to be released. In Exim, the default timeout is set
7746 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7747 option.
7748 .ecindex IIDfidalo1
7749 .ecindex IIDfidalo2
7750
7751
7752 . ////////////////////////////////////////////////////////////////////////////
7753 . ////////////////////////////////////////////////////////////////////////////
7754
7755 .chapter "Domain, host, address, and local part lists" &&&
7756          "CHAPdomhosaddlists" &&&
7757          "Domain, host, and address lists"
7758 .scindex IIDdohoadli "lists of domains; hosts; etc."
7759 A number of Exim configuration options contain lists of domains, hosts,
7760 email addresses, or local parts. For example, the &%hold_domains%& option
7761 contains a list of domains whose delivery is currently suspended. These lists
7762 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7763 arguments to expansion conditions such as &%match_domain%&.
7764
7765 Each item in one of these lists is a pattern to be matched against a domain,
7766 host, email address, or local part, respectively. In the sections below, the
7767 different types of pattern for each case are described, but first we cover some
7768 general facilities that apply to all four kinds of list.
7769
7770 Note that other parts of Exim use a &'string list'& which does not
7771 support all the complexity available in
7772 domain, host, address and local part lists.
7773
7774
7775
7776 .section "Expansion of lists" "SECTlistexpand"
7777 .cindex "expansion" "of lists"
7778 Each list is expanded as a single string before it is used.
7779
7780 .new
7781 &'Exception: the router headers_remove option, where list-item
7782 splitting is done before string-expansion.'&
7783 .wen
7784
7785 The result of
7786 expansion must be a list, possibly containing empty items, which is split up
7787 into separate items for matching. By default, colon is the separator character,
7788 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7789 &<<SECTempitelis>>& for details of the list syntax; the second of these
7790 discusses the way to specify empty list items.
7791
7792
7793 If the string expansion is forced to fail, Exim behaves as if the item it is
7794 testing (domain, host, address, or local part) is not in the list. Other
7795 expansion failures cause temporary errors.
7796
7797 If an item in a list is a regular expression, backslashes, dollars and possibly
7798 other special characters in the expression must be protected against
7799 misinterpretation by the string expander. The easiest way to do this is to use
7800 the &`\N`& expansion feature to indicate that the contents of the regular
7801 expression should not be expanded. For example, in an ACL you might have:
7802 .code
7803 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7804                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7805 .endd
7806 The first item is a regular expression that is protected from expansion by
7807 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7808 senders based on the receiving domain.
7809
7810
7811
7812
7813 .section "Negated items in lists" "SECID76"
7814 .cindex "list" "negation"
7815 .cindex "negation" "in lists"
7816 Items in a list may be positive or negative. Negative items are indicated by a
7817 leading exclamation mark, which may be followed by optional white space. A list
7818 defines a set of items (domains, etc). When Exim processes one of these lists,
7819 it is trying to find out whether a domain, host, address, or local part
7820 (respectively) is in the set that is defined by the list. It works like this:
7821
7822 The list is scanned from left to right. If a positive item is matched, the
7823 subject that is being checked is in the set; if a negative item is matched, the
7824 subject is not in the set. If the end of the list is reached without the
7825 subject having matched any of the patterns, it is in the set if the last item
7826 was a negative one, but not if it was a positive one. For example, the list in
7827 .code
7828 domainlist relay_to_domains = !a.b.c : *.b.c
7829 .endd
7830 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7831 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7832 list is positive. However, if the setting were
7833 .code
7834 domainlist relay_to_domains = !a.b.c
7835 .endd
7836 then all domains other than &'a.b.c'& would match because the last item in the
7837 list is negative. In other words, a list that ends with a negative item behaves
7838 as if it had an extra item &`:*`& on the end.
7839
7840 Another way of thinking about positive and negative items in lists is to read
7841 the connector as &"or"& after a positive item and as &"and"& after a negative
7842 item.
7843
7844
7845
7846 .section "File names in lists" "SECTfilnamlis"
7847 .cindex "list" "file name in"
7848 If an item in a domain, host, address, or local part list is an absolute file
7849 name (beginning with a slash character), each line of the file is read and
7850 processed as if it were an independent item in the list, except that further
7851 file names are not allowed,
7852 and no expansion of the data from the file takes place.
7853 Empty lines in the file are ignored, and the file may also contain comment
7854 lines:
7855
7856 .ilist
7857 For domain and host lists, if a # character appears anywhere in a line of the
7858 file, it and all following characters are ignored.
7859 .next
7860 Because local parts may legitimately contain # characters, a comment in an
7861 address list or local part list file is recognized only if # is preceded by
7862 white space or the start of the line. For example:
7863 .code
7864 not#comment@x.y.z   # but this is a comment
7865 .endd
7866 .endlist
7867
7868 Putting a file name in a list has the same effect as inserting each line of the
7869 file as an item in the list (blank lines and comments excepted). However, there
7870 is one important difference: the file is read each time the list is processed,
7871 so if its contents vary over time, Exim's behaviour changes.
7872
7873 If a file name is preceded by an exclamation mark, the sense of any match
7874 within the file is inverted. For example, if
7875 .code
7876 hold_domains = !/etc/nohold-domains
7877 .endd
7878 and the file contains the lines
7879 .code
7880 !a.b.c
7881 *.b.c
7882 .endd
7883 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7884 any domain matching &`*.b.c`& is not.
7885
7886
7887
7888 .section "An lsearch file is not an out-of-line list" "SECID77"
7889 As will be described in the sections that follow, lookups can be used in lists
7890 to provide indexed methods of checking list membership. There has been some
7891 confusion about the way &(lsearch)& lookups work in lists. Because
7892 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7893 sometimes thought that it is allowed to contain wild cards and other kinds of
7894 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7895 always fixed strings, just as for any other single-key lookup type.
7896
7897 If you want to use a file to contain wild-card patterns that form part of a
7898 list, just give the file name on its own, without a search type, as described
7899 in the previous section. You could also use the &(wildlsearch)& or
7900 &(nwildlsearch)&, but there is no advantage in doing this.
7901
7902
7903
7904
7905 .section "Named lists" "SECTnamedlists"
7906 .cindex "named lists"
7907 .cindex "list" "named"
7908 A list of domains, hosts, email addresses, or local parts can be given a name
7909 which is then used to refer to the list elsewhere in the configuration. This is
7910 particularly convenient if the same list is required in several different
7911 places. It also allows lists to be given meaningful names, which can improve
7912 the readability of the configuration. For example, it is conventional to define
7913 a domain list called &'local_domains'& for all the domains that are handled
7914 locally on a host, using a configuration line such as
7915 .code
7916 domainlist local_domains = localhost:my.dom.example
7917 .endd
7918 Named lists are referenced by giving their name preceded by a plus sign, so,
7919 for example, a router that is intended to handle local domains would be
7920 configured with the line
7921 .code
7922 domains = +local_domains
7923 .endd
7924 The first router in a configuration is often one that handles all domains
7925 except the local ones, using a configuration with a negated item like this:
7926 .code
7927 dnslookup:
7928   driver = dnslookup
7929   domains = ! +local_domains
7930   transport = remote_smtp
7931   no_more
7932 .endd
7933 The four kinds of named list are created by configuration lines starting with
7934 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7935 respectively. Then there follows the name that you are defining, followed by an
7936 equals sign and the list itself. For example:
7937 .code
7938 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7939 addresslist bad_senders = cdb;/etc/badsenders
7940 .endd
7941 A named list may refer to other named lists:
7942 .code
7943 domainlist  dom1 = first.example : second.example
7944 domainlist  dom2 = +dom1 : third.example
7945 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7946 .endd
7947 &*Warning*&: If the last item in a referenced list is a negative one, the
7948 effect may not be what you intended, because the negation does not propagate
7949 out to the higher level. For example, consider:
7950 .code
7951 domainlist  dom1 = !a.b
7952 domainlist  dom2 = +dom1 : *.b
7953 .endd
7954 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7955 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7956 means it matches the second list as well. The effect is not the same as
7957 .code
7958 domainlist  dom2 = !a.b : *.b
7959 .endd
7960 where &'x.y'& does not match. It's best to avoid negation altogether in
7961 referenced lists if you can.
7962
7963 Named lists may have a performance advantage. When Exim is routing an
7964 address or checking an incoming message, it caches the result of tests on named
7965 lists. So, if you have a setting such as
7966 .code
7967 domains = +local_domains
7968 .endd
7969 on several of your routers
7970 or in several ACL statements,
7971 the actual test is done only for the first one. However, the caching works only
7972 if there are no expansions within the list itself or any sublists that it
7973 references. In other words, caching happens only for lists that are known to be
7974 the same each time they are referenced.
7975
7976 By default, there may be up to 16 named lists of each type. This limit can be
7977 extended by changing a compile-time variable. The use of domain and host lists
7978 is recommended for concepts such as local domains, relay domains, and relay
7979 hosts. The default configuration is set up like this.
7980
7981
7982
7983 .section "Named lists compared with macros" "SECID78"
7984 .cindex "list" "named compared with macro"
7985 .cindex "macro" "compared with named list"
7986 At first sight, named lists might seem to be no different from macros in the
7987 configuration file. However, macros are just textual substitutions. If you
7988 write
7989 .code
7990 ALIST = host1 : host2
7991 auth_advertise_hosts = !ALIST
7992 .endd
7993 it probably won't do what you want, because that is exactly the same as
7994 .code
7995 auth_advertise_hosts = !host1 : host2
7996 .endd
7997 Notice that the second host name is not negated. However, if you use a host
7998 list, and write
7999 .code
8000 hostlist alist = host1 : host2
8001 auth_advertise_hosts = ! +alist
8002 .endd
8003 the negation applies to the whole list, and so that is equivalent to
8004 .code
8005 auth_advertise_hosts = !host1 : !host2
8006 .endd
8007
8008
8009 .section "Named list caching" "SECID79"
8010 .cindex "list" "caching of named"
8011 .cindex "caching" "named lists"
8012 While processing a message, Exim caches the result of checking a named list if
8013 it is sure that the list is the same each time. In practice, this means that
8014 the cache operates only if the list contains no $ characters, which guarantees
8015 that it will not change when it is expanded. Sometimes, however, you may have
8016 an expanded list that you know will be the same each time within a given
8017 message. For example:
8018 .code
8019 domainlist special_domains = \
8020            ${lookup{$sender_host_address}cdb{/some/file}}
8021 .endd
8022 This provides a list of domains that depends only on the sending host's IP
8023 address. If this domain list is referenced a number of times (for example,
8024 in several ACL lines, or in several routers) the result of the check is not
8025 cached by default, because Exim does not know that it is going to be the
8026 same list each time.
8027
8028 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8029 cache the result anyway. For example:
8030 .code
8031 domainlist_cache special_domains = ${lookup{...
8032 .endd
8033 If you do this, you should be absolutely sure that caching is going to do
8034 the right thing in all cases. When in doubt, leave it out.
8035
8036
8037
8038 .section "Domain lists" "SECTdomainlist"
8039 .cindex "domain list" "patterns for"
8040 .cindex "list" "domain list"
8041 Domain lists contain patterns that are to be matched against a mail domain.
8042 The following types of item may appear in domain lists:
8043
8044 .ilist
8045 .cindex "primary host name"
8046 .cindex "host name" "matched in domain list"
8047 .oindex "&%primary_hostname%&"
8048 .cindex "domain list" "matching primary host name"
8049 .cindex "@ in a domain list"
8050 If a pattern consists of a single @ character, it matches the local host name,
8051 as set by the &%primary_hostname%& option (or defaulted). This makes it
8052 possible to use the same configuration file on several different hosts that
8053 differ only in their names.
8054 .next
8055 .cindex "@[] in a domain list"
8056 .cindex "domain list" "matching local IP interfaces"
8057 .cindex "domain literal"
8058 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8059 in square brackets (as in an email address that contains a domain literal), but
8060 only if that IP address is recognized as local for email routing purposes. The
8061 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8062 control which of a host's several IP addresses are treated as local.
8063 In today's Internet, the use of domain literals is controversial.
8064 .next
8065 .cindex "@mx_any"
8066 .cindex "@mx_primary"
8067 .cindex "@mx_secondary"
8068 .cindex "domain list" "matching MX pointers to local host"
8069 If a pattern consists of the string &`@mx_any`& it matches any domain that
8070 has an MX record pointing to the local host or to any host that is listed in
8071 .oindex "&%hosts_treat_as_local%&"
8072 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8073 are similar, except that the first matches only when a primary MX target is the
8074 local host, and the second only when no primary MX target is the local host,
8075 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8076 preference value &-- there may of course be more than one of them.
8077
8078 The MX lookup that takes place when matching a pattern of this type is
8079 performed with the resolver options for widening names turned off. Thus, for
8080 example, a single-component domain will &'not'& be expanded by adding the
8081 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8082 options of the &(dnslookup)& router for a discussion of domain widening.
8083
8084 Sometimes you may want to ignore certain IP addresses when using one of these
8085 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8086 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8087 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8088 on a router). For example:
8089 .code
8090 domains = @mx_any/ignore=127.0.0.1
8091 .endd
8092 This example matches any domain that has an MX record pointing to one of
8093 the local host's IP addresses other than 127.0.0.1.
8094
8095 The list of IP addresses is in fact processed by the same code that processes
8096 host lists, so it may contain CIDR-coded network specifications and it may also
8097 contain negative items.
8098
8099 Because the list of IP addresses is a sublist within a domain list, you have to
8100 be careful about delimiters if there is more than one address. Like any other
8101 list, the default delimiter can be changed. Thus, you might have:
8102 .code
8103 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8104           an.other.domain : ...
8105 .endd
8106 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8107 involved, it is easiest to change the delimiter for the main list as well:
8108 .code
8109 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8110           an.other.domain ? ...
8111 .endd
8112 .next
8113 .cindex "asterisk" "in domain list"
8114 .cindex "domain list" "asterisk in"
8115 .cindex "domain list" "matching &""ends with""&"
8116 If a pattern starts with an asterisk, the remaining characters of the pattern
8117 are compared with the terminating characters of the domain. The use of &"*"& in
8118 domain lists differs from its use in partial matching lookups. In a domain
8119 list, the character following the asterisk need not be a dot, whereas partial
8120 matching works only in terms of dot-separated components. For example, a domain
8121 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8122 &'cipher.key.ex'&.
8123
8124 .next
8125 .cindex "regular expressions" "in domain list"
8126 .cindex "domain list" "matching regular expression"
8127 If a pattern starts with a circumflex character, it is treated as a regular
8128 expression, and matched against the domain using a regular expression matching
8129 function. The circumflex is treated as part of the regular expression.
8130 Email domains are case-independent, so this regular expression match is by
8131 default case-independent, but you can make it case-dependent by starting it
8132 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8133 are given in chapter &<<CHAPregexp>>&.
8134
8135 &*Warning*&: Because domain lists are expanded before being processed, you
8136 must escape any backslash and dollar characters in the regular expression, or
8137 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8138 it is not to be expanded (unless you really do want to build a regular
8139 expression by expansion, of course).
8140 .next
8141 .cindex "lookup" "in domain list"
8142 .cindex "domain list" "matching by lookup"
8143 If a pattern starts with the name of a single-key lookup type followed by a
8144 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8145 must be a file name in a suitable format for the lookup type. For example, for
8146 &"cdb;"& it must be an absolute path:
8147 .code
8148 domains = cdb;/etc/mail/local_domains.cdb
8149 .endd
8150 The appropriate type of lookup is done on the file using the domain name as the
8151 key. In most cases, the data that is looked up is not used; Exim is interested
8152 only in whether or not the key is present in the file. However, when a lookup
8153 is used for the &%domains%& option on a router
8154 or a &%domains%& condition in an ACL statement, the data is preserved in the
8155 &$domain_data$& variable and can be referred to in other router options or
8156 other statements in the same ACL.
8157
8158 .next
8159 Any of the single-key lookup type names may be preceded by
8160 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8161 .code
8162 domains = partial-dbm;/partial/domains
8163 .endd
8164 This causes partial matching logic to be invoked; a description of how this
8165 works is given in section &<<SECTpartiallookup>>&.
8166
8167 .next
8168 .cindex "asterisk" "in lookup type"
8169 Any of the single-key lookup types may be followed by an asterisk. This causes
8170 a default lookup for a key consisting of a single asterisk to be done if the
8171 original lookup fails. This is not a useful feature when using a domain list to
8172 select particular domains (because any domain would match), but it might have
8173 value if the result of the lookup is being used via the &$domain_data$&
8174 expansion variable.
8175 .next
8176 If the pattern starts with the name of a query-style lookup type followed by a
8177 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8178 pattern must be an appropriate query for the lookup type, as described in
8179 chapter &<<CHAPfdlookup>>&. For example:
8180 .code
8181 hold_domains = mysql;select domain from holdlist \
8182   where domain = '${quote_mysql:$domain}';
8183 .endd
8184 In most cases, the data that is looked up is not used (so for an SQL query, for
8185 example, it doesn't matter what field you select). Exim is interested only in
8186 whether or not the query succeeds. However, when a lookup is used for the
8187 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8188 variable and can be referred to in other options.
8189 .next
8190 .cindex "domain list" "matching literal domain name"
8191 If none of the above cases apply, a caseless textual comparison is made
8192 between the pattern and the domain.
8193 .endlist
8194
8195 Here is an example that uses several different kinds of pattern:
8196 .code
8197 domainlist funny_domains = \
8198   @ : \
8199   lib.unseen.edu : \
8200   *.foundation.fict.example : \
8201   \N^[1-2]\d{3}\.fict\.example$\N : \
8202   partial-dbm;/opt/data/penguin/book : \
8203   nis;domains.byname : \
8204   nisplus;[name=$domain,status=local],domains.org_dir
8205 .endd
8206 There are obvious processing trade-offs among the various matching modes. Using
8207 an asterisk is faster than a regular expression, and listing a few names
8208 explicitly probably is too. The use of a file or database lookup is expensive,
8209 but may be the only option if hundreds of names are required. Because the
8210 patterns are tested in order, it makes sense to put the most commonly matched
8211 patterns earlier.
8212
8213
8214
8215 .section "Host lists" "SECThostlist"
8216 .cindex "host list" "patterns in"
8217 .cindex "list" "host list"
8218 Host lists are used to control what remote hosts are allowed to do. For
8219 example, some hosts may be allowed to use the local host as a relay, and some
8220 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8221 two different ways, by name or by IP address. In a host list, some types of
8222 pattern are matched to a host name, and some are matched to an IP address.
8223 You need to be particularly careful with this when single-key lookups are
8224 involved, to ensure that the right value is being used as the key.
8225
8226
8227 .section "Special host list patterns" "SECID80"
8228 .cindex "empty item in hosts list"
8229 .cindex "host list" "empty string in"
8230 If a host list item is the empty string, it matches only when no remote host is
8231 involved. This is the case when a message is being received from a local
8232 process using SMTP on the standard input, that is, when a TCP/IP connection is
8233 not used.
8234
8235 .cindex "asterisk" "in host list"
8236 The special pattern &"*"& in a host list matches any host or no host. Neither
8237 the IP address nor the name is actually inspected.
8238
8239
8240
8241 .section "Host list patterns that match by IP address" "SECThoslispatip"
8242 .cindex "host list" "matching IP addresses"
8243 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8244 the incoming address actually appears in the IPv6 host as
8245 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8246 list, it is converted into a traditional IPv4 address first. (Not all operating
8247 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8248 concerns.)
8249
8250 The following types of pattern in a host list check the remote host by
8251 inspecting its IP address:
8252
8253 .ilist
8254 If the pattern is a plain domain name (not a regular expression, not starting
8255 with *, not a lookup of any kind), Exim calls the operating system function
8256 to find the associated IP address(es). Exim uses the newer
8257 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8258 This typically causes a forward DNS lookup of the name. The result is compared
8259 with the IP address of the subject host.
8260
8261 If there is a temporary problem (such as a DNS timeout) with the host name
8262 lookup, a temporary error occurs. For example, if the list is being used in an
8263 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8264 temporary SMTP error code. If no IP address can be found for the host name,
8265 what happens is described in section &<<SECTbehipnot>>& below.
8266
8267 .next
8268 .cindex "@ in a host list"
8269 If the pattern is &"@"&, the primary host name is substituted and used as a
8270 domain name, as just described.
8271
8272 .next
8273 If the pattern is an IP address, it is matched against the IP address of the
8274 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8275 IPv6 addresses can be given in colon-separated format, but the colons have to
8276 be doubled so as not to be taken as item separators when the default list
8277 separator is used. IPv6 addresses are recognized even when Exim is compiled
8278 without IPv6 support. This means that if they appear in a host list on an
8279 IPv4-only host, Exim will not treat them as host names. They are just addresses
8280 that can never match a client host.
8281
8282 .next
8283 .cindex "@[] in a host list"
8284 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8285 the local host. For example, if the local host is an IPv4 host with one
8286 interface address 10.45.23.56, these two ACL statements have the same effect:
8287 .code
8288 accept hosts = 127.0.0.1 : 10.45.23.56
8289 accept hosts = @[]
8290 .endd
8291 .next
8292 .cindex "CIDR notation"
8293 If the pattern is an IP address followed by a slash and a mask length (for
8294 example 10.11.42.0/24), it is matched against the IP address of the subject
8295 host under the given mask. This allows, an entire network of hosts to be
8296 included (or excluded) by a single item. The mask uses CIDR notation; it
8297 specifies the number of address bits that must match, starting from the most
8298 significant end of the address.
8299
8300 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8301 of a range of addresses. It is the number of bits in the network portion of the
8302 address. The above example specifies a 24-bit netmask, so it matches all 256
8303 addresses in the 10.11.42.0 network. An item such as
8304 .code
8305 192.168.23.236/31
8306 .endd
8307 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8308 32 for an IPv4 address is the same as no mask at all; just a single address
8309 matches.
8310
8311 Here is another example which shows an IPv4 and an IPv6 network:
8312 .code
8313 recipient_unqualified_hosts = 192.168.0.0/16: \
8314                               3ffe::ffff::836f::::/48
8315 .endd
8316 The doubling of list separator characters applies only when these items
8317 appear inline in a host list. It is not required when indirecting via a file.
8318 For example:
8319 .code
8320 recipient_unqualified_hosts = /opt/exim/unqualnets
8321 .endd
8322 could make use of a file containing
8323 .code
8324 172.16.0.0/12
8325 3ffe:ffff:836f::/48
8326 .endd
8327 to have exactly the same effect as the previous example. When listing IPv6
8328 addresses inline, it is usually more convenient to use the facility for
8329 changing separator characters. This list contains the same two networks:
8330 .code
8331 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8332                                  3ffe:ffff:836f::/48
8333 .endd
8334 The separator is changed to semicolon by the leading &"<;"& at the start of the
8335 list.
8336 .endlist
8337
8338
8339
8340 .section "Host list patterns for single-key lookups by host address" &&&
8341          "SECThoslispatsikey"
8342 .cindex "host list" "lookup of IP address"
8343 When a host is to be identified by a single-key lookup of its complete IP
8344 address, the pattern takes this form:
8345 .display
8346 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8347 .endd
8348 For example:
8349 .code
8350 hosts_lookup = net-cdb;/hosts-by-ip.db
8351 .endd
8352 The text form of the IP address of the subject host is used as the lookup key.
8353 IPv6 addresses are converted to an unabbreviated form, using lower case
8354 letters, with dots as separators because colon is the key terminator in
8355 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8356 quoting the keys, but this is a facility that was added later.] The data
8357 returned by the lookup is not used.
8358
8359 .cindex "IP address" "masking"
8360 .cindex "host list" "masked IP address"
8361 Single-key lookups can also be performed using masked IP addresses, using
8362 patterns of this form:
8363 .display
8364 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8365 .endd
8366 For example:
8367 .code
8368 net24-dbm;/networks.db
8369 .endd
8370 The IP address of the subject host is masked using <&'number'&> as the mask
8371 length. A textual string is constructed from the masked value, followed by the
8372 mask, and this is used as the lookup key. For example, if the host's IP address
8373 is 192.168.34.6, the key that is looked up for the above example is
8374 &"192.168.34.0/24"&.
8375
8376 When an IPv6 address is converted to a string, dots are normally used instead
8377 of colons, so that keys in &(lsearch)& files need not contain colons (which
8378 terminate &(lsearch)& keys). This was implemented some time before the ability
8379 to quote keys was made available in &(lsearch)& files. However, the more
8380 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8381 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8382 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8383 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8384 addresses are always used.
8385
8386 Ideally, it would be nice to tidy up this anomalous situation by changing to
8387 colons in all cases, given that quoting is now available for &(lsearch)&.
8388 However, this would be an incompatible change that might break some existing
8389 configurations.
8390
8391 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8392 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8393 the former case the key strings include the mask value, whereas in the latter
8394 case the IP address is used on its own.
8395
8396
8397
8398 .section "Host list patterns that match by host name" "SECThoslispatnam"
8399 .cindex "host" "lookup failures"
8400 .cindex "unknown host name"
8401 .cindex "host list" "matching host name"
8402 There are several types of pattern that require Exim to know the name of the
8403 remote host. These are either wildcard patterns or lookups by name. (If a
8404 complete hostname is given without any wildcarding, it is used to find an IP
8405 address to match against, as described in section &<<SECThoslispatip>>&
8406 above.)
8407
8408 If the remote host name is not already known when Exim encounters one of these
8409 patterns, it has to be found from the IP address.
8410 Although many sites on the Internet are conscientious about maintaining reverse
8411 DNS data for their hosts, there are also many that do not do this.
8412 Consequently, a name cannot always be found, and this may lead to unwanted
8413 effects. Take care when configuring host lists with wildcarded name patterns.
8414 Consider what will happen if a name cannot be found.
8415
8416 Because of the problems of determining host names from IP addresses, matching
8417 against host names is not as common as matching against IP addresses.
8418
8419 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8420 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8421 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8422 are done can be changed by setting the &%host_lookup_order%& option. For
8423 security, once Exim has found one or more names, it looks up the IP addresses
8424 for these names and compares them with the IP address that it started with.
8425 Only those names whose IP addresses match are accepted. Any other names are
8426 discarded. If no names are left, Exim behaves as if the host name cannot be
8427 found. In the most common case there is only one name and one IP address.
8428
8429 There are some options that control what happens if a host name cannot be
8430 found. These are described in section &<<SECTbehipnot>>& below.
8431
8432 .cindex "host" "alias for"
8433 .cindex "alias for host"
8434 As a result of aliasing, hosts may have more than one name. When processing any
8435 of the following types of pattern, all the host's names are checked:
8436
8437 .ilist
8438 .cindex "asterisk" "in host list"
8439 If a pattern starts with &"*"& the remainder of the item must match the end of
8440 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8441 &'.b.c'&. This special simple form is provided because this is a very common
8442 requirement. Other kinds of wildcarding require the use of a regular
8443 expression.
8444 .next
8445 .cindex "regular expressions" "in host list"
8446 .cindex "host list" "regular expression in"
8447 If the item starts with &"^"& it is taken to be a regular expression which is
8448 matched against the host name. Host names are case-independent, so this regular
8449 expression match is by default case-independent, but you can make it
8450 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8451 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8452 example,
8453 .code
8454 ^(a|b)\.c\.d$
8455 .endd
8456 is a regular expression that matches either of the two hosts &'a.c.d'& or
8457 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8458 that backslash and dollar characters are not misinterpreted as part of the
8459 string expansion. The simplest way to do this is to use &`\N`& to mark that
8460 part of the string as non-expandable. For example:
8461 .code
8462 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8463 .endd
8464 &*Warning*&: If you want to match a complete host name, you must include the
8465 &`$`& terminating metacharacter in the regular expression, as in the above
8466 example. Without it, a match at the start of the host name is all that is
8467 required.
8468 .endlist
8469
8470
8471
8472
8473 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8474 .cindex "host" "lookup failures, permanent"
8475 While processing a host list, Exim may need to look up an IP address from a
8476 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8477 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8478 behaviour when it fails to find the information it is seeking is the same.
8479
8480 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8481 apply to temporary DNS errors, whose handling is described in the next section.
8482
8483 .cindex "&`+include_unknown`&"
8484 .cindex "&`+ignore_unknown`&"
8485 Exim parses a host list from left to right. If it encounters a permanent
8486 lookup failure in any item in the host list before it has found a match,
8487 Exim treats it as a failure and the default behavior is as if the host
8488 does not match the list. This may not always be what you want to happen.
8489 To change Exim's behaviour, the special items &`+include_unknown`& or
8490 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8491 not recognized in an indirected file).
8492
8493 .ilist
8494 If any item that follows &`+include_unknown`& requires information that
8495 cannot found, Exim behaves as if the host does match the list. For example,
8496 .code
8497 host_reject_connection = +include_unknown:*.enemy.ex
8498 .endd
8499 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8500 any hosts whose name it cannot find.
8501
8502 .next
8503 If any item that follows &`+ignore_unknown`& requires information that cannot
8504 be found, Exim ignores that item and proceeds to the rest of the list. For
8505 example:
8506 .code
8507 accept hosts = +ignore_unknown : friend.example : \
8508                192.168.4.5
8509 .endd
8510 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8511 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8512 name can be found for 192.168.4.5, it is rejected.
8513 .endlist
8514
8515 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8516 list. The effect of each one lasts until the next, or until the end of the
8517 list.
8518
8519 .section "Mixing wildcarded host names and addresses in host lists" &&&
8520          "SECTmixwilhos"
8521 .cindex "host list" "mixing names and addresses in"
8522
8523 This section explains the host/ip processing logic with the same concepts
8524 as the previous section, but specifically addresses what happens when a
8525 wildcarded hostname is one of the items in the hostlist.
8526
8527 .ilist
8528 If you have name lookups or wildcarded host names and
8529 IP addresses in the same host list, you should normally put the IP
8530 addresses first. For example, in an ACL you could have:
8531 .code
8532 accept hosts = 10.9.8.7 : *.friend.example
8533 .endd
8534 The reason you normally would order it this way lies in the
8535 left-to-right way that Exim processes lists.  It can test IP addresses
8536 without doing any DNS lookups, but when it reaches an item that requires
8537 a host name, it fails if it cannot find a host name to compare with the
8538 pattern. If the above list is given in the opposite order, the
8539 &%accept%& statement fails for a host whose name cannot be found, even
8540 if its IP address is 10.9.8.7.
8541
8542 .next
8543 If you really do want to do the name check first, and still recognize the IP
8544 address, you can rewrite the ACL like this:
8545 .code
8546 accept hosts = *.friend.example
8547 accept hosts = 10.9.8.7
8548 .endd
8549 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8550 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8551 &`+ignore_unknown`&, which was discussed in depth in the first example in
8552 this section.
8553 .endlist
8554
8555
8556 .section "Temporary DNS errors when looking up host information" &&&
8557          "SECTtemdnserr"
8558 .cindex "host" "lookup failures, temporary"
8559 .cindex "&`+include_defer`&"
8560 .cindex "&`+ignore_defer`&"
8561 A temporary DNS lookup failure normally causes a defer action (except when
8562 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8563 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8564 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8565 section. These options should be used with care, probably only in non-critical
8566 host lists such as whitelists.
8567
8568
8569
8570 .section "Host list patterns for single-key lookups by host name" &&&
8571          "SECThoslispatnamsk"
8572 .cindex "unknown host name"
8573 .cindex "host list" "matching host name"
8574 If a pattern is of the form
8575 .display
8576 <&'single-key-search-type'&>;<&'search-data'&>
8577 .endd
8578 for example
8579 .code
8580 dbm;/host/accept/list
8581 .endd
8582 a single-key lookup is performed, using the host name as its key. If the
8583 lookup succeeds, the host matches the item. The actual data that is looked up
8584 is not used.
8585
8586 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8587 keys in the file, not IP addresses. If you want to do lookups based on IP
8588 addresses, you must precede the search type with &"net-"& (see section
8589 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8590 two items in the same list, one doing an address lookup and one doing a name
8591 lookup, both using the same file.
8592
8593
8594
8595 .section "Host list patterns for query-style lookups" "SECID81"
8596 If a pattern is of the form
8597 .display
8598 <&'query-style-search-type'&>;<&'query'&>
8599 .endd
8600 the query is obeyed, and if it succeeds, the host matches the item. The actual
8601 data that is looked up is not used. The variables &$sender_host_address$& and
8602 &$sender_host_name$& can be used in the query. For example:
8603 .code
8604 hosts_lookup = pgsql;\
8605   select ip from hostlist where ip='$sender_host_address'
8606 .endd
8607 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8608 can use the &%sg%& expansion item to change this if you need to. If you want to
8609 use masked IP addresses in database queries, you can use the &%mask%& expansion
8610 operator.
8611
8612 If the query contains a reference to &$sender_host_name$&, Exim automatically
8613 looks up the host name if it has not already done so. (See section
8614 &<<SECThoslispatnam>>& for comments on finding host names.)
8615
8616 Historical note: prior to release 4.30, Exim would always attempt to find a
8617 host name before running the query, unless the search type was preceded by
8618 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8619 still recognized for query-style lookups, but its presence or absence has no
8620 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8621 See section &<<SECThoslispatsikey>>&.)
8622
8623
8624
8625
8626
8627 .section "Address lists" "SECTaddresslist"
8628 .cindex "list" "address list"
8629 .cindex "address list" "empty item"
8630 .cindex "address list" "patterns"
8631 Address lists contain patterns that are matched against mail addresses. There
8632 is one special case to be considered: the sender address of a bounce message is
8633 always empty. You can test for this by providing an empty item in an address
8634 list. For example, you can set up a router to process bounce messages by
8635 using this option setting:
8636 .code
8637 senders = :
8638 .endd
8639 The presence of the colon creates an empty item. If you do not provide any
8640 data, the list is empty and matches nothing. The empty sender can also be
8641 detected by a regular expression that matches an empty string,
8642 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8643
8644 Non-empty items in an address list can be straightforward email addresses. For
8645 example:
8646 .code
8647 senders = jbc@askone.example : hs@anacreon.example
8648 .endd
8649 A certain amount of wildcarding is permitted. If a pattern contains an @
8650 character, but is not a regular expression and does not begin with a
8651 semicolon-terminated lookup type (described below), the local part of the
8652 subject address is compared with the local part of the pattern, which may start
8653 with an asterisk. If the local parts match, the domain is checked in exactly
8654 the same way as for a pattern in a domain list. For example, the domain can be
8655 wildcarded, refer to a named list, or be a lookup:
8656 .code
8657 deny senders = *@*.spamming.site:\
8658                *@+hostile_domains:\
8659                bozo@partial-lsearch;/list/of/dodgy/sites:\
8660                *@dbm;/bad/domains.db
8661 .endd
8662 .cindex "local part" "starting with !"
8663 .cindex "address list" "local part starting with !"
8664 If a local part that begins with an exclamation mark is required, it has to be
8665 specified using a regular expression, because otherwise the exclamation mark is
8666 treated as a sign of negation, as is standard in lists.
8667
8668 If a non-empty pattern that is not a regular expression or a lookup does not
8669 contain an @ character, it is matched against the domain part of the subject
8670 address. The only two formats that are recognized this way are a literal
8671 domain, or a domain pattern that starts with *. In both these cases, the effect
8672 is the same as if &`*@`& preceded the pattern. For example:
8673 .code
8674 deny senders = enemy.domain : *.enemy.domain
8675 .endd
8676
8677 The following kinds of more complicated address list pattern can match any
8678 address, including the empty address that is characteristic of bounce message
8679 senders:
8680
8681 .ilist
8682 .cindex "regular expressions" "in address list"
8683 .cindex "address list" "regular expression in"
8684 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8685 done against the complete address, with the pattern as the regular expression.
8686 You must take care that backslash and dollar characters are not misinterpreted
8687 as part of the string expansion. The simplest way to do this is to use &`\N`&
8688 to mark that part of the string as non-expandable. For example:
8689 .code
8690 deny senders = \N^.*this.*@example\.com$\N : \
8691                \N^\d{8}.+@spamhaus.example$\N : ...
8692 .endd
8693 The &`\N`& sequences are removed by the expansion, so these items do indeed
8694 start with &"^"& by the time they are being interpreted as address patterns.
8695
8696 .next
8697 .cindex "address list" "lookup for complete address"
8698 Complete addresses can be looked up by using a pattern that starts with a
8699 lookup type terminated by a semicolon, followed by the data for the lookup. For
8700 example:
8701 .code
8702 deny senders = cdb;/etc/blocked.senders : \
8703   mysql;select address from blocked where \
8704   address='${quote_mysql:$sender_address}'
8705 .endd
8706 Both query-style and single-key lookup types can be used. For a single-key
8707 lookup type, Exim uses the complete address as the key. However, empty keys are
8708 not supported for single-key lookups, so a match against the empty address
8709 always fails. This restriction does not apply to query-style lookups.
8710
8711 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8712 cannot be used, and is ignored if specified, with an entry being written to the
8713 panic log.
8714 .cindex "*@ with single-key lookup"
8715 However, you can configure lookup defaults, as described in section
8716 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8717 default. For example, with this lookup:
8718 .code
8719 accept senders = lsearch*@;/some/file
8720 .endd
8721 the file could contains lines like this:
8722 .code
8723 user1@domain1.example
8724 *@domain2.example
8725 .endd
8726 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8727 that are tried is:
8728 .code
8729 nimrod@jaeger.example
8730 *@jaeger.example
8731 *
8732 .endd
8733 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8734 would mean that every address matches, thus rendering the test useless.
8735
8736 &*Warning 2*&: Do not confuse these two kinds of item:
8737 .code
8738 deny recipients = dbm*@;/some/file
8739 deny recipients = *@dbm;/some/file
8740 .endd
8741 The first does a whole address lookup, with defaulting, as just described,
8742 because it starts with a lookup type. The second matches the local part and
8743 domain independently, as described in a bullet point below.
8744 .endlist
8745
8746
8747 The following kinds of address list pattern can match only non-empty addresses.
8748 If the subject address is empty, a match against any of these pattern types
8749 always fails.
8750
8751
8752 .ilist
8753 .cindex "@@ with single-key lookup"
8754 .cindex "address list" "@@ lookup type"
8755 .cindex "address list" "split local part and domain"
8756 If a pattern starts with &"@@"& followed by a single-key lookup item
8757 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8758 split into a local part and a domain. The domain is looked up in the file. If
8759 it is not found, there is no match. If it is found, the data that is looked up
8760 from the file is treated as a colon-separated list of local part patterns, each
8761 of which is matched against the subject local part in turn.
8762
8763 .cindex "asterisk" "in address list"
8764 The lookup may be a partial one, and/or one involving a search for a default
8765 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8766 patterns that are looked up can be regular expressions or begin with &"*"&, or
8767 even be further lookups. They may also be independently negated. For example,
8768 with
8769 .code
8770 deny senders = @@dbm;/etc/reject-by-domain
8771 .endd
8772 the data from which the DBM file is built could contain lines like
8773 .code
8774 baddomain.com:  !postmaster : *
8775 .endd
8776 to reject all senders except &%postmaster%& from that domain.
8777
8778 .cindex "local part" "starting with !"
8779 If a local part that actually begins with an exclamation mark is required, it
8780 has to be specified using a regular expression. In &(lsearch)& files, an entry
8781 may be split over several lines by indenting the second and subsequent lines,
8782 but the separating colon must still be included at line breaks. White space
8783 surrounding the colons is ignored. For example:
8784 .code
8785 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8786   spammer3 : spammer4
8787 .endd
8788 As in all colon-separated lists in Exim, a colon can be included in an item by
8789 doubling.
8790
8791 If the last item in the list starts with a right angle-bracket, the remainder
8792 of the item is taken as a new key to look up in order to obtain a continuation
8793 list of local parts. The new key can be any sequence of characters. Thus one
8794 might have entries like
8795 .code
8796 aol.com: spammer1 : spammer 2 : >*
8797 xyz.com: spammer3 : >*
8798 *:       ^\d{8}$
8799 .endd
8800 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8801 local parts for all domains, in addition to the specific local parts listed for
8802 each domain. Of course, using this feature costs another lookup each time a
8803 chain is followed, but the effort needed to maintain the data is reduced.
8804
8805 .cindex "loop" "in lookups"
8806 It is possible to construct loops using this facility, and in order to catch
8807 them, the chains may be no more than fifty items long.
8808
8809 .next
8810 The @@<&'lookup'&> style of item can also be used with a query-style
8811 lookup, but in this case, the chaining facility is not available. The lookup
8812 can only return a single list of local parts.
8813 .endlist
8814
8815 &*Warning*&: There is an important difference between the address list items
8816 in these two examples:
8817 .code
8818 senders = +my_list
8819 senders = *@+my_list
8820 .endd
8821 In the first one, &`my_list`& is a named address list, whereas in the second
8822 example it is a named domain list.
8823
8824
8825
8826
8827 .section "Case of letters in address lists" "SECTcasletadd"
8828 .cindex "case of local parts"
8829 .cindex "address list" "case forcing"
8830 .cindex "case forcing in address lists"
8831 Domains in email addresses are always handled caselessly, but for local parts
8832 case may be significant on some systems (see &%caseful_local_part%& for how
8833 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8834 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8835 blocking lists should be done in a case-independent manner. Since most address
8836 lists in Exim are used for this kind of control, Exim attempts to do this by
8837 default.
8838
8839 The domain portion of an address is always lowercased before matching it to an
8840 address list. The local part is lowercased by default, and any string
8841 comparisons that take place are done caselessly. This means that the data in
8842 the address list itself, in files included as plain file names, and in any file
8843 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8844 keys in files that are looked up by a search type other than &(lsearch)& (which
8845 works caselessly) must be in lower case, because these lookups are not
8846 case-independent.
8847
8848 .cindex "&`+caseful`&"
8849 To allow for the possibility of caseful address list matching, if an item in
8850 an address list is the string &"+caseful"&, the original case of the local
8851 part is restored for any comparisons that follow, and string comparisons are no
8852 longer case-independent. This does not affect the domain, which remains in
8853 lower case. However, although independent matches on the domain alone are still
8854 performed caselessly, regular expressions that match against an entire address
8855 become case-sensitive after &"+caseful"& has been seen.
8856
8857
8858
8859 .section "Local part lists" "SECTlocparlis"
8860 .cindex "list" "local part list"
8861 .cindex "local part" "list"
8862 Case-sensitivity in local part lists is handled in the same way as for address
8863 lists, as just described. The &"+caseful"& item can be used if required. In a
8864 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8865 set false, the subject is lowercased and the matching is initially
8866 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8867 matching in the local part list, but not elsewhere in the router. If
8868 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8869 option is case-sensitive from the start.
8870
8871 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8872 comments are handled in the same way as address lists &-- they are recognized
8873 only if the # is preceded by white space or the start of the line.
8874 Otherwise, local part lists are matched in the same way as domain lists, except
8875 that the special items that refer to the local host (&`@`&, &`@[]`&,
8876 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8877 Refer to section &<<SECTdomainlist>>& for details of the other available item
8878 types.
8879 .ecindex IIDdohoadli
8880
8881
8882
8883
8884 . ////////////////////////////////////////////////////////////////////////////
8885 . ////////////////////////////////////////////////////////////////////////////
8886
8887 .chapter "String expansions" "CHAPexpand"
8888 .scindex IIDstrexp "expansion" "of strings"
8889 Many strings in Exim's run time configuration are expanded before use. Some of
8890 them are expanded every time they are used; others are expanded only once.
8891
8892 When a string is being expanded it is copied verbatim from left to right except
8893 when a dollar or backslash character is encountered. A dollar specifies the
8894 start of a portion of the string that is interpreted and replaced as described
8895 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8896 escape character, as described in the following section.
8897
8898 Whether a string is expanded depends upon the context.  Usually this is solely
8899 dependent upon the option for which a value is sought; in this documentation,
8900 options for which string expansion is performed are marked with &dagger; after
8901 the data type.  ACL rules always expand strings.  A couple of expansion
8902 conditions do not expand some of the brace-delimited branches, for security
8903 reasons.
8904
8905
8906
8907 .section "Literal text in expanded strings" "SECTlittext"
8908 .cindex "expansion" "including literal text"
8909 An uninterpreted dollar can be included in an expanded string by putting a
8910 backslash in front of it. A backslash can be used to prevent any special
8911 character being treated specially in an expansion, including backslash itself.
8912 If the string appears in quotes in the configuration file, two backslashes are
8913 required because the quotes themselves cause interpretation of backslashes when
8914 the string is read in (see section &<<SECTstrings>>&).
8915
8916 .cindex "expansion" "non-expandable substrings"
8917 A portion of the string can specified as non-expandable by placing it between
8918 two occurrences of &`\N`&. This is particularly useful for protecting regular
8919 expressions, which often contain backslashes and dollar signs. For example:
8920 .code
8921 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8922 .endd
8923 On encountering the first &`\N`&, the expander copies subsequent characters
8924 without interpretation until it reaches the next &`\N`& or the end of the
8925 string.
8926
8927
8928
8929 .section "Character escape sequences in expanded strings" "SECID82"
8930 .cindex "expansion" "escape sequences"
8931 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8932 expanded string is recognized as an escape sequence for the character newline,
8933 carriage return, or tab, respectively. A backslash followed by up to three
8934 octal digits is recognized as an octal encoding for a single character, and a
8935 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8936 encoding.
8937
8938 These escape sequences are also recognized in quoted strings when they are read
8939 in. Their interpretation in expansions as well is useful for unquoted strings,
8940 and for other cases such as looked-up strings that are then expanded.
8941
8942
8943 .section "Testing string expansions" "SECID83"
8944 .cindex "expansion" "testing"
8945 .cindex "testing" "string expansion"
8946 .oindex "&%-be%&"
8947 Many expansions can be tested by calling Exim with the &%-be%& option. This
8948 takes the command arguments, or lines from the standard input if there are no
8949 arguments, runs them through the string expansion code, and writes the results
8950 to the standard output. Variables based on configuration values are set up, but
8951 since no message is being processed, variables such as &$local_part$& have no
8952 value. Nevertheless the &%-be%& option can be useful for checking out file and
8953 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8954 and &%nhash%&.
8955
8956 Exim gives up its root privilege when it is called with the &%-be%& option, and
8957 instead runs under the uid and gid it was called with, to prevent users from
8958 using &%-be%& for reading files to which they do not have access.
8959
8960 .oindex "&%-bem%&"
8961 If you want to test expansions that include variables whose values are taken
8962 from a message, there are two other options that can be used. The &%-bem%&
8963 option is like &%-be%& except that it is followed by a file name. The file is
8964 read as a message before doing the test expansions. For example:
8965 .code
8966 exim -bem /tmp/test.message '$h_subject:'
8967 .endd
8968 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8969 Exim message identifier. For example:
8970 .code
8971 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8972 .endd
8973 This loads the message from Exim's spool before doing the test expansions, and
8974 is therefore restricted to admin users.
8975
8976
8977 .section "Forced expansion failure" "SECTforexpfai"
8978 .cindex "expansion" "forced failure"
8979 A number of expansions that are described in the following section have
8980 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8981 (which are sometimes called &"curly brackets"&). Which of the two strings is
8982 used depends on some condition that is evaluated as part of the expansion. If,
8983 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8984 the entire string expansion fails in a way that can be detected by the code
8985 that requested the expansion. This is called &"forced expansion failure"&, and
8986 its consequences depend on the circumstances. In some cases it is no different
8987 from any other expansion failure, but in others a different action may be
8988 taken. Such variations are mentioned in the documentation of the option that is
8989 being expanded.
8990
8991
8992
8993
8994 .section "Expansion items" "SECTexpansionitems"
8995 The following items are recognized in expanded strings. White space may be used
8996 between sub-items that are keywords or substrings enclosed in braces inside an
8997 outer set of braces, to improve readability. &*Warning*&: Within braces,
8998 white space is significant.
8999
9000 .vlist
9001 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9002 .cindex "expansion" "variables"
9003 Substitute the contents of the named variable, for example:
9004 .code
9005 $local_part
9006 ${domain}
9007 .endd
9008 The second form can be used to separate the name from subsequent alphanumeric
9009 characters. This form (using braces) is available only for variables; it does
9010 &'not'& apply to message headers. The names of the variables are given in
9011 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9012 given, the expansion fails.
9013
9014 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9015 .cindex "expansion" "operators"
9016 The string is first itself expanded, and then the operation specified by
9017 <&'op'&> is applied to it. For example:
9018 .code
9019 ${lc:$local_part}
9020 .endd
9021 The string starts with the first character after the colon, which may be
9022 leading white space. A list of operators is given in section &<<SECTexpop>>&
9023 below. The operator notation is used for simple expansion items that have just
9024 one argument, because it reduces the number of braces and therefore makes the
9025 string easier to understand.
9026
9027 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9028 This item inserts &"basic"& header lines. It is described with the &%header%&
9029 expansion item below.
9030
9031
9032 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9033 .cindex "expansion" "calling an acl"
9034 .cindex "&%acl%&" "call from expansion"
9035 The name and zero to nine argument strings are first expanded separately.  The expanded
9036 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9037 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9038 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9039 and may use the variables; if another acl expansion is used the values
9040 are restored after it returns.  If the ACL sets
9041 a value using a "message =" modifier and returns accept or deny, the value becomes
9042 the result of the expansion.
9043 If no message is set and the ACL returns accept or deny
9044 the expansion result is an empty string.
9045 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9046
9047
9048 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9049        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9050 .cindex "expansion" "extracting cerificate fields"
9051 .cindex "&%certextract%&" "certificate fields"
9052 .cindex "certificate" "extracting fields"
9053 The <&'certificate'&> must be a variable of type certificate.
9054 The field name is expanded and used to retrieve the relevant field from
9055 the certificate.  Supported fields are:
9056 .display
9057 &`version        `&
9058 &`serial_number  `&
9059 &`subject        `& RFC4514 DN
9060 &`issuer         `& RFC4514 DN
9061 &`notbefore      `& time
9062 &`notafter       `& time
9063 &`sig_algorithm  `&
9064 &`signature      `&
9065 &`subj_altname   `& tagged list
9066 &`ocsp_uri       `& list
9067 &`crl_uri        `& list
9068 .endd
9069 If the field is found,
9070 <&'string2'&> is expanded, and replaces the whole item;
9071 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9072 variable &$value$& contains the value that has been extracted. Afterwards, it
9073 is restored to any previous value it might have had.
9074
9075 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9076 key is not found. If {<&'string2'&>} is also omitted, the value that was
9077 extracted is used.
9078
9079 Some field names take optional modifiers, appended and separated by commas.
9080
9081 The field selectors marked as "RFC4514" above
9082 output a Distinguished Name string which is
9083 not quite
9084 parseable by Exim as a comma-separated tagged list
9085 (the exceptions being elements containing commas).
9086 RDN elements of a single type may be selected by
9087 a modifier of the type label; if so the expansion
9088 result is a list (newline-separated by default).
9089 The separator may be changed by another modifier of
9090 a right angle-bracket followed immediately by the new separator.
9091 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9092
9093 The field selectors marked as "time" above
9094 take an optional modifier of "int"
9095 for which the result is the number of seconds since epoch.
9096 Otherwise the result is a human-readable string
9097 in the timezone selected by the main "timezone" option.
9098
9099 The field selectors marked as "list" above return a list,
9100 newline-separated by default,
9101 (embedded separator characters in elements are doubled).
9102 The separator may be changed by a modifier of
9103 a right angle-bracket followed immediately by the new separator.
9104
9105 The field selectors marked as "tagged" above
9106 prefix each list element with a type string and an equals sign.
9107 Elements of only one type may be selected by a modifier
9108 which is one of "dns", "uri" or "mail";
9109 if so the element tags are omitted.
9110
9111 If not otherwise noted field values are presented in human-readable form.
9112
9113 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9114        {*&<&'arg'&>&*}...}*&"
9115 .cindex &%dlfunc%&
9116 This expansion dynamically loads and then calls a locally-written C function.
9117 This functionality is available only if Exim is compiled with
9118 .code
9119 EXPAND_DLFUNC=yes
9120 .endd
9121 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9122 object so that it doesn't reload the same object file in the same Exim process
9123 (but of course Exim does start new processes frequently).
9124
9125 There may be from zero to eight arguments to the function. When compiling
9126 a local function that is to be called in this way, &_local_scan.h_& should be
9127 included. The Exim variables and functions that are defined by that API
9128 are also available for dynamically loaded functions. The function itself
9129 must have the following type:
9130 .code
9131 int dlfunction(uschar **yield, int argc, uschar *argv[])
9132 .endd
9133 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9134 function should return one of the following values:
9135
9136 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9137 into the expanded string that is being built.
9138
9139 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9140 from &'yield'&, if it is set.
9141
9142 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9143 taken from &'yield'& if it is set.
9144
9145 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9146
9147 When compiling a function that is to be used in this way with gcc,
9148 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9149 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9150
9151
9152 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9153 .cindex "expansion" "extracting value from environment"
9154 .cindex "environment" "values from"
9155 The key is first expanded separately, and leading and trailing white space
9156 removed.
9157 This is then searched for as a name in the environment.
9158 If a variable is found then its value is placed in &$value$&
9159 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9160
9161 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9162 appear, for example:
9163 .code
9164 ${env{USER}{$value} fail }
9165 .endd
9166 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9167 {<&'string1'&>} must be present for &"fail"& to be recognized.
9168
9169 If {<&'string2'&>} is omitted an empty string is substituted on
9170 search failure.
9171 If {<&'string1'&>} is omitted the search result is substituted on
9172 search success.
9173
9174 The environment is adjusted by the &%keep_environment%& and
9175 &%add_environment%& main section options.
9176
9177
9178 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9179        {*&<&'string3'&>&*}}*&"
9180 .cindex "expansion" "extracting substrings by key"
9181 .cindex "&%extract%&" "substrings by key"
9182 The key and <&'string1'&> are first expanded separately. Leading and trailing
9183 white space is removed from the key (but not from any of the strings). The key
9184 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9185 form:
9186 .display
9187 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9188 .endd
9189 .vindex "&$value$&"
9190 where the equals signs and spaces (but not both) are optional. If any of the
9191 values contain white space, they must be enclosed in double quotes, and any
9192 values that are enclosed in double quotes are subject to escape processing as
9193 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9194 for the value that corresponds to the key. The search is case-insensitive. If
9195 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9196 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9197 variable &$value$& contains the value that has been extracted. Afterwards, it
9198 is restored to any previous value it might have had.
9199
9200 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9201 key is not found. If {<&'string2'&>} is also omitted, the value that was
9202 extracted is used. Thus, for example, these two expansions are identical, and
9203 yield &"2001"&:
9204 .code
9205 ${extract{gid}{uid=1984 gid=2001}}
9206 ${extract{gid}{uid=1984 gid=2001}{$value}}
9207 .endd
9208 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9209 appear, for example:
9210 .code
9211 ${extract{Z}{A=... B=...}{$value} fail }
9212 .endd
9213 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9214 {<&'string2'&>} must be present for &"fail"& to be recognized.
9215
9216
9217 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9218         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9219 .cindex "expansion" "extracting substrings by number"
9220 .cindex "&%extract%&" "substrings by number"
9221 The <&'number'&> argument must consist entirely of decimal digits,
9222 apart from leading and trailing white space, which is ignored.
9223 This is what distinguishes this form of &%extract%& from the previous kind. It
9224 behaves in the same way, except that, instead of extracting a named field, it
9225 extracts from <&'string1'&> the field whose number is given as the first
9226 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9227 <&'string3'&> as before.
9228
9229 The fields in the string are separated by any one of the characters in the
9230 separator string. These may include space or tab characters.
9231 The first field is numbered one. If the number is negative, the fields are
9232 counted from the end of the string, with the rightmost one numbered -1. If the
9233 number given is zero, the entire string is returned. If the modulus of the
9234 number is greater than the number of fields in the string, the result is the
9235 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9236 provided. For example:
9237 .code
9238 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9239 .endd
9240 yields &"42"&, and
9241 .code
9242 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9243 .endd
9244 yields &"99"&. Two successive separators mean that the field between them is
9245 empty (for example, the fifth field above).
9246
9247
9248 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9249 .cindex "list" "selecting by condition"
9250 .cindex "expansion" "selecting from list by condition"
9251 .vindex "&$item$&"
9252 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9253 default, but the separator can be changed in the usual way. For each item
9254 in this list, its value is place in &$item$&, and then the condition is
9255 evaluated. If the condition is true, &$item$& is added to the output as an
9256 item in a new list; if the condition is false, the item is discarded. The
9257 separator used for the output list is the same as the one used for the
9258 input, but a separator setting is not included in the output. For example:
9259 .code
9260 ${filter{a:b:c}{!eq{$item}{b}}
9261 .endd
9262 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9263 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9264
9265
9266 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9267 .cindex "hash function" "textual"
9268 .cindex "expansion" "textual hash"
9269 This is a textual hashing function, and was the first to be implemented in
9270 early versions of Exim. In current releases, there are other hashing functions
9271 (numeric, MD5, and SHA-1), which are described below.
9272
9273 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9274 <&'n'&>. If you are using fixed values for these numbers, that is, if
9275 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9276 use the simpler operator notation that avoids some of the braces:
9277 .code
9278 ${hash_<n>_<m>:<string>}
9279 .endd
9280 The second number is optional (in both notations). If <&'n'&> is greater than
9281 or equal to the length of the string, the expansion item returns the string.
9282 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9283 function to the string. The new string consists of characters taken from the
9284 first <&'m'&> characters of the string
9285 .code
9286 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9287 .endd
9288 If <&'m'&> is not present the value 26 is used, so that only lower case
9289 letters appear. For example:
9290 .display
9291 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9292 &`$hash{5}{monty}}           `&   yields  &`monty`&
9293 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9294 .endd
9295
9296 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9297         &*$h_*&<&'header&~name'&>&*:*&" &&&
9298        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9299         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9300        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9301         &*$rh_*&<&'header&~name'&>&*:*&"
9302 .cindex "expansion" "header insertion"
9303 .vindex "&$header_$&"
9304 .vindex "&$bheader_$&"
9305 .vindex "&$rheader_$&"
9306 .cindex "header lines" "in expansion strings"
9307 .cindex "header lines" "character sets"
9308 .cindex "header lines" "decoding"
9309 Substitute the contents of the named message header line, for example
9310 .code
9311 $header_reply-to:
9312 .endd
9313 The newline that terminates a header line is not included in the expansion, but
9314 internal newlines (caused by splitting the header line over several physical
9315 lines) may be present.
9316
9317 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9318 the data in the header line is interpreted.
9319
9320 .ilist
9321 .cindex "white space" "in header lines"
9322 &%rheader%& gives the original &"raw"& content of the header line, with no
9323 processing at all, and without the removal of leading and trailing white space.
9324
9325 .next
9326 .cindex "base64 encoding" "in header lines"
9327 &%bheader%& removes leading and trailing white space, and then decodes base64
9328 or quoted-printable MIME &"words"& within the header text, but does no
9329 character set translation. If decoding of what looks superficially like a MIME
9330 &"word"& fails, the raw string is returned. If decoding
9331 .cindex "binary zero" "in header line"
9332 produces a binary zero character, it is replaced by a question mark &-- this is
9333 what Exim does for binary zeros that are actually received in header lines.
9334
9335 .next
9336 &%header%& tries to translate the string as decoded by &%bheader%& to a
9337 standard character set. This is an attempt to produce the same string as would
9338 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9339 returned. Translation is attempted only on operating systems that support the
9340 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9341 a system Makefile or in &_Local/Makefile_&.
9342 .endlist ilist
9343
9344 In a filter file, the target character set for &%header%& can be specified by a
9345 command of the following form:
9346 .code
9347 headers charset "UTF-8"
9348 .endd
9349 This command affects all references to &$h_$& (or &$header_$&) expansions in
9350 subsequently obeyed filter commands. In the absence of this command, the target
9351 character set in a filter is taken from the setting of the &%headers_charset%&
9352 option in the runtime configuration. The value of this option defaults to the
9353 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9354 ISO-8859-1.
9355
9356 Header names follow the syntax of RFC 2822, which states that they may contain
9357 any printing characters except space and colon. Consequently, curly brackets
9358 &'do not'& terminate header names, and should not be used to enclose them as
9359 if they were variables. Attempting to do so causes a syntax error.
9360
9361 Only header lines that are common to all copies of a message are visible to
9362 this mechanism. These are the original header lines that are received with the
9363 message, and any that are added by an ACL statement or by a system
9364 filter. Header lines that are added to a particular copy of a message by a
9365 router or transport are not accessible.
9366
9367 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9368 before the DATA ACL, because the header structure is not set up until the
9369 message is received. Header lines that are added in a RCPT ACL (for example)
9370 are saved until the message's incoming header lines are available, at which
9371 point they are added. When a DATA ACL is running, however, header lines added
9372 by earlier ACLs are visible.
9373
9374 Upper case and lower case letters are synonymous in header names. If the
9375 following character is white space, the terminating colon may be omitted, but
9376 this is not recommended, because you may then forget it when it is needed. When
9377 white space terminates the header name, this white space is included in the
9378 expanded string.  If the message does not contain the given header, the
9379 expansion item is replaced by an empty string. (See the &%def%& condition in
9380 section &<<SECTexpcond>>& for a means of testing for the existence of a
9381 header.)
9382
9383 If there is more than one header with the same name, they are all concatenated
9384 to form the substitution string, up to a maximum length of 64K. Unless
9385 &%rheader%& is being used, leading and trailing white space is removed from
9386 each header before concatenation, and a completely empty header is ignored. A
9387 newline character is then inserted between non-empty headers, but there is no
9388 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9389 those headers that contain lists of addresses, a comma is also inserted at the
9390 junctions between headers. This does not happen for the &%rheader%& expansion.
9391
9392
9393 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9394 .cindex "expansion" "hmac hashing"
9395 .cindex &%hmac%&
9396 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9397 shared secret and some text into a message authentication code, as specified in
9398 RFC 2104. This differs from &`${md5:secret_text...}`& or
9399 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9400 cryptographic hash, allowing for authentication that is not possible with MD5
9401 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9402 present. For example:
9403 .code
9404 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9405 .endd
9406 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9407 produces:
9408 .code
9409 dd97e3ba5d1a61b5006108f8c8252953
9410 .endd
9411 As an example of how this might be used, you might put in the main part of
9412 an Exim configuration:
9413 .code
9414 SPAMSCAN_SECRET=cohgheeLei2thahw
9415 .endd
9416 In a router or a transport you could then have:
9417 .code
9418 headers_add = \
9419   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9420   ${hmac{md5}{SPAMSCAN_SECRET}\
9421   {${primary_hostname},${message_exim_id},$h_message-id:}}
9422 .endd
9423 Then given a message, you can check where it was scanned by looking at the
9424 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9425 this header line is authentic by recomputing the authentication code from the
9426 host name, message ID and the &'Message-id:'& header line. This can be done
9427 using Exim's &%-be%& option, or by other means, for example by using the
9428 &'hmac_md5_hex()'& function in Perl.
9429
9430
9431 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9432 .cindex "expansion" "conditional"
9433 .cindex "&%if%&, expansion item"
9434 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9435 item; otherwise <&'string2'&> is used. The available conditions are described
9436 in section &<<SECTexpcond>>& below. For example:
9437 .code
9438 ${if eq {$local_part}{postmaster} {yes}{no} }
9439 .endd
9440 The second string need not be present; if it is not and the condition is not
9441 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9442 be present instead of the second string (without any curly brackets). In this
9443 case, the expansion is forced to fail if the condition is not true (see section
9444 &<<SECTforexpfai>>&).
9445
9446 If both strings are omitted, the result is the string &`true`& if the condition
9447 is true, and the empty string if the condition is false. This makes it less
9448 cumbersome to write custom ACL and router conditions. For example, instead of
9449 .code
9450 condition = ${if >{$acl_m4}{3}{true}{false}}
9451 .endd
9452 you can use
9453 .code
9454 condition = ${if >{$acl_m4}{3}}
9455 .endd
9456
9457
9458
9459 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9460 .cindex expansion "imap folder"
9461 .cindex "&%imapfolder%& expansion item"
9462 This item converts a (possibly multilevel, or with non-ASCII characters)
9463 folder specification to a Maildir name for filesystem use.
9464 For information on internationalisation support see &<<SECTi18nMDA>>&.
9465
9466
9467
9468 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9469 .cindex "expansion" "string truncation"
9470 .cindex "&%length%& expansion item"
9471 The &%length%& item is used to extract the initial portion of a string. Both
9472 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9473 you are using a fixed value for the number, that is, if <&'string1'&> does not
9474 change when expanded, you can use the simpler operator notation that avoids
9475 some of the braces:
9476 .code
9477 ${length_<n>:<string>}
9478 .endd
9479 The result of this item is either the first <&'n'&> characters or the whole
9480 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9481 &%strlen%&, which gives the length of a string.
9482
9483
9484 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9485         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9486 .cindex "expansion" "extracting list elements by number"
9487 .cindex "&%listextract%&" "extract list elements by number"
9488 .cindex "list" "extracting elements by number"
9489 The <&'number'&> argument must consist entirely of decimal digits,
9490 apart from an optional leading minus,
9491 and leading and trailing white space (which is ignored).
9492
9493 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9494 default, but the separator can be changed in the usual way.
9495
9496 The first field of the list is numbered one.
9497 If the number is negative, the fields are
9498 counted from the end of the list, with the rightmost one numbered -1.
9499 The numbered element of the list is extracted and placed in &$value$&,
9500 then <&'string2'&> is expanded as the result.
9501
9502 If the modulus of the
9503 number is zero or greater than the number of fields in the string,
9504 the result is the expansion of <&'string3'&>.
9505
9506 For example:
9507 .code
9508 ${listextract{2}{x:42:99}}
9509 .endd
9510 yields &"42"&, and
9511 .code
9512 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9513 .endd
9514 yields &"result: 42"&.
9515
9516 If {<&'string3'&>} is omitted, an empty string is used for string3.
9517 If {<&'string2'&>} is also omitted, the value that was
9518 extracted is used.
9519 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9520
9521
9522 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9523         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9524 This is the first of one of two different types of lookup item, which are both
9525 described in the next item.
9526
9527 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9528         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9529 .cindex "expansion" "lookup in"
9530 .cindex "file" "lookups"
9531 .cindex "lookup" "in expanded string"
9532 The two forms of lookup item specify data lookups in files and databases, as
9533 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9534 lookups, and the second is used for query-style lookups. The <&'key'&>,
9535 <&'file'&>, and <&'query'&> strings are expanded before use.
9536
9537 If there is any white space in a lookup item which is part of a filter command,
9538 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9539 other place where white space is significant, the lookup item must be enclosed
9540 in double quotes. The use of data lookups in users' filter files may be locked
9541 out by the system administrator.
9542
9543 .vindex "&$value$&"
9544 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9545 During its expansion, the variable &$value$& contains the data returned by the
9546 lookup. Afterwards it reverts to the value it had previously (at the outer
9547 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9548 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9549 string on failure. If <&'string2'&> is provided, it can itself be a nested
9550 lookup, thus providing a mechanism for looking up a default value when the
9551 original lookup fails.
9552
9553 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9554 data for the outer lookup while the parameters of the second lookup are
9555 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9556 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9557 appear, and in this case, if the lookup fails, the entire expansion is forced
9558 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9559 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9560 successful lookup, and nothing in the case of failure.
9561
9562 For single-key lookups, the string &"partial"& is permitted to precede the
9563 search type in order to do partial matching, and * or *@ may follow a search
9564 type to request default lookups if the key does not match (see sections
9565 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9566
9567 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9568 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9569 and non-wild parts of the key during the expansion of the replacement text.
9570 They return to their previous values at the end of the lookup item.
9571
9572 This example looks up the postmaster alias in the conventional alias file:
9573 .code
9574 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9575 .endd
9576 This example uses NIS+ to look up the full name of the user corresponding to
9577 the local part of an address, forcing the expansion to fail if it is not found:
9578 .code
9579 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9580   {$value}fail}
9581 .endd
9582
9583
9584 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9585 .cindex "expansion" "list creation"
9586 .vindex "&$item$&"
9587 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9588 default, but the separator can be changed in the usual way. For each item
9589 in this list, its value is place in &$item$&, and then <&'string2'&> is
9590 expanded and added to the output as an item in a new list. The separator used
9591 for the output list is the same as the one used for the input, but a separator
9592 setting is not included in the output. For example:
9593 .code
9594 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9595 .endd
9596 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9597 value of &$item$& is restored to what it was before. See also the &*filter*&
9598 and &*reduce*& expansion items.
9599
9600 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9601 .cindex "expansion" "numeric hash"
9602 .cindex "hash function" "numeric"
9603 The three strings are expanded; the first two must yield numbers. Call them
9604 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9605 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9606 can use the simpler operator notation that avoids some of the braces:
9607 .code
9608 ${nhash_<n>_<m>:<string>}
9609 .endd
9610 The second number is optional (in both notations). If there is only one number,
9611 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9612 processed by a div/mod hash function that returns two numbers, separated by a
9613 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9614 example,
9615 .code
9616 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9617 .endd
9618 returns the string &"6/33"&.
9619
9620
9621
9622 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9623 .cindex "Perl" "use in expanded string"
9624 .cindex "expansion" "calling Perl from"
9625 This item is available only if Exim has been built to include an embedded Perl
9626 interpreter. The subroutine name and the arguments are first separately
9627 expanded, and then the Perl subroutine is called with those arguments. No
9628 additional arguments need be given; the maximum number permitted, including the
9629 name of the subroutine, is nine.
9630
9631 The return value of the subroutine is inserted into the expanded string, unless
9632 the return value is &%undef%&. In that case, the expansion fails in the same
9633 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9634 Whatever you return is evaluated in a scalar context. For example, if you
9635 return the name of a Perl vector, the return value is the size of the vector,
9636 not its contents.
9637
9638 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9639 with the error message that was passed to &%die%&. More details of the embedded
9640 Perl facility are given in chapter &<<CHAPperl>>&.
9641
9642 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9643 out the use of this expansion item in filter files.
9644
9645
9646 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9647 .cindex "&%prvs%& expansion item"
9648 The first argument is a complete email address and the second is secret
9649 keystring. The third argument, specifying a key number, is optional. If absent,
9650 it defaults to 0. The result of the expansion is a prvs-signed email address,
9651 to be typically used with the &%return_path%& option on an &(smtp)& transport
9652 as part of a bounce address tag validation (BATV) scheme. For more discussion
9653 and an example, see section &<<SECTverifyPRVS>>&.
9654
9655 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9656         {*&<&'string'&>&*}}*&"
9657 .cindex "&%prvscheck%& expansion item"
9658 This expansion item is the complement of the &%prvs%& item. It is used for
9659 checking prvs-signed addresses. If the expansion of the first argument does not
9660 yield a syntactically valid prvs-signed address, the whole item expands to the
9661 empty string. When the first argument does expand to a syntactically valid
9662 prvs-signed address, the second argument is expanded, with the prvs-decoded
9663 version of the address and the key number extracted from the address in the
9664 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9665
9666 These two variables can be used in the expansion of the second argument to
9667 retrieve the secret. The validity of the prvs-signed address is then checked
9668 against the secret. The result is stored in the variable &$prvscheck_result$&,
9669 which is empty for failure or &"1"& for success.
9670
9671 The third argument is optional; if it is missing, it defaults to an empty
9672 string. This argument is now expanded. If the result is an empty string, the
9673 result of the expansion is the decoded version of the address. This is the case
9674 whether or not the signature was valid. Otherwise, the result of the expansion
9675 is the expansion of the third argument.
9676
9677 All three variables can be used in the expansion of the third argument.
9678 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9679 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9680
9681 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9682 .cindex "expansion" "inserting an entire file"
9683 .cindex "file" "inserting into expansion"
9684 .cindex "&%readfile%& expansion item"
9685 The file name and end-of-line string are first expanded separately. The file is
9686 then read, and its contents replace the entire item. All newline characters in
9687 the file are replaced by the end-of-line string if it is present. Otherwise,
9688 newlines are left in the string.
9689 String expansion is not applied to the contents of the file. If you want this,
9690 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9691 the string expansion fails.
9692
9693 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9694 locks out the use of this expansion item in filter files.
9695
9696
9697
9698 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9699         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9700 .cindex "expansion" "inserting from a socket"
9701 .cindex "socket, use of in expansion"
9702 .cindex "&%readsocket%& expansion item"
9703 This item inserts data from a Unix domain or TCP socket into the expanded
9704 string. The minimal way of using it uses just two arguments, as in these
9705 examples:
9706 .code
9707 ${readsocket{/socket/name}{request string}}
9708 ${readsocket{inet:some.host:1234}{request string}}
9709 .endd
9710 For a Unix domain socket, the first substring must be the path to the socket.
9711 For an Internet socket, the first substring must contain &`inet:`& followed by
9712 a host name or IP address, followed by a colon and a port, which can be a
9713 number or the name of a TCP port in &_/etc/services_&. An IP address may
9714 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9715 example:
9716 .code
9717 ${readsocket{inet:[::1]:1234}{request string}}
9718 .endd
9719 Only a single host name may be given, but if looking it up yields more than
9720 one IP address, they are each tried in turn until a connection is made. For
9721 both kinds of socket, Exim makes a connection, writes the request string
9722 unless it is an empty string; and no terminating NUL is ever sent)
9723 and reads from the socket until an end-of-file
9724 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9725 extend what can be done. Firstly, you can vary the timeout. For example:
9726 .code
9727 ${readsocket{/socket/name}{request string}{3s}}
9728 .endd
9729 A fourth argument allows you to change any newlines that are in the data
9730 that is read, in the same way as for &%readfile%& (see above). This example
9731 turns them into spaces:
9732 .code
9733 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9734 .endd
9735 As with all expansions, the substrings are expanded before the processing
9736 happens. Errors in these sub-expansions cause the expansion to fail. In
9737 addition, the following errors can occur:
9738
9739 .ilist
9740 Failure to create a socket file descriptor;
9741 .next
9742 Failure to connect the socket;
9743 .next
9744 Failure to write the request string;
9745 .next
9746 Timeout on reading from the socket.
9747 .endlist
9748
9749 By default, any of these errors causes the expansion to fail. However, if
9750 you supply a fifth substring, it is expanded and used when any of the above
9751 errors occurs. For example:
9752 .code
9753 ${readsocket{/socket/name}{request string}{3s}{\n}\
9754   {socket failure}}
9755 .endd
9756 You can test for the existence of a Unix domain socket by wrapping this
9757 expansion in &`${if exists`&, but there is a race condition between that test
9758 and the actual opening of the socket, so it is safer to use the fifth argument
9759 if you want to be absolutely sure of avoiding an expansion error for a
9760 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9761
9762 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9763 locks out the use of this expansion item in filter files.
9764
9765
9766 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9767 .cindex "expansion" "reducing a list to a scalar"
9768 .cindex "list" "reducing to a scalar"
9769 .vindex "&$value$&"
9770 .vindex "&$item$&"
9771 This operation reduces a list to a single, scalar string. After expansion,
9772 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9773 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9774 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9775 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9776 them. The result of that expansion is assigned to &$value$& before the next
9777 iteration. When the end of the list is reached, the final value of &$value$& is
9778 added to the expansion output. The &*reduce*& expansion item can be used in a
9779 number of ways. For example, to add up a list of numbers:
9780 .code
9781 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9782 .endd
9783 The result of that expansion would be &`6`&. The maximum of a list of numbers
9784 can be found:
9785 .code
9786 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9787 .endd
9788 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9789 restored to what they were before. See also the &*filter*& and &*map*&
9790 expansion items.
9791
9792 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9793 This item inserts &"raw"& header lines. It is described with the &%header%&
9794 expansion item above.
9795
9796 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9797         {*&<&'string2'&>&*}}*&"
9798 .cindex "expansion" "running a command"
9799 .cindex "&%run%& expansion item"
9800 The command and its arguments are first expanded as one string. The string is
9801 split apart into individual arguments by spaces, and then the command is run
9802 in a separate process, but under the same uid and gid.  As in other command
9803 executions from Exim, a shell is not used by default. If the command requires
9804 a shell, you must explicitly code it.
9805
9806 Since the arguments are split by spaces, when there is a variable expansion
9807 which has an empty result, it will cause the situation that the argument will
9808 simply be omitted when the program is actually executed by Exim. If the
9809 script/program requires a specific number of arguments and the expanded
9810 variable could possibly result in this empty expansion, the variable must be
9811 quoted. This is more difficult if the expanded variable itself could result
9812 in a string containing quotes, because it would interfere with the quotes
9813 around the command arguments. A possible guard against this is to wrap the
9814 variable in the &%sg%& operator to change any quote marks to some other
9815 character.
9816
9817 The standard input for the command exists, but is empty. The standard output
9818 and standard error are set to the same file descriptor.
9819 .cindex "return code" "from &%run%& expansion"
9820 .vindex "&$value$&"
9821 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9822 and replaces the entire item; during this expansion, the standard output/error
9823 from the command is in the variable &$value$&. If the command fails,
9824 <&'string2'&>, if present, is expanded and used. Once again, during the
9825 expansion, the standard output/error from the command is in the variable
9826 &$value$&.
9827
9828 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9829 can be the word &"fail"& (not in braces) to force expansion failure if the
9830 command does not succeed. If both strings are omitted, the result is contents
9831 of the standard output/error on success, and nothing on failure.
9832
9833 .vindex "&$run_in_acl$&"
9834 The standard output/error of the command is put in the variable &$value$&.
9835 In this ACL example, the output of a command is logged for the admin to
9836 troubleshoot:
9837 .code
9838 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9839       log_message  = Output of id: $value
9840 .endd
9841 If the command requires shell idioms, such as the > redirect operator, the
9842 shell must be invoked directly, such as with:
9843 .code
9844 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9845 .endd
9846
9847 .vindex "&$runrc$&"
9848 The return code from the command is put in the variable &$runrc$&, and this
9849 remains set afterwards, so in a filter file you can do things like this:
9850 .code
9851 if "${run{x y z}{}}$runrc" is 1 then ...
9852   elif $runrc is 2 then ...
9853   ...
9854 endif
9855 .endd
9856 If execution of the command fails (for example, the command does not exist),
9857 the return code is 127 &-- the same code that shells use for non-existent
9858 commands.
9859
9860 &*Warning*&: In a router or transport, you cannot assume the order in which
9861 option values are expanded, except for those preconditions whose order of
9862 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9863 by the expansion of one option, and use it in another.
9864
9865 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9866 out the use of this expansion item in filter files.
9867
9868
9869 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9870 .cindex "expansion" "string substitution"
9871 .cindex "&%sg%& expansion item"
9872 This item works like Perl's substitution operator (s) with the global (/g)
9873 option; hence its name. However, unlike the Perl equivalent, Exim does not
9874 modify the subject string; instead it returns the modified string for insertion
9875 into the overall expansion. The item takes three arguments: the subject string,
9876 a regular expression, and a substitution string. For example:
9877 .code
9878 ${sg{abcdefabcdef}{abc}{xyz}}
9879 .endd
9880 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9881 if any $ or \ characters are required in the regular expression or in the
9882 substitution string, they have to be escaped. For example:
9883 .code
9884 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9885 .endd
9886 yields &"defabc"&, and
9887 .code
9888 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9889 .endd
9890 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9891 the regular expression from string expansion.
9892
9893
9894
9895 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9896 .cindex sorting "a list"
9897 .cindex list sorting
9898 .cindex expansion "list sorting"
9899 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9900 default, but the separator can be changed in the usual way.
9901 The <&'comparator'&> argument is interpreted as the operator
9902 of a two-argument expansion condition.
9903 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9904 The comparison should return true when applied to two values
9905 if the first value should sort before the second value.
9906 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9907 the element being placed in &$item$&,
9908 to give values for comparison.
9909
9910 The item result is a sorted list,
9911 with the original list separator,
9912 of the list elements (in full) of the original.
9913
9914 Examples:
9915 .code
9916 ${sort{3:2:1:4}{<}{$item}}
9917 .endd
9918 sorts a list of numbers, and
9919 .code
9920 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9921 .endd
9922 will sort an MX lookup into priority order.
9923
9924
9925 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9926 .cindex "&%substr%& expansion item"
9927 .cindex "substring extraction"
9928 .cindex "expansion" "substring extraction"
9929 The three strings are expanded; the first two must yield numbers. Call them
9930 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9931 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9932 can use the simpler operator notation that avoids some of the braces:
9933 .code
9934 ${substr_<n>_<m>:<string>}
9935 .endd
9936 The second number is optional (in both notations).
9937 If it is absent in the simpler format, the preceding underscore must also be
9938 omitted.
9939
9940 The &%substr%& item can be used to extract more general substrings than
9941 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9942 length required. For example
9943 .code
9944 ${substr{3}{2}{$local_part}}
9945 .endd
9946 If the starting offset is greater than the string length the result is the
9947 null string; if the length plus starting offset is greater than the string
9948 length, the result is the right-hand part of the string, starting from the
9949 given offset. The first character in the string has offset zero.
9950
9951 The &%substr%& expansion item can take negative offset values to count
9952 from the right-hand end of its operand. The last character is offset -1, the
9953 second-last is offset -2, and so on. Thus, for example,
9954 .code
9955 ${substr{-5}{2}{1234567}}
9956 .endd
9957 yields &"34"&. If the absolute value of a negative offset is greater than the
9958 length of the string, the substring starts at the beginning of the string, and
9959 the length is reduced by the amount of overshoot. Thus, for example,
9960 .code
9961 ${substr{-5}{2}{12}}
9962 .endd
9963 yields an empty string, but
9964 .code
9965 ${substr{-3}{2}{12}}
9966 .endd
9967 yields &"1"&.
9968
9969 When the second number is omitted from &%substr%&, the remainder of the string
9970 is taken if the offset is positive. If it is negative, all characters in the
9971 string preceding the offset point are taken. For example, an offset of -1 and
9972 no length, as in these semantically identical examples:
9973 .code
9974 ${substr_-1:abcde}
9975 ${substr{-1}{abcde}}
9976 .endd
9977 yields all but the last character of the string, that is, &"abcd"&.
9978
9979
9980
9981 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9982         {*&<&'replacements'&>&*}}*&"
9983 .cindex "expansion" "character translation"
9984 .cindex "&%tr%& expansion item"
9985 This item does single-character translation on its subject string. The second
9986 argument is a list of characters to be translated in the subject string. Each
9987 matching character is replaced by the corresponding character from the
9988 replacement list. For example
9989 .code
9990 ${tr{abcdea}{ac}{13}}
9991 .endd
9992 yields &`1b3de1`&. If there are duplicates in the second character string, the
9993 last occurrence is used. If the third string is shorter than the second, its
9994 last character is replicated. However, if it is empty, no translation takes
9995 place.
9996 .endlist
9997
9998
9999
10000 .section "Expansion operators" "SECTexpop"
10001 .cindex "expansion" "operators"
10002 For expansion items that perform transformations on a single argument string,
10003 the &"operator"& notation is used because it is simpler and uses fewer braces.
10004 The substring is first expanded before the operation is applied to it. The
10005 following operations can be performed:
10006
10007 .vlist
10008 .vitem &*${address:*&<&'string'&>&*}*&
10009 .cindex "expansion" "RFC 2822 address handling"
10010 .cindex "&%address%& expansion item"
10011 The string is interpreted as an RFC 2822 address, as it might appear in a
10012 header line, and the effective address is extracted from it. If the string does
10013 not parse successfully, the result is empty.
10014
10015
10016 .vitem &*${addresses:*&<&'string'&>&*}*&
10017 .cindex "expansion" "RFC 2822 address handling"
10018 .cindex "&%addresses%& expansion item"
10019 The string (after expansion) is interpreted as a list of addresses in RFC
10020 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10021 operative address (&'local-part@domain'&) is extracted from each item, and the
10022 result of the expansion is a colon-separated list, with appropriate
10023 doubling of colons should any happen to be present in the email addresses.
10024 Syntactically invalid RFC2822 address items are omitted from the output.
10025
10026 It is possible to specify a character other than colon for the output
10027 separator by starting the string with > followed by the new separator
10028 character. For example:
10029 .code
10030 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10031 .endd
10032 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10033 expansion item, which extracts the working address from a single RFC2822
10034 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10035 processing lists.
10036
10037 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10038 a strict interpretation of header line formatting.  Exim parses the bare,
10039 unquoted portion of an email address and if it finds a comma, treats it as an
10040 email address separator. For the example header line:
10041 .code
10042 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10043 .endd
10044 The first example below demonstrates that Q-encoded email addresses are parsed
10045 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10046 It does not see the comma because it's still encoded as "=2C".  The second
10047 example below is passed the contents of &`$header_from:`&, meaning it gets
10048 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10049 The third example shows that the presence of a comma is skipped when it is
10050 quoted.
10051 .code
10052 # exim -be '${addresses:From: \
10053 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10054 user@example.com
10055 # exim -be '${addresses:From: Last, First <user@example.com>}'
10056 Last:user@example.com
10057 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10058 user@example.com
10059 .endd
10060
10061 .vitem &*${base62:*&<&'digits'&>&*}*&
10062 .cindex "&%base62%& expansion item"
10063 .cindex "expansion" "conversion to base 62"
10064 The string must consist entirely of decimal digits. The number is converted to
10065 base 62 and output as a string of six characters, including leading zeros. In
10066 the few operating environments where Exim uses base 36 instead of base 62 for
10067 its message identifiers (because those systems do not have case-sensitive file
10068 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10069 be absolutely clear: this is &'not'& base64 encoding.
10070
10071 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10072 .cindex "&%base62d%& expansion item"
10073 .cindex "expansion" "conversion to base 62"
10074 The string must consist entirely of base-62 digits, or, in operating
10075 environments where Exim uses base 36 instead of base 62 for its message
10076 identifiers, base-36 digits. The number is converted to decimal and output as a
10077 string.
10078
10079 .vitem &*${base64:*&<&'string'&>&*}*&
10080 .cindex "expansion" "base64 encoding"
10081 .cindex "base64 encoding" "in string expansion"
10082 .cindex "&%base64%& expansion item"
10083 .cindex certificate "base64 of DER"
10084 This operator converts a string into one that is base64 encoded.
10085
10086 If the string is a single variable of type certificate,
10087 returns the base64 encoding of the DER form of the certificate.
10088
10089
10090 .vitem &*${base64d:*&<&'string'&>&*}*&
10091 .cindex "expansion" "base64 decoding"
10092 .cindex "base64 decoding" "in string expansion"
10093 .cindex "&%base64d%& expansion item"
10094 This operator converts a base64-encoded string into the un-coded form.
10095
10096
10097 .vitem &*${domain:*&<&'string'&>&*}*&
10098 .cindex "domain" "extraction"
10099 .cindex "expansion" "domain extraction"
10100 The string is interpreted as an RFC 2822 address and the domain is extracted
10101 from it. If the string does not parse successfully, the result is empty.
10102
10103
10104 .vitem &*${escape:*&<&'string'&>&*}*&
10105 .cindex "expansion" "escaping non-printing characters"
10106 .cindex "&%escape%& expansion item"
10107 If the string contains any non-printing characters, they are converted to
10108 escape sequences starting with a backslash. Whether characters with the most
10109 significant bit set (so-called &"8-bit characters"&) count as printing or not
10110 is controlled by the &%print_topbitchars%& option.
10111
10112
10113 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10114 .cindex "expansion" "expression evaluation"
10115 .cindex "expansion" "arithmetic expression"
10116 .cindex "&%eval%& expansion item"
10117 These items supports simple arithmetic and bitwise logical operations in
10118 expansion strings. The string (after expansion) must be a conventional
10119 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10120 logical operators, and parentheses. All operations are carried out using
10121 integer arithmetic. The operator priorities are as follows (the same as in the
10122 C programming language):
10123 .table2 70pt 300pt
10124 .irow &'highest:'& "not (~), negate (-)"
10125 .irow ""   "multiply (*), divide (/), remainder (%)"
10126 .irow ""   "plus (+), minus (-)"
10127 .irow ""   "shift-left (<<), shift-right (>>)"
10128 .irow ""   "and (&&)"
10129 .irow ""   "xor (^)"
10130 .irow &'lowest:'&  "or (|)"
10131 .endtable
10132 Binary operators with the same priority are evaluated from left to right. White
10133 space is permitted before or after operators.
10134
10135 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10136 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10137 decimal, even if they start with a leading zero; hexadecimal numbers are not
10138 permitted. This can be useful when processing numbers extracted from dates or
10139 times, which often do have leading zeros.
10140
10141 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10142 or 1024*1024*1024,
10143 respectively. Negative numbers are supported. The result of the computation is
10144 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10145
10146 .display
10147 &`${eval:1+1}            `&  yields 2
10148 &`${eval:1+2*3}          `&  yields 7
10149 &`${eval:(1+2)*3}        `&  yields 9
10150 &`${eval:2+42%5}         `&  yields 4
10151 &`${eval:0xc&amp;5}          `&  yields 4
10152 &`${eval:0xc|5}          `&  yields 13
10153 &`${eval:0xc^5}          `&  yields 9
10154 &`${eval:0xc>>1}         `&  yields 6
10155 &`${eval:0xc<<1}         `&  yields 24
10156 &`${eval:~255&amp;0x1234}    `&  yields 4608
10157 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10158 .endd
10159
10160 As a more realistic example, in an ACL you might have
10161 .code
10162 deny   message = Too many bad recipients
10163        condition =                    \
10164          ${if and {                   \
10165            {>{$rcpt_count}{10}}       \
10166            {                          \
10167            <                          \
10168              {$recipients_count}      \
10169              {${eval:$rcpt_count/2}}  \
10170            }                          \
10171          }{yes}{no}}
10172 .endd
10173 The condition is true if there have been more than 10 RCPT commands and
10174 fewer than half of them have resulted in a valid recipient.
10175
10176
10177 .vitem &*${expand:*&<&'string'&>&*}*&
10178 .cindex "expansion" "re-expansion of substring"
10179 The &%expand%& operator causes a string to be expanded for a second time. For
10180 example,
10181 .code
10182 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10183 .endd
10184 first looks up a string in a file while expanding the operand for &%expand%&,
10185 and then re-expands what it has found.
10186
10187
10188 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10189 .cindex "Unicode"
10190 .cindex "UTF-8" "conversion from"
10191 .cindex "expansion" "UTF-8 conversion"
10192 .cindex "&%from_utf8%& expansion item"
10193 The world is slowly moving towards Unicode, although there are no standards for
10194 email yet. However, other applications (including some databases) are starting
10195 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10196 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10197 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10198 the result is an undefined sequence of bytes.
10199
10200 Unicode code points with values less than 256 are compatible with ASCII and
10201 ISO-8859-1 (also known as Latin-1).
10202 For example, character 169 is the copyright symbol in both cases, though the
10203 way it is encoded is different. In UTF-8, more than one byte is needed for
10204 characters with code values greater than 127, whereas ISO-8859-1 is a
10205 single-byte encoding (but thereby limited to 256 characters). This makes
10206 translation from UTF-8 to ISO-8859-1 straightforward.
10207
10208
10209 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10210 .cindex "hash function" "textual"
10211 .cindex "expansion" "textual hash"
10212 The &%hash%& operator is a simpler interface to the hashing function that can
10213 be used when the two parameters are fixed numbers (as opposed to strings that
10214 change when expanded). The effect is the same as
10215 .code
10216 ${hash{<n>}{<m>}{<string>}}
10217 .endd
10218 See the description of the general &%hash%& item above for details. The
10219 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10220
10221
10222
10223 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10224 .cindex "base64 encoding" "conversion from hex"
10225 .cindex "expansion" "hex to base64"
10226 .cindex "&%hex2b64%& expansion item"
10227 This operator converts a hex string into one that is base64 encoded. This can
10228 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10229
10230
10231
10232 .vitem &*${hexquote:*&<&'string'&>&*}*&
10233 .cindex "quoting" "hex-encoded unprintable characters"
10234 .cindex "&%hexquote%& expansion item"
10235 This operator converts non-printable characters in a string into a hex
10236 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10237 as is, and other byte values are converted to &`\xNN`&, for example a
10238 byte value 127 is converted to &`\x7f`&.
10239
10240
10241 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10242 .cindex "&%ipv6denorm%& expansion item"
10243 .cindex "IP address" normalisation
10244 This expands an IPv6 address to a full eight-element colon-separated set
10245 of hex digits including leading zeroes.
10246 A trailing ipv4-style dotted-decimal set is converted to hex.
10247 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10248
10249 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10250 .cindex "&%ipv6norm%& expansion item"
10251 .cindex "IP address" normalisation
10252 .cindex "IP address" "canonical form"
10253 This converts an IPv6 address to canonical form.
10254 Leading zeroes of groups are omitted, and the longest
10255 set of zero-valued groups is replaced with a double colon.
10256 A trailing ipv4-style dotted-decimal set is converted to hex.
10257 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10258
10259
10260 .vitem &*${lc:*&<&'string'&>&*}*&
10261 .cindex "case forcing in strings"
10262 .cindex "string" "case forcing"
10263 .cindex "lower casing"
10264 .cindex "expansion" "case forcing"
10265 .cindex "&%lc%& expansion item"
10266 This forces the letters in the string into lower-case, for example:
10267 .code
10268 ${lc:$local_part}
10269 .endd
10270
10271 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10272 .cindex "expansion" "string truncation"
10273 .cindex "&%length%& expansion item"
10274 The &%length%& operator is a simpler interface to the &%length%& function that
10275 can be used when the parameter is a fixed number (as opposed to a string that
10276 changes when expanded). The effect is the same as
10277 .code
10278 ${length{<number>}{<string>}}
10279 .endd
10280 See the description of the general &%length%& item above for details. Note that
10281 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10282 when &%length%& is used as an operator.
10283
10284
10285 .vitem &*${listcount:*&<&'string'&>&*}*&
10286 .cindex "expansion" "list item count"
10287 .cindex "list" "item count"
10288 .cindex "list" "count of items"
10289 .cindex "&%listcount%& expansion item"
10290 The string is interpreted as a list and the number of items is returned.
10291
10292
10293 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10294 .cindex "expansion" "named list"
10295 .cindex "&%listnamed%& expansion item"
10296 The name is interpreted as a named list and the content of the list is returned,
10297 expanding any referenced lists, re-quoting as needed for colon-separation.
10298 If the optional type is given it must be one of "a", "d", "h" or "l"
10299 and selects address-, domain-, host- or localpart- lists to search among respectively.
10300 Otherwise all types are searched in an undefined order and the first
10301 matching list is returned.
10302
10303
10304 .vitem &*${local_part:*&<&'string'&>&*}*&
10305 .cindex "expansion" "local part extraction"
10306 .cindex "&%local_part%& expansion item"
10307 The string is interpreted as an RFC 2822 address and the local part is
10308 extracted from it. If the string does not parse successfully, the result is
10309 empty.
10310
10311
10312 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10313 .cindex "masked IP address"
10314 .cindex "IP address" "masking"
10315 .cindex "CIDR notation"
10316 .cindex "expansion" "IP address masking"
10317 .cindex "&%mask%& expansion item"
10318 If the form of the string to be operated on is not an IP address followed by a
10319 slash and an integer (that is, a network address in CIDR notation), the
10320 expansion fails. Otherwise, this operator converts the IP address to binary,
10321 masks off the least significant bits according to the bit count, and converts
10322 the result back to text, with mask appended. For example,
10323 .code
10324 ${mask:10.111.131.206/28}
10325 .endd
10326 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10327 be mostly used for looking up masked addresses in files, the result for an IPv6
10328 address uses dots to separate components instead of colons, because colon
10329 terminates a key string in lsearch files. So, for example,
10330 .code
10331 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10332 .endd
10333 returns the string
10334 .code
10335 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10336 .endd
10337 Letters in IPv6 addresses are always output in lower case.
10338
10339
10340 .vitem &*${md5:*&<&'string'&>&*}*&
10341 .cindex "MD5 hash"
10342 .cindex "expansion" "MD5 hash"
10343 .cindex certificate fingerprint
10344 .cindex "&%md5%& expansion item"
10345 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10346 as a 32-digit hexadecimal number, in which any letters are in lower case.
10347
10348 If the string is a single variable of type certificate,
10349 returns the MD5 hash fingerprint of the certificate.
10350
10351
10352 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10353 .cindex "expansion" "numeric hash"
10354 .cindex "hash function" "numeric"
10355 The &%nhash%& operator is a simpler interface to the numeric hashing function
10356 that can be used when the two parameters are fixed numbers (as opposed to
10357 strings that change when expanded). The effect is the same as
10358 .code
10359 ${nhash{<n>}{<m>}{<string>}}
10360 .endd
10361 See the description of the general &%nhash%& item above for details.
10362
10363
10364 .vitem &*${quote:*&<&'string'&>&*}*&
10365 .cindex "quoting" "in string expansions"
10366 .cindex "expansion" "quoting"
10367 .cindex "&%quote%& expansion item"
10368 The &%quote%& operator puts its argument into double quotes if it
10369 is an empty string or
10370 contains anything other than letters, digits, underscores, dots, and hyphens.
10371 Any occurrences of double quotes and backslashes are escaped with a backslash.
10372 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10373 respectively For example,
10374 .code
10375 ${quote:ab"*"cd}
10376 .endd
10377 becomes
10378 .code
10379 "ab\"*\"cd"
10380 .endd
10381 The place where this is useful is when the argument is a substitution from a
10382 variable or a message header.
10383
10384 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10385 .cindex "&%quote_local_part%& expansion item"
10386 This operator is like &%quote%&, except that it quotes the string only if
10387 required to do so by the rules of RFC 2822 for quoting local parts. For
10388 example, a plus sign would not cause quoting (but it would for &%quote%&).
10389 If you are creating a new email address from the contents of &$local_part$&
10390 (or any other unknown data), you should always use this operator.
10391
10392
10393 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10394 .cindex "quoting" "lookup-specific"
10395 This operator applies lookup-specific quoting rules to the string. Each
10396 query-style lookup type has its own quoting rules which are described with
10397 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10398 .code
10399 ${quote_ldap:two * two}
10400 .endd
10401 returns
10402 .code
10403 two%20%5C2A%20two
10404 .endd
10405 For single-key lookup types, no quoting is ever necessary and this operator
10406 yields an unchanged string.
10407
10408
10409 .vitem &*${randint:*&<&'n'&>&*}*&
10410 .cindex "random number"
10411 This operator returns a somewhat random number which is less than the
10412 supplied number and is at least 0.  The quality of this randomness depends
10413 on how Exim was built; the values are not suitable for keying material.
10414 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10415 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10416 for versions of GnuTLS with that function.
10417 Otherwise, the implementation may be arc4random(), random() seeded by
10418 srandomdev() or srandom(), or a custom implementation even weaker than
10419 random().
10420
10421
10422 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10423 .cindex "expansion" "IP address"
10424 This operator reverses an IP address; for IPv4 addresses, the result is in
10425 dotted-quad decimal form, while for IPv6 addresses the result is in
10426 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10427 for DNS.  For example,
10428 .code
10429 ${reverse_ip:192.0.2.4}
10430 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10431 .endd
10432 returns
10433 .code
10434 4.2.0.192
10435 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
10436 .endd
10437
10438
10439 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10440 .cindex "expansion" "RFC 2047"
10441 .cindex "RFC 2047" "expansion operator"
10442 .cindex "&%rfc2047%& expansion item"
10443 This operator encodes text according to the rules of RFC 2047. This is an
10444 encoding that is used in header lines to encode non-ASCII characters. It is
10445 assumed that the input string is in the encoding specified by the
10446 &%headers_charset%& option, which gets its default at build time. If the string
10447 contains only characters in the range 33&--126, and no instances of the
10448 characters
10449 .code
10450 ? = ( ) < > @ , ; : \ " . [ ] _
10451 .endd
10452 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10453 string, using as many &"encoded words"& as necessary to encode all the
10454 characters.
10455
10456
10457 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10458 .cindex "expansion" "RFC 2047"
10459 .cindex "RFC 2047" "decoding"
10460 .cindex "&%rfc2047d%& expansion item"
10461 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10462 bytes are replaced by question marks. Characters are converted into the
10463 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10464 not recognized unless &%check_rfc2047_length%& is set false.
10465
10466 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10467 access a header line, RFC 2047 decoding is done automatically. You do not need
10468 to use this operator as well.
10469
10470
10471
10472 .vitem &*${rxquote:*&<&'string'&>&*}*&
10473 .cindex "quoting" "in regular expressions"
10474 .cindex "regular expressions" "quoting"
10475 .cindex "&%rxquote%& expansion item"
10476 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10477 characters in its argument. This is useful when substituting the values of
10478 variables or headers inside regular expressions.
10479
10480
10481 .vitem &*${sha1:*&<&'string'&>&*}*&
10482 .cindex "SHA-1 hash"
10483 .cindex "expansion" "SHA-1 hashing"
10484 .cindex certificate fingerprint
10485 .cindex "&%sha2%& expansion item"
10486 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10487 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10488
10489 If the string is a single variable of type certificate,
10490 returns the SHA-1 hash fingerprint of the certificate.
10491
10492
10493 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10494 .cindex "SHA-256 hash"
10495 .cindex certificate fingerprint
10496 .cindex "expansion" "SHA-256 hashing"
10497 .cindex "&%sha256%& expansion item"
10498 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10499 certificate,
10500 and returns
10501 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10502 Only arguments which are a single variable of certificate type are supported.
10503
10504
10505 .vitem &*${stat:*&<&'string'&>&*}*&
10506 .cindex "expansion" "statting a file"
10507 .cindex "file" "extracting characteristics"
10508 .cindex "&%stat%& expansion item"
10509 The string, after expansion, must be a file path. A call to the &[stat()]&
10510 function is made for this path. If &[stat()]& fails, an error occurs and the
10511 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10512 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10513 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10514 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10515 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10516 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10517 can extract individual fields using the &%extract%& expansion item.
10518
10519 The use of the &%stat%& expansion in users' filter files can be locked out by
10520 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10521 systems for files larger than 2GB.
10522
10523 .vitem &*${str2b64:*&<&'string'&>&*}*&
10524 .cindex "&%str2b64%& expansion item"
10525 Now deprecated, a synonym for the &%base64%& expansion operator.
10526
10527
10528
10529 .vitem &*${strlen:*&<&'string'&>&*}*&
10530 .cindex "expansion" "string length"
10531 .cindex "string" "length in expansion"
10532 .cindex "&%strlen%& expansion item"
10533 The item is replace by the length of the expanded string, expressed as a
10534 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10535
10536
10537 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10538 .cindex "&%substr%& expansion item"
10539 .cindex "substring extraction"
10540 .cindex "expansion" "substring expansion"
10541 The &%substr%& operator is a simpler interface to the &%substr%& function that
10542 can be used when the two parameters are fixed numbers (as opposed to strings
10543 that change when expanded). The effect is the same as
10544 .code
10545 ${substr{<start>}{<length>}{<string>}}
10546 .endd
10547 See the description of the general &%substr%& item above for details. The
10548 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10549
10550 .vitem &*${time_eval:*&<&'string'&>&*}*&
10551 .cindex "&%time_eval%& expansion item"
10552 .cindex "time interval" "decoding"
10553 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10554 seconds.
10555
10556 .vitem &*${time_interval:*&<&'string'&>&*}*&
10557 .cindex "&%time_interval%& expansion item"
10558 .cindex "time interval" "formatting"
10559 The argument (after sub-expansion) must be a sequence of decimal digits that
10560 represents an interval of time as a number of seconds. It is converted into a
10561 number of larger units and output in Exim's normal time format, for example,
10562 &`1w3d4h2m6s`&.
10563
10564 .vitem &*${uc:*&<&'string'&>&*}*&
10565 .cindex "case forcing in strings"
10566 .cindex "string" "case forcing"
10567 .cindex "upper casing"
10568 .cindex "expansion" "case forcing"
10569 .cindex "&%uc%& expansion item"
10570 This forces the letters in the string into upper-case.
10571
10572 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10573 .cindex "correction of invalid utf-8 sequences in strings"
10574 .cindex "utf-8" "utf-8 sequences"
10575 .cindex "incorrect utf-8"
10576 .cindex "expansion" "utf-8 forcing"
10577 .cindex "&%utf8clean%& expansion item"
10578 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10579
10580 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10581        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10582        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10583        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10584 .cindex expansion UTF-8
10585 .cindex UTF-8 expansion
10586 .cindex EAI
10587 .cindex internationalisation
10588 .cindex "&%utf8_domain_to_alabel%& expansion item"
10589 .cindex "&%utf8_domain_from_alabel%& expansion item"
10590 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10591 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10592 These convert EAI mail name components between UTF-8 and a-label forms.
10593 For information on internationalisation support see &<<SECTi18nMTA>>&.
10594 .endlist
10595
10596
10597
10598
10599
10600
10601 .section "Expansion conditions" "SECTexpcond"
10602 .scindex IIDexpcond "expansion" "conditions"
10603 The following conditions are available for testing by the &%${if%& construct
10604 while expanding strings:
10605
10606 .vlist
10607 .vitem &*!*&<&'condition'&>
10608 .cindex "expansion" "negating a condition"
10609 .cindex "negation" "in expansion condition"
10610 Preceding any condition with an exclamation mark negates the result of the
10611 condition.
10612
10613 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10614 .cindex "numeric comparison"
10615 .cindex "expansion" "numeric comparison"
10616 There are a number of symbolic operators for doing numeric comparisons. They
10617 are:
10618 .display
10619 &`=   `&   equal
10620 &`==  `&   equal
10621 &`>   `&   greater
10622 &`>=  `&   greater or equal
10623 &`<   `&   less
10624 &`<=  `&   less or equal
10625 .endd
10626 For example:
10627 .code
10628 ${if >{$message_size}{10M} ...
10629 .endd
10630 Note that the general negation operator provides for inequality testing. The
10631 two strings must take the form of optionally signed decimal integers,
10632 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10633 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10634 As a special case, the numerical value of an empty string is taken as
10635 zero.
10636
10637 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10638 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10639 10M, not if 10M is larger than &$message_size$&.
10640
10641
10642 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10643         {*&<&'arg2'&>&*}...}*&
10644 .cindex "expansion" "calling an acl"
10645 .cindex "&%acl%&" "expansion condition"
10646 The name and zero to nine argument strings are first expanded separately.  The expanded
10647 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10648 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10649 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10650 and may use the variables; if another acl expansion is used the values
10651 are restored after it returns.  If the ACL sets
10652 a value using a "message =" modifier the variable $value becomes
10653 the result of the expansion, otherwise it is empty.
10654 If the ACL returns accept the condition is true; if deny, false.
10655 If the ACL returns defer the result is a forced-fail.
10656
10657 .vitem &*bool&~{*&<&'string'&>&*}*&
10658 .cindex "expansion" "boolean parsing"
10659 .cindex "&%bool%& expansion condition"
10660 This condition turns a string holding a true or false representation into
10661 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10662 (case-insensitively); also integer numbers map to true if non-zero,
10663 false if zero.
10664 An empty string is treated as false.
10665 Leading and trailing whitespace is ignored;
10666 thus a string consisting only of whitespace is false.
10667 All other string values will result in expansion failure.
10668
10669 When combined with ACL variables, this expansion condition will let you
10670 make decisions in one place and act on those decisions in another place.
10671 For example:
10672 .code
10673 ${if bool{$acl_m_privileged_sender} ...
10674 .endd
10675
10676
10677 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10678 .cindex "expansion" "boolean parsing"
10679 .cindex "&%bool_lax%& expansion condition"
10680 Like &%bool%&, this condition turns a string into a boolean state.  But
10681 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10682 loose definition that the Router &%condition%& option uses.  The empty string
10683 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10684 true.  Leading and trailing whitespace is ignored.
10685
10686 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10687
10688 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10689 .cindex "expansion" "encrypted comparison"
10690 .cindex "encrypted strings, comparing"
10691 .cindex "&%crypteq%& expansion condition"
10692 This condition is included in the Exim binary if it is built to support any
10693 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10694 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10695 included in the binary.
10696
10697 The &%crypteq%& condition has two arguments. The first is encrypted and
10698 compared against the second, which is already encrypted. The second string may
10699 be in the LDAP form for storing encrypted strings, which starts with the
10700 encryption type in curly brackets, followed by the data. If the second string
10701 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10702 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10703 Typically this will be a field from a password file. An example of an encrypted
10704 string in LDAP form is:
10705 .code
10706 {md5}CY9rzUYh03PK3k6DJie09g==
10707 .endd
10708 If such a string appears directly in an expansion, the curly brackets have to
10709 be quoted, because they are part of the expansion syntax. For example:
10710 .code
10711 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10712 .endd
10713 The following encryption types (whose names are matched case-independently) are
10714 supported:
10715
10716 .ilist
10717 .cindex "MD5 hash"
10718 .cindex "base64 encoding" "in encrypted password"
10719 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10720 printable characters to compare with the remainder of the second string. If the
10721 length of the comparison string is 24, Exim assumes that it is base64 encoded
10722 (as in the above example). If the length is 32, Exim assumes that it is a
10723 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10724 comparison fails.
10725
10726 .next
10727 .cindex "SHA-1 hash"
10728 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10729 printable characters to compare with the remainder of the second string. If the
10730 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10731 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10732 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10733
10734 .next
10735 .cindex "&[crypt()]&"
10736 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10737 only the first eight characters of the password. However, in modern operating
10738 systems this is no longer true, and in many cases the entire password is used,
10739 whatever its length.
10740
10741 .next
10742 .cindex "&[crypt16()]&"
10743 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10744 use up to 16 characters of the password in some operating systems. Again, in
10745 modern operating systems, more characters may be used.
10746 .endlist
10747 Exim has its own version of &[crypt16()]&, which is just a double call to
10748 &[crypt()]&. For operating systems that have their own version, setting
10749 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10750 operating system version instead of its own. This option is set by default in
10751 the OS-dependent &_Makefile_& for those operating systems that are known to
10752 support &[crypt16()]&.
10753
10754 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10755 it was not using the same algorithm as some operating systems' versions. It
10756 turns out that as well as &[crypt16()]& there is a function called
10757 &[bigcrypt()]& in some operating systems. This may or may not use the same
10758 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10759
10760 However, since there is now a move away from the traditional &[crypt()]&
10761 functions towards using SHA1 and other algorithms, tidying up this area of
10762 Exim is seen as very low priority.
10763
10764 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10765 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10766 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10767 default is &`{crypt}`&. Whatever the default, you can always use either
10768 function by specifying it explicitly in curly brackets.
10769
10770 .vitem &*def:*&<&'variable&~name'&>
10771 .cindex "expansion" "checking for empty variable"
10772 .cindex "&%def%& expansion condition"
10773 The &%def%& condition must be followed by the name of one of the expansion
10774 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10775 variable does not contain the empty string. For example:
10776 .code
10777 ${if def:sender_ident {from $sender_ident}}
10778 .endd
10779 Note that the variable name is given without a leading &%$%& character. If the
10780 variable does not exist, the expansion fails.
10781
10782 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10783         &~&*def:h_*&<&'header&~name'&>&*:*&"
10784 .cindex "expansion" "checking header line existence"
10785 This condition is true if a message is being processed and the named header
10786 exists in the message. For example,
10787 .code
10788 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10789 .endd
10790 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10791 the header name must be terminated by a colon if white space does not follow.
10792
10793 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10794        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10795 .cindex "string" "comparison"
10796 .cindex "expansion" "string comparison"
10797 .cindex "&%eq%& expansion condition"
10798 .cindex "&%eqi%& expansion condition"
10799 The two substrings are first expanded. The condition is true if the two
10800 resulting strings are identical. For &%eq%& the comparison includes the case of
10801 letters, whereas for &%eqi%& the comparison is case-independent.
10802
10803 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10804 .cindex "expansion" "file existence test"
10805 .cindex "file" "existence test"
10806 .cindex "&%exists%&, expansion condition"
10807 The substring is first expanded and then interpreted as an absolute path. The
10808 condition is true if the named file (or directory) exists. The existence test
10809 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10810 users' filter files may be locked out by the system administrator.
10811
10812 .vitem &*first_delivery*&
10813 .cindex "delivery" "first"
10814 .cindex "first delivery"
10815 .cindex "expansion" "first delivery test"
10816 .cindex "&%first_delivery%& expansion condition"
10817 This condition, which has no data, is true during a message's first delivery
10818 attempt. It is false during any subsequent delivery attempts.
10819
10820
10821 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10822        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10823 .cindex "list" "iterative conditions"
10824 .cindex "expansion" "&*forall*& condition"
10825 .cindex "expansion" "&*forany*& condition"
10826 .vindex "&$item$&"
10827 These conditions iterate over a list. The first argument is expanded to form
10828 the list. By default, the list separator is a colon, but it can be changed by
10829 the normal method. The second argument is interpreted as a condition that is to
10830 be applied to each item in the list in turn. During the interpretation of the
10831 condition, the current list item is placed in a variable called &$item$&.
10832 .ilist
10833 For &*forany*&, interpretation stops if the condition is true for any item, and
10834 the result of the whole condition is true. If the condition is false for all
10835 items in the list, the overall condition is false.
10836 .next
10837 For &*forall*&, interpretation stops if the condition is false for any item,
10838 and the result of the whole condition is false. If the condition is true for
10839 all items in the list, the overall condition is true.
10840 .endlist
10841 Note that negation of &*forany*& means that the condition must be false for all
10842 items for the overall condition to succeed, and negation of &*forall*& means
10843 that the condition must be false for at least one item. In this example, the
10844 list separator is changed to a comma:
10845 .code
10846 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10847 .endd
10848 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10849 being processed, to enable these expansion items to be nested.
10850
10851 To scan a named list, expand it with the &*listnamed*& operator.
10852
10853
10854 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10855        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10856 .cindex "string" "comparison"
10857 .cindex "expansion" "string comparison"
10858 .cindex "&%ge%& expansion condition"
10859 .cindex "&%gei%& expansion condition"
10860 The two substrings are first expanded. The condition is true if the first
10861 string is lexically greater than or equal to the second string. For &%ge%& the
10862 comparison includes the case of letters, whereas for &%gei%& the comparison is
10863 case-independent.
10864
10865 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10866        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10867 .cindex "string" "comparison"
10868 .cindex "expansion" "string comparison"
10869 .cindex "&%gt%& expansion condition"
10870 .cindex "&%gti%& expansion condition"
10871 The two substrings are first expanded. The condition is true if the first
10872 string is lexically greater than the second string. For &%gt%& the comparison
10873 includes the case of letters, whereas for &%gti%& the comparison is
10874 case-independent.
10875
10876 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10877        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10878 .cindex "string" "comparison"
10879 .cindex "list" "iterative conditions"
10880 Both strings are expanded; the second string is treated as a list of simple
10881 strings; if the first string is a member of the second, then the condition
10882 is true.
10883
10884 These are simpler to use versions of the more powerful &*forany*& condition.
10885 Examples, and the &*forany*& equivalents:
10886 .code
10887 ${if inlist{needle}{foo:needle:bar}}
10888   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10889 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10890   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10891 .endd
10892
10893 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10894        &*isip4&~{*&<&'string'&>&*}*& &&&
10895        &*isip6&~{*&<&'string'&>&*}*&
10896 .cindex "IP address" "testing string format"
10897 .cindex "string" "testing for IP address"
10898 .cindex "&%isip%& expansion condition"
10899 .cindex "&%isip4%& expansion condition"
10900 .cindex "&%isip6%& expansion condition"
10901 The substring is first expanded, and then tested to see if it has the form of
10902 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10903 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10904
10905 For an IPv4 address, the test is for four dot-separated components, each of
10906 which consists of from one to three digits. For an IPv6 address, up to eight
10907 colon-separated components are permitted, each containing from one to four
10908 hexadecimal digits. There may be fewer than eight components if an empty
10909 component (adjacent colons) is present. Only one empty component is permitted.
10910
10911 &*Note*&: The checks are just on the form of the address; actual numerical
10912 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10913 check. The main use of these tests is to distinguish between IP addresses and
10914 host names, or between IPv4 and IPv6 addresses. For example, you could use
10915 .code
10916 ${if isip4{$sender_host_address}...
10917 .endd
10918 to test which IP version an incoming SMTP connection is using.
10919
10920 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10921 .cindex "LDAP" "use for authentication"
10922 .cindex "expansion" "LDAP authentication test"
10923 .cindex "&%ldapauth%& expansion condition"
10924 This condition supports user authentication using LDAP. See section
10925 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10926 queries. For this use, the query must contain a user name and password. The
10927 query itself is not used, and can be empty. The condition is true if the
10928 password is not empty, and the user name and password are accepted by the LDAP
10929 server. An empty password is rejected without calling LDAP because LDAP binds
10930 with an empty password are considered anonymous regardless of the username, and
10931 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10932 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10933 this can be used.
10934
10935
10936 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10937        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10938 .cindex "string" "comparison"
10939 .cindex "expansion" "string comparison"
10940 .cindex "&%le%& expansion condition"
10941 .cindex "&%lei%& expansion condition"
10942 The two substrings are first expanded. The condition is true if the first
10943 string is lexically less than or equal to the second string. For &%le%& the
10944 comparison includes the case of letters, whereas for &%lei%& the comparison is
10945 case-independent.
10946
10947 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10948        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10949 .cindex "string" "comparison"
10950 .cindex "expansion" "string comparison"
10951 .cindex "&%lt%& expansion condition"
10952 .cindex "&%lti%& expansion condition"
10953 The two substrings are first expanded. The condition is true if the first
10954 string is lexically less than the second string. For &%lt%& the comparison
10955 includes the case of letters, whereas for &%lti%& the comparison is
10956 case-independent.
10957
10958
10959 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10960 .cindex "expansion" "regular expression comparison"
10961 .cindex "regular expressions" "match in expanded string"
10962 .cindex "&%match%& expansion condition"
10963 The two substrings are first expanded. The second is then treated as a regular
10964 expression and applied to the first. Because of the pre-expansion, if the
10965 regular expression contains dollar, or backslash characters, they must be
10966 escaped. Care must also be taken if the regular expression contains braces
10967 (curly brackets). A closing brace must be escaped so that it is not taken as a
10968 premature termination of <&'string2'&>. The easiest approach is to use the
10969 &`\N`& feature to disable expansion of the regular expression.
10970 For example,
10971 .code
10972 ${if match {$local_part}{\N^\d{3}\N} ...
10973 .endd
10974 If the whole expansion string is in double quotes, further escaping of
10975 backslashes is also required.
10976
10977 The condition is true if the regular expression match succeeds.
10978 The regular expression is not required to begin with a circumflex
10979 metacharacter, but if there is no circumflex, the expression is not anchored,
10980 and it may match anywhere in the subject, not just at the start. If you want
10981 the pattern to match at the end of the subject, you must include the &`$`&
10982 metacharacter at an appropriate point.
10983
10984 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10985 At the start of an &%if%& expansion the values of the numeric variable
10986 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10987 succeeds causes them to be reset to the substrings of that condition and they
10988 will have these values during the expansion of the success string. At the end
10989 of the &%if%& expansion, the previous values are restored. After testing a
10990 combination of conditions using &%or%&, the subsequent values of the numeric
10991 variables are those of the condition that succeeded.
10992
10993 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10994 .cindex "&%match_address%& expansion condition"
10995 See &*match_local_part*&.
10996
10997 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10998 .cindex "&%match_domain%& expansion condition"
10999 See &*match_local_part*&.
11000
11001 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11002 .cindex "&%match_ip%& expansion condition"
11003 This condition matches an IP address to a list of IP address patterns. It must
11004 be followed by two argument strings. The first (after expansion) must be an IP
11005 address or an empty string. The second (not expanded) is a restricted host
11006 list that can match only an IP address, not a host name. For example:
11007 .code
11008 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11009 .endd
11010 The specific types of host list item that are permitted in the list are:
11011
11012 .ilist
11013 An IP address, optionally with a CIDR mask.
11014 .next
11015 A single asterisk, which matches any IP address.
11016 .next
11017 An empty item, which matches only if the IP address is empty. This could be
11018 useful for testing for a locally submitted message or one from specific hosts
11019 in a single test such as
11020 . ==== As this is a nested list, any displays it contains must be indented
11021 . ==== as otherwise they are too far to the left. This comment applies to
11022 . ==== the use of xmlto plus fop. There's no problem when formatting with
11023 . ==== sdop, with or without the extra indent.
11024 .code
11025   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11026 .endd
11027 where the first item in the list is the empty string.
11028 .next
11029 The item @[] matches any of the local host's interface addresses.
11030 .next
11031 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11032 even if &`net-`& is not specified. There is never any attempt to turn the IP
11033 address into a host name. The most common type of linear search for
11034 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11035 masks. For example:
11036 .code
11037   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11038 .endd
11039 It is of course possible to use other kinds of lookup, and in such a case, you
11040 do need to specify the &`net-`& prefix if you want to specify a specific
11041 address mask, for example:
11042 .code
11043   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11044 .endd
11045 However, unless you are combining a &%match_ip%& condition with others, it is
11046 just as easy to use the fact that a lookup is itself a condition, and write:
11047 .code
11048   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11049 .endd
11050 .endlist ilist
11051
11052 Note that <&'string2'&> is not itself subject to string expansion, unless
11053 Exim was built with the EXPAND_LISTMATCH_RHS option.
11054
11055 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11056
11057 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11058 .cindex "domain list" "in expansion condition"
11059 .cindex "address list" "in expansion condition"
11060 .cindex "local part" "list, in expansion condition"
11061 .cindex "&%match_local_part%& expansion condition"
11062 This condition, together with &%match_address%& and &%match_domain%&, make it
11063 possible to test domain, address, and local part lists within expansions. Each
11064 condition requires two arguments: an item and a list to match. A trivial
11065 example is:
11066 .code
11067 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11068 .endd
11069 In each case, the second argument may contain any of the allowable items for a
11070 list of the appropriate type. Also, because the second argument (after
11071 expansion) is a standard form of list, it is possible to refer to a named list.
11072 Thus, you can use conditions like this:
11073 .code
11074 ${if match_domain{$domain}{+local_domains}{...
11075 .endd
11076 .cindex "&`+caseful`&"
11077 For address lists, the matching starts off caselessly, but the &`+caseful`&
11078 item can be used, as in all address lists, to cause subsequent items to
11079 have their local parts matched casefully. Domains are always matched
11080 caselessly.
11081
11082 Note that <&'string2'&> is not itself subject to string expansion, unless
11083 Exim was built with the EXPAND_LISTMATCH_RHS option.
11084
11085 &*Note*&: Host lists are &'not'& supported in this way. This is because
11086 hosts have two identities: a name and an IP address, and it is not clear
11087 how to specify cleanly how such a test would work. However, IP addresses can be
11088 matched using &%match_ip%&.
11089
11090 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11091 .cindex "PAM authentication"
11092 .cindex "AUTH" "with PAM"
11093 .cindex "Solaris" "PAM support"
11094 .cindex "expansion" "PAM authentication test"
11095 .cindex "&%pam%& expansion condition"
11096 &'Pluggable Authentication Modules'&
11097 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11098 available in the latest releases of Solaris and in some GNU/Linux
11099 distributions. The Exim support, which is intended for use in conjunction with
11100 the SMTP AUTH command, is available only if Exim is compiled with
11101 .code
11102 SUPPORT_PAM=yes
11103 .endd
11104 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11105 in some releases of GNU/Linux &%-ldl%& is also needed.
11106
11107 The argument string is first expanded, and the result must be a
11108 colon-separated list of strings. Leading and trailing white space is ignored.
11109 The PAM module is initialized with the service name &"exim"& and the user name
11110 taken from the first item in the colon-separated data string (<&'string1'&>).
11111 The remaining items in the data string are passed over in response to requests
11112 from the authentication function. In the simple case there will only be one
11113 request, for a password, so the data consists of just two strings.
11114
11115 There can be problems if any of the strings are permitted to contain colon
11116 characters. In the usual way, these have to be doubled to avoid being taken as
11117 separators. If the data is being inserted from a variable, the &%sg%& expansion
11118 item can be used to double any existing colons. For example, the configuration
11119 of a LOGIN authenticator might contain this setting:
11120 .code
11121 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11122 .endd
11123 For a PLAIN authenticator you could use:
11124 .code
11125 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11126 .endd
11127 In some operating systems, PAM authentication can be done only from a process
11128 running as root. Since Exim is running as the Exim user when receiving
11129 messages, this means that PAM cannot be used directly in those systems.
11130 A patched version of the &'pam_unix'& module that comes with the
11131 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11132 The patched module allows one special uid/gid combination, in addition to root,
11133 to authenticate. If you build the patched module to allow the Exim user and
11134 group, PAM can then be used from an Exim authenticator.
11135
11136
11137 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11138 .cindex "&'pwcheck'& daemon"
11139 .cindex "Cyrus"
11140 .cindex "expansion" "&'pwcheck'& authentication test"
11141 .cindex "&%pwcheck%& expansion condition"
11142 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11143 This is one way of making it possible for passwords to be checked by a process
11144 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11145 deprecated. Its replacement is &'saslauthd'& (see below).
11146
11147 The pwcheck support is not included in Exim by default. You need to specify
11148 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11149 building Exim. For example:
11150 .code
11151 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11152 .endd
11153 You do not need to install the full Cyrus software suite in order to use
11154 the pwcheck daemon. You can compile and install just the daemon alone
11155 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11156 access to the &_/var/pwcheck_& directory.
11157
11158 The &%pwcheck%& condition takes one argument, which must be the user name and
11159 password, separated by a colon. For example, in a LOGIN authenticator
11160 configuration, you might have this:
11161 .code
11162 server_condition = ${if pwcheck{$auth1:$auth2}}
11163 .endd
11164 Again, for a PLAIN authenticator configuration, this would be:
11165 .code
11166 server_condition = ${if pwcheck{$auth2:$auth3}}
11167 .endd
11168 .vitem &*queue_running*&
11169 .cindex "queue runner" "detecting when delivering from"
11170 .cindex "expansion" "queue runner test"
11171 .cindex "&%queue_running%& expansion condition"
11172 This condition, which has no data, is true during delivery attempts that are
11173 initiated by queue runner processes, and false otherwise.
11174
11175
11176 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11177 .cindex "Radius"
11178 .cindex "expansion" "Radius authentication"
11179 .cindex "&%radius%& expansion condition"
11180 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11181 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11182 the Radius client configuration file in order to build Exim with Radius
11183 support.
11184
11185 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11186 library, using the original API. If you are using release 0.4.0 or later of
11187 this library, you need to set
11188 .code
11189 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11190 .endd
11191 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11192 &%libradius%& library that comes with FreeBSD. To do this, set
11193 .code
11194 RADIUS_LIB_TYPE=RADLIB
11195 .endd
11196 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11197 You may also have to supply a suitable setting in EXTRALIBS so that the
11198 Radius library can be found when Exim is linked.
11199
11200 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11201 Radius client library, which calls the Radius server. The condition is true if
11202 the authentication is successful. For example:
11203 .code
11204 server_condition = ${if radius{<arguments>}}
11205 .endd
11206
11207
11208 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11209         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11210 .cindex "&'saslauthd'& daemon"
11211 .cindex "Cyrus"
11212 .cindex "expansion" "&'saslauthd'& authentication test"
11213 .cindex "&%saslauthd%& expansion condition"
11214 This condition supports user authentication using the Cyrus &'saslauthd'&
11215 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11216 Using this daemon is one way of making it possible for passwords to be checked
11217 by a process that is not running as root.
11218
11219 The saslauthd support is not included in Exim by default. You need to specify
11220 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11221 building Exim. For example:
11222 .code
11223 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11224 .endd
11225 You do not need to install the full Cyrus software suite in order to use
11226 the saslauthd daemon. You can compile and install just the daemon alone
11227 from the Cyrus SASL library.
11228
11229 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11230 two are mandatory. For example:
11231 .code
11232 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11233 .endd
11234 The service and the realm are optional (which is why the arguments are enclosed
11235 in their own set of braces). For details of the meaning of the service and
11236 realm, and how to run the daemon, consult the Cyrus documentation.
11237 .endlist vlist
11238
11239
11240
11241 .section "Combining expansion conditions" "SECID84"
11242 .cindex "expansion" "combining conditions"
11243 Several conditions can be tested at once by combining them using the &%and%&
11244 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11245 conditions on their own, and precede their lists of sub-conditions. Each
11246 sub-condition must be enclosed in braces within the overall braces that contain
11247 the list. No repetition of &%if%& is used.
11248
11249
11250 .vlist
11251 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11252 .cindex "&""or""& expansion condition"
11253 .cindex "expansion" "&""or""& of conditions"
11254 The sub-conditions are evaluated from left to right. The condition is true if
11255 any one of the sub-conditions is true.
11256 For example,
11257 .code
11258 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11259 .endd
11260 When a true sub-condition is found, the following ones are parsed but not
11261 evaluated. If there are several &"match"& sub-conditions the values of the
11262 numeric variables afterwards are taken from the first one that succeeds.
11263
11264 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11265 .cindex "&""and""& expansion condition"
11266 .cindex "expansion" "&""and""& of conditions"
11267 The sub-conditions are evaluated from left to right. The condition is true if
11268 all of the sub-conditions are true. If there are several &"match"&
11269 sub-conditions, the values of the numeric variables afterwards are taken from
11270 the last one. When a false sub-condition is found, the following ones are
11271 parsed but not evaluated.
11272 .endlist
11273 .ecindex IIDexpcond
11274
11275
11276
11277
11278 .section "Expansion variables" "SECTexpvar"
11279 .cindex "expansion" "variables, list of"
11280 This section contains an alphabetical list of all the expansion variables. Some
11281 of them are available only when Exim is compiled with specific options such as
11282 support for TLS or the content scanning extension.
11283
11284 .vlist
11285 .vitem "&$0$&, &$1$&, etc"
11286 .cindex "numerical variables (&$1$& &$2$& etc)"
11287 When a &%match%& expansion condition succeeds, these variables contain the
11288 captured substrings identified by the regular expression during subsequent
11289 processing of the success string of the containing &%if%& expansion item.
11290 In the expansion condition case
11291 they do not retain their values afterwards; in fact, their previous
11292 values are restored at the end of processing an &%if%& item. The numerical
11293 variables may also be set externally by some other matching process which
11294 precedes the expansion of the string. For example, the commands available in
11295 Exim filter files include an &%if%& command with its own regular expression
11296 matching condition.
11297
11298 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11299 Within an acl condition, expansion condition or expansion item
11300 any arguments are copied to these variables,
11301 any unused variables being made empty.
11302
11303 .vitem "&$acl_c...$&"
11304 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11305 can be given any name that starts with &$acl_c$& and is at least six characters
11306 long, but the sixth character must be either a digit or an underscore. For
11307 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11308 variables persist throughout the lifetime of an SMTP connection. They can be
11309 used to pass information between ACLs and between different invocations of the
11310 same ACL. When a message is received, the values of these variables are saved
11311 with the message, and can be accessed by filters, routers, and transports
11312 during subsequent delivery.
11313
11314 .vitem "&$acl_m...$&"
11315 These variables are like the &$acl_c...$& variables, except that their values
11316 are reset after a message has been received. Thus, if several messages are
11317 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11318 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11319 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11320 message is received, the values of these variables are saved with the message,
11321 and can be accessed by filters, routers, and transports during subsequent
11322 delivery.
11323
11324 .vitem &$acl_narg$&
11325 Within an acl condition, expansion condition or expansion item
11326 this variable has the number of arguments.
11327
11328 .vitem &$acl_verify_message$&
11329 .vindex "&$acl_verify_message$&"
11330 After an address verification has failed, this variable contains the failure
11331 message. It retains its value for use in subsequent modifiers. The message can
11332 be preserved by coding like this:
11333 .code
11334 warn !verify = sender
11335      set acl_m0 = $acl_verify_message
11336 .endd
11337 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11338 &%log_message%& modifiers, to include information about the verification
11339 failure.
11340
11341 .vitem &$address_data$&
11342 .vindex "&$address_data$&"
11343 This variable is set by means of the &%address_data%& option in routers. The
11344 value then remains with the address while it is processed by subsequent routers
11345 and eventually a transport. If the transport is handling multiple addresses,
11346 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11347 for more details. &*Note*&: The contents of &$address_data$& are visible in
11348 user filter files.
11349
11350 If &$address_data$& is set when the routers are called from an ACL to verify
11351 a recipient address, the final value is still in the variable for subsequent
11352 conditions and modifiers of the ACL statement. If routing the address caused it
11353 to be redirected to just one address, the child address is also routed as part
11354 of the verification, and in this case the final value of &$address_data$& is
11355 from the child's routing.
11356
11357 If &$address_data$& is set when the routers are called from an ACL to verify a
11358 sender address, the final value is also preserved, but this time in
11359 &$sender_address_data$&, to distinguish it from data from a recipient
11360 address.
11361
11362 In both cases (recipient and sender verification), the value does not persist
11363 after the end of the current ACL statement. If you want to preserve
11364 these values for longer, you can save them in ACL variables.
11365
11366 .vitem &$address_file$&
11367 .vindex "&$address_file$&"
11368 When, as a result of aliasing, forwarding, or filtering, a message is directed
11369 to a specific file, this variable holds the name of the file when the transport
11370 is running. At other times, the variable is empty. For example, using the
11371 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11372 .code
11373 /home/r2d2/savemail
11374 .endd
11375 then when the &(address_file)& transport is running, &$address_file$&
11376 contains the text string &`/home/r2d2/savemail`&.
11377 .cindex "Sieve filter" "value of &$address_file$&"
11378 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11379 then up to the transport configuration to generate an appropriate absolute path
11380 to the relevant file.
11381
11382 .vitem &$address_pipe$&
11383 .vindex "&$address_pipe$&"
11384 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11385 this variable holds the pipe command when the transport is running.
11386
11387 .vitem "&$auth1$& &-- &$auth3$&"
11388 .vindex "&$auth1$&, &$auth2$&, etc"
11389 These variables are used in SMTP authenticators (see chapters
11390 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11391
11392 .vitem &$authenticated_id$&
11393 .cindex "authentication" "id"
11394 .vindex "&$authenticated_id$&"
11395 When a server successfully authenticates a client it may be configured to
11396 preserve some of the authentication information in the variable
11397 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11398 user/password authenticator configuration might preserve the user name for use
11399 in the routers. Note that this is not the same information that is saved in
11400 &$sender_host_authenticated$&.
11401 When a message is submitted locally (that is, not over a TCP connection)
11402 the value of &$authenticated_id$& is normally the login name of the calling
11403 process. However, a trusted user can override this by means of the &%-oMai%&
11404 command line option.
11405
11406 .vitem &$authenticated_fail_id$&
11407 .cindex "authentication" "fail" "id"
11408 .vindex "&$authenticated_fail_id$&"
11409 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11410 will contain the failed authentication id. If more than one authentication
11411 id is attempted, it will contain only the last one. The variable is
11412 available for processing in the ACL's, generally the quit or notquit ACL.
11413 A message to a local recipient could still be accepted without requiring
11414 authentication, which means this variable could also be visible in all of
11415 the ACL's as well.
11416
11417
11418 .vitem &$authenticated_sender$&
11419 .cindex "sender" "authenticated"
11420 .cindex "authentication" "sender"
11421 .cindex "AUTH" "on MAIL command"
11422 .vindex "&$authenticated_sender$&"
11423 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11424 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11425 described in section &<<SECTauthparamail>>&. Unless the data is the string
11426 &"<>"&, it is set as the authenticated sender of the message, and the value is
11427 available during delivery in the &$authenticated_sender$& variable. If the
11428 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11429
11430 .vindex "&$qualify_domain$&"
11431 When a message is submitted locally (that is, not over a TCP connection), the
11432 value of &$authenticated_sender$& is an address constructed from the login
11433 name of the calling process and &$qualify_domain$&, except that a trusted user
11434 can override this by means of the &%-oMas%& command line option.
11435
11436
11437 .vitem &$authentication_failed$&
11438 .cindex "authentication" "failure"
11439 .vindex "&$authentication_failed$&"
11440 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11441 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11442 possible to distinguish between &"did not try to authenticate"&
11443 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11444 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11445 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11446 negative response to an AUTH command, including (for example) an attempt to use
11447 an undefined mechanism.
11448
11449 .vitem &$av_failed$&
11450 .cindex "content scanning" "AV scanner failure"
11451 This variable is available when Exim is compiled with the content-scanning
11452 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11453 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11454 the ACL malware condition.
11455
11456 .vitem &$body_linecount$&
11457 .cindex "message body" "line count"
11458 .cindex "body of message" "line count"
11459 .vindex "&$body_linecount$&"
11460 When a message is being received or delivered, this variable contains the
11461 number of lines in the message's body. See also &$message_linecount$&.
11462
11463 .vitem &$body_zerocount$&
11464 .cindex "message body" "binary zero count"
11465 .cindex "body of message" "binary zero count"
11466 .cindex "binary zero" "in message body"
11467 .vindex "&$body_zerocount$&"
11468 When a message is being received or delivered, this variable contains the
11469 number of binary zero bytes (ASCII NULs) in the message's body.
11470
11471 .vitem &$bounce_recipient$&
11472 .vindex "&$bounce_recipient$&"
11473 This is set to the recipient address of a bounce message while Exim is creating
11474 it. It is useful if a customized bounce message text file is in use (see
11475 chapter &<<CHAPemsgcust>>&).
11476
11477 .vitem &$bounce_return_size_limit$&
11478 .vindex "&$bounce_return_size_limit$&"
11479 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11480 up to a multiple of 1000. It is useful when a customized error message text
11481 file is in use (see chapter &<<CHAPemsgcust>>&).
11482
11483 .vitem &$caller_gid$&
11484 .cindex "gid (group id)" "caller"
11485 .vindex "&$caller_gid$&"
11486 The real group id under which the process that called Exim was running. This is
11487 not the same as the group id of the originator of a message (see
11488 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11489 incarnation normally contains the Exim gid.
11490
11491 .vitem &$caller_uid$&
11492 .cindex "uid (user id)" "caller"
11493 .vindex "&$caller_uid$&"
11494 The real user id under which the process that called Exim was running. This is
11495 not the same as the user id of the originator of a message (see
11496 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11497 incarnation normally contains the Exim uid.
11498
11499 .vitem &$callout_address$&
11500 .vindex "&$callout_address$&"
11501 After a callout for verification, spamd or malware daemon service, the
11502 address that was connected to.
11503
11504 .vitem &$compile_number$&
11505 .vindex "&$compile_number$&"
11506 The building process for Exim keeps a count of the number
11507 of times it has been compiled. This serves to distinguish different
11508 compilations of the same version of the program.
11509
11510 .vitem &$config_dir$&
11511 .vindex "&$config_dir$&"
11512 The directory name of the main configuration file. That is, the content of
11513 &$config_file$& with the last component stripped. The value does not
11514 contain the trailing slash. If &$config_file$& does not contain a slash,
11515 &$config_dir$& is ".".
11516
11517 .vitem &$config_file$&
11518 .vindex "&$config_file$&"
11519 The name of the main configuration file Exim is using.
11520
11521 .vitem &$dkim_cur_signer$& &&&
11522        &$dkim_verify_status$& &&&
11523        &$dkim_verify_reason$& &&&
11524        &$dkim_domain$& &&&
11525        &$dkim_identity$& &&&
11526        &$dkim_selector$& &&&
11527        &$dkim_algo$& &&&
11528        &$dkim_canon_body$& &&&
11529        &$dkim_canon_headers$& &&&
11530        &$dkim_copiedheaders$& &&&
11531        &$dkim_bodylength$& &&&
11532        &$dkim_created$& &&&
11533        &$dkim_expires$& &&&
11534        &$dkim_headernames$& &&&
11535        &$dkim_key_testing$& &&&
11536        &$dkim_key_nosubdomains$& &&&
11537        &$dkim_key_srvtype$& &&&
11538        &$dkim_key_granularity$& &&&
11539        &$dkim_key_notes$& &&&
11540        &$dkim_key_length$&
11541 These variables are only available within the DKIM ACL.
11542 For details see chapter &<<CHAPdkim>>&.
11543
11544 .vitem &$dkim_signers$&
11545 .vindex &$dkim_signers$&
11546 When a message has been received this variable contains
11547 a colon-separated list of signer domains and identities for the message.
11548 For details see chapter &<<CHAPdkim>>&.
11549
11550 .vitem &$dnslist_domain$& &&&
11551        &$dnslist_matched$& &&&
11552        &$dnslist_text$& &&&
11553        &$dnslist_value$&
11554 .vindex "&$dnslist_domain$&"
11555 .vindex "&$dnslist_matched$&"
11556 .vindex "&$dnslist_text$&"
11557 .vindex "&$dnslist_value$&"
11558 .cindex "black list (DNS)"
11559 When a DNS (black) list lookup succeeds, these variables are set to contain
11560 the following data from the lookup: the list's domain name, the key that was
11561 looked up, the contents of any associated TXT record, and the value from the
11562 main A record. See section &<<SECID204>>& for more details.
11563
11564 .vitem &$domain$&
11565 .vindex "&$domain$&"
11566 When an address is being routed, or delivered on its own, this variable
11567 contains the domain. Uppercase letters in the domain are converted into lower
11568 case for &$domain$&.
11569
11570 Global address rewriting happens when a message is received, so the value of
11571 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11572 is set during user filtering, but not during system filtering, because a
11573 message may have many recipients and the system filter is called just once.
11574
11575 When more than one address is being delivered at once (for example, several
11576 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11577 have the same domain. Transports can be restricted to handling only one domain
11578 at a time if the value of &$domain$& is required at transport time &-- this is
11579 the default for local transports. For further details of the environment in
11580 which local transports are run, see chapter &<<CHAPenvironment>>&.
11581
11582 .oindex "&%delay_warning_condition%&"
11583 At the end of a delivery, if all deferred addresses have the same domain, it is
11584 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11585
11586 The &$domain$& variable is also used in some other circumstances:
11587
11588 .ilist
11589 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11590 the recipient address. The domain of the &'sender'& address is in
11591 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11592 normally set during the running of the MAIL ACL. However, if the sender address
11593 is verified with a callout during the MAIL ACL, the sender domain is placed in
11594 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11595 the &(smtp)& transport.
11596
11597 .next
11598 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11599 &$domain$& contains the domain portion of the address that is being rewritten;
11600 it can be used in the expansion of the replacement address, for example, to
11601 rewrite domains by file lookup.
11602
11603 .next
11604 With one important exception, whenever a domain list is being scanned,
11605 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11606 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11607 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11608 that, in a RCPT ACL, the sender domain list can be dependent on the
11609 recipient domain (which is what is in &$domain$& at this time).
11610
11611 .next
11612 .cindex "ETRN" "value of &$domain$&"
11613 .oindex "&%smtp_etrn_command%&"
11614 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11615 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11616 .endlist
11617
11618
11619 .vitem &$domain_data$&
11620 .vindex "&$domain_data$&"
11621 When the &%domains%& option on a router matches a domain by
11622 means of a lookup, the data read by the lookup is available during the running
11623 of the router as &$domain_data$&. In addition, if the driver routes the
11624 address to a transport, the value is available in that transport. If the
11625 transport is handling multiple addresses, the value from the first address is
11626 used.
11627
11628 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11629 domain by means of a lookup. The data read by the lookup is available during
11630 the rest of the ACL statement. In all other situations, this variable expands
11631 to nothing.
11632
11633 .vitem &$exim_gid$&
11634 .vindex "&$exim_gid$&"
11635 This variable contains the numerical value of the Exim group id.
11636
11637 .vitem &$exim_path$&
11638 .vindex "&$exim_path$&"
11639 This variable contains the path to the Exim binary.
11640
11641 .vitem &$exim_uid$&
11642 .vindex "&$exim_uid$&"
11643 This variable contains the numerical value of the Exim user id.
11644
11645 .vitem &$exim_version$&
11646 .vindex "&$exim_version$&"
11647 This variable contains the version string of the Exim build.
11648 The first character is a major version number, currently 4.
11649 Then after a dot, the next group of digits is a minor version number.
11650 There may be other characters following the minor version.
11651
11652 .vitem &$header_$&<&'name'&>
11653 This is not strictly an expansion variable. It is expansion syntax for
11654 inserting the message header line with the given name. Note that the name must
11655 be terminated by colon or white space, because it may contain a wide variety of
11656 characters. Note also that braces must &'not'& be used.
11657
11658 .vitem &$headers_added$&
11659 .vindex "&$headers_added$&"
11660 Within an ACL this variable contains the headers added so far by
11661 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11662 The headers are a newline-separated list.
11663
11664 .vitem &$home$&
11665 .vindex "&$home$&"
11666 When the &%check_local_user%& option is set for a router, the user's home
11667 directory is placed in &$home$& when the check succeeds. In particular, this
11668 means it is set during the running of users' filter files. A router may also
11669 explicitly set a home directory for use by a transport; this can be overridden
11670 by a setting on the transport itself.
11671
11672 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11673 of the environment variable HOME, which is subject to the
11674 &%keep_environment%& and &%add_environment%& main config options.
11675
11676 .vitem &$host$&
11677 .vindex "&$host$&"
11678 If a router assigns an address to a transport (any transport), and passes a
11679 list of hosts with the address, the value of &$host$& when the transport starts
11680 to run is the name of the first host on the list. Note that this applies both
11681 to local and remote transports.
11682
11683 .cindex "transport" "filter"
11684 .cindex "filter" "transport filter"
11685 For the &(smtp)& transport, if there is more than one host, the value of
11686 &$host$& changes as the transport works its way through the list. In
11687 particular, when the &(smtp)& transport is expanding its options for encryption
11688 using TLS, or for specifying a transport filter (see chapter
11689 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11690 is connected.
11691
11692 When used in the client part of an authenticator configuration (see chapter
11693 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11694 client is connected.
11695
11696
11697 .vitem &$host_address$&
11698 .vindex "&$host_address$&"
11699 This variable is set to the remote host's IP address whenever &$host$& is set
11700 for a remote connection. It is also set to the IP address that is being checked
11701 when the &%ignore_target_hosts%& option is being processed.
11702
11703 .vitem &$host_data$&
11704 .vindex "&$host_data$&"
11705 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11706 result of the lookup is made available in the &$host_data$& variable. This
11707 allows you, for example, to do things like this:
11708 .code
11709 deny  hosts = net-lsearch;/some/file
11710 message = $host_data
11711 .endd
11712 .vitem &$host_lookup_deferred$&
11713 .cindex "host name" "lookup, failure of"
11714 .vindex "&$host_lookup_deferred$&"
11715 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11716 message comes from a remote host and there is an attempt to look up the host's
11717 name from its IP address, and the attempt is not successful, one of these
11718 variables is set to &"1"&.
11719
11720 .ilist
11721 If the lookup receives a definite negative response (for example, a DNS lookup
11722 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11723
11724 .next
11725 If there is any kind of problem during the lookup, such that Exim cannot
11726 tell whether or not the host name is defined (for example, a timeout for a DNS
11727 lookup), &$host_lookup_deferred$& is set to &"1"&.
11728 .endlist ilist
11729
11730 Looking up a host's name from its IP address consists of more than just a
11731 single reverse lookup. Exim checks that a forward lookup of at least one of the
11732 names it receives from a reverse lookup yields the original IP address. If this
11733 is not the case, Exim does not accept the looked up name(s), and
11734 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11735 IP address (for example, the existence of a PTR record in the DNS) is not
11736 sufficient on its own for the success of a host name lookup. If the reverse
11737 lookup succeeds, but there is a lookup problem such as a timeout when checking
11738 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11739 &"1"&. See also &$sender_host_name$&.
11740
11741 .vitem &$host_lookup_failed$&
11742 .vindex "&$host_lookup_failed$&"
11743 See &$host_lookup_deferred$&.
11744
11745 .vitem &$host_port$&
11746 .vindex "&$host_port$&"
11747 This variable is set to the remote host's TCP port whenever &$host$& is set
11748 for an outbound connection.
11749
11750 .vitem &$initial_cwd$&
11751 .vindex "&$initial_cwd$&
11752 This variable contains the full path name of the initial working
11753 directory of the current Exim process. This may differ from the current
11754 working directory, as Exim changes this to "/" during early startup, and
11755 to &$spool_directory$& later.
11756
11757 .vitem &$inode$&
11758 .vindex "&$inode$&"
11759 The only time this variable is set is while expanding the &%directory_file%&
11760 option in the &(appendfile)& transport. The variable contains the inode number
11761 of the temporary file which is about to be renamed. It can be used to construct
11762 a unique name for the file.
11763
11764 .vitem &$interface_address$&
11765 .vindex "&$interface_address$&"
11766 This is an obsolete name for &$received_ip_address$&.
11767
11768 .vitem &$interface_port$&
11769 .vindex "&$interface_port$&"
11770 This is an obsolete name for &$received_port$&.
11771
11772 .vitem &$item$&
11773 .vindex "&$item$&"
11774 This variable is used during the expansion of &*forall*& and &*forany*&
11775 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11776 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11777 empty.
11778
11779 .vitem &$ldap_dn$&
11780 .vindex "&$ldap_dn$&"
11781 This variable, which is available only when Exim is compiled with LDAP support,
11782 contains the DN from the last entry in the most recently successful LDAP
11783 lookup.
11784
11785 .vitem &$load_average$&
11786 .vindex "&$load_average$&"
11787 This variable contains the system load average, multiplied by 1000 so that it
11788 is an integer. For example, if the load average is 0.21, the value of the
11789 variable is 210. The value is recomputed every time the variable is referenced.
11790
11791 .vitem &$local_part$&
11792 .vindex "&$local_part$&"
11793 When an address is being routed, or delivered on its own, this
11794 variable contains the local part. When a number of addresses are being
11795 delivered together (for example, multiple RCPT commands in an SMTP
11796 session), &$local_part$& is not set.
11797
11798 Global address rewriting happens when a message is received, so the value of
11799 &$local_part$& during routing and delivery is the value after rewriting.
11800 &$local_part$& is set during user filtering, but not during system filtering,
11801 because a message may have many recipients and the system filter is called just
11802 once.
11803
11804 .vindex "&$local_part_prefix$&"
11805 .vindex "&$local_part_suffix$&"
11806 If a local part prefix or suffix has been recognized, it is not included in the
11807 value of &$local_part$& during routing and subsequent delivery. The values of
11808 any prefix or suffix are in &$local_part_prefix$& and
11809 &$local_part_suffix$&, respectively.
11810
11811 When a message is being delivered to a file, pipe, or autoreply transport as a
11812 result of aliasing or forwarding, &$local_part$& is set to the local part of
11813 the parent address, not to the file name or command (see &$address_file$& and
11814 &$address_pipe$&).
11815
11816 When an ACL is running for a RCPT command, &$local_part$& contains the
11817 local part of the recipient address.
11818
11819 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11820 &$local_part$& contains the local part of the address that is being rewritten;
11821 it can be used in the expansion of the replacement address, for example.
11822
11823 In all cases, all quoting is removed from the local part. For example, for both
11824 the addresses
11825 .code
11826 "abc:xyz"@test.example
11827 abc\:xyz@test.example
11828 .endd
11829 the value of &$local_part$& is
11830 .code
11831 abc:xyz
11832 .endd
11833 If you use &$local_part$& to create another address, you should always wrap it
11834 inside a quoting operator. For example, in a &(redirect)& router you could
11835 have:
11836 .code
11837 data = ${quote_local_part:$local_part}@new.domain.example
11838 .endd
11839 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11840 to process local parts in a case-dependent manner in a router, you can set the
11841 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11842
11843 .vitem &$local_part_data$&
11844 .vindex "&$local_part_data$&"
11845 When the &%local_parts%& option on a router matches a local part by means of a
11846 lookup, the data read by the lookup is available during the running of the
11847 router as &$local_part_data$&. In addition, if the driver routes the address
11848 to a transport, the value is available in that transport. If the transport is
11849 handling multiple addresses, the value from the first address is used.
11850
11851 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11852 matches a local part by means of a lookup. The data read by the lookup is
11853 available during the rest of the ACL statement. In all other situations, this
11854 variable expands to nothing.
11855
11856 .vitem &$local_part_prefix$&
11857 .vindex "&$local_part_prefix$&"
11858 When an address is being routed or delivered, and a
11859 specific prefix for the local part was recognized, it is available in this
11860 variable, having been removed from &$local_part$&.
11861
11862 .vitem &$local_part_suffix$&
11863 .vindex "&$local_part_suffix$&"
11864 When an address is being routed or delivered, and a
11865 specific suffix for the local part was recognized, it is available in this
11866 variable, having been removed from &$local_part$&.
11867
11868 .vitem &$local_scan_data$&
11869 .vindex "&$local_scan_data$&"
11870 This variable contains the text returned by the &[local_scan()]& function when
11871 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11872
11873 .vitem &$local_user_gid$&
11874 .vindex "&$local_user_gid$&"
11875 See &$local_user_uid$&.
11876
11877 .vitem &$local_user_uid$&
11878 .vindex "&$local_user_uid$&"
11879 This variable and &$local_user_gid$& are set to the uid and gid after the
11880 &%check_local_user%& router precondition succeeds. This means that their values
11881 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11882 and &%condition%&), for the &%address_data%& expansion, and for any
11883 router-specific expansions. At all other times, the values in these variables
11884 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11885
11886 .vitem &$localhost_number$&
11887 .vindex "&$localhost_number$&"
11888 This contains the expanded value of the
11889 &%localhost_number%& option. The expansion happens after the main options have
11890 been read.
11891
11892 .vitem &$log_inodes$&
11893 .vindex "&$log_inodes$&"
11894 The number of free inodes in the disk partition where Exim's
11895 log files are being written. The value is recalculated whenever the variable is
11896 referenced. If the relevant file system does not have the concept of inodes,
11897 the value of is -1. See also the &%check_log_inodes%& option.
11898
11899 .vitem &$log_space$&
11900 .vindex "&$log_space$&"
11901 The amount of free space (as a number of kilobytes) in the disk
11902 partition where Exim's log files are being written. The value is recalculated
11903 whenever the variable is referenced. If the operating system does not have the
11904 ability to find the amount of free space (only true for experimental systems),
11905 the space value is -1. See also the &%check_log_space%& option.
11906
11907
11908 .vitem &$lookup_dnssec_authenticated$&
11909 .vindex "&$lookup_dnssec_authenticated$&"
11910 This variable is set after a DNS lookup done by
11911 a dnsdb lookup expansion, dnslookup router or smtp transport.
11912 .cindex "DNS" "DNSSEC"
11913 It will be empty if &(DNSSEC)& was not requested,
11914 &"no"& if the result was not labelled as authenticated data
11915 and &"yes"& if it was.
11916 Results that are labelled as authoritative answer that match
11917 the &%dns_trust_aa%& configuration variable count also
11918 as authenticated data.
11919
11920 .vitem &$mailstore_basename$&
11921 .vindex "&$mailstore_basename$&"
11922 This variable is set only when doing deliveries in &"mailstore"& format in the
11923 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11924 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11925 contains the basename of the files that are being written, that is, the name
11926 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11927 variable is empty.
11928
11929 .vitem &$malware_name$&
11930 .vindex "&$malware_name$&"
11931 This variable is available when Exim is compiled with the
11932 content-scanning extension. It is set to the name of the virus that was found
11933 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11934
11935 .vitem &$max_received_linelength$&
11936 .vindex "&$max_received_linelength$&"
11937 .cindex "maximum" "line length"
11938 .cindex "line length" "maximum"
11939 This variable contains the number of bytes in the longest line that was
11940 received as part of the message, not counting the line termination
11941 character(s).
11942
11943 .vitem &$message_age$&
11944 .cindex "message" "age of"
11945 .vindex "&$message_age$&"
11946 This variable is set at the start of a delivery attempt to contain the number
11947 of seconds since the message was received. It does not change during a single
11948 delivery attempt.
11949
11950 .vitem &$message_body$&
11951 .cindex "body of message" "expansion variable"
11952 .cindex "message body" "in expansion"
11953 .cindex "binary zero" "in message body"
11954 .vindex "&$message_body$&"
11955 .oindex "&%message_body_visible%&"
11956 This variable contains the initial portion of a message's body while it is
11957 being delivered, and is intended mainly for use in filter files. The maximum
11958 number of characters of the body that are put into the variable is set by the
11959 &%message_body_visible%& configuration option; the default is 500.
11960
11961 .oindex "&%message_body_newlines%&"
11962 By default, newlines are converted into spaces in &$message_body$&, to make it
11963 easier to search for phrases that might be split over a line break. However,
11964 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11965 zeros are always converted into spaces.
11966
11967 .vitem &$message_body_end$&
11968 .cindex "body of message" "expansion variable"
11969 .cindex "message body" "in expansion"
11970 .vindex "&$message_body_end$&"
11971 This variable contains the final portion of a message's
11972 body while it is being delivered. The format and maximum size are as for
11973 &$message_body$&.
11974
11975 .vitem &$message_body_size$&
11976 .cindex "body of message" "size"
11977 .cindex "message body" "size"
11978 .vindex "&$message_body_size$&"
11979 When a message is being delivered, this variable contains the size of the body
11980 in bytes. The count starts from the character after the blank line that
11981 separates the body from the header. Newlines are included in the count. See
11982 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11983
11984 .vitem &$message_exim_id$&
11985 .vindex "&$message_exim_id$&"
11986 When a message is being received or delivered, this variable contains the
11987 unique message id that is generated and used by Exim to identify the message.
11988 An id is not created for a message until after its header has been successfully
11989 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11990 line; it is the local id that Exim assigns to the message, for example:
11991 &`1BXTIK-0001yO-VA`&.
11992
11993 .vitem &$message_headers$&
11994 .vindex &$message_headers$&
11995 This variable contains a concatenation of all the header lines when a message
11996 is being processed, except for lines added by routers or transports. The header
11997 lines are separated by newline characters. Their contents are decoded in the
11998 same way as a header line that is inserted by &%bheader%&.
11999
12000 .vitem &$message_headers_raw$&
12001 .vindex &$message_headers_raw$&
12002 This variable is like &$message_headers$& except that no processing of the
12003 contents of header lines is done.
12004
12005 .vitem &$message_id$&
12006 This is an old name for &$message_exim_id$&. It is now deprecated.
12007
12008 .vitem &$message_linecount$&
12009 .vindex "&$message_linecount$&"
12010 This variable contains the total number of lines in the header and body of the
12011 message. Compare &$body_linecount$&, which is the count for the body only.
12012 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12013 number of lines received. Before delivery happens (that is, before filters,
12014 routers, and transports run) the count is increased to include the
12015 &'Received:'& header line that Exim standardly adds, and also any other header
12016 lines that are added by ACLs. The blank line that separates the message header
12017 from the body is not counted.
12018
12019 As with the special case of &$message_size$&, during the expansion of the
12020 appendfile transport's maildir_tag option in maildir format, the value of
12021 &$message_linecount$& is the precise size of the number of newlines in the
12022 file that has been written (minus one for the blank line between the
12023 header and the body).
12024
12025 Here is an example of the use of this variable in a DATA ACL:
12026 .code
12027 deny message   = Too many lines in message header
12028      condition = \
12029       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12030 .endd
12031 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12032 message has not yet been received.
12033
12034 .vitem &$message_size$&
12035 .cindex "size" "of message"
12036 .cindex "message" "size"
12037 .vindex "&$message_size$&"
12038 When a message is being processed, this variable contains its size in bytes. In
12039 most cases, the size includes those headers that were received with the
12040 message, but not those (such as &'Envelope-to:'&) that are added to individual
12041 deliveries as they are written. However, there is one special case: during the
12042 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12043 doing a delivery in maildir format, the value of &$message_size$& is the
12044 precise size of the file that has been written. See also
12045 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12046
12047 .cindex "RCPT" "value of &$message_size$&"
12048 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12049 contains the size supplied on the MAIL command, or -1 if no size was given. The
12050 value may not, of course, be truthful.
12051
12052 .vitem &$mime_$&&'xxx'&
12053 A number of variables whose names start with &$mime$& are
12054 available when Exim is compiled with the content-scanning extension. For
12055 details, see section &<<SECTscanmimepart>>&.
12056
12057 .vitem "&$n0$& &-- &$n9$&"
12058 These variables are counters that can be incremented by means
12059 of the &%add%& command in filter files.
12060
12061 .vitem &$original_domain$&
12062 .vindex "&$domain$&"
12063 .vindex "&$original_domain$&"
12064 When a top-level address is being processed for delivery, this contains the
12065 same value as &$domain$&. However, if a &"child"& address (for example,
12066 generated by an alias, forward, or filter file) is being processed, this
12067 variable contains the domain of the original address (lower cased). This
12068 differs from &$parent_domain$& only when there is more than one level of
12069 aliasing or forwarding. When more than one address is being delivered in a
12070 single transport run, &$original_domain$& is not set.
12071
12072 If a new address is created by means of a &%deliver%& command in a system
12073 filter, it is set up with an artificial &"parent"& address. This has the local
12074 part &'system-filter'& and the default qualify domain.
12075
12076 .vitem &$original_local_part$&
12077 .vindex "&$local_part$&"
12078 .vindex "&$original_local_part$&"
12079 When a top-level address is being processed for delivery, this contains the
12080 same value as &$local_part$&, unless a prefix or suffix was removed from the
12081 local part, because &$original_local_part$& always contains the full local
12082 part. When a &"child"& address (for example, generated by an alias, forward, or
12083 filter file) is being processed, this variable contains the full local part of
12084 the original address.
12085
12086 If the router that did the redirection processed the local part
12087 case-insensitively, the value in &$original_local_part$& is in lower case.
12088 This variable differs from &$parent_local_part$& only when there is more than
12089 one level of aliasing or forwarding. When more than one address is being
12090 delivered in a single transport run, &$original_local_part$& is not set.
12091
12092 If a new address is created by means of a &%deliver%& command in a system
12093 filter, it is set up with an artificial &"parent"& address. This has the local
12094 part &'system-filter'& and the default qualify domain.
12095
12096 .vitem &$originator_gid$&
12097 .cindex "gid (group id)" "of originating user"
12098 .cindex "sender" "gid"
12099 .vindex "&$caller_gid$&"
12100 .vindex "&$originator_gid$&"
12101 This variable contains the value of &$caller_gid$& that was set when the
12102 message was received. For messages received via the command line, this is the
12103 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12104 normally the gid of the Exim user.
12105
12106 .vitem &$originator_uid$&
12107 .cindex "uid (user id)" "of originating user"
12108 .cindex "sender" "uid"
12109 .vindex "&$caller_uid$&"
12110 .vindex "&$originaltor_uid$&"
12111 The value of &$caller_uid$& that was set when the message was received. For
12112 messages received via the command line, this is the uid of the sending user.
12113 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12114 user.
12115
12116 .vitem &$parent_domain$&
12117 .vindex "&$parent_domain$&"
12118 This variable is similar to &$original_domain$& (see
12119 above), except that it refers to the immediately preceding parent address.
12120
12121 .vitem &$parent_local_part$&
12122 .vindex "&$parent_local_part$&"
12123 This variable is similar to &$original_local_part$&
12124 (see above), except that it refers to the immediately preceding parent address.
12125
12126 .vitem &$pid$&
12127 .cindex "pid (process id)" "of current process"
12128 .vindex "&$pid$&"
12129 This variable contains the current process id.
12130
12131 .vitem &$pipe_addresses$&
12132 .cindex "filter" "transport filter"
12133 .cindex "transport" "filter"
12134 .vindex "&$pipe_addresses$&"
12135 This is not an expansion variable, but is mentioned here because the string
12136 &`$pipe_addresses`& is handled specially in the command specification for the
12137 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12138 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12139 It cannot be used in general expansion strings, and provokes an &"unknown
12140 variable"& error if encountered.
12141
12142 .vitem &$primary_hostname$&
12143 .vindex "&$primary_hostname$&"
12144 This variable contains the value set by &%primary_hostname%& in the
12145 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12146 a single-component name, Exim calls &[gethostbyname()]& (or
12147 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12148 qualified host name. See also &$smtp_active_hostname$&.
12149
12150
12151 .new
12152 .vitem &$proxy_external_address$& &&&
12153        &$proxy_external_port$& &&&
12154        &$proxy_local_address$& &&&
12155        &$proxy_local_port$& &&&
12156        &$proxy_session$&
12157 These variables are only available when built with Proxy Protocol
12158 or Socks5 support
12159 For details see chapter &<<SECTproxyInbound>>&.
12160 .wen
12161
12162 .vitem &$prdr_requested$&
12163 .cindex "PRDR" "variable for"
12164 This variable is set to &"yes"& if PRDR was requested by the client for the
12165 current message, otherwise &"no"&.
12166
12167 .vitem &$prvscheck_address$&
12168 This variable is used in conjunction with the &%prvscheck%& expansion item,
12169 which is described in sections &<<SECTexpansionitems>>& and
12170 &<<SECTverifyPRVS>>&.
12171
12172 .vitem &$prvscheck_keynum$&
12173 This variable is used in conjunction with the &%prvscheck%& expansion item,
12174 which is described in sections &<<SECTexpansionitems>>& and
12175 &<<SECTverifyPRVS>>&.
12176
12177 .vitem &$prvscheck_result$&
12178 This variable is used in conjunction with the &%prvscheck%& expansion item,
12179 which is described in sections &<<SECTexpansionitems>>& and
12180 &<<SECTverifyPRVS>>&.
12181
12182 .vitem &$qualify_domain$&
12183 .vindex "&$qualify_domain$&"
12184 The value set for the &%qualify_domain%& option in the configuration file.
12185
12186 .vitem &$qualify_recipient$&
12187 .vindex "&$qualify_recipient$&"
12188 The value set for the &%qualify_recipient%& option in the configuration file,
12189 or if not set, the value of &$qualify_domain$&.
12190
12191 .vitem &$rcpt_count$&
12192 .vindex "&$rcpt_count$&"
12193 When a message is being received by SMTP, this variable contains the number of
12194 RCPT commands received for the current message. If this variable is used in a
12195 RCPT ACL, its value includes the current command.
12196
12197 .vitem &$rcpt_defer_count$&
12198 .vindex "&$rcpt_defer_count$&"
12199 .cindex "4&'xx'& responses" "count of"
12200 When a message is being received by SMTP, this variable contains the number of
12201 RCPT commands in the current message that have previously been rejected with a
12202 temporary (4&'xx'&) response.
12203
12204 .vitem &$rcpt_fail_count$&
12205 .vindex "&$rcpt_fail_count$&"
12206 When a message is being received by SMTP, this variable contains the number of
12207 RCPT commands in the current message that have previously been rejected with a
12208 permanent (5&'xx'&) response.
12209
12210 .vitem &$received_count$&
12211 .vindex "&$received_count$&"
12212 This variable contains the number of &'Received:'& header lines in the message,
12213 including the one added by Exim (so its value is always greater than zero). It
12214 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12215 delivering.
12216
12217 .vitem &$received_for$&
12218 .vindex "&$received_for$&"
12219 If there is only a single recipient address in an incoming message, this
12220 variable contains that address when the &'Received:'& header line is being
12221 built. The value is copied after recipient rewriting has happened, but before
12222 the &[local_scan()]& function is run.
12223
12224 .vitem &$received_ip_address$&
12225 .vindex "&$received_ip_address$&"
12226 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12227 variable is set to the address of the local IP interface, and &$received_port$&
12228 is set to the local port number. (The remote IP address and port are in
12229 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12230 the port value is -1 unless it has been set using the &%-oMi%& command line
12231 option.
12232
12233 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12234 could be used, for example, to make the file name for a TLS certificate depend
12235 on which interface and/or port is being used for the incoming connection. The
12236 values of &$received_ip_address$& and &$received_port$& are saved with any
12237 messages that are received, thus making these variables available at delivery
12238 time.
12239 For outbound connections see &$sending_ip_address$&.
12240
12241 .vitem &$received_port$&
12242 .vindex "&$received_port$&"
12243 See &$received_ip_address$&.
12244
12245 .vitem &$received_protocol$&
12246 .vindex "&$received_protocol$&"
12247 When a message is being processed, this variable contains the name of the
12248 protocol by which it was received. Most of the names used by Exim are defined
12249 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12250 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12251 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12252 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12253 connection and the client was successfully authenticated.
12254
12255 Exim uses the protocol name &"smtps"& for the case when encryption is
12256 automatically set up on connection without the use of STARTTLS (see
12257 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12258 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12259 where the client initially uses EHLO, sets up an encrypted connection using
12260 STARTTLS, and then uses HELO afterwards.
12261
12262 The &%-oMr%& option provides a way of specifying a custom protocol name for
12263 messages that are injected locally by trusted callers. This is commonly used to
12264 identify messages that are being re-injected after some kind of scanning.
12265
12266 .vitem &$received_time$&
12267 .vindex "&$received_time$&"
12268 This variable contains the date and time when the current message was received,
12269 as a number of seconds since the start of the Unix epoch.
12270
12271 .vitem &$recipient_data$&
12272 .vindex "&$recipient_data$&"
12273 This variable is set after an indexing lookup success in an ACL &%recipients%&
12274 condition. It contains the data from the lookup, and the value remains set
12275 until the next &%recipients%& test. Thus, you can do things like this:
12276 .display
12277 &`require recipients  = cdb*@;/some/file`&
12278 &`deny    `&&'some further test involving'& &`$recipient_data`&
12279 .endd
12280 &*Warning*&: This variable is set only when a lookup is used as an indexing
12281 method in the address list, using the semicolon syntax as in the example above.
12282 The variable is not set for a lookup that is used as part of the string
12283 expansion that all such lists undergo before being interpreted.
12284
12285 .vitem &$recipient_verify_failure$&
12286 .vindex "&$recipient_verify_failure$&"
12287 In an ACL, when a recipient verification fails, this variable contains
12288 information about the failure. It is set to one of the following words:
12289
12290 .ilist
12291 &"qualify"&: The address was unqualified (no domain), and the message
12292 was neither local nor came from an exempted host.
12293
12294 .next
12295 &"route"&: Routing failed.
12296
12297 .next
12298 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12299 or before the MAIL command (that is, on initial connection, HELO, or
12300 MAIL).
12301
12302 .next
12303 &"recipient"&: The RCPT command in a callout was rejected.
12304 .next
12305
12306 &"postmaster"&: The postmaster check in a callout was rejected.
12307 .endlist
12308
12309 The main use of this variable is expected to be to distinguish between
12310 rejections of MAIL and rejections of RCPT.
12311
12312 .vitem &$recipients$&
12313 .vindex "&$recipients$&"
12314 This variable contains a list of envelope recipients for a message. A comma and
12315 a space separate the addresses in the replacement text. However, the variable
12316 is not generally available, to prevent exposure of Bcc recipients in
12317 unprivileged users' filter files. You can use &$recipients$& only in these
12318 cases:
12319
12320 .olist
12321 In a system filter file.
12322 .next
12323 In the ACLs associated with the DATA command and with non-SMTP messages, that
12324 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12325 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12326 &%acl_not_smtp_mime%&.
12327 .next
12328 From within a &[local_scan()]& function.
12329 .endlist
12330
12331
12332 .vitem &$recipients_count$&
12333 .vindex "&$recipients_count$&"
12334 When a message is being processed, this variable contains the number of
12335 envelope recipients that came with the message. Duplicates are not excluded
12336 from the count. While a message is being received over SMTP, the number
12337 increases for each accepted recipient. It can be referenced in an ACL.
12338
12339
12340 .vitem &$regex_match_string$&
12341 .vindex "&$regex_match_string$&"
12342 This variable is set to contain the matching regular expression after a
12343 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12344
12345 .vitem "&$regex1$&, &$regex2$&, etc"
12346 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12347 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12348 these variables contain the
12349 captured substrings identified by the regular expression.
12350
12351
12352 .vitem &$reply_address$&
12353 .vindex "&$reply_address$&"
12354 When a message is being processed, this variable contains the contents of the
12355 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12356 contents of the &'From:'& header line. Apart from the removal of leading
12357 white space, the value is not processed in any way. In particular, no RFC 2047
12358 decoding or character code translation takes place.
12359
12360 .vitem &$return_path$&
12361 .vindex "&$return_path$&"
12362 When a message is being delivered, this variable contains the return path &--
12363 the sender field that will be sent as part of the envelope. It is not enclosed
12364 in <> characters. At the start of routing an address, &$return_path$& has the
12365 same value as &$sender_address$&, but if, for example, an incoming message to a
12366 mailing list has been expanded by a router which specifies a different address
12367 for bounce messages, &$return_path$& subsequently contains the new bounce
12368 address, whereas &$sender_address$& always contains the original sender address
12369 that was received with the message. In other words, &$sender_address$& contains
12370 the incoming envelope sender, and &$return_path$& contains the outgoing
12371 envelope sender.
12372
12373 .vitem &$return_size_limit$&
12374 .vindex "&$return_size_limit$&"
12375 This is an obsolete name for &$bounce_return_size_limit$&.
12376
12377 .vitem &$router_name$&
12378 .cindex "router" "name"
12379 .cindex "name" "of router"
12380 .vindex "&$router_name$&"
12381 During the running of a router this variable contains its name.
12382
12383 .vitem &$runrc$&
12384 .cindex "return code" "from &%run%& expansion"
12385 .vindex "&$runrc$&"
12386 This variable contains the return code from a command that is run by the
12387 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12388 assume the order in which option values are expanded, except for those
12389 preconditions whose order of testing is documented. Therefore, you cannot
12390 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12391 another.
12392
12393 .vitem &$self_hostname$&
12394 .oindex "&%self%&" "value of host name"
12395 .vindex "&$self_hostname$&"
12396 When an address is routed to a supposedly remote host that turns out to be the
12397 local host, what happens is controlled by the &%self%& generic router option.
12398 One of its values causes the address to be passed to another router. When this
12399 happens, &$self_hostname$& is set to the name of the local host that the
12400 original router encountered. In other circumstances its contents are null.
12401
12402 .vitem &$sender_address$&
12403 .vindex "&$sender_address$&"
12404 When a message is being processed, this variable contains the sender's address
12405 that was received in the message's envelope. The case of letters in the address
12406 is retained, in both the local part and the domain. For bounce messages, the
12407 value of this variable is the empty string. See also &$return_path$&.
12408
12409 .vitem &$sender_address_data$&
12410 .vindex "&$address_data$&"
12411 .vindex "&$sender_address_data$&"
12412 If &$address_data$& is set when the routers are called from an ACL to verify a
12413 sender address, the final value is preserved in &$sender_address_data$&, to
12414 distinguish it from data from a recipient address. The value does not persist
12415 after the end of the current ACL statement. If you want to preserve it for
12416 longer, you can save it in an ACL variable.
12417
12418 .vitem &$sender_address_domain$&
12419 .vindex "&$sender_address_domain$&"
12420 The domain portion of &$sender_address$&.
12421
12422 .vitem &$sender_address_local_part$&
12423 .vindex "&$sender_address_local_part$&"
12424 The local part portion of &$sender_address$&.
12425
12426 .vitem &$sender_data$&
12427 .vindex "&$sender_data$&"
12428 This variable is set after a lookup success in an ACL &%senders%& condition or
12429 in a router &%senders%& option. It contains the data from the lookup, and the
12430 value remains set until the next &%senders%& test. Thus, you can do things like
12431 this:
12432 .display
12433 &`require senders      = cdb*@;/some/file`&
12434 &`deny    `&&'some further test involving'& &`$sender_data`&
12435 .endd
12436 &*Warning*&: This variable is set only when a lookup is used as an indexing
12437 method in the address list, using the semicolon syntax as in the example above.
12438 The variable is not set for a lookup that is used as part of the string
12439 expansion that all such lists undergo before being interpreted.
12440
12441 .vitem &$sender_fullhost$&
12442 .vindex "&$sender_fullhost$&"
12443 When a message is received from a remote host, this variable contains the host
12444 name and IP address in a single string. It ends with the IP address in square
12445 brackets, followed by a colon and a port number if the logging of ports is
12446 enabled. The format of the rest of the string depends on whether the host
12447 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12448 looking up its IP address. (Looking up the IP address can be forced by the
12449 &%host_lookup%& option, independent of verification.) A plain host name at the
12450 start of the string is a verified host name; if this is not present,
12451 verification either failed or was not requested. A host name in parentheses is
12452 the argument of a HELO or EHLO command. This is omitted if it is identical to
12453 the verified host name or to the host's IP address in square brackets.
12454
12455 .vitem &$sender_helo_dnssec$&
12456 .vindex "&$sender_helo_dnssec$&"
12457 This boolean variable is true if a successful HELO verification was
12458 .cindex "DNS" "DNSSEC"
12459 done using DNS information the resolver library stated was authenticated data.
12460
12461 .vitem &$sender_helo_name$&
12462 .vindex "&$sender_helo_name$&"
12463 When a message is received from a remote host that has issued a HELO or EHLO
12464 command, the argument of that command is placed in this variable. It is also
12465 set if HELO or EHLO is used when a message is received using SMTP locally via
12466 the &%-bs%& or &%-bS%& options.
12467
12468 .vitem &$sender_host_address$&
12469 .vindex "&$sender_host_address$&"
12470 When a message is received from a remote host using SMTP,
12471 this variable contains that
12472 host's IP address. For locally non-SMTP submitted messages, it is empty.
12473
12474 .vitem &$sender_host_authenticated$&
12475 .vindex "&$sender_host_authenticated$&"
12476 This variable contains the name (not the public name) of the authenticator
12477 driver that successfully authenticated the client from which the message was
12478 received. It is empty if there was no successful authentication. See also
12479 &$authenticated_id$&.
12480
12481 .vitem &$sender_host_dnssec$&
12482 .vindex "&$sender_host_dnssec$&"
12483 If an attempt to populate &$sender_host_name$& has been made
12484 (by reference, &%hosts_lookup%& or
12485 otherwise) then this boolean will have been set true if, and only if, the
12486 resolver library states that both
12487 the reverse and forward DNS were authenticated data.  At all
12488 other times, this variable is false.
12489
12490 .cindex "DNS" "DNSSEC"
12491 It is likely that you will need to coerce DNSSEC support on in the resolver
12492 library, by setting:
12493 .code
12494 dns_dnssec_ok = 1
12495 .endd
12496
12497 Exim does not perform DNSSEC validation itself, instead leaving that to a
12498 validating resolver (e.g. unbound, or bind with suitable configuration).
12499
12500 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12501 mechanism in the list, then this variable will be false.
12502
12503
12504 .vitem &$sender_host_name$&
12505 .vindex "&$sender_host_name$&"
12506 When a message is received from a remote host, this variable contains the
12507 host's name as obtained by looking up its IP address. For messages received by
12508 other means, this variable is empty.
12509
12510 .vindex "&$host_lookup_failed$&"
12511 If the host name has not previously been looked up, a reference to
12512 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12513 A looked up name is accepted only if it leads back to the original IP address
12514 via a forward lookup. If either the reverse or the forward lookup fails to find
12515 any data, or if the forward lookup does not yield the original IP address,
12516 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12517
12518 .vindex "&$host_lookup_deferred$&"
12519 However, if either of the lookups cannot be completed (for example, there is a
12520 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12521 &$host_lookup_failed$& remains set to &"0"&.
12522
12523 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12524 host name again if there is a subsequent reference to &$sender_host_name$&
12525 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12526 is set to &"1"&.
12527
12528 Exim does not automatically look up every calling host's name. If you want
12529 maximum efficiency, you should arrange your configuration so that it avoids
12530 these lookups altogether. The lookup happens only if one or more of the
12531 following are true:
12532
12533 .ilist
12534 A string containing &$sender_host_name$& is expanded.
12535 .next
12536 The calling host matches the list in &%host_lookup%&. In the default
12537 configuration, this option is set to *, so it must be changed if lookups are
12538 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12539 .next
12540 Exim needs the host name in order to test an item in a host list. The items
12541 that require this are described in sections &<<SECThoslispatnam>>& and
12542 &<<SECThoslispatnamsk>>&.
12543 .next
12544 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12545 In this case, the host name is required to compare with the name quoted in any
12546 EHLO or HELO commands that the client issues.
12547 .next
12548 The remote host issues a EHLO or HELO command that quotes one of the
12549 domains in &%helo_lookup_domains%&. The default value of this option is
12550 . ==== As this is a nested list, any displays it contains must be indented
12551 . ==== as otherwise they are too far to the left.
12552 .code
12553   helo_lookup_domains = @ : @[]
12554 .endd
12555 which causes a lookup if a remote host (incorrectly) gives the server's name or
12556 IP address in an EHLO or HELO command.
12557 .endlist
12558
12559
12560 .vitem &$sender_host_port$&
12561 .vindex "&$sender_host_port$&"
12562 When a message is received from a remote host, this variable contains the port
12563 number that was used on the remote host.
12564
12565 .vitem &$sender_ident$&
12566 .vindex "&$sender_ident$&"
12567 When a message is received from a remote host, this variable contains the
12568 identification received in response to an RFC 1413 request. When a message has
12569 been received locally, this variable contains the login name of the user that
12570 called Exim.
12571
12572 .vitem &$sender_rate_$&&'xxx'&
12573 A number of variables whose names begin &$sender_rate_$& are set as part of the
12574 &%ratelimit%& ACL condition. Details are given in section
12575 &<<SECTratelimiting>>&.
12576
12577 .vitem &$sender_rcvhost$&
12578 .cindex "DNS" "reverse lookup"
12579 .cindex "reverse DNS lookup"
12580 .vindex "&$sender_rcvhost$&"
12581 This is provided specifically for use in &'Received:'& headers. It starts with
12582 either the verified host name (as obtained from a reverse DNS lookup) or, if
12583 there is no verified host name, the IP address in square brackets. After that
12584 there may be text in parentheses. When the first item is a verified host name,
12585 the first thing in the parentheses is the IP address in square brackets,
12586 followed by a colon and a port number if port logging is enabled. When the
12587 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12588 the parentheses.
12589
12590 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12591 was used and its argument was not identical to the real host name or IP
12592 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12593 all three items are present in the parentheses, a newline and tab are inserted
12594 into the string, to improve the formatting of the &'Received:'& header.
12595
12596 .vitem &$sender_verify_failure$&
12597 .vindex "&$sender_verify_failure$&"
12598 In an ACL, when a sender verification fails, this variable contains information
12599 about the failure. The details are the same as for
12600 &$recipient_verify_failure$&.
12601
12602 .vitem &$sending_ip_address$&
12603 .vindex "&$sending_ip_address$&"
12604 This variable is set whenever an outgoing SMTP connection to another host has
12605 been set up. It contains the IP address of the local interface that is being
12606 used. This is useful if a host that has more than one IP address wants to take
12607 on different personalities depending on which one is being used. For incoming
12608 connections, see &$received_ip_address$&.
12609
12610 .vitem &$sending_port$&
12611 .vindex "&$sending_port$&"
12612 This variable is set whenever an outgoing SMTP connection to another host has
12613 been set up. It contains the local port that is being used. For incoming
12614 connections, see &$received_port$&.
12615
12616 .vitem &$smtp_active_hostname$&
12617 .vindex "&$smtp_active_hostname$&"
12618 During an incoming SMTP session, this variable contains the value of the active
12619 host name, as specified by the &%smtp_active_hostname%& option. The value of
12620 &$smtp_active_hostname$& is saved with any message that is received, so its
12621 value can be consulted during routing and delivery.
12622
12623 .vitem &$smtp_command$&
12624 .vindex "&$smtp_command$&"
12625 During the processing of an incoming SMTP command, this variable contains the
12626 entire command. This makes it possible to distinguish between HELO and EHLO in
12627 the HELO ACL, and also to distinguish between commands such as these:
12628 .code
12629 MAIL FROM:<>
12630 MAIL FROM: <>
12631 .endd
12632 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12633 command, the address in &$smtp_command$& is the original address before any
12634 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12635 the address after SMTP-time rewriting.
12636
12637 .vitem &$smtp_command_argument$&
12638 .cindex "SMTP" "command, argument for"
12639 .vindex "&$smtp_command_argument$&"
12640 While an ACL is running to check an SMTP command, this variable contains the
12641 argument, that is, the text that follows the command name, with leading white
12642 space removed. Following the introduction of &$smtp_command$&, this variable is
12643 somewhat redundant, but is retained for backwards compatibility.
12644
12645 .vitem &$smtp_count_at_connection_start$&
12646 .vindex "&$smtp_count_at_connection_start$&"
12647 This variable is set greater than zero only in processes spawned by the Exim
12648 daemon for handling incoming SMTP connections. The name is deliberately long,
12649 in order to emphasize what the contents are. When the daemon accepts a new
12650 connection, it increments this variable. A copy of the variable is passed to
12651 the child process that handles the connection, but its value is fixed, and
12652 never changes. It is only an approximation of how many incoming connections
12653 there actually are, because many other connections may come and go while a
12654 single connection is being processed. When a child process terminates, the
12655 daemon decrements its copy of the variable.
12656
12657 .vitem "&$sn0$& &-- &$sn9$&"
12658 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12659 that were current at the end of the system filter file. This allows a system
12660 filter file to set values that can be tested in users' filter files. For
12661 example, a system filter could set a value indicating how likely it is that a
12662 message is junk mail.
12663
12664 .vitem &$spam_$&&'xxx'&
12665 A number of variables whose names start with &$spam$& are available when Exim
12666 is compiled with the content-scanning extension. For details, see section
12667 &<<SECTscanspamass>>&.
12668
12669
12670 .vitem &$spool_directory$&
12671 .vindex "&$spool_directory$&"
12672 The name of Exim's spool directory.
12673
12674 .vitem &$spool_inodes$&
12675 .vindex "&$spool_inodes$&"
12676 The number of free inodes in the disk partition where Exim's spool files are
12677 being written. The value is recalculated whenever the variable is referenced.
12678 If the relevant file system does not have the concept of inodes, the value of
12679 is -1. See also the &%check_spool_inodes%& option.
12680
12681 .vitem &$spool_space$&
12682 .vindex "&$spool_space$&"
12683 The amount of free space (as a number of kilobytes) in the disk partition where
12684 Exim's spool files are being written. The value is recalculated whenever the
12685 variable is referenced. If the operating system does not have the ability to
12686 find the amount of free space (only true for experimental systems), the space
12687 value is -1. For example, to check in an ACL that there is at least 50
12688 megabytes free on the spool, you could write:
12689 .code
12690 condition = ${if > {$spool_space}{50000}}
12691 .endd
12692 See also the &%check_spool_space%& option.
12693
12694
12695 .vitem &$thisaddress$&
12696 .vindex "&$thisaddress$&"
12697 This variable is set only during the processing of the &%foranyaddress%&
12698 command in a filter file. Its use is explained in the description of that
12699 command, which can be found in the separate document entitled &'Exim's
12700 interfaces to mail filtering'&.
12701
12702 .vitem &$tls_in_bits$&
12703 .vindex "&$tls_in_bits$&"
12704 Contains an approximation of the TLS cipher's bit-strength
12705 on the inbound connection; the meaning of
12706 this depends upon the TLS implementation used.
12707 If TLS has not been negotiated, the value will be 0.
12708 The value of this is automatically fed into the Cyrus SASL authenticator
12709 when acting as a server, to specify the "external SSF" (a SASL term).
12710
12711 The deprecated &$tls_bits$& variable refers to the inbound side
12712 except when used in the context of an outbound SMTP delivery, when it refers to
12713 the outbound.
12714
12715 .vitem &$tls_out_bits$&
12716 .vindex "&$tls_out_bits$&"
12717 Contains an approximation of the TLS cipher's bit-strength
12718 on an outbound SMTP connection; the meaning of
12719 this depends upon the TLS implementation used.
12720 If TLS has not been negotiated, the value will be 0.
12721
12722 .vitem &$tls_in_ourcert$&
12723 .vindex "&$tls_in_ourcert$&"
12724 .cindex certificate veriables
12725 This variable refers to the certificate presented to the peer of an
12726 inbound connection when the message was received.
12727 It is only useful as the argument of a
12728 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12729 or a &%def%& condition.
12730
12731 .vitem &$tls_in_peercert$&
12732 .vindex "&$tls_in_peercert$&"
12733 This variable refers to the certificate presented by the peer of an
12734 inbound connection when the message was received.
12735 It is only useful as the argument of a
12736 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12737 or a &%def%& condition.
12738 If certificate verification fails it may refer to a failing chain element
12739 which is not the leaf.
12740
12741 .vitem &$tls_out_ourcert$&
12742 .vindex "&$tls_out_ourcert$&"
12743 This variable refers to the certificate presented to the peer of an
12744 outbound connection.  It is only useful as the argument of a
12745 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12746 or a &%def%& condition.
12747
12748 .vitem &$tls_out_peercert$&
12749 .vindex "&$tls_out_peercert$&"
12750 This variable refers to the certificate presented by the peer of an
12751 outbound connection.  It is only useful as the argument of a
12752 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12753 or a &%def%& condition.
12754 If certificate verification fails it may refer to a failing chain element
12755 which is not the leaf.
12756
12757 .vitem &$tls_in_certificate_verified$&
12758 .vindex "&$tls_in_certificate_verified$&"
12759 This variable is set to &"1"& if a TLS certificate was verified when the
12760 message was received, and &"0"& otherwise.
12761
12762 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12763 except when used in the context of an outbound SMTP delivery, when it refers to
12764 the outbound.
12765
12766 .vitem &$tls_out_certificate_verified$&
12767 .vindex "&$tls_out_certificate_verified$&"
12768 This variable is set to &"1"& if a TLS certificate was verified when an
12769 outbound SMTP connection was made,
12770 and &"0"& otherwise.
12771
12772 .vitem &$tls_in_cipher$&
12773 .vindex "&$tls_in_cipher$&"
12774 .vindex "&$tls_cipher$&"
12775 When a message is received from a remote host over an encrypted SMTP
12776 connection, this variable is set to the cipher suite that was negotiated, for
12777 example DES-CBC3-SHA. In other circumstances, in particular, for message
12778 received over unencrypted connections, the variable is empty. Testing
12779 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12780 non-encrypted connections during ACL processing.
12781
12782 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12783 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12784 becomes the same as &$tls_out_cipher$&.
12785
12786 .vitem &$tls_out_cipher$&
12787 .vindex "&$tls_out_cipher$&"
12788 This variable is
12789 cleared before any outgoing SMTP connection is made,
12790 and then set to the outgoing cipher suite if one is negotiated. See chapter
12791 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12792 details of the &(smtp)& transport.
12793
12794 .vitem &$tls_in_ocsp$&
12795 .vindex "&$tls_in_ocsp$&"
12796 When a message is received from a remote client connection
12797 the result of any OCSP request from the client is encoded in this variable:
12798 .code
12799 0 OCSP proof was not requested (default value)
12800 1 No response to request
12801 2 Response not verified
12802 3 Verification failed
12803 4 Verification succeeded
12804 .endd
12805
12806 .vitem &$tls_out_ocsp$&
12807 .vindex "&$tls_out_ocsp$&"
12808 When a message is sent to a remote host connection
12809 the result of any OCSP request made is encoded in this variable.
12810 See &$tls_in_ocsp$& for values.
12811
12812 .vitem &$tls_in_peerdn$&
12813 .vindex "&$tls_in_peerdn$&"
12814 .vindex "&$tls_peerdn$&"
12815 .cindex certificate "extracting fields"
12816 When a message is received from a remote host over an encrypted SMTP
12817 connection, and Exim is configured to request a certificate from the client,
12818 the value of the Distinguished Name of the certificate is made available in the
12819 &$tls_in_peerdn$& during subsequent processing.
12820 If certificate verification fails it may refer to a failing chain element
12821 which is not the leaf.
12822
12823 The deprecated &$tls_peerdn$& variable refers to the inbound side
12824 except when used in the context of an outbound SMTP delivery, when it refers to
12825 the outbound.
12826
12827 .vitem &$tls_out_peerdn$&
12828 .vindex "&$tls_out_peerdn$&"
12829 When a message is being delivered to a remote host over an encrypted SMTP
12830 connection, and Exim is configured to request a certificate from the server,
12831 the value of the Distinguished Name of the certificate is made available in the
12832 &$tls_out_peerdn$& during subsequent processing.
12833 If certificate verification fails it may refer to a failing chain element
12834 which is not the leaf.
12835
12836 .vitem &$tls_in_sni$&
12837 .vindex "&$tls_in_sni$&"
12838 .vindex "&$tls_sni$&"
12839 .cindex "TLS" "Server Name Indication"
12840 When a TLS session is being established, if the client sends the Server
12841 Name Indication extension, the value will be placed in this variable.
12842 If the variable appears in &%tls_certificate%& then this option and
12843 some others, described in &<<SECTtlssni>>&,
12844 will be re-expanded early in the TLS session, to permit
12845 a different certificate to be presented (and optionally a different key to be
12846 used) to the client, based upon the value of the SNI extension.
12847
12848 The deprecated &$tls_sni$& variable refers to the inbound side
12849 except when used in the context of an outbound SMTP delivery, when it refers to
12850 the outbound.
12851
12852 .vitem &$tls_out_sni$&
12853 .vindex "&$tls_out_sni$&"
12854 .cindex "TLS" "Server Name Indication"
12855 During outbound
12856 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12857 the transport.
12858
12859 .vitem &$tod_bsdinbox$&
12860 .vindex "&$tod_bsdinbox$&"
12861 The time of day and the date, in the format required for BSD-style mailbox
12862 files, for example: Thu Oct 17 17:14:09 1995.
12863
12864 .vitem &$tod_epoch$&
12865 .vindex "&$tod_epoch$&"
12866 The time and date as a number of seconds since the start of the Unix epoch.
12867
12868 .vitem &$tod_epoch_l$&
12869 .vindex "&$tod_epoch_l$&"
12870 The time and date as a number of microseconds since the start of the Unix epoch.
12871
12872 .vitem &$tod_full$&
12873 .vindex "&$tod_full$&"
12874 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12875 +0100. The timezone is always given as a numerical offset from UTC, with
12876 positive values used for timezones that are ahead (east) of UTC, and negative
12877 values for those that are behind (west).
12878
12879 .vitem &$tod_log$&
12880 .vindex "&$tod_log$&"
12881 The time and date in the format used for writing Exim's log files, for example:
12882 1995-10-12 15:32:29, but without a timezone.
12883
12884 .vitem &$tod_logfile$&
12885 .vindex "&$tod_logfile$&"
12886 This variable contains the date in the format yyyymmdd. This is the format that
12887 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12888 flag.
12889
12890 .vitem &$tod_zone$&
12891 .vindex "&$tod_zone$&"
12892 This variable contains the numerical value of the local timezone, for example:
12893 -0500.
12894
12895 .vitem &$tod_zulu$&
12896 .vindex "&$tod_zulu$&"
12897 This variable contains the UTC date and time in &"Zulu"& format, as specified
12898 by ISO 8601, for example: 20030221154023Z.
12899
12900 .vitem &$transport_name$&
12901 .cindex "transport" "name"
12902 .cindex "name" "of transport"
12903 .vindex "&$transport_name$&"
12904 During the running of a transport, this variable contains its name.
12905
12906 .vitem &$value$&
12907 .vindex "&$value$&"
12908 This variable contains the result of an expansion lookup, extraction operation,
12909 or external command, as described above. It is also used during a
12910 &*reduce*& expansion.
12911
12912 .vitem &$verify_mode$&
12913 .vindex "&$verify_mode$&"
12914 While a router or transport is being run in verify mode
12915 or for cutthrough delivery,
12916 contains "S" for sender-verification or "R" for recipient-verification.
12917 Otherwise, empty.
12918
12919 .vitem &$version_number$&
12920 .vindex "&$version_number$&"
12921 The version number of Exim.
12922
12923 .vitem &$warn_message_delay$&
12924 .vindex "&$warn_message_delay$&"
12925 This variable is set only during the creation of a message warning about a
12926 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12927
12928 .vitem &$warn_message_recipients$&
12929 .vindex "&$warn_message_recipients$&"
12930 This variable is set only during the creation of a message warning about a
12931 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12932 .endlist
12933 .ecindex IIDstrexp
12934
12935
12936
12937 . ////////////////////////////////////////////////////////////////////////////
12938 . ////////////////////////////////////////////////////////////////////////////
12939
12940 .chapter "Embedded Perl" "CHAPperl"
12941 .scindex IIDperl "Perl" "calling from Exim"
12942 Exim can be built to include an embedded Perl interpreter. When this is done,
12943 Perl subroutines can be called as part of the string expansion process. To make
12944 use of the Perl support, you need version 5.004 or later of Perl installed on
12945 your system. To include the embedded interpreter in the Exim binary, include
12946 the line
12947 .code
12948 EXIM_PERL = perl.o
12949 .endd
12950 in your &_Local/Makefile_& and then build Exim in the normal way.
12951
12952
12953 .section "Setting up so Perl can be used" "SECID85"
12954 .oindex "&%perl_startup%&"
12955 Access to Perl subroutines is via a global configuration option called
12956 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12957 no &%perl_startup%& option in the Exim configuration file then no Perl
12958 interpreter is started and there is almost no overhead for Exim (since none of
12959 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12960 option then the associated value is taken to be Perl code which is executed in
12961 a newly created Perl interpreter.
12962
12963 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12964 need backslashes before any characters to escape special meanings. The option
12965 should usually be something like
12966 .code
12967 perl_startup = do '/etc/exim.pl'
12968 .endd
12969 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12970 use from Exim. Exim can be configured either to start up a Perl interpreter as
12971 soon as it is entered, or to wait until the first time it is needed. Starting
12972 the interpreter at the beginning ensures that it is done while Exim still has
12973 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12974 fact used in a particular run. Also, note that this does not mean that Exim is
12975 necessarily running as root when Perl is called at a later time. By default,
12976 the interpreter is started only when it is needed, but this can be changed in
12977 two ways:
12978
12979 .ilist
12980 .oindex "&%perl_at_start%&"
12981 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12982 a startup when Exim is entered.
12983 .next
12984 The command line option &%-ps%& also requests a startup when Exim is entered,
12985 overriding the setting of &%perl_at_start%&.
12986 .endlist
12987
12988 There is also a command line option &%-pd%& (for delay) which suppresses the
12989 initial startup, even if &%perl_at_start%& is set.
12990
12991 .new
12992 .ilist
12993 .oindex "&%perl_taintmode%&"
12994 .cindex "Perl" "taintmode"
12995 To provide more security executing Perl code via the embedded Perl
12996 interpeter, the &%perl_taintmode%& option can be set. This enables the
12997 taint mode of the Perl interpreter. You are encouraged to set this
12998 option to a true value. To avoid breaking existing installations, it
12999 defaults to false.
13000 .wen
13001
13002
13003 .section "Calling Perl subroutines" "SECID86"
13004 When the configuration file includes a &%perl_startup%& option you can make use
13005 of the string expansion item to call the Perl subroutines that are defined
13006 by the &%perl_startup%& code. The operator is used in any of the following
13007 forms:
13008 .code
13009 ${perl{foo}}
13010 ${perl{foo}{argument}}
13011 ${perl{foo}{argument1}{argument2} ... }
13012 .endd
13013 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13014 arguments may be passed. Passing more than this results in an expansion failure
13015 with an error message of the form
13016 .code
13017 Too many arguments passed to Perl subroutine "foo" (max is 8)
13018 .endd
13019 The return value of the Perl subroutine is evaluated in a scalar context before
13020 it is passed back to Exim to be inserted into the expanded string. If the
13021 return value is &'undef'&, the expansion is forced to fail in the same way as
13022 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13023 by obeying Perl's &%die%& function, the expansion fails with the error message
13024 that was passed to &%die%&.
13025
13026
13027 .section "Calling Exim functions from Perl" "SECID87"
13028 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13029 is available to call back into Exim's string expansion function. For example,
13030 the Perl code
13031 .code
13032 my $lp = Exim::expand_string('$local_part');
13033 .endd
13034 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13035 Note those are single quotes and not double quotes to protect against
13036 &$local_part$& being interpolated as a Perl variable.
13037
13038 If the string expansion is forced to fail by a &"fail"& item, the result of
13039 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13040 expansion string, the Perl call from the original expansion string fails with
13041 an appropriate error message, in the same way as if &%die%& were used.
13042
13043 .cindex "debugging" "from embedded Perl"
13044 .cindex "log" "writing from embedded Perl"
13045 Two other Exim functions are available for use from within Perl code.
13046 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13047 debugging is enabled. If you want a newline at the end, you must supply it.
13048 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13049 timestamp. In this case, you should not supply a terminating newline.
13050
13051
13052 .section "Use of standard output and error by Perl" "SECID88"
13053 .cindex "Perl" "standard output and error"
13054 You should not write to the standard error or output streams from within your
13055 Perl code, as it is not defined how these are set up. In versions of Exim
13056 before 4.50, it is possible for the standard output or error to refer to the
13057 SMTP connection during message reception via the daemon. Writing to this stream
13058 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13059 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13060 avoided, but the output is lost.
13061
13062 .cindex "Perl" "use of &%warn%&"
13063 The Perl &%warn%& statement writes to the standard error stream by default.
13064 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13065 you have no control. When Exim starts up the Perl interpreter, it arranges for
13066 output from the &%warn%& statement to be written to the Exim main log. You can
13067 change this by including appropriate Perl magic somewhere in your Perl code.
13068 For example, to discard &%warn%& output completely, you need this:
13069 .code
13070 $SIG{__WARN__} = sub { };
13071 .endd
13072 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13073 example, the code for the subroutine is empty, so it does nothing, but you can
13074 include any Perl code that you like. The text of the &%warn%& message is passed
13075 as the first subroutine argument.
13076 .ecindex IIDperl
13077
13078
13079 . ////////////////////////////////////////////////////////////////////////////
13080 . ////////////////////////////////////////////////////////////////////////////
13081
13082 .chapter "Starting the daemon and the use of network interfaces" &&&
13083          "CHAPinterfaces" &&&
13084          "Starting the daemon"
13085 .cindex "daemon" "starting"
13086 .cindex "interface" "listening"
13087 .cindex "network interface"
13088 .cindex "interface" "network"
13089 .cindex "IP address" "for listening"
13090 .cindex "daemon" "listening IP addresses"
13091 .cindex "TCP/IP" "setting listening interfaces"
13092 .cindex "TCP/IP" "setting listening ports"
13093 A host that is connected to a TCP/IP network may have one or more physical
13094 hardware network interfaces. Each of these interfaces may be configured as one
13095 or more &"logical"& interfaces, which are the entities that a program actually
13096 works with. Each of these logical interfaces is associated with an IP address.
13097 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13098 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13099 knowledge about the host's interfaces for use in three different circumstances:
13100
13101 .olist
13102 When a listening daemon is started, Exim needs to know which interfaces
13103 and ports to listen on.
13104 .next
13105 When Exim is routing an address, it needs to know which IP addresses
13106 are associated with local interfaces. This is required for the correct
13107 processing of MX lists by removing the local host and others with the
13108 same or higher priority values. Also, Exim needs to detect cases
13109 when an address is routed to an IP address that in fact belongs to the
13110 local host. Unless the &%self%& router option or the &%allow_localhost%&
13111 option of the smtp transport is set (as appropriate), this is treated
13112 as an error situation.
13113 .next
13114 When Exim connects to a remote host, it may need to know which interface to use
13115 for the outgoing connection.
13116 .endlist
13117
13118
13119 Exim's default behaviour is likely to be appropriate in the vast majority
13120 of cases. If your host has only one interface, and you want all its IP
13121 addresses to be treated in the same way, and you are using only the
13122 standard SMTP port, you should not need to take any special action. The
13123 rest of this chapter does not apply to you.
13124
13125 In a more complicated situation you may want to listen only on certain
13126 interfaces, or on different ports, and for this reason there are a number of
13127 options that can be used to influence Exim's behaviour. The rest of this
13128 chapter describes how they operate.
13129
13130 When a message is received over TCP/IP, the interface and port that were
13131 actually used are set in &$received_ip_address$& and &$received_port$&.
13132
13133
13134
13135 .section "Starting a listening daemon" "SECID89"
13136 When a listening daemon is started (by means of the &%-bd%& command line
13137 option), the interfaces and ports on which it listens are controlled by the
13138 following options:
13139
13140 .ilist
13141 &%daemon_smtp_ports%& contains a list of default ports
13142 or service names.
13143 (For backward compatibility, this option can also be specified in the singular.)
13144 .next
13145 &%local_interfaces%& contains list of interface IP addresses on which to
13146 listen. Each item may optionally also specify a port.
13147 .endlist
13148
13149 The default list separator in both cases is a colon, but this can be changed as
13150 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13151 it is usually best to change the separator to avoid having to double all the
13152 colons. For example:
13153 .code
13154 local_interfaces = <; 127.0.0.1 ; \
13155                       192.168.23.65 ; \
13156                       ::1 ; \
13157                       3ffe:ffff:836f::fe86:a061
13158 .endd
13159 There are two different formats for specifying a port along with an IP address
13160 in &%local_interfaces%&:
13161
13162 .olist
13163 The port is added onto the address with a dot separator. For example, to listen
13164 on port 1234 on two different IP addresses:
13165 .code
13166 local_interfaces = <; 192.168.23.65.1234 ; \
13167                       3ffe:ffff:836f::fe86:a061.1234
13168 .endd
13169 .next
13170 The IP address is enclosed in square brackets, and the port is added
13171 with a colon separator, for example:
13172 .code
13173 local_interfaces = <; [192.168.23.65]:1234 ; \
13174                       [3ffe:ffff:836f::fe86:a061]:1234
13175 .endd
13176 .endlist
13177
13178 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13179 default setting contains just one port:
13180 .code
13181 daemon_smtp_ports = smtp
13182 .endd
13183 If more than one port is listed, each interface that does not have its own port
13184 specified listens on all of them. Ports that are listed in
13185 &%daemon_smtp_ports%& can be identified either by name (defined in
13186 &_/etc/services_&) or by number. However, when ports are given with individual
13187 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13188
13189
13190
13191 .section "Special IP listening addresses" "SECID90"
13192 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13193 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13194 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13195 instead of setting up separate listening sockets for each interface. The
13196 default value of &%local_interfaces%& is
13197 .code
13198 local_interfaces = 0.0.0.0
13199 .endd
13200 when Exim is built without IPv6 support; otherwise it is:
13201 .code
13202 local_interfaces = <; ::0 ; 0.0.0.0
13203 .endd
13204 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13205
13206
13207
13208 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13209 The &%-oX%& command line option can be used to override the values of
13210 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13211 instance. Another way of doing this would be to use macros and the &%-D%&
13212 option. However, &%-oX%& can be used by any admin user, whereas modification of
13213 the runtime configuration by &%-D%& is allowed only when the caller is root or
13214 exim.
13215
13216 The value of &%-oX%& is a list of items. The default colon separator can be
13217 changed in the usual way if required. If there are any items that do not
13218 contain dots or colons (that is, are not IP addresses), the value of
13219 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13220 items that do contain dots or colons, the value of &%local_interfaces%& is
13221 replaced by those items. Thus, for example,
13222 .code
13223 -oX 1225
13224 .endd
13225 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13226 whereas
13227 .code
13228 -oX 192.168.34.5.1125
13229 .endd
13230 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13231 (However, since &%local_interfaces%& now contains no items without ports, the
13232 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13233
13234
13235
13236 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13237 .cindex "ssmtp protocol"
13238 .cindex "smtps protocol"
13239 .cindex "SMTP" "ssmtp protocol"
13240 .cindex "SMTP" "smtps protocol"
13241 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13242 before the STARTTLS command was standardized for SMTP. Some legacy clients
13243 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13244 list of port numbers or service names,
13245 connections to those ports must use SSMTP. The most
13246 common use of this option is expected to be
13247 .code
13248 tls_on_connect_ports = 465
13249 .endd
13250 because 465 is the usual port number used by the legacy clients. There is also
13251 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13252 this way when a daemon is started.
13253
13254 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13255 daemon to listen on those ports. You must still specify them in
13256 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13257 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13258 connections via the daemon.)
13259
13260
13261
13262
13263 .section "IPv6 address scopes" "SECID92"
13264 .cindex "IPv6" "address scopes"
13265 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13266 can, in principle, have the same link-local IPv6 address on different
13267 interfaces. Thus, additional information is needed, over and above the IP
13268 address, to distinguish individual interfaces. A convention of using a
13269 percent sign followed by something (often the interface name) has been
13270 adopted in some cases, leading to addresses like this:
13271 .code
13272 fe80::202:b3ff:fe03:45c1%eth0
13273 .endd
13274 To accommodate this usage, a percent sign followed by an arbitrary string is
13275 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13276 to convert a textual IPv6 address for actual use. This function recognizes the
13277 percent convention in operating systems that support it, and it processes the
13278 address appropriately. Unfortunately, some older libraries have problems with
13279 &[getaddrinfo()]&. If
13280 .code
13281 IPV6_USE_INET_PTON=yes
13282 .endd
13283 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13284 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13285 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13286 function.) Of course, this means that the additional functionality of
13287 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13288
13289 .section "Disabling IPv6" "SECID93"
13290 .cindex "IPv6" "disabling"
13291 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13292 run on a host whose kernel does not support IPv6. The binary will fall back to
13293 using IPv4, but it may waste resources looking up AAAA records, and trying to
13294 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13295 .oindex "&%disable_ipv6%&"
13296 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13297 activities take place. AAAA records are never looked up, and any IPv6 addresses
13298 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13299 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13300 to handle IPv6 literal addresses.
13301
13302 On the other hand, when IPv6 is in use, there may be times when you want to
13303 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13304 option to globally suppress the lookup of AAAA records for specified domains,
13305 and you can use the &%ignore_target_hosts%& generic router option to ignore
13306 IPv6 addresses in an individual router.
13307
13308
13309
13310 .section "Examples of starting a listening daemon" "SECID94"
13311 The default case in an IPv6 environment is
13312 .code
13313 daemon_smtp_ports = smtp
13314 local_interfaces = <; ::0 ; 0.0.0.0
13315 .endd
13316 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13317 Either one or two sockets may be used, depending on the characteristics of
13318 the TCP/IP stack. (This is complicated and messy; for more information,
13319 read the comments in the &_daemon.c_& source file.)
13320
13321 To specify listening on ports 25 and 26 on all interfaces:
13322 .code
13323 daemon_smtp_ports = 25 : 26
13324 .endd
13325 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13326 .code
13327 local_interfaces = <; ::0.25     ; ::0.26 \
13328                       0.0.0.0.25 ; 0.0.0.0.26
13329 .endd
13330 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13331 IPv4 loopback address only:
13332 .code
13333 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13334 .endd
13335 To specify listening on the default port on specific interfaces only:
13336 .code
13337 local_interfaces = 10.0.0.67 : 192.168.34.67
13338 .endd
13339 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13340
13341
13342
13343 .section "Recognizing the local host" "SECTreclocipadd"
13344 The &%local_interfaces%& option is also used when Exim needs to determine
13345 whether or not an IP address refers to the local host. That is, the IP
13346 addresses of all the interfaces on which a daemon is listening are always
13347 treated as local.
13348
13349 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13350 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13351 available interfaces from the operating system, and extracts the relevant
13352 (that is, IPv4 or IPv6) addresses to use for checking.
13353
13354 Some systems set up large numbers of virtual interfaces in order to provide
13355 many virtual web servers. In this situation, you may want to listen for
13356 email on only a few of the available interfaces, but nevertheless treat all
13357 interfaces as local when routing. You can do this by setting
13358 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13359 &"all"& wildcard values. These addresses are recognized as local, but are not
13360 used for listening. Consider this example:
13361 .code
13362 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13363                       192.168.53.235 ; \
13364                       3ffe:2101:12:1:a00:20ff:fe86:a061
13365
13366 extra_local_interfaces = <; ::0 ; 0.0.0.0
13367 .endd
13368 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13369 address, but all available interface addresses are treated as local when
13370 Exim is routing.
13371
13372 In some environments the local host name may be in an MX list, but with an IP
13373 address that is not assigned to any local interface. In other cases it may be
13374 desirable to treat other host names as if they referred to the local host. Both
13375 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13376 This contains host names rather than IP addresses. When a host is referenced
13377 during routing, either via an MX record or directly, it is treated as the local
13378 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13379 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13380
13381
13382
13383 .section "Delivering to a remote host" "SECID95"
13384 Delivery to a remote host is handled by the smtp transport. By default, it
13385 allows the system's TCP/IP functions to choose which interface to use (if
13386 there is more than one) when connecting to a remote host. However, the
13387 &%interface%& option can be set to specify which interface is used. See the
13388 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13389 details.
13390
13391
13392
13393
13394 . ////////////////////////////////////////////////////////////////////////////
13395 . ////////////////////////////////////////////////////////////////////////////
13396
13397 .chapter "Main configuration" "CHAPmainconfig"
13398 .scindex IIDconfima "configuration file" "main section"
13399 .scindex IIDmaiconf "main configuration"
13400 The first part of the run time configuration file contains three types of item:
13401
13402 .ilist
13403 Macro definitions: These lines start with an upper case letter. See section
13404 &<<SECTmacrodefs>>& for details of macro processing.
13405 .next
13406 Named list definitions: These lines start with one of the words &"domainlist"&,
13407 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13408 section &<<SECTnamedlists>>&.
13409 .next
13410 Main configuration settings: Each setting occupies one line of the file
13411 (with possible continuations). If any setting is preceded by the word
13412 &"hide"&, the &%-bP%& command line option displays its value to admin users
13413 only. See section &<<SECTcos>>& for a description of the syntax of these option
13414 settings.
13415 .endlist
13416
13417 This chapter specifies all the main configuration options, along with their
13418 types and default values. For ease of finding a particular option, they appear
13419 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13420 are now so many options, they are first listed briefly in functional groups, as
13421 an aid to finding the name of the option you are looking for. Some options are
13422 listed in more than one group.
13423
13424 .section "Miscellaneous" "SECID96"
13425 .table2
13426 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13427 .row &%disable_ipv6%&                "do no IPv6 processing"
13428 .row &%keep_malformed%&              "for broken files &-- should not happen"
13429 .row &%localhost_number%&            "for unique message ids in clusters"
13430 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13431 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13432 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13433 .row &%print_topbitchars%&           "top-bit characters are printing"
13434 .row &%timezone%&                    "force time zone"
13435 .endtable
13436
13437
13438 .section "Exim parameters" "SECID97"
13439 .table2
13440 .row &%exim_group%&                  "override compiled-in value"
13441 .row &%exim_path%&                   "override compiled-in value"
13442 .row &%exim_user%&                   "override compiled-in value"
13443 .row &%primary_hostname%&            "default from &[uname()]&"
13444 .row &%split_spool_directory%&       "use multiple directories"
13445 .row &%spool_directory%&             "override compiled-in value"
13446 .endtable
13447
13448
13449
13450 .section "Privilege controls" "SECID98"
13451 .table2
13452 .row &%admin_groups%&                "groups that are Exim admin users"
13453 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13454 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13455 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13456 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13457 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13458 .row &%never_users%&                 "do not run deliveries as these"
13459 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13460 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13461 .row &%trusted_groups%&              "groups that are trusted"
13462 .row &%trusted_users%&               "users that are trusted"
13463 .endtable
13464
13465
13466
13467 .section "Logging" "SECID99"
13468 .table2
13469 .row &%event_action%&                "custom logging"
13470 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13471 .row &%log_file_path%&               "override compiled-in value"
13472 .row &%log_selector%&                "set/unset optional logging"
13473 .row &%log_timezone%&                "add timezone to log lines"
13474 .row &%message_logs%&                "create per-message logs"
13475 .row &%preserve_message_logs%&       "after message completion"
13476 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13477 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13478 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13479 .row &%syslog_facility%&             "set syslog &""facility""& field"
13480 .row &%syslog_processname%&          "set syslog &""ident""& field"
13481 .row &%syslog_timestamp%&            "timestamp syslog lines"
13482 .row &%write_rejectlog%&             "control use of message log"
13483 .endtable
13484
13485
13486
13487 .section "Frozen messages" "SECID100"
13488 .table2
13489 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13490 .row &%freeze_tell%&                 "send message when freezing"
13491 .row &%move_frozen_messages%&        "to another directory"
13492 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13493 .endtable
13494
13495
13496
13497 .section "Data lookups" "SECID101"
13498 .table2
13499 .row &%ibase_servers%&               "InterBase servers"
13500 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13501 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13502 .row &%ldap_cert_file%&              "client cert file for LDAP"
13503 .row &%ldap_cert_key%&               "client key file for LDAP"
13504 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13505 .row &%ldap_default_servers%&        "used if no server in query"
13506 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13507 .row &%ldap_start_tls%&              "require TLS within LDAP"
13508 .row &%ldap_version%&                "set protocol version"
13509 .row &%lookup_open_max%&             "lookup files held open"
13510 .row &%mysql_servers%&               "default MySQL servers"
13511 .row &%oracle_servers%&              "Oracle servers"
13512 .row &%pgsql_servers%&               "default PostgreSQL servers"
13513 .row &%sqlite_lock_timeout%&         "as it says"
13514 .endtable
13515
13516
13517
13518 .section "Message ids" "SECID102"
13519 .table2
13520 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13521 .row &%message_id_header_text%&      "ditto"
13522 .endtable
13523
13524
13525
13526 .section "Embedded Perl Startup" "SECID103"
13527 .table2
13528 .row &%perl_at_start%&               "always start the interpreter"
13529 .row &%perl_startup%&                "code to obey when starting Perl"
13530 .row &%perl_taintmode%&              "enable taint mode in Perl"
13531 .endtable
13532
13533
13534
13535 .section "Daemon" "SECID104"
13536 .table2
13537 .row &%daemon_smtp_ports%&           "default ports"
13538 .row &%daemon_startup_retries%&      "number of times to retry"
13539 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13540 .row &%extra_local_interfaces%&      "not necessarily listened on"
13541 .row &%local_interfaces%&            "on which to listen, with optional ports"
13542 .row &%pid_file_path%&               "override compiled-in value"
13543 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13544 .endtable
13545
13546
13547
13548 .section "Resource control" "SECID105"
13549 .table2
13550 .row &%check_log_inodes%&            "before accepting a message"
13551 .row &%check_log_space%&             "before accepting a message"
13552 .row &%check_spool_inodes%&          "before accepting a message"
13553 .row &%check_spool_space%&           "before accepting a message"
13554 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13555 .row &%queue_only_load%&             "queue incoming if load high"
13556 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13557 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13558 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13559 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13560 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13561 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13562 .row &%smtp_accept_max_per_connection%& "messages per connection"
13563 .row &%smtp_accept_max_per_host%&    "connections from one host"
13564 .row &%smtp_accept_queue%&           "queue mail if more connections"
13565 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13566                                            connection"
13567 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13568 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13569 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13570 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13571 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13572 .endtable
13573
13574
13575
13576 .section "Policy controls" "SECID106"
13577 .table2
13578 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13579 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13580 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13581 .row &%acl_smtp_auth%&               "ACL for AUTH"
13582 .row &%acl_smtp_connect%&            "ACL for connection"
13583 .row &%acl_smtp_data%&               "ACL for DATA"
13584 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13585 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13586 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13587 .row &%acl_smtp_expn%&               "ACL for EXPN"
13588 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13589 .row &%acl_smtp_mail%&               "ACL for MAIL"
13590 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13591 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13592 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13593 .row &%acl_smtp_predata%&            "ACL for start of data"
13594 .row &%acl_smtp_quit%&               "ACL for QUIT"
13595 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13596 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13597 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13598 .row &%av_scanner%&                  "specify virus scanner"
13599 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13600                                       words""&"
13601 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13602 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13603 .row &%header_maxsize%&              "total size of message header"
13604 .row &%header_line_maxsize%&         "individual header line limit"
13605 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13606 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13607 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13608 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13609 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13610 .row &%host_lookup%&                 "host name looked up for these hosts"
13611 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13612 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13613 .row &%host_reject_connection%&      "reject connection from these hosts"
13614 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13615 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13616 .row &%message_size_limit%&          "for all messages"
13617 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13618 .row &%spamd_address%&               "set interface to SpamAssassin"
13619 .row &%strict_acl_vars%&             "object to unset ACL variables"
13620 .endtable
13621
13622
13623
13624 .section "Callout cache" "SECID107"
13625 .table2
13626 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13627                                          item"
13628 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13629                                          item"
13630 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13631 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13632 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13633 .endtable
13634
13635
13636
13637 .section "TLS" "SECID108"
13638 .table2
13639 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13640 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13641 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13642 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13643 .row &%tls_certificate%&             "location of server certificate"
13644 .row &%tls_crl%&                     "certificate revocation list"
13645 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13646 .row &%tls_dhparam%&                 "DH parameters for server"
13647 .row &%tls_eccurve%&                 "EC curve selection for server"
13648 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13649 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13650 .row &%tls_privatekey%&              "location of server private key"
13651 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13652 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13653 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13654 .row &%tls_verify_certificates%&     "expected client certificates"
13655 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13656 .endtable
13657
13658
13659
13660 .section "Local user handling" "SECID109"
13661 .table2
13662 .row &%finduser_retries%&            "useful in NIS environments"
13663 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13664 .row &%gecos_pattern%&               "ditto"
13665 .row &%max_username_length%&         "for systems that truncate"
13666 .row &%unknown_login%&               "used when no login name found"
13667 .row &%unknown_username%&            "ditto"
13668 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13669 .row &%uucp_from_sender%&            "ditto"
13670 .endtable
13671
13672
13673
13674 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13675 .table2
13676 .row &%header_maxsize%&              "total size of message header"
13677 .row &%header_line_maxsize%&         "individual header line limit"
13678 .row &%message_size_limit%&          "applies to all messages"
13679 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13680 .row &%received_header_text%&        "expanded to make &'Received:'&"
13681 .row &%received_headers_max%&        "for mail loop detection"
13682 .row &%recipients_max%&              "limit per message"
13683 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13684 .endtable
13685
13686
13687
13688
13689 .section "Non-SMTP incoming messages" "SECID111"
13690 .table2
13691 .row &%receive_timeout%&             "for non-SMTP messages"
13692 .endtable
13693
13694
13695
13696
13697
13698 .section "Incoming SMTP messages" "SECID112"
13699 See also the &'Policy controls'& section above.
13700
13701 .table2
13702 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13703 .row &%host_lookup%&                 "host name looked up for these hosts"
13704 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13705 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13706 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13707 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13708 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13709 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13710 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13711 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13712 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13713 .row &%smtp_accept_max_per_connection%& "messages per connection"
13714 .row &%smtp_accept_max_per_host%&    "connections from one host"
13715 .row &%smtp_accept_queue%&           "queue mail if more connections"
13716 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13717                                            connection"
13718 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13719 .row &%smtp_active_hostname%&        "host name to use in messages"
13720 .row &%smtp_banner%&                 "text for welcome banner"
13721 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13722 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13723 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13724 .row &%smtp_etrn_command%&           "what to run for ETRN"
13725 .row &%smtp_etrn_serialize%&         "only one at once"
13726 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13727 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13728 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13729 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13730 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13731 .row &%smtp_receive_timeout%&        "per command or data line"
13732 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13733 .row &%smtp_return_error_details%&   "give detail on rejections"
13734 .endtable
13735
13736
13737
13738 .section "SMTP extensions" "SECID113"
13739 .table2
13740 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13741 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13742 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13743 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13744 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13745 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13746 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13747 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13748 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13749 .endtable
13750
13751
13752
13753 .section "Processing messages" "SECID114"
13754 .table2
13755 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13756 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13757 .row &%allow_utf8_domains%&          "in addresses"
13758 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13759                                       words""&"
13760 .row &%delivery_date_remove%&        "from incoming messages"
13761 .row &%envelope_to_remove%&          "from incoming messages"
13762 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13763 .row &%headers_charset%&             "default for translations"
13764 .row &%qualify_domain%&              "default for senders"
13765 .row &%qualify_recipient%&           "default for recipients"
13766 .row &%return_path_remove%&          "from incoming messages"
13767 .row &%strip_excess_angle_brackets%& "in addresses"
13768 .row &%strip_trailing_dot%&          "at end of addresses"
13769 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13770 .endtable
13771
13772
13773
13774 .section "System filter" "SECID115"
13775 .table2
13776 .row &%system_filter%&               "locate system filter"
13777 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13778                                             directory"
13779 .row &%system_filter_file_transport%& "transport for delivery to a file"
13780 .row &%system_filter_group%&         "group for filter running"
13781 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13782 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13783 .row &%system_filter_user%&          "user for filter running"
13784 .endtable
13785
13786
13787
13788 .section "Routing and delivery" "SECID116"
13789 .table2
13790 .row &%disable_ipv6%&                "do no IPv6 processing"
13791 .row &%dns_again_means_nonexist%&    "for broken domains"
13792 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13793 .row &%dns_dnssec_ok%&               "parameter for resolver"
13794 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13795 .row &%dns_retrans%&                 "parameter for resolver"
13796 .row &%dns_retry%&                   "parameter for resolver"
13797 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13798 .row &%dns_use_edns0%&               "parameter for resolver"
13799 .row &%hold_domains%&                "hold delivery for these domains"
13800 .row &%local_interfaces%&            "for routing checks"
13801 .row &%queue_domains%&               "no immediate delivery for these"
13802 .row &%queue_only%&                  "no immediate delivery at all"
13803 .row &%queue_only_file%&             "no immediate delivery if file exists"
13804 .row &%queue_only_load%&             "no immediate delivery if load is high"
13805 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13806 .row &%queue_only_override%&         "allow command line to override"
13807 .row &%queue_run_in_order%&          "order of arrival"
13808 .row &%queue_run_max%&               "of simultaneous queue runners"
13809 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13810 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13811 .row &%remote_sort_domains%&         "order of remote deliveries"
13812 .row &%retry_data_expire%&           "timeout for retry data"
13813 .row &%retry_interval_max%&          "safety net for retry rules"
13814 .endtable
13815
13816
13817
13818 .section "Bounce and warning messages" "SECID117"
13819 .table2
13820 .row &%bounce_message_file%&         "content of bounce"
13821 .row &%bounce_message_text%&         "content of bounce"
13822 .row &%bounce_return_body%&          "include body if returning message"
13823 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13824 .row &%bounce_return_message%&       "include original message in bounce"
13825 .row &%bounce_return_size_limit%&    "limit on returned message"
13826 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13827 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13828 .row &%errors_copy%&                 "copy bounce messages"
13829 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13830 .row &%delay_warning%&               "time schedule"
13831 .row &%delay_warning_condition%&     "condition for warning messages"
13832 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13833 .row &%smtp_return_error_details%&   "give detail on rejections"
13834 .row &%warn_message_file%&           "content of warning message"
13835 .endtable
13836
13837
13838
13839 .section "Alphabetical list of main options" "SECTalomo"
13840 Those options that undergo string expansion before use are marked with
13841 &dagger;.
13842
13843 .option accept_8bitmime main boolean true
13844 .cindex "8BITMIME"
13845 .cindex "8-bit characters"
13846 .cindex "log" "selectors"
13847 .cindex "log" "8BITMIME"
13848 This option causes Exim to send 8BITMIME in its response to an SMTP
13849 EHLO command, and to accept the BODY= parameter on MAIL commands.
13850 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13851 takes no steps to do anything special with messages received by this route.
13852
13853 Historically Exim kept this option off by default, but the maintainers
13854 feel that in today's Internet, this causes more problems than it solves.
13855 It now defaults to true.
13856 A more detailed analysis of the issues is provided by Dan Bernstein:
13857 .display
13858 &url(http://cr.yp.to/smtp/8bitmime.html)
13859 .endd
13860
13861 To log received 8BITMIME status use
13862 .code
13863 log_selector = +8bitmime
13864 .endd
13865
13866 .option acl_not_smtp main string&!! unset
13867 .cindex "&ACL;" "for non-SMTP messages"
13868 .cindex "non-SMTP messages" "ACLs for"
13869 This option defines the ACL that is run when a non-SMTP message has been
13870 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13871 further details.
13872
13873 .option acl_not_smtp_mime main string&!! unset
13874 This option defines the ACL that is run for individual MIME parts of non-SMTP
13875 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13876 SMTP messages.
13877
13878 .option acl_not_smtp_start main string&!! unset
13879 .cindex "&ACL;" "at start of non-SMTP message"
13880 .cindex "non-SMTP messages" "ACLs for"
13881 This option defines the ACL that is run before Exim starts reading a
13882 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13883
13884 .option acl_smtp_auth main string&!! unset
13885 .cindex "&ACL;" "setting up for SMTP commands"
13886 .cindex "AUTH" "ACL for"
13887 This option defines the ACL that is run when an SMTP AUTH command is
13888 received. See chapter &<<CHAPACL>>& for further details.
13889
13890 .option acl_smtp_connect main string&!! unset
13891 .cindex "&ACL;" "on SMTP connection"
13892 This option defines the ACL that is run when an SMTP connection is received.
13893 See chapter &<<CHAPACL>>& for further details.
13894
13895 .option acl_smtp_data main string&!! unset
13896 .cindex "DATA" "ACL for"
13897 This option defines the ACL that is run after an SMTP DATA command has been
13898 processed and the message itself has been received, but before the final
13899 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13900
13901 .option acl_smtp_data_prdr main string&!! accept
13902 .cindex "PRDR" "ACL for"
13903 .cindex "DATA" "PRDR ACL for"
13904 .cindex "&ACL;" "PRDR-related"
13905 .cindex "&ACL;" "per-user data processing"
13906 This option defines the ACL that,
13907 if the PRDR feature has been negotiated,
13908 is run for each recipient after an SMTP DATA command has been
13909 processed and the message itself has been received, but before the
13910 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13911
13912 .option acl_smtp_dkim main string&!! unset
13913 .cindex DKIM "ACL for"
13914 This option defines the ACL that is run for each DKIM signature
13915 of a received message.
13916 See chapter &<<CHAPdkim>>& for further details.
13917
13918 .option acl_smtp_etrn main string&!! unset
13919 .cindex "ETRN" "ACL for"
13920 This option defines the ACL that is run when an SMTP ETRN command is
13921 received. See chapter &<<CHAPACL>>& for further details.
13922
13923 .option acl_smtp_expn main string&!! unset
13924 .cindex "EXPN" "ACL for"
13925 This option defines the ACL that is run when an SMTP EXPN command is
13926 received. See chapter &<<CHAPACL>>& for further details.
13927
13928 .option acl_smtp_helo main string&!! unset
13929 .cindex "EHLO" "ACL for"
13930 .cindex "HELO" "ACL for"
13931 This option defines the ACL that is run when an SMTP EHLO or HELO
13932 command is received. See chapter &<<CHAPACL>>& for further details.
13933
13934
13935 .option acl_smtp_mail main string&!! unset
13936 .cindex "MAIL" "ACL for"
13937 This option defines the ACL that is run when an SMTP MAIL command is
13938 received. See chapter &<<CHAPACL>>& for further details.
13939
13940 .option acl_smtp_mailauth main string&!! unset
13941 .cindex "AUTH" "on MAIL command"
13942 This option defines the ACL that is run when there is an AUTH parameter on
13943 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13944 &<<CHAPSMTPAUTH>>& for details of authentication.
13945
13946 .option acl_smtp_mime main string&!! unset
13947 .cindex "MIME content scanning" "ACL for"
13948 This option is available when Exim is built with the content-scanning
13949 extension. It defines the ACL that is run for each MIME part in a message. See
13950 section &<<SECTscanmimepart>>& for details.
13951
13952 .option acl_smtp_notquit main string&!! unset
13953 .cindex "not-QUIT, ACL for"
13954 This option defines the ACL that is run when an SMTP session
13955 ends without a QUIT command being received.
13956 See chapter &<<CHAPACL>>& for further details.
13957
13958 .option acl_smtp_predata main string&!! unset
13959 This option defines the ACL that is run when an SMTP DATA command is
13960 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13961 further details.
13962
13963 .option acl_smtp_quit main string&!! unset
13964 .cindex "QUIT, ACL for"
13965 This option defines the ACL that is run when an SMTP QUIT command is
13966 received. See chapter &<<CHAPACL>>& for further details.
13967
13968 .option acl_smtp_rcpt main string&!! unset
13969 .cindex "RCPT" "ACL for"
13970 This option defines the ACL that is run when an SMTP RCPT command is
13971 received. See chapter &<<CHAPACL>>& for further details.
13972
13973 .option acl_smtp_starttls main string&!! unset
13974 .cindex "STARTTLS, ACL for"
13975 This option defines the ACL that is run when an SMTP STARTTLS command is
13976 received. See chapter &<<CHAPACL>>& for further details.
13977
13978 .option acl_smtp_vrfy main string&!! unset
13979 .cindex "VRFY" "ACL for"
13980 This option defines the ACL that is run when an SMTP VRFY command is
13981 received. See chapter &<<CHAPACL>>& for further details.
13982
13983 .option add_environment main "string list" empty
13984 .cindex "environment" "set values"
13985 This option allows to set individual environment variables that the
13986 currently linked libraries and programs in child processes use.
13987 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
13988
13989 .option admin_groups main "string list&!!" unset
13990 .cindex "admin user"
13991 This option is expanded just once, at the start of Exim's processing. If the
13992 current group or any of the supplementary groups of an Exim caller is in this
13993 colon-separated list, the caller has admin privileges. If all your system
13994 programmers are in a specific group, for example, you can give them all Exim
13995 admin privileges by putting that group in &%admin_groups%&. However, this does
13996 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13997 To permit this, you have to add individuals to the Exim group.
13998
13999 .option allow_domain_literals main boolean false
14000 .cindex "domain literal"
14001 If this option is set, the RFC 2822 domain literal format is permitted in
14002 email addresses. The option is not set by default, because the domain literal
14003 format is not normally required these days, and few people know about it. It
14004 has, however, been exploited by mail abusers.
14005
14006 Unfortunately, it seems that some DNS black list maintainers are using this
14007 format to report black listing to postmasters. If you want to accept messages
14008 addressed to your hosts by IP address, you need to set
14009 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14010 domains (defined in the named domain list &%local_domains%& in the default
14011 configuration). This &"magic string"& matches the domain literal form of all
14012 the local host's IP addresses.
14013
14014
14015 .option allow_mx_to_ip main boolean false
14016 .cindex "MX record" "pointing to IP address"
14017 It appears that more and more DNS zone administrators are breaking the rules
14018 and putting domain names that look like IP addresses on the right hand side of
14019 MX records. Exim follows the rules and rejects this, giving an error message
14020 that explains the misconfiguration. However, some other MTAs support this
14021 practice, so to avoid &"Why can't Exim do this?"& complaints,
14022 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14023 recommended, except when you have no other choice.
14024
14025 .option allow_utf8_domains main boolean false
14026 .cindex "domain" "UTF-8 characters in"
14027 .cindex "UTF-8" "in domain name"
14028 Lots of discussion is going on about internationalized domain names. One
14029 camp is strongly in favour of just using UTF-8 characters, and it seems
14030 that at least two other MTAs permit this. This option allows Exim users to
14031 experiment if they wish.
14032
14033 If it is set true, Exim's domain parsing function allows valid
14034 UTF-8 multicharacters to appear in domain name components, in addition to
14035 letters, digits, and hyphens. However, just setting this option is not
14036 enough; if you want to look up these domain names in the DNS, you must also
14037 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14038 suitable setting is:
14039 .code
14040 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14041   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14042 .endd
14043 Alternatively, you can just disable this feature by setting
14044 .code
14045 dns_check_names_pattern =
14046 .endd
14047 That is, set the option to an empty string so that no check is done.
14048
14049
14050 .option auth_advertise_hosts main "host list&!!" *
14051 .cindex "authentication" "advertising"
14052 .cindex "AUTH" "advertising"
14053 If any server authentication mechanisms are configured, Exim advertises them in
14054 response to an EHLO command only if the calling host matches this list.
14055 Otherwise, Exim does not advertise AUTH.
14056 Exim does not accept AUTH commands from clients to which it has not
14057 advertised the availability of AUTH. The advertising of individual
14058 authentication mechanisms can be controlled by the use of the
14059 &%server_advertise_condition%& generic authenticator option on the individual
14060 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14061
14062 Certain mail clients (for example, Netscape) require the user to provide a name
14063 and password for authentication if AUTH is advertised, even though it may
14064 not be needed (the host may accept messages from hosts on its local LAN without
14065 authentication, for example). The &%auth_advertise_hosts%& option can be used
14066 to make these clients more friendly by excluding them from the set of hosts to
14067 which Exim advertises AUTH.
14068
14069 .cindex "AUTH" "advertising when encrypted"
14070 If you want to advertise the availability of AUTH only when the connection
14071 is encrypted using TLS, you can make use of the fact that the value of this
14072 option is expanded, with a setting like this:
14073 .code
14074 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14075 .endd
14076 .vindex "&$tls_in_cipher$&"
14077 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14078 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14079 expansion is *, which matches all hosts.
14080
14081
14082 .option auto_thaw main time 0s
14083 .cindex "thawing messages"
14084 .cindex "unfreezing messages"
14085 If this option is set to a time greater than zero, a queue runner will try a
14086 new delivery attempt on any frozen message, other than a bounce message, if
14087 this much time has passed since it was frozen. This may result in the message
14088 being re-frozen if nothing has changed since the last attempt. It is a way of
14089 saying &"keep on trying, even though there are big problems"&.
14090
14091 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14092 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14093 thought to be very useful any more, and its use should probably be avoided.
14094
14095
14096 .option av_scanner main string "see below"
14097 This option is available if Exim is built with the content-scanning extension.
14098 It specifies which anti-virus scanner to use. The default value is:
14099 .code
14100 sophie:/var/run/sophie
14101 .endd
14102 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14103 before use. See section &<<SECTscanvirus>>& for further details.
14104
14105
14106 .option bi_command main string unset
14107 .oindex "&%-bi%&"
14108 This option supplies the name of a command that is run when Exim is called with
14109 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14110 just the command name, it is not a complete command line. If an argument is
14111 required, it must come from the &%-oA%& command line option.
14112
14113
14114 .option bounce_message_file main string unset
14115 .cindex "bounce message" "customizing"
14116 .cindex "customizing" "bounce message"
14117 This option defines a template file containing paragraphs of text to be used
14118 for constructing bounce messages.  Details of the file's contents are given in
14119 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14120
14121
14122 .option bounce_message_text main string unset
14123 When this option is set, its contents are included in the default bounce
14124 message immediately after &"This message was created automatically by mail
14125 delivery software."& It is not used if &%bounce_message_file%& is set.
14126
14127 .option bounce_return_body main boolean true
14128 .cindex "bounce message" "including body"
14129 This option controls whether the body of an incoming message is included in a
14130 bounce message when &%bounce_return_message%& is true. The default setting
14131 causes the entire message, both header and body, to be returned (subject to the
14132 value of &%bounce_return_size_limit%&). If this option is false, only the
14133 message header is included. In the case of a non-SMTP message containing an
14134 error that is detected during reception, only those header lines preceding the
14135 point at which the error was detected are returned.
14136 .cindex "bounce message" "including original"
14137
14138 .option bounce_return_linesize_limit main integer 998
14139 .cindex "size" "of bounce lines, limit"
14140 .cindex "bounce message" "line length limit"
14141 .cindex "limit" "bounce message line length"
14142 This option sets a limit in bytes on the line length of messages
14143 that are returned to senders due to delivery problems,
14144 when &%bounce_return_message%& is true.
14145 The default value corresponds to RFC limits.
14146 If the message being returned has lines longer than this value it is
14147 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14148
14149 The option also applies to bounces returned when an error is detected
14150 during reception of a message.
14151 In this case lines from the original are truncated.
14152
14153 The option does not apply to messages generated by an &(autoreply)& transport.
14154
14155
14156 .option bounce_return_message main boolean true
14157 If this option is set false, none of the original message is included in
14158 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14159 &%bounce_return_body%&.
14160
14161
14162 .option bounce_return_size_limit main integer 100K
14163 .cindex "size" "of bounce, limit"
14164 .cindex "bounce message" "size limit"
14165 .cindex "limit" "bounce message size"
14166 This option sets a limit in bytes on the size of messages that are returned to
14167 senders as part of bounce messages when &%bounce_return_message%& is true. The
14168 limit should be less than the value of the global &%message_size_limit%& and of
14169 any &%message_size_limit%& settings on transports, to allow for the bounce text
14170 that Exim generates. If this option is set to zero there is no limit.
14171
14172 When the body of any message that is to be included in a bounce message is
14173 greater than the limit, it is truncated, and a comment pointing this out is
14174 added at the top. The actual cutoff may be greater than the value given, owing
14175 to the use of buffering for transferring the message in chunks (typically 8K in
14176 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14177 messages.
14178
14179 .option bounce_sender_authentication main string unset
14180 .cindex "bounce message" "sender authentication"
14181 .cindex "authentication" "bounce message"
14182 .cindex "AUTH" "on bounce message"
14183 This option provides an authenticated sender address that is sent with any
14184 bounce messages generated by Exim that are sent over an authenticated SMTP
14185 connection. A typical setting might be:
14186 .code
14187 bounce_sender_authentication = mailer-daemon@my.domain.example
14188 .endd
14189 which would cause bounce messages to be sent using the SMTP command:
14190 .code
14191 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14192 .endd
14193 The value of &%bounce_sender_authentication%& must always be a complete email
14194 address.
14195
14196 .option callout_domain_negative_expire main time 3h
14197 .cindex "caching" "callout timeouts"
14198 .cindex "callout" "caching timeouts"
14199 This option specifies the expiry time for negative callout cache data for a
14200 domain. See section &<<SECTcallver>>& for details of callout verification, and
14201 section &<<SECTcallvercache>>& for details of the caching.
14202
14203
14204 .option callout_domain_positive_expire main time 7d
14205 This option specifies the expiry time for positive callout cache data for a
14206 domain. See section &<<SECTcallver>>& for details of callout verification, and
14207 section &<<SECTcallvercache>>& for details of the caching.
14208
14209
14210 .option callout_negative_expire main time 2h
14211 This option specifies the expiry time for negative callout cache data for an
14212 address. See section &<<SECTcallver>>& for details of callout verification, and
14213 section &<<SECTcallvercache>>& for details of the caching.
14214
14215
14216 .option callout_positive_expire main time 24h
14217 This option specifies the expiry time for positive callout cache data for an
14218 address. See section &<<SECTcallver>>& for details of callout verification, and
14219 section &<<SECTcallvercache>>& for details of the caching.
14220
14221
14222 .option callout_random_local_part main string&!! "see below"
14223 This option defines the &"random"& local part that can be used as part of
14224 callout verification. The default value is
14225 .code
14226 $primary_hostname-$tod_epoch-testing
14227 .endd
14228 See section &<<CALLaddparcall>>& for details of how this value is used.
14229
14230
14231 .option check_log_inodes main integer 0
14232 See &%check_spool_space%& below.
14233
14234
14235 .option check_log_space main integer 0
14236 See &%check_spool_space%& below.
14237
14238 .oindex "&%check_rfc2047_length%&"
14239 .cindex "RFC 2047" "disabling length check"
14240 .option check_rfc2047_length main boolean true
14241 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14242 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14243 word; strings to be encoded that exceed this length are supposed to use
14244 multiple encoded words. By default, Exim does not recognize encoded words that
14245 exceed the maximum length. However, it seems that some software, in violation
14246 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14247 set false, Exim recognizes encoded words of any length.
14248
14249
14250 .option check_spool_inodes main integer 0
14251 See &%check_spool_space%& below.
14252
14253
14254 .option check_spool_space main integer 0
14255 .cindex "checking disk space"
14256 .cindex "disk space, checking"
14257 .cindex "spool directory" "checking space"
14258 The four &%check_...%& options allow for checking of disk resources before a
14259 message is accepted.
14260
14261 .vindex "&$log_inodes$&"
14262 .vindex "&$log_space$&"
14263 .vindex "&$spool_inodes$&"
14264 .vindex "&$spool_space$&"
14265 When any of these options are set, they apply to all incoming messages. If you
14266 want to apply different checks to different kinds of message, you can do so by
14267 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14268 &$spool_space$& in an ACL with appropriate additional conditions.
14269
14270
14271 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14272 either value is greater than zero, for example:
14273 .code
14274 check_spool_space = 10M
14275 check_spool_inodes = 100
14276 .endd
14277 The spool partition is the one that contains the directory defined by
14278 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14279 transit.
14280
14281 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14282 files are written if either is greater than zero. These should be set only if
14283 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14284
14285 If there is less space or fewer inodes than requested, Exim refuses to accept
14286 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14287 error response to the MAIL command. If ESMTP is in use and there was a
14288 SIZE parameter on the MAIL command, its value is added to the
14289 &%check_spool_space%& value, and the check is performed even if
14290 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14291
14292 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14293 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14294
14295 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14296 failure a message is written to stderr and Exim exits with a non-zero code, as
14297 it obviously cannot send an error message of any kind.
14298
14299 .option daemon_smtp_ports main string &`smtp`&
14300 .cindex "port" "for daemon"
14301 .cindex "TCP/IP" "setting listening ports"
14302 This option specifies one or more default SMTP ports on which the Exim daemon
14303 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14304 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14305
14306 .option daemon_startup_retries main integer 9
14307 .cindex "daemon startup, retrying"
14308 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14309 the daemon at startup when it cannot immediately bind a listening socket
14310 (typically because the socket is already in use): &%daemon_startup_retries%&
14311 defines the number of retries after the first failure, and
14312 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14313
14314 .option daemon_startup_sleep main time 30s
14315 See &%daemon_startup_retries%&.
14316
14317 .option delay_warning main "time list" 24h
14318 .cindex "warning of delay"
14319 .cindex "delay warning, specifying"
14320 When a message is delayed, Exim sends a warning message to the sender at
14321 intervals specified by this option. The data is a colon-separated list of times
14322 after which to send warning messages. If the value of the option is an empty
14323 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14324 message has been on the queue for longer than the last time, the last interval
14325 between the times is used to compute subsequent warning times. For example,
14326 with
14327 .code
14328 delay_warning = 4h:8h:24h
14329 .endd
14330 the first message is sent after 4 hours, the second after 8 hours, and
14331 the third one after 24 hours. After that, messages are sent every 16 hours,
14332 because that is the interval between the last two times on the list. If you set
14333 just one time, it specifies the repeat interval. For example, with:
14334 .code
14335 delay_warning = 6h
14336 .endd
14337 messages are repeated every six hours. To stop warnings after a given time, set
14338 a very large time at the end of the list. For example:
14339 .code
14340 delay_warning = 2h:12h:99d
14341 .endd
14342 Note that the option is only evaluated at the time a delivery attempt fails,
14343 which depends on retry and queue-runner configuration.
14344 Typically retries will be configured more frequently than warning messages.
14345
14346 .option delay_warning_condition main string&!! "see below"
14347 .vindex "&$domain$&"
14348 The string is expanded at the time a warning message might be sent. If all the
14349 deferred addresses have the same domain, it is set in &$domain$& during the
14350 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14351 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14352 &"false"& (the comparison being done caselessly) then the warning message is
14353 not sent. The default is:
14354 .code
14355 delay_warning_condition = ${if or {\
14356   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14357   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14358   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14359   } {no}{yes}}
14360 .endd
14361 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14362 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14363 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14364 &"auto-replied"& in an &'Auto-Submitted:'& header.
14365
14366 .option deliver_drop_privilege main boolean false
14367 .cindex "unprivileged delivery"
14368 .cindex "delivery" "unprivileged"
14369 If this option is set true, Exim drops its root privilege at the start of a
14370 delivery process, and runs as the Exim user throughout. This severely restricts
14371 the kinds of local delivery that are possible, but is viable in certain types
14372 of configuration. There is a discussion about the use of root privilege in
14373 chapter &<<CHAPsecurity>>&.
14374
14375 .option deliver_queue_load_max main fixed-point unset
14376 .cindex "load average"
14377 .cindex "queue runner" "abandoning"
14378 When this option is set, a queue run is abandoned if the system load average
14379 becomes greater than the value of the option. The option has no effect on
14380 ancient operating systems on which Exim cannot determine the load average.
14381 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14382
14383
14384 .option delivery_date_remove main boolean true
14385 .cindex "&'Delivery-date:'& header line"
14386 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14387 message when it is delivered, in exactly the same way as &'Return-path:'& is
14388 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14389 should not be present in incoming messages, and this option causes them to be
14390 removed at the time the message is received, to avoid any problems that might
14391 occur when a delivered message is subsequently sent on to some other recipient.
14392
14393 .option disable_fsync main boolean false
14394 .cindex "&[fsync()]&, disabling"
14395 This option is available only if Exim was built with the compile-time option
14396 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14397 a runtime configuration generates an &"unknown option"& error. You should not
14398 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14399 really, really, really understand what you are doing. &'No pre-compiled
14400 distributions of Exim should ever make this option available.'&
14401
14402 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14403 updated files' data to be written to disc before continuing. Unexpected events
14404 such as crashes and power outages may cause data to be lost or scrambled.
14405 Here be Dragons. &*Beware.*&
14406
14407
14408 .option disable_ipv6 main boolean false
14409 .cindex "IPv6" "disabling"
14410 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14411 activities take place. AAAA records are never looked up, and any IPv6 addresses
14412 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14413 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14414 to handle IPv6 literal addresses.
14415
14416
14417 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14418 .cindex DKIM "controlling calls to the ACL"
14419 This option gives a list of DKIM domains for which the DKIM ACL is run.
14420 It is expanded after the message is received; by default it runs
14421 the ACL once for each signature in the message.
14422 See chapter &<<CHAPdkim>>&.
14423
14424
14425 .option dns_again_means_nonexist main "domain list&!!" unset
14426 .cindex "DNS" "&""try again""& response; overriding"
14427 DNS lookups give a &"try again"& response for the DNS errors
14428 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14429 keep trying to deliver a message, or to give repeated temporary errors to
14430 incoming mail. Sometimes the effect is caused by a badly set up name server and
14431 may persist for a long time. If a domain which exhibits this problem matches
14432 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14433 This option should be used with care. You can make it apply to reverse lookups
14434 by a setting such as this:
14435 .code
14436 dns_again_means_nonexist = *.in-addr.arpa
14437 .endd
14438 This option applies to all DNS lookups that Exim does. It also applies when the
14439 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14440 since these are most likely to be caused by DNS lookup problems. The
14441 &(dnslookup)& router has some options of its own for controlling what happens
14442 when lookups for MX or SRV records give temporary errors. These more specific
14443 options are applied after this global option.
14444
14445 .option dns_check_names_pattern main string "see below"
14446 .cindex "DNS" "pre-check of name syntax"
14447 When this option is set to a non-empty string, it causes Exim to check domain
14448 names for characters that are not allowed in host names before handing them to
14449 the DNS resolver, because some resolvers give temporary errors for names that
14450 contain unusual characters. If a domain name contains any unwanted characters,
14451 a &"not found"& result is forced, and the resolver is not called. The check is
14452 done by matching the domain name against a regular expression, which is the
14453 value of this option. The default pattern is
14454 .code
14455 dns_check_names_pattern = \
14456   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14457 .endd
14458 which permits only letters, digits, slashes, and hyphens in components, but
14459 they must start and end with a letter or digit. Slashes are not, in fact,
14460 permitted in host names, but they are found in certain NS records (which can be
14461 accessed in Exim by using a &%dnsdb%& lookup). If you set
14462 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14463 empty string.
14464
14465 .option dns_csa_search_limit main integer 5
14466 This option controls the depth of parental searching for CSA SRV records in the
14467 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14468
14469 .option dns_csa_use_reverse main boolean true
14470 This option controls whether or not an IP address, given as a CSA domain, is
14471 reversed and looked up in the reverse DNS, as described in more detail in
14472 section &<<SECTverifyCSA>>&.
14473
14474
14475 .option dns_dnssec_ok main integer -1
14476 .cindex "DNS" "resolver options"
14477 .cindex "DNS" "DNSSEC"
14478 If this option is set to a non-negative number then Exim will initialise the
14479 DNS resolver library to either use or not use DNSSEC, overriding the system
14480 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14481
14482 If the resolver library does not support DNSSEC then this option has no effect.
14483
14484
14485 .option dns_ipv4_lookup main "domain list&!!" unset
14486 .cindex "IPv6" "DNS lookup for AAAA records"
14487 .cindex "DNS" "IPv6 lookup for AAAA records"
14488 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14489 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14490 (A records) when trying to find IP addresses for hosts, unless the host's
14491 domain matches this list.
14492
14493 This is a fudge to help with name servers that give big delays or otherwise do
14494 not work for the AAAA record type. In due course, when the world's name
14495 servers have all been upgraded, there should be no need for this option.
14496
14497
14498 .option dns_retrans main time 0s
14499 .cindex "DNS" "resolver options"
14500 .cindex timeout "dns lookup"
14501 .cindex "DNS" timeout
14502 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14503 retransmission and retry parameters for DNS lookups. Values of zero (the
14504 defaults) leave the system default settings unchanged. The first value is the
14505 time between retries, and the second is the number of retries. It isn't
14506 totally clear exactly how these settings affect the total time a DNS lookup may
14507 take. I haven't found any documentation about timeouts on DNS lookups; these
14508 parameter values are available in the external resolver interface structure,
14509 but nowhere does it seem to describe how they are used or what you might want
14510 to set in them.
14511 See also the &%slow_lookup_log%& option.
14512
14513
14514 .option dns_retry main integer 0
14515 See &%dns_retrans%& above.
14516
14517
14518 .option dns_trust_aa main "domain list&!!" unset
14519 .cindex "DNS" "resolver options"
14520 .cindex "DNS" "DNSSEC"
14521 If this option is set then lookup results marked with the AA bit
14522 (Authoritative Answer) are trusted the same way as if they were
14523 DNSSEC-verified. The authority section's name of the answer must
14524 match with this expanded domain list.
14525
14526 Use this option only if you talk directly to a resolver that is
14527 authoritative for some zones and does not set the AD (Authentic Data)
14528 bit in the answer. Some DNS servers may have an configuration option to
14529 mark the answers from their own zones as verified (they set the AD bit).
14530 Others do not have this option. It is considered as poor practice using
14531 a resolver that is an authoritative server for some zones.
14532
14533 Use this option only if you really have to (e.g. if you want
14534 to use DANE for remote delivery to a server that is listed in the DNS
14535 zones that your resolver is authoritative for).
14536
14537 If the DNS answer packet has the AA bit set and contains resource record
14538 in the answer section, the name of the first NS record appearing in the
14539 authority section is compared against the list. If the answer packet is
14540 authoritative but the answer section is empty, the name of the first SOA
14541 record in the authoritative section is used instead.
14542
14543 .cindex "DNS" "resolver options"
14544 .option dns_use_edns0 main integer -1
14545 .cindex "DNS" "resolver options"
14546 .cindex "DNS" "EDNS0"
14547 If this option is set to a non-negative number then Exim will initialise the
14548 DNS resolver library to either use or not use EDNS0 extensions, overriding
14549 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14550 on.
14551
14552 If the resolver library does not support EDNS0 then this option has no effect.
14553
14554
14555 .option drop_cr main boolean false
14556 This is an obsolete option that is now a no-op. It used to affect the way Exim
14557 handled CR and LF characters in incoming messages. What happens now is
14558 described in section &<<SECTlineendings>>&.
14559
14560 .option dsn_advertise_hosts main "host list&!!" unset
14561 .cindex "bounce messages" "success"
14562 .cindex "DSN" "success"
14563 .cindex "Delivery Status Notification" "success"
14564 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14565 and accepted from, these hosts.
14566 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14567 and RET and ORCPT options on MAIL FROM commands.
14568 A NOTIFY=SUCCESS option requests success-DSN messages.
14569 A NOTIFY= option with no argument requests that no delay or failure DSNs
14570 are sent.
14571
14572 .option dsn_from main "string&!!" "see below"
14573 .cindex "&'From:'& header line" "in bounces"
14574 .cindex "bounce messages" "&'From:'& line, specifying"
14575 This option can be used to vary the contents of &'From:'& header lines in
14576 bounces and other automatically generated messages (&"Delivery Status
14577 Notifications"& &-- hence the name of the option). The default setting is:
14578 .code
14579 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14580 .endd
14581 The value is expanded every time it is needed. If the expansion fails, a
14582 panic is logged, and the default value is used.
14583
14584 .option envelope_to_remove main boolean true
14585 .cindex "&'Envelope-to:'& header line"
14586 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14587 message when it is delivered, in exactly the same way as &'Return-path:'& is
14588 handled. &'Envelope-to:'& records the original recipient address from the
14589 message's envelope that caused the delivery to happen. Such headers should not
14590 be present in incoming messages, and this option causes them to be removed at
14591 the time the message is received, to avoid any problems that might occur when a
14592 delivered message is subsequently sent on to some other recipient.
14593
14594
14595 .option errors_copy main "string list&!!" unset
14596 .cindex "bounce message" "copy to other address"
14597 .cindex "copy of bounce message"
14598 Setting this option causes Exim to send bcc copies of bounce messages that it
14599 generates to other addresses. &*Note*&: This does not apply to bounce messages
14600 coming from elsewhere. The value of the option is a colon-separated list of
14601 items. Each item consists of a pattern, terminated by white space, followed by
14602 a comma-separated list of email addresses. If a pattern contains spaces, it
14603 must be enclosed in double quotes.
14604
14605 Each pattern is processed in the same way as a single item in an address list
14606 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14607 the bounce message, the message is copied to the addresses on the list. The
14608 items are scanned in order, and once a matching one is found, no further items
14609 are examined. For example:
14610 .code
14611 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14612               rqps@mydomain   hostmaster@mydomain.example,\
14613                               postmaster@mydomain.example
14614 .endd
14615 .vindex "&$domain$&"
14616 .vindex "&$local_part$&"
14617 The address list is expanded before use. The expansion variables &$local_part$&
14618 and &$domain$& are set from the original recipient of the error message, and if
14619 there was any wildcard matching in the pattern, the expansion
14620 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14621 variables &$0$&, &$1$&, etc. are set in the normal way.
14622
14623
14624 .option errors_reply_to main string unset
14625 .cindex "bounce message" "&'Reply-to:'& in"
14626 By default, Exim's bounce and delivery warning messages contain the header line
14627 .display
14628 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14629 .endd
14630 .oindex &%quota_warn_message%&
14631 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14632 A warning message that is generated by the &%quota_warn_message%& option in an
14633 &(appendfile)& transport may contain its own &'From:'& header line that
14634 overrides the default.
14635
14636 Experience shows that people reply to bounce messages. If the
14637 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14638 and warning messages. For example:
14639 .code
14640 errors_reply_to = postmaster@my.domain.example
14641 .endd
14642 The value of the option is not expanded. It must specify a valid RFC 2822
14643 address. However, if a warning message that is generated by the
14644 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14645 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14646 not used.
14647
14648
14649 .option event_action main string&!! unset
14650 .cindex events
14651 This option declares a string to be expanded for Exim's events mechanism.
14652 For details see &<<CHAPevents>>&.
14653
14654
14655 .option exim_group main string "compile-time configured"
14656 .cindex "gid (group id)" "Exim's own"
14657 .cindex "Exim group"
14658 This option changes the gid under which Exim runs when it gives up root
14659 privilege. The default value is compiled into the binary. The value of this
14660 option is used only when &%exim_user%& is also set. Unless it consists entirely
14661 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14662 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14663 security issues.
14664
14665
14666 .option exim_path main string "see below"
14667 .cindex "Exim binary, path name"
14668 This option specifies the path name of the Exim binary, which is used when Exim
14669 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14670 the directory configured at compile time by the BIN_DIRECTORY setting. It
14671 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14672 other place.
14673 &*Warning*&: Do not use a macro to define the value of this option, because
14674 you will break those Exim utilities that scan the configuration file to find
14675 where the binary is. (They then use the &%-bP%& option to extract option
14676 settings such as the value of &%spool_directory%&.)
14677
14678
14679 .option exim_user main string "compile-time configured"
14680 .cindex "uid (user id)" "Exim's own"
14681 .cindex "Exim user"
14682 This option changes the uid under which Exim runs when it gives up root
14683 privilege. The default value is compiled into the binary. Ownership of the run
14684 time configuration file and the use of the &%-C%& and &%-D%& command line
14685 options is checked against the values in the binary, not what is set here.
14686
14687 Unless it consists entirely of digits, the string is looked up using
14688 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14689 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14690 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14691
14692
14693 .option extra_local_interfaces main "string list" unset
14694 This option defines network interfaces that are to be considered local when
14695 routing, but which are not used for listening by the daemon. See section
14696 &<<SECTreclocipadd>>& for details.
14697
14698
14699 . Allow this long option name to split; give it unsplit as a fifth argument
14700 . for the automatic .oindex that is generated by .option.
14701
14702 .option "extract_addresses_remove_arguments" main boolean true &&&
14703          extract_addresses_remove_arguments
14704 .oindex "&%-t%&"
14705 .cindex "command line" "addresses with &%-t%&"
14706 .cindex "Sendmail compatibility" "&%-t%& option"
14707 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14708 are present on the command line when the &%-t%& option is used to build an
14709 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14710 line addresses are removed from the recipients list. This is also how Smail
14711 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14712 command line addresses are added to those obtained from the header lines. When
14713 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14714 argument headers. If it is set false, Exim adds rather than removes argument
14715 addresses.
14716
14717
14718 .option finduser_retries main integer 0
14719 .cindex "NIS, retrying user lookups"
14720 On systems running NIS or other schemes in which user and group information is
14721 distributed from a remote system, there can be times when &[getpwnam()]& and
14722 related functions fail, even when given valid data, because things time out.
14723 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14724 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14725 many extra times to find a user or a group, waiting for one second between
14726 retries.
14727
14728 .cindex "&_/etc/passwd_&" "multiple reading of"
14729 You should not set this option greater than zero if your user information is in
14730 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14731 search the file multiple times for non-existent users, and also cause delay.
14732
14733
14734
14735 .option freeze_tell main "string list, comma separated" unset
14736 .cindex "freezing messages" "sending a message when freezing"
14737 On encountering certain errors, or when configured to do so in a system filter,
14738 ACL, or special router, Exim freezes a message. This means that no further
14739 delivery attempts take place until an administrator thaws the message, or the
14740 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14741 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14742 warning message whenever it freezes something, unless the message it is
14743 freezing is a locally-generated bounce message. (Without this exception there
14744 is the possibility of looping.) The warning message is sent to the addresses
14745 supplied as the comma-separated value of this option. If several of the
14746 message's addresses cause freezing, only a single message is sent. If the
14747 freezing was automatic, the reason(s) for freezing can be found in the message
14748 log. If you configure freezing in a filter or ACL, you must arrange for any
14749 logging that you require.
14750
14751
14752 .option gecos_name main string&!! unset
14753 .cindex "HP-UX"
14754 .cindex "&""gecos""& field, parsing"
14755 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14756 password file to hold other information in addition to users' real names. Exim
14757 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14758 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14759 of the field are used unchanged, except that, if an ampersand is encountered,
14760 it is replaced by the user's login name with the first character forced to
14761 upper case, since this is a convention that is observed on many systems.
14762
14763 When these options are set, &%gecos_pattern%& is treated as a regular
14764 expression that is to be applied to the field (again with && replaced by the
14765 login name), and if it matches, &%gecos_name%& is expanded and used as the
14766 user's name.
14767
14768 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14769 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14770 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14771 name terminates at the first comma, the following can be used:
14772 .code
14773 gecos_pattern = ([^,]*)
14774 gecos_name = $1
14775 .endd
14776
14777 .option gecos_pattern main string unset
14778 See &%gecos_name%& above.
14779
14780
14781 .option gnutls_compat_mode main boolean unset
14782 This option controls whether GnuTLS is used in compatibility mode in an Exim
14783 server. This reduces security slightly, but improves interworking with older
14784 implementations of TLS.
14785
14786
14787 option gnutls_allow_auto_pkcs11 main boolean unset
14788 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14789 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14790
14791 See
14792 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14793 for documentation.
14794
14795
14796
14797 .option headers_charset main string "see below"
14798 This option sets a default character set for translating from encoded MIME
14799 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14800 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14801 ultimate default is ISO-8859-1. For more details see the description of header
14802 insertions in section &<<SECTexpansionitems>>&.
14803
14804
14805
14806 .option header_maxsize main integer "see below"
14807 .cindex "header section" "maximum size of"
14808 .cindex "limit" "size of message header section"
14809 This option controls the overall maximum size of a message's header
14810 section. The default is the value of HEADER_MAXSIZE in
14811 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14812 sections are rejected.
14813
14814
14815 .option header_line_maxsize main integer 0
14816 .cindex "header lines" "maximum size of"
14817 .cindex "limit" "size of one header line"
14818 This option limits the length of any individual header line in a message, after
14819 all the continuations have been joined together. Messages with individual
14820 header lines that are longer than the limit are rejected. The default value of
14821 zero means &"no limit"&.
14822
14823
14824
14825
14826 .option helo_accept_junk_hosts main "host list&!!" unset
14827 .cindex "HELO" "accepting junk data"
14828 .cindex "EHLO" "accepting junk data"
14829 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14830 mail, and gives an error response for invalid data. Unfortunately, there are
14831 some SMTP clients that send syntactic junk. They can be accommodated by setting
14832 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14833 if you want to do semantic checking.
14834 See also &%helo_allow_chars%& for a way of extending the permitted character
14835 set.
14836
14837
14838 .option helo_allow_chars main string unset
14839 .cindex "HELO" "underscores in"
14840 .cindex "EHLO" "underscores in"
14841 .cindex "underscore in EHLO/HELO"
14842 This option can be set to a string of rogue characters that are permitted in
14843 all EHLO and HELO names in addition to the standard letters, digits,
14844 hyphens, and dots. If you really must allow underscores, you can set
14845 .code
14846 helo_allow_chars = _
14847 .endd
14848 Note that the value is one string, not a list.
14849
14850
14851 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14852 .cindex "HELO" "forcing reverse lookup"
14853 .cindex "EHLO" "forcing reverse lookup"
14854 If the domain given by a client in a HELO or EHLO command matches this
14855 list, a reverse lookup is done in order to establish the host's true name. The
14856 default forces a lookup if the client host gives the server's name or any of
14857 its IP addresses (in brackets), something that broken clients have been seen to
14858 do.
14859
14860
14861 .option helo_try_verify_hosts main "host list&!!" unset
14862 .cindex "HELO verifying" "optional"
14863 .cindex "EHLO" "verifying, optional"
14864 By default, Exim just checks the syntax of HELO and EHLO commands (see
14865 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14866 to do more extensive checking of the data supplied by these commands. The ACL
14867 condition &`verify = helo`& is provided to make this possible.
14868 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14869 to force the check to occur. From release 4.53 onwards, this is no longer
14870 necessary. If the check has not been done before &`verify = helo`& is
14871 encountered, it is done at that time. Consequently, this option is obsolete.
14872 Its specification is retained here for backwards compatibility.
14873
14874 When an EHLO or HELO command is received, if the calling host matches
14875 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14876 EHLO command either:
14877
14878 .ilist
14879 is an IP literal matching the calling address of the host, or
14880 .next
14881 .cindex "DNS" "reverse lookup"
14882 .cindex "reverse DNS lookup"
14883 matches the host name that Exim obtains by doing a reverse lookup of the
14884 calling host address, or
14885 .next
14886 when looked up in DNS yields the calling host address.
14887 .endlist
14888
14889 However, the EHLO or HELO command is not rejected if any of the checks
14890 fail. Processing continues, but the result of the check is remembered, and can
14891 be detected later in an ACL by the &`verify = helo`& condition.
14892
14893 If DNS was used for successful verification, the variable
14894 .cindex "DNS" "DNSSEC"
14895 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14896
14897 .option helo_verify_hosts main "host list&!!" unset
14898 .cindex "HELO verifying" "mandatory"
14899 .cindex "EHLO" "verifying, mandatory"
14900 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14901 backwards compatibility. For hosts that match this option, Exim checks the host
14902 name given in the HELO or EHLO in the same way as for
14903 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14904 rejected with a 550 error, and entries are written to the main and reject logs.
14905 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14906 error.
14907
14908 .option hold_domains main "domain list&!!" unset
14909 .cindex "domain" "delaying delivery"
14910 .cindex "delivery" "delaying certain domains"
14911 This option allows mail for particular domains to be held on the queue
14912 manually. The option is overridden if a message delivery is forced with the
14913 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14914 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14915 item in &%hold_domains%&, no routing or delivery for that address is done, and
14916 it is deferred every time the message is looked at.
14917
14918 This option is intended as a temporary operational measure for delaying the
14919 delivery of mail while some problem is being sorted out, or some new
14920 configuration tested. If you just want to delay the processing of some
14921 domains until a queue run occurs, you should use &%queue_domains%& or
14922 &%queue_smtp_domains%&, not &%hold_domains%&.
14923
14924 A setting of &%hold_domains%& does not override Exim's code for removing
14925 messages from the queue if they have been there longer than the longest retry
14926 time in any retry rule. If you want to hold messages for longer than the normal
14927 retry times, insert a dummy retry rule with a long retry time.
14928
14929
14930 .option host_lookup main "host list&!!" unset
14931 .cindex "host name" "lookup, forcing"
14932 Exim does not look up the name of a calling host from its IP address unless it
14933 is required to compare against some host list, or the host matches
14934 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14935 option (which normally contains IP addresses rather than host names). The
14936 default configuration file contains
14937 .code
14938 host_lookup = *
14939 .endd
14940 which causes a lookup to happen for all hosts. If the expense of these lookups
14941 is felt to be too great, the setting can be changed or removed.
14942
14943 After a successful reverse lookup, Exim does a forward lookup on the name it
14944 has obtained, to verify that it yields the IP address that it started with. If
14945 this check fails, Exim behaves as if the name lookup failed.
14946
14947 .vindex "&$host_lookup_failed$&"
14948 .vindex "&$sender_host_name$&"
14949 After any kind of failure, the host name (in &$sender_host_name$&) remains
14950 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14951 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14952 &`verify = reverse_host_lookup`& in ACLs.
14953
14954
14955 .option host_lookup_order main "string list" &`bydns:byaddr`&
14956 This option specifies the order of different lookup methods when Exim is trying
14957 to find a host name from an IP address. The default is to do a DNS lookup
14958 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14959 if that fails. You can change the order of these lookups, or omit one entirely,
14960 if you want.
14961
14962 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14963 multiple PTR records in the DNS and the IP address is not listed in
14964 &_/etc/hosts_&. Different operating systems give different results in this
14965 case. That is why the default tries a DNS lookup first.
14966
14967
14968
14969 .option host_reject_connection main "host list&!!" unset
14970 .cindex "host" "rejecting connections from"
14971 If this option is set, incoming SMTP calls from the hosts listed are rejected
14972 as soon as the connection is made.
14973 This option is obsolete, and retained only for backward compatibility, because
14974 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14975 connections immediately.
14976
14977 The ability to give an immediate rejection (either by this option or using an
14978 ACL) is provided for use in unusual cases. Many hosts will just try again,
14979 sometimes without much delay. Normally, it is better to use an ACL to reject
14980 incoming messages at a later stage, such as after RCPT commands. See
14981 chapter &<<CHAPACL>>&.
14982
14983
14984 .option hosts_connection_nolog main "host list&!!" unset
14985 .cindex "host" "not logging connections from"
14986 This option defines a list of hosts for which connection logging does not
14987 happen, even though the &%smtp_connection%& log selector is set. For example,
14988 you might want not to log SMTP connections from local processes, or from
14989 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14990 the daemon; you should therefore strive to restrict its value to a short inline
14991 list of IP addresses and networks. To disable logging SMTP connections from
14992 local processes, you must create a host list with an empty item. For example:
14993 .code
14994 hosts_connection_nolog = :
14995 .endd
14996 If the &%smtp_connection%& log selector is not set, this option has no effect.
14997
14998
14999
15000 .option hosts_proxy main "host list&!!" unset
15001 .cindex proxy "proxy protocol"
15002 This option enables use of Proxy Protocol proxies for incoming
15003 connections.  For details see &<<SECTproxyInbound>>&.
15004
15005
15006 .option hosts_treat_as_local main "domain list&!!" unset
15007 .cindex "local host" "domains treated as"
15008 .cindex "host" "treated as local"
15009 If this option is set, any host names that match the domain list are treated as
15010 if they were the local host when Exim is scanning host lists obtained from MX
15011 records
15012 or other sources. Note that the value of this option is a domain list, not a
15013 host list, because it is always used to check host names, not IP addresses.
15014
15015 This option also applies when Exim is matching the special items
15016 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15017 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15018 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15019 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15020 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15021 interfaces and recognizing the local host.
15022
15023
15024 .option ibase_servers main "string list" unset
15025 .cindex "InterBase" "server list"
15026 This option provides a list of InterBase servers and associated connection data,
15027 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15028 The option is available only if Exim has been built with InterBase support.
15029
15030
15031
15032 .option ignore_bounce_errors_after main time 10w
15033 .cindex "bounce message" "discarding"
15034 .cindex "discarding bounce message"
15035 This option affects the processing of bounce messages that cannot be delivered,
15036 that is, those that suffer a permanent delivery failure. (Bounce messages that
15037 suffer temporary delivery failures are of course retried in the usual way.)
15038
15039 After a permanent delivery failure, bounce messages are frozen,
15040 because there is no sender to whom they can be returned. When a frozen bounce
15041 message has been on the queue for more than the given time, it is unfrozen at
15042 the next queue run, and a further delivery is attempted. If delivery fails
15043 again, the bounce message is discarded. This makes it possible to keep failed
15044 bounce messages around for a shorter time than the normal maximum retry time
15045 for frozen messages. For example,
15046 .code
15047 ignore_bounce_errors_after = 12h
15048 .endd
15049 retries failed bounce message deliveries after 12 hours, discarding any further
15050 failures. If the value of this option is set to a zero time period, bounce
15051 failures are discarded immediately. Setting a very long time (as in the default
15052 value) has the effect of disabling this option. For ways of automatically
15053 dealing with other kinds of frozen message, see &%auto_thaw%& and
15054 &%timeout_frozen_after%&.
15055
15056
15057 .option ignore_fromline_hosts main "host list&!!" unset
15058 .cindex "&""From""& line"
15059 .cindex "UUCP" "&""From""& line"
15060 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15061 the headers of a message. By default this is treated as the start of the
15062 message's body, which means that any following headers are not recognized as
15063 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15064 match those hosts that insist on sending it. If the sender is actually a local
15065 process rather than a remote host, and is using &%-bs%& to inject the messages,
15066 &%ignore_fromline_local%& must be set to achieve this effect.
15067
15068
15069 .option ignore_fromline_local main boolean false
15070 See &%ignore_fromline_hosts%& above.
15071
15072 .option keep_environment main "string list" unset
15073 .cindex "environment" "values from"
15074 This option contains a string list of environment variables to keep.
15075 You have to trust these variables or you have to be sure that
15076 these variables do not impose any security risk. Keep in mind that
15077 during the startup phase Exim is running with an effective UID 0 in most
15078 installations. As the default value is an empty list, the default
15079 environment for using libraries, running embedded Perl code, or running
15080 external binaries is empty, and does not not even contain PATH or HOME.
15081
15082 Actually the list is interpreted as a list of patterns
15083 (&<<SECTlistexpand>>&), except that it is not expanded first.
15084
15085 WARNING: Macro substitution is still done first, so having a macro
15086 FOO and having FOO_HOME in your &%keep_environment%& option may have
15087 unexpected results. You may work around this using a regular expression
15088 that does not match the macro name: ^[F]OO_HOME$.
15089
15090 Current versions of Exim issue a warning during startup if you do not mention
15091 &%keep_environment%& in your runtime configuration file and if your
15092 current environment is not empty. Future versions may not issue that warning
15093 anymore.
15094
15095 See the &%add_environment%& main config option for a way to set
15096 environment variables to a fixed value.  The environment for &(pipe)&
15097 transports is handled separately, see section &<<SECTpipeenv>>& for
15098 details.
15099
15100
15101 .option keep_malformed main time 4d
15102 This option specifies the length of time to keep messages whose spool files
15103 have been corrupted in some way. This should, of course, never happen. At the
15104 next attempt to deliver such a message, it gets removed. The incident is
15105 logged.
15106
15107
15108 .option ldap_ca_cert_dir main string unset
15109 .cindex "LDAP", "TLS CA certificate directory"
15110 .cindex certificate "directory for LDAP"
15111 This option indicates which directory contains CA certificates for verifying
15112 a TLS certificate presented by an LDAP server.
15113 While Exim does not provide a default value, your SSL library may.
15114 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15115 and constrained to be a directory.
15116
15117
15118 .option ldap_ca_cert_file main string unset
15119 .cindex "LDAP", "TLS CA certificate file"
15120 .cindex certificate "file for LDAP"
15121 This option indicates which file contains CA certificates for verifying
15122 a TLS certificate presented by an LDAP server.
15123 While Exim does not provide a default value, your SSL library may.
15124 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15125 and constrained to be a file.
15126
15127
15128 .option ldap_cert_file main string unset
15129 .cindex "LDAP" "TLS client certificate file"
15130 .cindex certificate "file for LDAP"
15131 This option indicates which file contains an TLS client certificate which
15132 Exim should present to the LDAP server during TLS negotiation.
15133 Should be used together with &%ldap_cert_key%&.
15134
15135
15136 .option ldap_cert_key main string unset
15137 .cindex "LDAP" "TLS client key file"
15138 .cindex certificate "key for LDAP"
15139 This option indicates which file contains the secret/private key to use
15140 to prove identity to the LDAP server during TLS negotiation.
15141 Should be used together with &%ldap_cert_file%&, which contains the
15142 identity to be proven.
15143
15144
15145 .option ldap_cipher_suite main string unset
15146 .cindex "LDAP" "TLS cipher suite"
15147 This controls the TLS cipher-suite negotiation during TLS negotiation with
15148 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15149 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15150
15151
15152 .option ldap_default_servers main "string list" unset
15153 .cindex "LDAP" "default servers"
15154 This option provides a list of LDAP servers which are tried in turn when an
15155 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15156 details of LDAP queries. This option is available only when Exim has been built
15157 with LDAP support.
15158
15159
15160 .option ldap_require_cert main string unset.
15161 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15162 This should be one of the values "hard", "demand", "allow", "try" or "never".
15163 A value other than one of these is interpreted as "never".
15164 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15165 Although Exim does not set a default, the LDAP library probably defaults
15166 to hard/demand.
15167
15168
15169 .option ldap_start_tls main boolean false
15170 .cindex "LDAP" "whether or not to negotiate TLS"
15171 If set, Exim will attempt to negotiate TLS with the LDAP server when
15172 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15173 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15174 of SSL-on-connect.
15175 In the event of failure to negotiate TLS, the action taken is controlled
15176 by &%ldap_require_cert%&.
15177
15178
15179 .option ldap_version main integer unset
15180 .cindex "LDAP" "protocol version, forcing"
15181 This option can be used to force Exim to set a specific protocol version for
15182 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15183 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15184 the LDAP headers; otherwise it is 2. This option is available only when Exim
15185 has been built with LDAP support.
15186
15187
15188
15189 .option local_from_check main boolean true
15190 .cindex "&'Sender:'& header line" "disabling addition of"
15191 .cindex "&'From:'& header line" "disabling checking of"
15192 When a message is submitted locally (that is, not over a TCP/IP connection) by
15193 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15194 checks that the &'From:'& header line matches the login of the calling user and
15195 the domain specified by &%qualify_domain%&.
15196
15197 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15198 locally submitted message is automatically qualified by Exim, unless the
15199 &%-bnq%& command line option is used.
15200
15201 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15202 on the local part. If the &'From:'& header line does not match, Exim adds a
15203 &'Sender:'& header with an address constructed from the calling user's login
15204 and the default qualify domain.
15205
15206 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15207 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15208 &'Sender:'& header lines supplied by untrusted users, you must also set
15209 &%local_sender_retain%& to be true.
15210
15211 .cindex "envelope sender"
15212 These options affect only the header lines in the message. The envelope sender
15213 is still forced to be the login id at the qualify domain unless
15214 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15215
15216 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15217 request similar header line checking. See section &<<SECTthesenhea>>&, which
15218 has more details about &'Sender:'& processing.
15219
15220
15221
15222
15223 .option local_from_prefix main string unset
15224 When Exim checks the &'From:'& header line of locally submitted messages for
15225 matching the login id (see &%local_from_check%& above), it can be configured to
15226 ignore certain prefixes and suffixes in the local part of the address. This is
15227 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15228 appropriate lists, in the same form as the &%local_part_prefix%& and
15229 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15230 example, if
15231 .code
15232 local_from_prefix = *-
15233 .endd
15234 is set, a &'From:'& line containing
15235 .code
15236 From: anything-user@your.domain.example
15237 .endd
15238 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15239 matches the actual sender address that is constructed from the login name and
15240 qualify domain.
15241
15242
15243 .option local_from_suffix main string unset
15244 See &%local_from_prefix%& above.
15245
15246
15247 .option local_interfaces main "string list" "see below"
15248 This option controls which network interfaces are used by the daemon for
15249 listening; they are also used to identify the local host when routing. Chapter
15250 &<<CHAPinterfaces>>& contains a full description of this option and the related
15251 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15252 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15253 &%local_interfaces%& is
15254 .code
15255 local_interfaces = 0.0.0.0
15256 .endd
15257 when Exim is built without IPv6 support; otherwise it is
15258 .code
15259 local_interfaces = <; ::0 ; 0.0.0.0
15260 .endd
15261
15262 .option local_scan_timeout main time 5m
15263 .cindex "timeout" "for &[local_scan()]& function"
15264 .cindex "&[local_scan()]& function" "timeout"
15265 This timeout applies to the &[local_scan()]& function (see chapter
15266 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15267 the incoming message is rejected with a temporary error if it is an SMTP
15268 message. For a non-SMTP message, the message is dropped and Exim ends with a
15269 non-zero code. The incident is logged on the main and reject logs.
15270
15271
15272
15273 .option local_sender_retain main boolean false
15274 .cindex "&'Sender:'& header line" "retaining from local submission"
15275 When a message is submitted locally (that is, not over a TCP/IP connection) by
15276 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15277 do not want this to happen, you must set &%local_sender_retain%&, and you must
15278 also set &%local_from_check%& to be false (Exim will complain if you do not).
15279 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15280 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15281
15282
15283
15284
15285 .option localhost_number main string&!! unset
15286 .cindex "host" "locally unique number for"
15287 .cindex "message ids" "with multiple hosts"
15288 .vindex "&$localhost_number$&"
15289 Exim's message ids are normally unique only within the local host. If
15290 uniqueness among a set of hosts is required, each host must set a different
15291 value for the &%localhost_number%& option. The string is expanded immediately
15292 after reading the configuration file (so that a number can be computed from the
15293 host name, for example) and the result of the expansion must be a number in the
15294 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15295 systems). This is available in subsequent string expansions via the variable
15296 &$localhost_number$&. When &%localhost_number is set%&, the final two
15297 characters of the message id, instead of just being a fractional part of the
15298 time, are computed from the time and the local host number as described in
15299 section &<<SECTmessiden>>&.
15300
15301
15302
15303 .option log_file_path main "string list&!!" "set at compile time"
15304 .cindex "log" "file path for"
15305 This option sets the path which is used to determine the names of Exim's log
15306 files, or indicates that logging is to be to syslog, or both. It is expanded
15307 when Exim is entered, so it can, for example, contain a reference to the host
15308 name. If no specific path is set for the log files at compile or run time,
15309 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15310 they are written in a sub-directory called &_log_& in Exim's spool directory.
15311 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15312 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15313 used. If this string is fixed at your installation (contains no expansion
15314 variables) it is recommended that you do not set this option in the
15315 configuration file, but instead supply the path using LOG_FILE_PATH in
15316 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15317 early on &-- in particular, failure to read the configuration file.
15318
15319
15320 .option log_selector main string unset
15321 .cindex "log" "selectors"
15322 This option can be used to reduce or increase the number of things that Exim
15323 writes to its log files. Its argument is made up of names preceded by plus or
15324 minus characters. For example:
15325 .code
15326 log_selector = +arguments -retry_defer
15327 .endd
15328 A list of possible names and what they control is given in the chapter on
15329 logging, in section &<<SECTlogselector>>&.
15330
15331
15332 .option log_timezone main boolean false
15333 .cindex "log" "timezone for entries"
15334 .vindex "&$tod_log$&"
15335 .vindex "&$tod_zone$&"
15336 By default, the timestamps on log lines are in local time without the
15337 timezone. This means that if your timezone changes twice a year, the timestamps
15338 in log lines are ambiguous for an hour when the clocks go back. One way of
15339 avoiding this problem is to set the timezone to UTC. An alternative is to set
15340 &%log_timezone%& true. This turns on the addition of the timezone offset to
15341 timestamps in log lines. Turning on this option can add quite a lot to the size
15342 of log files because each line is extended by 6 characters. Note that the
15343 &$tod_log$& variable contains the log timestamp without the zone, but there is
15344 another variable called &$tod_zone$& that contains just the timezone offset.
15345
15346
15347 .option lookup_open_max main integer 25
15348 .cindex "too many open files"
15349 .cindex "open files, too many"
15350 .cindex "file" "too many open"
15351 .cindex "lookup" "maximum open files"
15352 .cindex "limit" "open files for lookups"
15353 This option limits the number of simultaneously open files for single-key
15354 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15355 Exim normally keeps these files open during routing, because often the same
15356 file is required several times. If the limit is reached, Exim closes the least
15357 recently used file. Note that if you are using the &'ndbm'& library, it
15358 actually opens two files for each logical DBM database, though it still counts
15359 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15360 open files"& errors with NDBM, you need to reduce the value of
15361 &%lookup_open_max%&.
15362
15363
15364 .option max_username_length main integer 0
15365 .cindex "length of login name"
15366 .cindex "user name" "maximum length"
15367 .cindex "limit" "user name length"
15368 Some operating systems are broken in that they truncate long arguments to
15369 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15370 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15371 an argument that is longer behaves as if &[getpwnam()]& failed.
15372
15373
15374 .option message_body_newlines main bool false
15375 .cindex "message body" "newlines in variables"
15376 .cindex "newline" "in message body variables"
15377 .vindex "&$message_body$&"
15378 .vindex "&$message_body_end$&"
15379 By default, newlines in the message body are replaced by spaces when setting
15380 the &$message_body$& and &$message_body_end$& expansion variables. If this
15381 option is set true, this no longer happens.
15382
15383
15384 .option message_body_visible main integer 500
15385 .cindex "body of message" "visible size"
15386 .cindex "message body" "visible size"
15387 .vindex "&$message_body$&"
15388 .vindex "&$message_body_end$&"
15389 This option specifies how much of a message's body is to be included in the
15390 &$message_body$& and &$message_body_end$& expansion variables.
15391
15392
15393 .option message_id_header_domain main string&!! unset
15394 .cindex "&'Message-ID:'& header line"
15395 If this option is set, the string is expanded and used as the right hand side
15396 (domain) of the &'Message-ID:'& header that Exim creates if a
15397 locally-originated incoming message does not have one. &"Locally-originated"&
15398 means &"not received over TCP/IP."&
15399 Otherwise, the primary host name is used.
15400 Only letters, digits, dot and hyphen are accepted; any other characters are
15401 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15402 empty string, the option is ignored.
15403
15404
15405 .option message_id_header_text main string&!! unset
15406 If this variable is set, the string is expanded and used to augment the text of
15407 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15408 message does not have one. The text of this header is required by RFC 2822 to
15409 take the form of an address. By default, Exim uses its internal message id as
15410 the local part, and the primary host name as the domain. If this option is set,
15411 it is expanded, and provided the expansion is not forced to fail, and does not
15412 yield an empty string, the result is inserted into the header immediately
15413 before the @, separated from the internal message id by a dot. Any characters
15414 that are illegal in an address are automatically converted into hyphens. This
15415 means that variables such as &$tod_log$& can be used, because the spaces and
15416 colons will become hyphens.
15417
15418
15419 .option message_logs main boolean true
15420 .cindex "message logs" "disabling"
15421 .cindex "log" "message log; disabling"
15422 If this option is turned off, per-message log files are not created in the
15423 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15424 Exim, by reducing the number of files involved in handling a message from a
15425 minimum of four (header spool file, body spool file, delivery journal, and
15426 per-message log) to three. The other major I/O activity is Exim's main log,
15427 which is not affected by this option.
15428
15429
15430 .option message_size_limit main string&!! 50M
15431 .cindex "message" "size limit"
15432 .cindex "limit" "message size"
15433 .cindex "size" "of message, limit"
15434 This option limits the maximum size of message that Exim will process. The
15435 value is expanded for each incoming connection so, for example, it can be made
15436 to depend on the IP address of the remote host for messages arriving via
15437 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15438 optionally followed by K or M.
15439
15440 &*Note*&: This limit cannot be made to depend on a message's sender or any
15441 other properties of an individual message, because it has to be advertised in
15442 the server's response to EHLO. String expansion failure causes a temporary
15443 error. A value of zero means no limit, but its use is not recommended. See also
15444 &%bounce_return_size_limit%&.
15445
15446 Incoming SMTP messages are failed with a 552 error if the limit is
15447 exceeded; locally-generated messages either get a stderr message or a delivery
15448 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15449 an oversized message is logged in both the main and the reject logs. See also
15450 the generic transport option &%message_size_limit%&, which limits the size of
15451 message that an individual transport can process.
15452
15453 If you use a virus-scanner and set this option to to a value larger than the
15454 maximum size that your virus-scanner is configured to support, you may get
15455 failures triggered by large mails.  The right size to configure for the
15456 virus-scanner depends upon what data is passed and the options in use but it's
15457 probably safest to just set it to a little larger than this value.  E.g., with a
15458 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15459 some problems may result.
15460
15461 A value of 0 will disable size limit checking; Exim will still advertise the
15462 SIZE extension in an EHLO response, but without a limit, so as to permit
15463 SMTP clients to still indicate the message size along with the MAIL verb.
15464
15465
15466 .option move_frozen_messages main boolean false
15467 .cindex "frozen messages" "moving"
15468 This option, which is available only if Exim has been built with the setting
15469 .code
15470 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15471 .endd
15472 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15473 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15474 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15475 standard utilities for handling such moved messages, and they do not show up in
15476 lists generated by &%-bp%& or by the Exim monitor.
15477
15478
15479 .option mua_wrapper main boolean false
15480 Setting this option true causes Exim to run in a very restrictive mode in which
15481 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15482 contains a full description of this facility.
15483
15484
15485
15486 .option mysql_servers main "string list" unset
15487 .cindex "MySQL" "server list"
15488 This option provides a list of MySQL servers and associated connection data, to
15489 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15490 option is available only if Exim has been built with MySQL support.
15491
15492
15493 .option never_users main "string list&!!" unset
15494 This option is expanded just once, at the start of Exim's processing. Local
15495 message deliveries are normally run in processes that are setuid to the
15496 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15497 It is usually desirable to prevent any deliveries from running as root, as a
15498 safety precaution.
15499
15500 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15501 list of users that must not be used for local deliveries. This list is fixed in
15502 the binary and cannot be overridden by the configuration file. By default, it
15503 contains just the single user name &"root"&. The &%never_users%& runtime option
15504 can be used to add more users to the fixed list.
15505
15506 If a message is to be delivered as one of the users on the fixed list or the
15507 &%never_users%& list, an error occurs, and delivery is deferred. A common
15508 example is
15509 .code
15510 never_users = root:daemon:bin
15511 .endd
15512 Including root is redundant if it is also on the fixed list, but it does no
15513 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15514 transport driver.
15515
15516
15517 .option openssl_options main "string list" "+no_sslv2 +single_dh_use"
15518 .cindex "OpenSSL "compatibility options"
15519 This option allows an administrator to adjust the SSL options applied
15520 by OpenSSL to connections.  It is given as a space-separated list of items,
15521 each one to be +added or -subtracted from the current value.
15522
15523 This option is only available if Exim is built against OpenSSL.  The values
15524 available for this option vary according to the age of your OpenSSL install.
15525 The &"all"& value controls a subset of flags which are available, typically
15526 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15527 list the values known on your system and Exim should support all the
15528 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15529 names lose the leading &"SSL_OP_"& and are lower-cased.
15530
15531 Note that adjusting the options can have severe impact upon the security of
15532 SSL as used by Exim.  It is possible to disable safety checks and shoot
15533 yourself in the foot in various unpleasant ways.  This option should not be
15534 adjusted lightly.  An unrecognised item will be detected at startup, by
15535 invoking Exim with the &%-bV%& flag.
15536
15537 The option affects Exim operating both as a server and as a client.
15538
15539 Historical note: prior to release 4.80, Exim defaulted this value to
15540 "+dont_insert_empty_fragments", which may still be needed for compatibility
15541 with some clients, but which lowers security by increasing exposure to
15542 some now infamous attacks.
15543
15544 Examples:
15545 .code
15546 # Make both old MS and old Eudora happy:
15547 openssl_options = -all +microsoft_big_sslv3_buffer \
15548                        +dont_insert_empty_fragments
15549
15550 # Disable older protocol versions:
15551 openssl_options = +no_sslv2 +no_sslv3
15552 .endd
15553
15554 Possible options may include:
15555 .ilist
15556 &`all`&
15557 .next
15558 &`allow_unsafe_legacy_renegotiation`&
15559 .next
15560 &`cipher_server_preference`&
15561 .next
15562 &`dont_insert_empty_fragments`&
15563 .next
15564 &`ephemeral_rsa`&
15565 .next
15566 &`legacy_server_connect`&
15567 .next
15568 &`microsoft_big_sslv3_buffer`&
15569 .next
15570 &`microsoft_sess_id_bug`&
15571 .next
15572 &`msie_sslv2_rsa_padding`&
15573 .next
15574 &`netscape_challenge_bug`&
15575 .next
15576 &`netscape_reuse_cipher_change_bug`&
15577 .next
15578 &`no_compression`&
15579 .next
15580 &`no_session_resumption_on_renegotiation`&
15581 .next
15582 &`no_sslv2`&
15583 .next
15584 &`no_sslv3`&
15585 .next
15586 &`no_ticket`&
15587 .next
15588 &`no_tlsv1`&
15589 .next
15590 &`no_tlsv1_1`&
15591 .next
15592 &`no_tlsv1_2`&
15593 .next
15594 &`safari_ecdhe_ecdsa_bug`&
15595 .next
15596 &`single_dh_use`&
15597 .next
15598 &`single_ecdh_use`&
15599 .next
15600 &`ssleay_080_client_dh_bug`&
15601 .next
15602 &`sslref2_reuse_cert_type_bug`&
15603 .next
15604 &`tls_block_padding_bug`&
15605 .next
15606 &`tls_d5_bug`&
15607 .next
15608 &`tls_rollback_bug`&
15609 .endlist
15610
15611 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15612 all clients connecting using the MacOS SecureTransport TLS facility prior
15613 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15614 to negotiate TLS then this option value might help, provided that your OpenSSL
15615 release is new enough to contain this work-around.  This may be a situation
15616 where you have to upgrade OpenSSL to get buggy clients working.
15617
15618
15619 .option oracle_servers main "string list" unset
15620 .cindex "Oracle" "server list"
15621 This option provides a list of Oracle servers and associated connection data,
15622 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15623 The option is available only if Exim has been built with Oracle support.
15624
15625
15626 .option percent_hack_domains main "domain list&!!" unset
15627 .cindex "&""percent hack""&"
15628 .cindex "source routing" "in email address"
15629 .cindex "address" "source-routed"
15630 The &"percent hack"& is the convention whereby a local part containing a
15631 percent sign is re-interpreted as a new email address, with the percent
15632 replaced by @. This is sometimes called &"source routing"&, though that term is
15633 also applied to RFC 2822 addresses that begin with an @ character. If this
15634 option is set, Exim implements the percent facility for those domains listed,
15635 but no others. This happens before an incoming SMTP address is tested against
15636 an ACL.
15637
15638 &*Warning*&: The &"percent hack"& has often been abused by people who are
15639 trying to get round relaying restrictions. For this reason, it is best avoided
15640 if at all possible. Unfortunately, a number of less security-conscious MTAs
15641 implement it unconditionally. If you are running Exim on a gateway host, and
15642 routing mail through to internal MTAs without processing the local parts, it is
15643 a good idea to reject recipient addresses with percent characters in their
15644 local parts. Exim's default configuration does this.
15645
15646
15647 .option perl_at_start main boolean false
15648 .cindex "Perl"
15649 This option is available only when Exim is built with an embedded Perl
15650 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15651
15652
15653 .option perl_startup main string unset
15654 .cindex "Perl"
15655 This option is available only when Exim is built with an embedded Perl
15656 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15657
15658 .option perl_startup main boolean false
15659 .cindex "Perl"
15660 This Option enables the taint mode of the embedded Perl interpreter.
15661
15662
15663 .option pgsql_servers main "string list" unset
15664 .cindex "PostgreSQL lookup type" "server list"
15665 This option provides a list of PostgreSQL servers and associated connection
15666 data, to be used in conjunction with &(pgsql)& lookups (see section
15667 &<<SECID72>>&). The option is available only if Exim has been built with
15668 PostgreSQL support.
15669
15670
15671 .option pid_file_path main string&!! "set at compile time"
15672 .cindex "daemon" "pid file path"
15673 .cindex "pid file, path for"
15674 This option sets the name of the file to which the Exim daemon writes its
15675 process id. The string is expanded, so it can contain, for example, references
15676 to the host name:
15677 .code
15678 pid_file_path = /var/log/$primary_hostname/exim.pid
15679 .endd
15680 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15681 spool directory.
15682 The value set by the option can be overridden by the &%-oP%& command line
15683 option. A pid file is not written if a &"non-standard"& daemon is run by means
15684 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15685
15686
15687 .option pipelining_advertise_hosts main "host list&!!" *
15688 .cindex "PIPELINING" "suppressing advertising"
15689 This option can be used to suppress the advertisement of the SMTP
15690 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15691 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15692 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15693 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15694 that clients will use it; &"out of order"& commands that are &"expected"& do
15695 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15696
15697
15698 .option prdr_enable main boolean false
15699 .cindex "PRDR" "enabling on server"
15700 This option can be used to enable the Per-Recipient Data Response extension
15701 to SMTP, defined by Eric Hall.
15702 If the option is set, PRDR is advertised by Exim when operating as a server.
15703 If the client requests PRDR, and more than one recipient, for a message
15704 an additional ACL is called for each recipient after the message content
15705 is received.  See section &<<SECTPRDRACL>>&.
15706
15707 .option preserve_message_logs main boolean false
15708 .cindex "message logs" "preserving"
15709 If this option is set, message log files are not deleted when messages are
15710 completed. Instead, they are moved to a sub-directory of the spool directory
15711 called &_msglog.OLD_&, where they remain available for statistical or debugging
15712 purposes. This is a dangerous option to set on systems with any appreciable
15713 volume of mail. Use with care!
15714
15715
15716 .option primary_hostname main string "see below"
15717 .cindex "name" "of local host"
15718 .cindex "host" "name of local"
15719 .cindex "local host" "name of"
15720 .vindex "&$primary_hostname$&"
15721 This specifies the name of the current host. It is used in the default EHLO or
15722 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15723 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15724 The value is also used by default in some SMTP response messages from an Exim
15725 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15726
15727 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15728 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15729 contains only one component, Exim passes it to &[gethostbyname()]& (or
15730 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15731 version. The variable &$primary_hostname$& contains the host name, whether set
15732 explicitly by this option, or defaulted.
15733
15734
15735 .option print_topbitchars main boolean false
15736 .cindex "printing characters"
15737 .cindex "8-bit characters"
15738 By default, Exim considers only those characters whose codes lie in the range
15739 32&--126 to be printing characters. In a number of circumstances (for example,
15740 when writing log entries) non-printing characters are converted into escape
15741 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15742 is set, code values of 128 and above are also considered to be printing
15743 characters.
15744
15745 This option also affects the header syntax checks performed by the
15746 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15747 the user's full name when constructing From: and Sender: addresses (as
15748 described in section &<<SECTconstr>>&). Setting this option can cause
15749 Exim to generate eight bit message headers that do not conform to the
15750 standards.
15751
15752
15753 .option process_log_path main string unset
15754 .cindex "process log path"
15755 .cindex "log" "process log"
15756 .cindex "&'exiwhat'&"
15757 This option sets the name of the file to which an Exim process writes its
15758 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15759 utility script. If this option is unset, the file called &_exim-process.info_&
15760 in Exim's spool directory is used. The ability to specify the name explicitly
15761 can be useful in environments where two different Exims are running, using
15762 different spool directories.
15763
15764
15765 .option prod_requires_admin main boolean true
15766 .oindex "&%-M%&"
15767 .oindex "&%-R%&"
15768 .oindex "&%-q%&"
15769 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15770 admin user unless &%prod_requires_admin%& is set false. See also
15771 &%queue_list_requires_admin%&.
15772
15773
15774 .option qualify_domain main string "see below"
15775 .cindex "domain" "for qualifying addresses"
15776 .cindex "address" "qualification"
15777 This option specifies the domain name that is added to any envelope sender
15778 addresses that do not have a domain qualification. It also applies to
15779 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15780 are accepted by default only for locally-generated messages. Qualification is
15781 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15782 locally-generated messages, unless the &%-bnq%& command line option is used.
15783
15784 Messages from external sources must always contain fully qualified addresses,
15785 unless the sending host matches &%sender_unqualified_hosts%& or
15786 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15787 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15788 necessary. Internally, Exim always works with fully qualified envelope
15789 addresses. If &%qualify_domain%& is not set, it defaults to the
15790 &%primary_hostname%& value.
15791
15792
15793 .option qualify_recipient main string "see below"
15794 This option allows you to specify a different domain for qualifying recipient
15795 addresses to the one that is used for senders. See &%qualify_domain%& above.
15796
15797
15798
15799 .option queue_domains main "domain list&!!" unset
15800 .cindex "domain" "specifying non-immediate delivery"
15801 .cindex "queueing incoming messages"
15802 .cindex "message" "queueing certain domains"
15803 This option lists domains for which immediate delivery is not required.
15804 A delivery process is started whenever a message is received, but only those
15805 domains that do not match are processed. All other deliveries wait until the
15806 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15807
15808
15809 .option queue_list_requires_admin main boolean true
15810 .oindex "&%-bp%&"
15811 The &%-bp%& command-line option, which lists the messages that are on the
15812 queue, requires the caller to be an admin user unless
15813 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15814
15815
15816 .option queue_only main boolean false
15817 .cindex "queueing incoming messages"
15818 .cindex "message" "queueing unconditionally"
15819 If &%queue_only%& is set, a delivery process is not automatically started
15820 whenever a message is received. Instead, the message waits on the queue for the
15821 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15822 delivered immediately when certain conditions (such as heavy load) occur.
15823
15824 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15825 and &%-odi%& command line options override &%queue_only%& unless
15826 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15827 &%queue_only_load%&, and &%smtp_accept_queue%&.
15828
15829
15830 .option queue_only_file main string unset
15831 .cindex "queueing incoming messages"
15832 .cindex "message" "queueing by file existence"
15833 This option can be set to a colon-separated list of absolute path names, each
15834 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15835 it tests for the existence of each listed path using a call to &[stat()]&. For
15836 each path that exists, the corresponding queueing option is set.
15837 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15838 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15839 .code
15840 queue_only_file = smtp/some/file
15841 .endd
15842 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15843 &_/some/file_& exists.
15844
15845
15846 .option queue_only_load main fixed-point unset
15847 .cindex "load average"
15848 .cindex "queueing incoming messages"
15849 .cindex "message" "queueing by load"
15850 If the system load average is higher than this value, incoming messages from
15851 all sources are queued, and no automatic deliveries are started. If this
15852 happens during local or remote SMTP input, all subsequent messages received on
15853 the same SMTP connection are queued by default, whatever happens to the load in
15854 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15855 false.
15856
15857 Deliveries will subsequently be performed by queue runner processes. This
15858 option has no effect on ancient operating systems on which Exim cannot
15859 determine the load average. See also &%deliver_queue_load_max%& and
15860 &%smtp_load_reserve%&.
15861
15862
15863 .option queue_only_load_latch main boolean true
15864 .cindex "load average" "re-evaluating per message"
15865 When this option is true (the default), once one message has been queued
15866 because the load average is higher than the value set by &%queue_only_load%&,
15867 all subsequent messages received on the same SMTP connection are also queued.
15868 This is a deliberate choice; even though the load average may fall below the
15869 threshold, it doesn't seem right to deliver later messages on the same
15870 connection when not delivering earlier ones. However, there are special
15871 circumstances such as very long-lived connections from scanning appliances
15872 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15873 should be set false. This causes the value of the load average to be
15874 re-evaluated for each message.
15875
15876
15877 .option queue_only_override main boolean true
15878 .cindex "queueing incoming messages"
15879 When this option is true, the &%-od%&&'x'& command line options override the
15880 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15881 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15882 to override; they are accepted, but ignored.
15883
15884
15885 .option queue_run_in_order main boolean false
15886 .cindex "queue runner" "processing messages in order"
15887 If this option is set, queue runs happen in order of message arrival instead of
15888 in an arbitrary order. For this to happen, a complete list of the entire queue
15889 must be set up before the deliveries start. When the queue is all held in a
15890 single directory (the default), a single list is created for both the ordered
15891 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15892 single list is not created when &%queue_run_in_order%& is false. In this case,
15893 the sub-directories are processed one at a time (in a random order), and this
15894 avoids setting up one huge list for the whole queue. Thus, setting
15895 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15896 when the queue is large, because of the extra work in setting up the single,
15897 large list. In most situations, &%queue_run_in_order%& should not be set.
15898
15899
15900
15901 .option queue_run_max main integer 5
15902 .cindex "queue runner" "maximum number of"
15903 This controls the maximum number of queue runner processes that an Exim daemon
15904 can run simultaneously. This does not mean that it starts them all at once,
15905 but rather that if the maximum number are still running when the time comes to
15906 start another one, it refrains from starting another one. This can happen with
15907 very large queues and/or very sluggish deliveries. This option does not,
15908 however, interlock with other processes, so additional queue runners can be
15909 started by other means, or by killing and restarting the daemon.
15910
15911 Setting this option to zero does not suppress queue runs; rather, it disables
15912 the limit, allowing any number of simultaneous queue runner processes to be
15913 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15914 the daemon's command line.
15915
15916 .option queue_smtp_domains main "domain list&!!" unset
15917 .cindex "queueing incoming messages"
15918 .cindex "message" "queueing remote deliveries"
15919 When this option is set, a delivery process is started whenever a message is
15920 received, routing is performed, and local deliveries take place.
15921 However, if any SMTP deliveries are required for domains that match
15922 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15923 message waits on the queue for the next queue run. Since routing of the message
15924 has taken place, Exim knows to which remote hosts it must be delivered, and so
15925 when the queue run happens, multiple messages for the same host are delivered
15926 over a single SMTP connection. The &%-odqs%& command line option causes all
15927 SMTP deliveries to be queued in this way, and is equivalent to setting
15928 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15929 &%queue_domains%&.
15930
15931
15932 .option receive_timeout main time 0s
15933 .cindex "timeout" "for non-SMTP input"
15934 This option sets the timeout for accepting a non-SMTP message, that is, the
15935 maximum time that Exim waits when reading a message on the standard input. If
15936 the value is zero, it will wait for ever. This setting is overridden by the
15937 &%-or%& command line option. The timeout for incoming SMTP messages is
15938 controlled by &%smtp_receive_timeout%&.
15939
15940 .option received_header_text main string&!! "see below"
15941 .cindex "customizing" "&'Received:'& header"
15942 .cindex "&'Received:'& header line" "customizing"
15943 This string defines the contents of the &'Received:'& message header that is
15944 added to each message, except for the timestamp, which is automatically added
15945 on at the end (preceded by a semicolon). The string is expanded each time it is
15946 used. If the expansion yields an empty string, no &'Received:'& header line is
15947 added to the message. Otherwise, the string should start with the text
15948 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15949 header lines. The default setting is:
15950
15951 .code
15952 received_header_text = Received: \
15953   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15954   {${if def:sender_ident \
15955   {from ${quote_local_part:$sender_ident} }}\
15956   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15957   by $primary_hostname \
15958   ${if def:received_protocol {with $received_protocol}} \
15959   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15960   (Exim $version_number)\n\t\
15961   ${if def:sender_address \
15962   {(envelope-from <$sender_address>)\n\t}}\
15963   id $message_exim_id\
15964   ${if def:received_for {\n\tfor $received_for}}
15965 .endd
15966
15967 The reference to the TLS cipher is omitted when Exim is built without TLS
15968 support. The use of conditional expansions ensures that this works for both
15969 locally generated messages and messages received from remote hosts, giving
15970 header lines such as the following:
15971 .code
15972 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15973 by marley.carol.example with esmtp (Exim 4.00)
15974 (envelope-from <bob@carol.example>)
15975 id 16IOWa-00019l-00
15976 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15977 Received: by scrooge.carol.example with local (Exim 4.00)
15978 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15979 .endd
15980 Until the body of the message has been received, the timestamp is the time when
15981 the message started to be received. Once the body has arrived, and all policy
15982 checks have taken place, the timestamp is updated to the time at which the
15983 message was accepted.
15984
15985
15986 .option received_headers_max main integer 30
15987 .cindex "loop" "prevention"
15988 .cindex "mail loop prevention"
15989 .cindex "&'Received:'& header line" "counting"
15990 When a message is to be delivered, the number of &'Received:'& headers is
15991 counted, and if it is greater than this parameter, a mail loop is assumed to
15992 have occurred, the delivery is abandoned, and an error message is generated.
15993 This applies to both local and remote deliveries.
15994
15995
15996 .option recipient_unqualified_hosts main "host list&!!" unset
15997 .cindex "unqualified addresses"
15998 .cindex "host" "unqualified addresses from"
15999 This option lists those hosts from which Exim is prepared to accept unqualified
16000 recipient addresses in message envelopes. The addresses are made fully
16001 qualified by the addition of the &%qualify_recipient%& value. This option also
16002 affects message header lines. Exim does not reject unqualified recipient
16003 addresses in headers, but it qualifies them only if the message came from a
16004 host that matches &%recipient_unqualified_hosts%&,
16005 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16006 option was not set.
16007
16008
16009 .option recipients_max main integer 0
16010 .cindex "limit" "number of recipients"
16011 .cindex "recipient" "maximum number"
16012 If this option is set greater than zero, it specifies the maximum number of
16013 original recipients for any message. Additional recipients that are generated
16014 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16015 all recipients over the limit; earlier recipients are delivered as normal.
16016 Non-SMTP messages with too many recipients are failed, and no deliveries are
16017 done.
16018
16019 .cindex "RCPT" "maximum number of incoming"
16020 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16021 RCPT commands in a single message.
16022
16023
16024 .option recipients_max_reject main boolean false
16025 If this option is set true, Exim rejects SMTP messages containing too many
16026 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16027 error to the eventual DATA command. Otherwise (the default) it gives a 452
16028 error to the surplus RCPT commands and accepts the message on behalf of the
16029 initial set of recipients. The remote server should then re-send the message
16030 for the remaining recipients at a later time.
16031
16032
16033 .option remote_max_parallel main integer 2
16034 .cindex "delivery" "parallelism for remote"
16035 This option controls parallel delivery of one message to a number of remote
16036 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16037 does all the remote deliveries for a message one by one. Otherwise, if a single
16038 message has to be delivered to more than one remote host, or if several copies
16039 have to be sent to the same remote host, up to &%remote_max_parallel%&
16040 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16041 deliveries are required, the maximum number of processes are started, and as
16042 each one finishes, another is begun. The order of starting processes is the
16043 same as if sequential delivery were being done, and can be controlled by the
16044 &%remote_sort_domains%& option. If parallel delivery takes place while running
16045 with debugging turned on, the debugging output from each delivery process is
16046 tagged with its process id.
16047
16048 This option controls only the maximum number of parallel deliveries for one
16049 message in one Exim delivery process. Because Exim has no central queue
16050 manager, there is no way of controlling the total number of simultaneous
16051 deliveries if the configuration allows a delivery attempt as soon as a message
16052 is received.
16053
16054 .cindex "number of deliveries"
16055 .cindex "delivery" "maximum number of"
16056 If you want to control the total number of deliveries on the system, you
16057 need to set the &%queue_only%& option. This ensures that all incoming messages
16058 are added to the queue without starting a delivery process. Then set up an Exim
16059 daemon to start queue runner processes at appropriate intervals (probably
16060 fairly often, for example, every minute), and limit the total number of queue
16061 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16062 delivers only one message at a time, the maximum number of deliveries that can
16063 then take place at once is &%queue_run_max%& multiplied by
16064 &%remote_max_parallel%&.
16065
16066 If it is purely remote deliveries you want to control, use
16067 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16068 doing the SMTP routing before queueing, so that several messages for the same
16069 host will eventually get delivered down the same connection.
16070
16071
16072 .option remote_sort_domains main "domain list&!!" unset
16073 .cindex "sorting remote deliveries"
16074 .cindex "delivery" "sorting remote"
16075 When there are a number of remote deliveries for a message, they are sorted by
16076 domain into the order given by this list. For example,
16077 .code
16078 remote_sort_domains = *.cam.ac.uk:*.uk
16079 .endd
16080 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16081 then to those in the &%uk%& domain, then to any others.
16082
16083
16084 .option retry_data_expire main time 7d
16085 .cindex "hints database" "data expiry"
16086 This option sets a &"use before"& time on retry information in Exim's hints
16087 database. Any older retry data is ignored. This means that, for example, once a
16088 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16089 past failures.
16090
16091
16092 .option retry_interval_max main time 24h
16093 .cindex "retry" "limit on interval"
16094 .cindex "limit" "on retry interval"
16095 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16096 intervals between delivery attempts for messages that cannot be delivered
16097 straight away. This option sets an overall limit to the length of time between
16098 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16099 the default value.
16100
16101
16102 .option return_path_remove main boolean true
16103 .cindex "&'Return-path:'& header line" "removing"
16104 RFC 2821, section 4.4, states that an SMTP server must insert a
16105 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16106 The &'Return-path:'& header preserves the sender address as received in the
16107 MAIL command. This description implies that this header should not be present
16108 in an incoming message. If &%return_path_remove%& is true, any existing
16109 &'Return-path:'& headers are removed from messages at the time they are
16110 received. Exim's transports have options for adding &'Return-path:'& headers at
16111 the time of delivery. They are normally used only for final local deliveries.
16112
16113
16114 .option return_size_limit main integer 100K
16115 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16116
16117
16118 .option rfc1413_hosts main "host list&!!" @[]
16119 .cindex "RFC 1413"
16120 .cindex "host" "for RFC 1413 calls"
16121 RFC 1413 identification calls are made to any client host which matches
16122 an item in the list.
16123 The default value specifies just this host, being any local interface
16124 for the system.
16125
16126 .option rfc1413_query_timeout main time 0s
16127 .cindex "RFC 1413" "query timeout"
16128 .cindex "timeout" "for RFC 1413 call"
16129 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16130 no RFC 1413 calls are ever made.
16131
16132
16133 .option sender_unqualified_hosts main "host list&!!" unset
16134 .cindex "unqualified addresses"
16135 .cindex "host" "unqualified addresses from"
16136 This option lists those hosts from which Exim is prepared to accept unqualified
16137 sender addresses. The addresses are made fully qualified by the addition of
16138 &%qualify_domain%&. This option also affects message header lines. Exim does
16139 not reject unqualified addresses in headers that contain sender addresses, but
16140 it qualifies them only if the message came from a host that matches
16141 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16142 using TCP/IP), and the &%-bnq%& option was not set.
16143
16144 .option set_environment main "string list" empty
16145 .cindex "environment"
16146 This option allows to set individual environment variables that the
16147 currently linked libraries and programs in child processes use. The
16148 default list is empty,
16149
16150
16151 .option slow_lookup_log main integer 0
16152 .cindex "logging" "slow lookups"
16153 .cindex "dns" "logging slow lookups"
16154 This option controls logging of slow lookups.
16155 If the value is nonzero it is taken as a number of milliseconds
16156 and lookups taking longer than this are logged.
16157 Currently this applies only to DNS lookups.
16158
16159
16160
16161 .option smtp_accept_keepalive main boolean true
16162 .cindex "keepalive" "on incoming connection"
16163 This option controls the setting of the SO_KEEPALIVE option on incoming
16164 TCP/IP socket connections. When set, it causes the kernel to probe idle
16165 connections periodically, by sending packets with &"old"& sequence numbers. The
16166 other end of the connection should send an acknowledgment if the connection is
16167 still okay or a reset if the connection has been aborted. The reason for doing
16168 this is that it has the beneficial effect of freeing up certain types of
16169 connection that can get stuck when the remote host is disconnected without
16170 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16171 hours to detect unreachable hosts.
16172
16173
16174
16175 .option smtp_accept_max main integer 20
16176 .cindex "limit" "incoming SMTP connections"
16177 .cindex "SMTP" "incoming connection count"
16178 .cindex "inetd"
16179 This option specifies the maximum number of simultaneous incoming SMTP calls
16180 that Exim will accept. It applies only to the listening daemon; there is no
16181 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16182 value is set to zero, no limit is applied. However, it is required to be
16183 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16184 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16185
16186 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16187 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16188 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16189 and &%smtp_load_reserve%& are then checked before accepting the connection.
16190
16191
16192 .option smtp_accept_max_nonmail main integer 10
16193 .cindex "limit" "non-mail SMTP commands"
16194 .cindex "SMTP" "limiting non-mail commands"
16195 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16196 the connection if there are too many. This option defines &"too many"&. The
16197 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16198 client looping sending EHLO, for example. The check is applied only if the
16199 client host matches &%smtp_accept_max_nonmail_hosts%&.
16200
16201 When a new message is expected, one occurrence of RSET is not counted. This
16202 allows a client to send one RSET between messages (this is not necessary,
16203 but some clients do it). Exim also allows one uncounted occurrence of HELO
16204 or EHLO, and one occurrence of STARTTLS between messages. After
16205 starting up a TLS session, another EHLO is expected, and so it too is not
16206 counted. The first occurrence of AUTH in a connection, or immediately
16207 following STARTTLS is not counted. Otherwise, all commands other than
16208 MAIL, RCPT, DATA, and QUIT are counted.
16209
16210
16211 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16212 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16213 check by setting this option. The default value makes it apply to all hosts. By
16214 changing the value, you can exclude any badly-behaved hosts that you have to
16215 live with.
16216
16217
16218 . Allow this long option name to split; give it unsplit as a fifth argument
16219 . for the automatic .oindex that is generated by .option.
16220 . We insert " &~&~" which is both pretty nasty visually and results in
16221 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16222 . zero-width-space, which would be nicer visually and results in (at least)
16223 . html that Firefox will split on when it's forced to reflow (rather than
16224 . inserting a horizontal scrollbar).  However, the text is still not
16225 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16226 . the option name to split.
16227
16228 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16229          smtp_accept_max_per_connection
16230 .cindex "SMTP" "limiting incoming message count"
16231 .cindex "limit" "messages per SMTP connection"
16232 The value of this option limits the number of MAIL commands that Exim is
16233 prepared to accept over a single SMTP connection, whether or not each command
16234 results in the transfer of a message. After the limit is reached, a 421
16235 response is given to subsequent MAIL commands. This limit is a safety
16236 precaution against a client that goes mad (incidents of this type have been
16237 seen).
16238
16239
16240 .option smtp_accept_max_per_host main string&!! unset
16241 .cindex "limit" "SMTP connections from one host"
16242 .cindex "host" "limiting SMTP connections from"
16243 This option restricts the number of simultaneous IP connections from a single
16244 host (strictly, from a single IP address) to the Exim daemon. The option is
16245 expanded, to enable different limits to be applied to different hosts by
16246 reference to &$sender_host_address$&. Once the limit is reached, additional
16247 connection attempts from the same host are rejected with error code 421. This
16248 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16249 of zero imposes no limit. If this option is set greater than zero, it is
16250 required that &%smtp_accept_max%& be non-zero.
16251
16252 &*Warning*&: When setting this option you should not use any expansion
16253 constructions that take an appreciable amount of time. The expansion and test
16254 happen in the main daemon loop, in order to reject additional connections
16255 without forking additional processes (otherwise a denial-of-service attack
16256 could cause a vast number or processes to be created). While the daemon is
16257 doing this processing, it cannot accept any other incoming connections.
16258
16259
16260
16261 .option smtp_accept_queue main integer 0
16262 .cindex "SMTP" "incoming connection count"
16263 .cindex "queueing incoming messages"
16264 .cindex "message" "queueing by SMTP connection count"
16265 If the number of simultaneous incoming SMTP connections being handled via the
16266 listening daemon exceeds this value, messages received by SMTP are just placed
16267 on the queue; no delivery processes are started automatically. The count is
16268 fixed at the start of an SMTP connection. It cannot be updated in the
16269 subprocess that receives messages, and so the queueing or not queueing applies
16270 to all messages received in the same connection.
16271
16272 A value of zero implies no limit, and clearly any non-zero value is useful only
16273 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16274 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16275 various &%-od%&&'x'& command line options.
16276
16277
16278 . See the comment on smtp_accept_max_per_connection
16279
16280 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16281          smtp_accept_queue_per_connection
16282 .cindex "queueing incoming messages"
16283 .cindex "message" "queueing by message count"
16284 This option limits the number of delivery processes that Exim starts
16285 automatically when receiving messages via SMTP, whether via the daemon or by
16286 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16287 and the number of messages received in a single SMTP session exceeds this
16288 number, subsequent messages are placed on the queue, but no delivery processes
16289 are started. This helps to limit the number of Exim processes when a server
16290 restarts after downtime and there is a lot of mail waiting for it on other
16291 systems. On large systems, the default should probably be increased, and on
16292 dial-in client systems it should probably be set to zero (that is, disabled).
16293
16294
16295 .option smtp_accept_reserve main integer 0
16296 .cindex "SMTP" "incoming call count"
16297 .cindex "host" "reserved"
16298 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16299 number of SMTP connections that are reserved for connections from the hosts
16300 that are specified in &%smtp_reserve_hosts%&. The value set in
16301 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16302 restricted to this number of connections; the option specifies a minimum number
16303 of connection slots for them, not a maximum. It is a guarantee that this group
16304 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16305 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16306 individual host.
16307
16308 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16309 set to 5, once there are 45 active connections (from any hosts), new
16310 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16311 provided the other criteria for acceptance are met.
16312
16313
16314 .option smtp_active_hostname main string&!! unset
16315 .cindex "host" "name in SMTP responses"
16316 .cindex "SMTP" "host name in responses"
16317 .vindex "&$primary_hostname$&"
16318 This option is provided for multi-homed servers that want to masquerade as
16319 several different hosts. At the start of an incoming SMTP connection, its value
16320 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16321 responses. For example, it is used as domain name in the response to an
16322 incoming HELO or EHLO command.
16323
16324 .vindex "&$smtp_active_hostname$&"
16325 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16326 is saved with any messages that are received. It is therefore available for use
16327 in routers and transports when the message is later delivered.
16328
16329 If this option is unset, or if its expansion is forced to fail, or if the
16330 expansion results in an empty string, the value of &$primary_hostname$& is
16331 used. Other expansion failures cause a message to be written to the main and
16332 panic logs, and the SMTP command receives a temporary error. Typically, the
16333 value of &%smtp_active_hostname%& depends on the incoming interface address.
16334 For example:
16335 .code
16336 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16337   {cox.mydomain}{box.mydomain}}
16338 .endd
16339
16340 Although &$smtp_active_hostname$& is primarily concerned with incoming
16341 messages, it is also used as the default for HELO commands in callout
16342 verification if there is no remote transport from which to obtain a
16343 &%helo_data%& value.
16344
16345 .option smtp_banner main string&!! "see below"
16346 .cindex "SMTP" "welcome banner"
16347 .cindex "banner for SMTP"
16348 .cindex "welcome banner for SMTP"
16349 .cindex "customizing" "SMTP banner"
16350 This string, which is expanded every time it is used, is output as the initial
16351 positive response to an SMTP connection. The default setting is:
16352 .code
16353 smtp_banner = $smtp_active_hostname ESMTP Exim \
16354   $version_number $tod_full
16355 .endd
16356 Failure to expand the string causes a panic error. If you want to create a
16357 multiline response to the initial SMTP connection, use &"\n"& in the string at
16358 appropriate points, but not at the end. Note that the 220 code is not included
16359 in this string. Exim adds it automatically (several times in the case of a
16360 multiline response).
16361
16362
16363 .option smtp_check_spool_space main boolean true
16364 .cindex "checking disk space"
16365 .cindex "disk space, checking"
16366 .cindex "spool directory" "checking space"
16367 When this option is set, if an incoming SMTP session encounters the SIZE
16368 option on a MAIL command, it checks that there is enough space in the
16369 spool directory's partition to accept a message of that size, while still
16370 leaving free the amount specified by &%check_spool_space%& (even if that value
16371 is zero). If there isn't enough space, a temporary error code is returned.
16372
16373
16374 .option smtp_connect_backlog main integer 20
16375 .cindex "connection backlog"
16376 .cindex "SMTP" "connection backlog"
16377 .cindex "backlog of connections"
16378 This option specifies a maximum number of waiting SMTP connections. Exim passes
16379 this value to the TCP/IP system when it sets up its listener. Once this number
16380 of connections are waiting for the daemon's attention, subsequent connection
16381 attempts are refused at the TCP/IP level. At least, that is what the manuals
16382 say; in some circumstances such connection attempts have been observed to time
16383 out instead. For large systems it is probably a good idea to increase the
16384 value (to 50, say). It also gives some protection against denial-of-service
16385 attacks by SYN flooding.
16386
16387
16388 .option smtp_enforce_sync main boolean true
16389 .cindex "SMTP" "synchronization checking"
16390 .cindex "synchronization checking in SMTP"
16391 The SMTP protocol specification requires the client to wait for a response from
16392 the server at certain points in the dialogue. Without PIPELINING these
16393 synchronization points are after every command; with PIPELINING they are
16394 fewer, but they still exist.
16395
16396 Some spamming sites send out a complete set of SMTP commands without waiting
16397 for any response. Exim protects against this by rejecting a message if the
16398 client has sent further input when it should not have. The error response &"554
16399 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16400 for this error cannot be perfect because of transmission delays (unexpected
16401 input may be on its way but not yet received when Exim checks). However, it
16402 does detect many instances.
16403
16404 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16405 If you want to disable the check selectively (for example, only for certain
16406 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16407 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16408
16409
16410
16411 .option smtp_etrn_command main string&!! unset
16412 .cindex "ETRN" "command to be run"
16413 .vindex "&$domain$&"
16414 If this option is set, the given command is run whenever an SMTP ETRN
16415 command is received from a host that is permitted to issue such commands (see
16416 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16417 are independently expanded. The expansion variable &$domain$& is set to the
16418 argument of the ETRN command, and no syntax checking is done on it. For
16419 example:
16420 .code
16421 smtp_etrn_command = /etc/etrn_command $domain \
16422                     $sender_host_address
16423 .endd
16424 A new process is created to run the command, but Exim does not wait for it to
16425 complete. Consequently, its status cannot be checked. If the command cannot be
16426 run, a line is written to the panic log, but the ETRN caller still receives
16427 a 250 success response. Exim is normally running under its own uid when
16428 receiving SMTP, so it is not possible for it to change the uid before running
16429 the command.
16430
16431
16432 .option smtp_etrn_serialize main boolean true
16433 .cindex "ETRN" "serializing"
16434 When this option is set, it prevents the simultaneous execution of more than
16435 one identical command as a result of ETRN in an SMTP connection. See
16436 section &<<SECTETRN>>& for details.
16437
16438
16439 .option smtp_load_reserve main fixed-point unset
16440 .cindex "load average"
16441 If the system load average ever gets higher than this, incoming SMTP calls are
16442 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16443 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16444 the load is over the limit. The option has no effect on ancient operating
16445 systems on which Exim cannot determine the load average. See also
16446 &%deliver_queue_load_max%& and &%queue_only_load%&.
16447
16448
16449
16450 .option smtp_max_synprot_errors main integer 3
16451 .cindex "SMTP" "limiting syntax and protocol errors"
16452 .cindex "limit" "SMTP syntax and protocol errors"
16453 Exim rejects SMTP commands that contain syntax or protocol errors. In
16454 particular, a syntactically invalid email address, as in this command:
16455 .code
16456 RCPT TO:<abc xyz@a.b.c>
16457 .endd
16458 causes immediate rejection of the command, before any other tests are done.
16459 (The ACL cannot be run if there is no valid address to set up for it.) An
16460 example of a protocol error is receiving RCPT before MAIL. If there are
16461 too many syntax or protocol errors in one SMTP session, the connection is
16462 dropped. The limit is set by this option.
16463
16464 .cindex "PIPELINING" "expected errors"
16465 When the PIPELINING extension to SMTP is in use, some protocol errors are
16466 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16467 Exim assumes that PIPELINING will be used if it advertises it (see
16468 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16469 not count towards the limit.
16470
16471
16472
16473 .option smtp_max_unknown_commands main integer 3
16474 .cindex "SMTP" "limiting unknown commands"
16475 .cindex "limit" "unknown SMTP commands"
16476 If there are too many unrecognized commands in an incoming SMTP session, an
16477 Exim server drops the connection. This is a defence against some kinds of abuse
16478 that subvert web
16479 clients
16480 into making connections to SMTP ports; in these circumstances, a number of
16481 non-SMTP command lines are sent first.
16482
16483
16484
16485 .option smtp_ratelimit_hosts main "host list&!!" unset
16486 .cindex "SMTP" "rate limiting"
16487 .cindex "limit" "rate of message arrival"
16488 .cindex "RCPT" "rate limiting"
16489 Some sites find it helpful to be able to limit the rate at which certain hosts
16490 can send them messages, and the rate at which an individual message can specify
16491 recipients.
16492
16493 Exim has two rate-limiting facilities. This section describes the older
16494 facility, which can limit rates within a single connection. The newer
16495 &%ratelimit%& ACL condition can limit rates across all connections. See section
16496 &<<SECTratelimiting>>& for details of the newer facility.
16497
16498 When a host matches &%smtp_ratelimit_hosts%&, the values of
16499 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16500 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16501 respectively. Each option, if set, must contain a set of four comma-separated
16502 values:
16503
16504 .ilist
16505 A threshold, before which there is no rate limiting.
16506 .next
16507 An initial time delay. Unlike other times in Exim, numbers with decimal
16508 fractional parts are allowed here.
16509 .next
16510 A factor by which to increase the delay each time.
16511 .next
16512 A maximum value for the delay. This should normally be less than 5 minutes,
16513 because after that time, the client is liable to timeout the SMTP command.
16514 .endlist
16515
16516 For example, these settings have been used successfully at the site which
16517 first suggested this feature, for controlling mail from their customers:
16518 .code
16519 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16520 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16521 .endd
16522 The first setting specifies delays that are applied to MAIL commands after
16523 two have been received over a single connection. The initial delay is 0.5
16524 seconds, increasing by a factor of 1.05 each time. The second setting applies
16525 delays to RCPT commands when more than four occur in a single message.
16526
16527
16528 .option smtp_ratelimit_mail main string unset
16529 See &%smtp_ratelimit_hosts%& above.
16530
16531
16532 .option smtp_ratelimit_rcpt main string unset
16533 See &%smtp_ratelimit_hosts%& above.
16534
16535
16536 .option smtp_receive_timeout main time&!! 5m
16537 .cindex "timeout" "for SMTP input"
16538 .cindex "SMTP" "input timeout"
16539 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16540 input, including batch SMTP. If a line of input (either an SMTP command or a
16541 data line) is not received within this time, the SMTP connection is dropped and
16542 the message is abandoned.
16543 A line is written to the log containing one of the following messages:
16544 .code
16545 SMTP command timeout on connection from...
16546 SMTP data timeout on connection from...
16547 .endd
16548 The former means that Exim was expecting to read an SMTP command; the latter
16549 means that it was in the DATA phase, reading the contents of a message.
16550
16551 If the first character of the option is a &"$"& the option is
16552 expanded before use and may depend on
16553 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16554
16555
16556 .oindex "&%-os%&"
16557 The value set by this option can be overridden by the
16558 &%-os%& command-line option. A setting of zero time disables the timeout, but
16559 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16560 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16561 timeout is controlled by &%receive_timeout%& and &%-or%&.
16562
16563
16564 .option smtp_reserve_hosts main "host list&!!" unset
16565 This option defines hosts for which SMTP connections are reserved; see
16566 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16567
16568
16569 .option smtp_return_error_details main boolean false
16570 .cindex "SMTP" "details policy failures"
16571 .cindex "policy control" "rejection, returning details"
16572 In the default state, Exim uses bland messages such as
16573 &"Administrative prohibition"& when it rejects SMTP commands for policy
16574 reasons. Many sysadmins like this because it gives away little information
16575 to spammers. However, some other sysadmins who are applying strict checking
16576 policies want to give out much fuller information about failures. Setting
16577 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16578 example, instead of &"Administrative prohibition"&, it might give:
16579 .code
16580 550-Rejected after DATA: '>' missing at end of address:
16581 550 failing address in "From" header is: <user@dom.ain
16582 .endd
16583
16584
16585 .option smtputf8_advertise_hosts main "host list&!!" *
16586 .cindex "SMTPUTF8" "advertising"
16587 When Exim is built with support for internationalised mail names,
16588 the availability therof is advertised in
16589 response to EHLO only to those client hosts that match this option. See
16590 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16591
16592
16593 .option spamd_address main string "see below"
16594 This option is available when Exim is compiled with the content-scanning
16595 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16596 The default value is
16597 .code
16598 127.0.0.1 783
16599 .endd
16600 See section &<<SECTscanspamass>>& for more details.
16601
16602
16603
16604 .option split_spool_directory main boolean false
16605 .cindex "multiple spool directories"
16606 .cindex "spool directory" "split"
16607 .cindex "directories, multiple"
16608 If this option is set, it causes Exim to split its input directory into 62
16609 subdirectories, each with a single alphanumeric character as its name. The
16610 sixth character of the message id is used to allocate messages to
16611 subdirectories; this is the least significant base-62 digit of the time of
16612 arrival of the message.
16613
16614 Splitting up the spool in this way may provide better performance on systems
16615 where there are long mail queues, by reducing the number of files in any one
16616 directory. The msglog directory is also split up in a similar way to the input
16617 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16618 are still placed in the single directory &_msglog.OLD_&.
16619
16620 It is not necessary to take any special action for existing messages when
16621 changing &%split_spool_directory%&. Exim notices messages that are in the
16622 &"wrong"& place, and continues to process them. If the option is turned off
16623 after a period of being on, the subdirectories will eventually empty and be
16624 automatically deleted.
16625
16626 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16627 changes. Instead of creating a list of all messages in the queue, and then
16628 trying to deliver each one in turn, it constructs a list of those in one
16629 sub-directory and tries to deliver them, before moving on to the next
16630 sub-directory. The sub-directories are processed in a random order. This
16631 spreads out the scanning of the input directories, and uses less memory. It is
16632 particularly beneficial when there are lots of messages on the queue. However,
16633 if &%queue_run_in_order%& is set, none of this new processing happens. The
16634 entire queue has to be scanned and sorted before any deliveries can start.
16635
16636
16637 .option spool_directory main string&!! "set at compile time"
16638 .cindex "spool directory" "path to"
16639 This defines the directory in which Exim keeps its spool, that is, the messages
16640 it is waiting to deliver. The default value is taken from the compile-time
16641 configuration setting, if there is one. If not, this option must be set. The
16642 string is expanded, so it can contain, for example, a reference to
16643 &$primary_hostname$&.
16644
16645 If the spool directory name is fixed on your installation, it is recommended
16646 that you set it at build time rather than from this option, particularly if the
16647 log files are being written to the spool directory (see &%log_file_path%&).
16648 Otherwise log files cannot be used for errors that are detected early on, such
16649 as failures in the configuration file.
16650
16651 By using this option to override the compiled-in path, it is possible to run
16652 tests of Exim without using the standard spool.
16653
16654 .option sqlite_lock_timeout main time 5s
16655 .cindex "sqlite lookup type" "lock timeout"
16656 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16657 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16658
16659 .option strict_acl_vars main boolean false
16660 .cindex "&ACL;" "variables, handling unset"
16661 This option controls what happens if a syntactically valid but undefined ACL
16662 variable is referenced. If it is false (the default), an empty string
16663 is substituted; if it is true, an error is generated. See section
16664 &<<SECTaclvariables>>& for details of ACL variables.
16665
16666 .option strip_excess_angle_brackets main boolean false
16667 .cindex "angle brackets, excess"
16668 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16669 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16670 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16671 passed on to another MTA, the excess angle brackets are not passed on. If this
16672 option is not set, multiple pairs of angle brackets cause a syntax error.
16673
16674
16675 .option strip_trailing_dot main boolean false
16676 .cindex "trailing dot on domain"
16677 .cindex "dot" "trailing on domain"
16678 If this option is set, a trailing dot at the end of a domain in an address is
16679 ignored. If this is in the envelope and the message is passed on to another
16680 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16681 domain causes a syntax error.
16682 However, addresses in header lines are checked only when an ACL requests header
16683 syntax checking.
16684
16685
16686 .option syslog_duplication main boolean true
16687 .cindex "syslog" "duplicate log lines; suppressing"
16688 When Exim is logging to syslog, it writes the log lines for its three
16689 separate logs at different syslog priorities so that they can in principle
16690 be separated on the logging hosts. Some installations do not require this
16691 separation, and in those cases, the duplication of certain log lines is a
16692 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16693 particular log line is written to syslog. For lines that normally go to
16694 both the main log and the reject log, the reject log version (possibly
16695 containing message header lines) is written, at LOG_NOTICE priority.
16696 Lines that normally go to both the main and the panic log are written at
16697 the LOG_ALERT priority.
16698
16699
16700 .option syslog_facility main string unset
16701 .cindex "syslog" "facility; setting"
16702 This option sets the syslog &"facility"& name, used when Exim is logging to
16703 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16704 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16705 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16706 details of Exim's logging.
16707
16708
16709
16710 .option syslog_processname main string &`exim`&
16711 .cindex "syslog" "process name; setting"
16712 This option sets the syslog &"ident"& name, used when Exim is logging to
16713 syslog. The value must be no longer than 32 characters. See chapter
16714 &<<CHAPlog>>& for details of Exim's logging.
16715
16716
16717
16718 .option syslog_timestamp main boolean true
16719 .cindex "syslog" "timestamps"
16720 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16721 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16722 details of Exim's logging.
16723
16724
16725 .option system_filter main string&!! unset
16726 .cindex "filter" "system filter"
16727 .cindex "system filter" "specifying"
16728 .cindex "Sieve filter" "not available for system filter"
16729 This option specifies an Exim filter file that is applied to all messages at
16730 the start of each delivery attempt, before any routing is done. System filters
16731 must be Exim filters; they cannot be Sieve filters. If the system filter
16732 generates any deliveries to files or pipes, or any new mail messages, the
16733 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16734 which transports are to be used. Details of this facility are given in chapter
16735 &<<CHAPsystemfilter>>&.
16736
16737
16738 .option system_filter_directory_transport main string&!! unset
16739 .vindex "&$address_file$&"
16740 This sets the name of the transport driver that is to be used when the
16741 &%save%& command in a system message filter specifies a path ending in &"/"&,
16742 implying delivery of each message into a separate file in some directory.
16743 During the delivery, the variable &$address_file$& contains the path name.
16744
16745
16746 .option system_filter_file_transport main string&!! unset
16747 .cindex "file" "transport for system filter"
16748 This sets the name of the transport driver that is to be used when the &%save%&
16749 command in a system message filter specifies a path not ending in &"/"&. During
16750 the delivery, the variable &$address_file$& contains the path name.
16751
16752 .option system_filter_group main string unset
16753 .cindex "gid (group id)" "system filter"
16754 This option is used only when &%system_filter_user%& is also set. It sets the
16755 gid under which the system filter is run, overriding any gid that is associated
16756 with the user. The value may be numerical or symbolic.
16757
16758 .option system_filter_pipe_transport main string&!! unset
16759 .cindex "&(pipe)& transport" "for system filter"
16760 .vindex "&$address_pipe$&"
16761 This specifies the transport driver that is to be used when a &%pipe%& command
16762 is used in a system filter. During the delivery, the variable &$address_pipe$&
16763 contains the pipe command.
16764
16765
16766 .option system_filter_reply_transport main string&!! unset
16767 .cindex "&(autoreply)& transport" "for system filter"
16768 This specifies the transport driver that is to be used when a &%mail%& command
16769 is used in a system filter.
16770
16771
16772 .option system_filter_user main string unset
16773 .cindex "uid (user id)" "system filter"
16774 If this option is set to root, the system filter is run in the main Exim
16775 delivery process, as root.  Otherwise, the system filter runs in a separate
16776 process, as the given user, defaulting to the Exim run-time user.
16777 Unless the string consists entirely of digits, it
16778 is looked up in the password data. Failure to find the named user causes a
16779 configuration error. The gid is either taken from the password data, or
16780 specified by &%system_filter_group%&. When the uid is specified numerically,
16781 &%system_filter_group%& is required to be set.
16782
16783 If the system filter generates any pipe, file, or reply deliveries, the uid
16784 under which the filter is run is used when transporting them, unless a
16785 transport option overrides.
16786
16787
16788 .option tcp_nodelay main boolean true
16789 .cindex "daemon" "TCP_NODELAY on sockets"
16790 .cindex "Nagle algorithm"
16791 .cindex "TCP_NODELAY on listening sockets"
16792 If this option is set false, it stops the Exim daemon setting the
16793 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16794 turns off the &"Nagle algorithm"&, which is a way of improving network
16795 performance in interactive (character-by-character) situations. Turning it off
16796 should improve Exim's performance a bit, so that is what happens by default.
16797 However, it appears that some broken clients cannot cope, and time out. Hence
16798 this option. It affects only those sockets that are set up for listening by the
16799 daemon. Sockets created by the smtp transport for delivering mail always set
16800 TCP_NODELAY.
16801
16802
16803 .option timeout_frozen_after main time 0s
16804 .cindex "frozen messages" "timing out"
16805 .cindex "timeout" "frozen messages"
16806 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16807 message of any kind that has been on the queue for longer than the given time
16808 is automatically cancelled at the next queue run. If the frozen message is a
16809 bounce message, it is just discarded; otherwise, a bounce is sent to the
16810 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16811 If you want to timeout frozen bounce messages earlier than other kinds of
16812 frozen message, see &%ignore_bounce_errors_after%&.
16813
16814 &*Note:*& the default value of zero means no timeouts; with this setting,
16815 frozen messages remain on the queue forever (except for any frozen bounce
16816 messages that are released by &%ignore_bounce_errors_after%&).
16817
16818
16819 .option timezone main string unset
16820 .cindex "timezone, setting"
16821 .cindex "environment" "values from"
16822 The value of &%timezone%& is used to set the environment variable TZ while
16823 running Exim (if it is different on entry). This ensures that all timestamps
16824 created by Exim are in the required timezone. If you want all your timestamps
16825 to be in UTC (aka GMT) you should set
16826 .code
16827 timezone = UTC
16828 .endd
16829 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16830 or, if that is not set, from the value of the TZ environment variable when Exim
16831 is built. If &%timezone%& is set to the empty string, either at build or run
16832 time, any existing TZ variable is removed from the environment when Exim
16833 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16834 unfortunately not all, operating systems.
16835
16836
16837 .option tls_advertise_hosts main "host list&!!" *
16838 .cindex "TLS" "advertising"
16839 .cindex "encryption" "on SMTP connection"
16840 .cindex "SMTP" "encrypted connection"
16841 When Exim is built with support for TLS encrypted connections, the availability
16842 of the STARTTLS command to set up an encrypted session is advertised in
16843 response to EHLO only to those client hosts that match this option. See
16844 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16845 Note that the default value requires that a certificate be supplied
16846 using the &%tls_certificate%& option.  If TLS support for incoming connections
16847 is not required the &%tls_advertise_hosts%& option should be set empty.
16848
16849
16850 .option tls_certificate main string&!! unset
16851 .cindex "TLS" "server certificate; location of"
16852 .cindex "certificate" "server, location of"
16853 The value of this option is expanded, and must then be the absolute path to a
16854 file which contains the server's certificates. The server's private key is also
16855 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16856 &<<CHAPTLS>>& for further details.
16857
16858 &*Note*&: The certificates defined by this option are used only when Exim is
16859 receiving incoming messages as a server. If you want to supply certificates for
16860 use when sending messages as a client, you must set the &%tls_certificate%&
16861 option in the relevant &(smtp)& transport.
16862
16863 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16864 if the OpenSSL build supports TLS extensions and the TLS client sends the
16865 Server Name Indication extension, then this option and others documented in
16866 &<<SECTtlssni>>& will be re-expanded.
16867
16868 .new
16869 If this option is unset or empty a fresh self-signed certificate will be
16870 generated for every connection.
16871 .wen
16872
16873 .option tls_crl main string&!! unset
16874 .cindex "TLS" "server certificate revocation list"
16875 .cindex "certificate" "revocation list for server"
16876 This option specifies a certificate revocation list. The expanded value must
16877 be the name of a file that contains a CRL in PEM format.
16878
16879 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16880
16881
16882 .option tls_dh_max_bits main integer 2236
16883 .cindex "TLS" "D-H bit count"
16884 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16885 the chosen TLS library.  That value might prove to be too high for
16886 interoperability.  This option provides a maximum clamp on the value
16887 suggested, trading off security for interoperability.
16888
16889 The value must be at least 1024.
16890
16891 The value 2236 was chosen because, at time of adding the option, it was the
16892 hard-coded maximum value supported by the NSS cryptographic library, as used
16893 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16894
16895 If you prefer more security and are willing to break some clients, raise this
16896 number.
16897
16898 Note that the value passed to GnuTLS for *generating* a new prime may be a
16899 little less than this figure, because GnuTLS is inexact and may produce a
16900 larger prime than requested.
16901
16902
16903 .option tls_dhparam main string&!! unset
16904 .cindex "TLS" "D-H parameters for server"
16905 The value of this option is expanded and indicates the source of DH parameters
16906 to be used by Exim.
16907
16908 If it is a filename starting with a &`/`&, then it names a file from which DH
16909 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16910 PKCS#3 representation of the DH prime.  If the file does not exist, for
16911 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16912 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16913 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16914 and treated as though the &%tls_dhparam%& were set to "none".
16915
16916 If this option expands to the string "none", then no DH parameters will be
16917 loaded by Exim.
16918
16919 If this option expands to the string "historic" and Exim is using GnuTLS, then
16920 Exim will attempt to load a file from inside the spool directory.  If the file
16921 does not exist, Exim will attempt to create it.
16922 See section &<<SECTgnutlsparam>>& for further details.
16923
16924 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16925 a default DH prime; the default is the 2048 bit prime described in section
16926 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16927 in IKE is assigned number 23.
16928
16929 Otherwise, the option must expand to the name used by Exim for any of a number
16930 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16931 "ike" followed by the number used by IKE, of "default" which corresponds to
16932 "ike23".
16933
16934 The available primes are:
16935 &`ike1`&, &`ike2`&, &`ike5`&,
16936 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16937 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16938
16939 Some of these will be too small to be accepted by clients.
16940 Some may be too large to be accepted by clients.
16941
16942 The TLS protocol does not negotiate an acceptable size for this; clients tend
16943 to hard-drop connections if what is offered by the server is unacceptable,
16944 whether too large or too small, and there's no provision for the client to
16945 tell the server what these constraints are.  Thus, as a server operator, you
16946 need to make an educated guess as to what is most likely to work for your
16947 userbase.
16948
16949 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16950 is most likely to maximise interoperability.  The upper bound comes from
16951 applications using the Mozilla Network Security Services (NSS) library, which
16952 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16953 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16954 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16955 acceptable bound from 1024 to 2048.
16956
16957
16958 .option tls_eccurve main string&!! prime256v1
16959 .cindex TLS "EC cryptography"
16960 If built with a recent-enough version of OpenSSL,
16961 this option selects a EC curve for use by Exim.
16962
16963 Curve names of the form &'prime256v1'& are accepted.
16964 For even more-recent library versions, names of the form &'P-512'&
16965 are also accepted, plus the special value &'auto'&
16966 which tells the library to choose.
16967
16968 If the option is set to an empty string, no EC curves will be enabled.
16969
16970
16971 .option tls_ocsp_file main string&!! unset
16972 .cindex TLS "certificate status"
16973 .cindex TLS "OCSP proof file"
16974 This option
16975 must if set expand to the absolute path to a file which contains a current
16976 status proof for the server's certificate, as obtained from the
16977 Certificate Authority.
16978
16979 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
16980
16981
16982 .option tls_on_connect_ports main "string list" unset
16983 .cindex SSMTP
16984 .cindex SMTPS
16985 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16986 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16987 set up without waiting for the client to issue a STARTTLS command. For
16988 further details, see section &<<SECTsupobssmt>>&.
16989
16990
16991
16992 .option tls_privatekey main string&!! unset
16993 .cindex "TLS" "server private key; location of"
16994 The value of this option is expanded, and must then be the absolute path to a
16995 file which contains the server's private key. If this option is unset, or if
16996 the expansion is forced to fail, or the result is an empty string, the private
16997 key is assumed to be in the same file as the server's certificates. See chapter
16998 &<<CHAPTLS>>& for further details.
16999
17000 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17001
17002
17003 .option tls_remember_esmtp main boolean false
17004 .cindex "TLS" "esmtp state; remembering"
17005 .cindex "TLS" "broken clients"
17006 If this option is set true, Exim violates the RFCs by remembering that it is in
17007 &"esmtp"& state after successfully negotiating a TLS session. This provides
17008 support for broken clients that fail to send a new EHLO after starting a
17009 TLS session.
17010
17011
17012 .option tls_require_ciphers main string&!! unset
17013 .cindex "TLS" "requiring specific ciphers"
17014 .cindex "cipher" "requiring specific"
17015 This option controls which ciphers can be used for incoming TLS connections.
17016 The &(smtp)& transport has an option of the same name for controlling outgoing
17017 connections. This option is expanded for each connection, so can be varied for
17018 different clients if required. The value of this option must be a list of
17019 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17020 in somewhat different ways. If GnuTLS is being used, the client controls the
17021 preference order of the available ciphers. Details are given in sections
17022 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17023
17024
17025 .option tls_try_verify_hosts main "host list&!!" unset
17026 .cindex "TLS" "client certificate verification"
17027 .cindex "certificate" "verification of client"
17028 See &%tls_verify_hosts%& below.
17029
17030
17031 .option tls_verify_certificates main string&!! system
17032 .cindex "TLS" "client certificate verification"
17033 .cindex "certificate" "verification of client"
17034 The value of this option is expanded, and must then be either the
17035 word "system"
17036 or the absolute path to
17037 a file or directory containing permitted certificates for clients that
17038 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17039
17040 The "system" value for the option will use a
17041 system default location compiled into the SSL library.
17042 This is not available for GnuTLS versions preceding 3.0.20,
17043 and will be taken as empty; an explicit location
17044 must be specified.
17045
17046 The use of a directory for the option value is not available for GnuTLS versions
17047 preceding 3.3.6 and a single file must be used.
17048
17049 With OpenSSL the certificates specified
17050 explicitly
17051 either by file or directory
17052 are added to those given by the system default location.
17053
17054 These certificates should be for the certificate authorities trusted, rather
17055 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17056 the value is a file then the certificates are sent by Exim as a server to
17057 connecting clients, defining the list of accepted certificate authorities.
17058 Thus the values defined should be considered public data.  To avoid this,
17059 use the explicit directory version.
17060
17061 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17062
17063 A forced expansion failure or setting to an empty string is equivalent to
17064 being unset.
17065
17066
17067 .option tls_verify_hosts main "host list&!!" unset
17068 .cindex "TLS" "client certificate verification"
17069 .cindex "certificate" "verification of client"
17070 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17071 certificates from clients. The expected certificates are defined by
17072 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17073 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17074 &%tls_verify_certificates%& is not set.
17075
17076 Any client that matches &%tls_verify_hosts%& is constrained by
17077 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17078 present one of the listed certificates. If it does not, the connection is
17079 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17080 the host to use TLS. It can still send SMTP commands through unencrypted
17081 connections. Forcing a client to use TLS has to be done separately using an
17082 ACL to reject inappropriate commands when the connection is not encrypted.
17083
17084 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17085 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17086 certificate and checks it against &%tls_verify_certificates%&, but does not
17087 abort the connection if there is no certificate or if it does not match. This
17088 state can be detected in an ACL, which makes it possible to implement policies
17089 such as &"accept for relay only if a verified certificate has been received,
17090 but accept for local delivery if encrypted, even without a verified
17091 certificate"&.
17092
17093 Client hosts that match neither of these lists are not asked to present
17094 certificates.
17095
17096
17097 .option trusted_groups main "string list&!!" unset
17098 .cindex "trusted groups"
17099 .cindex "groups" "trusted"
17100 This option is expanded just once, at the start of Exim's processing. If this
17101 option is set, any process that is running in one of the listed groups, or
17102 which has one of them as a supplementary group, is trusted. The groups can be
17103 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17104 details of what trusted callers are permitted to do. If neither
17105 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17106 are trusted.
17107
17108 .option trusted_users main "string list&!!" unset
17109 .cindex "trusted users"
17110 .cindex "user" "trusted"
17111 This option is expanded just once, at the start of Exim's processing. If this
17112 option is set, any process that is running as one of the listed users is
17113 trusted. The users can be specified numerically or by name. See section
17114 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17115 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17116 Exim user are trusted.
17117
17118 .option unknown_login main string&!! unset
17119 .cindex "uid (user id)" "unknown caller"
17120 .vindex "&$caller_uid$&"
17121 This is a specialized feature for use in unusual configurations. By default, if
17122 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17123 gives up. The &%unknown_login%& option can be used to set a login name to be
17124 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17125 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17126 is used for the user's real name (gecos field), unless this has been set by the
17127 &%-F%& option.
17128
17129 .option unknown_username main string unset
17130 See &%unknown_login%&.
17131
17132 .option untrusted_set_sender main "address list&!!" unset
17133 .cindex "trusted users"
17134 .cindex "sender" "setting by untrusted user"
17135 .cindex "untrusted user setting sender"
17136 .cindex "user" "untrusted setting sender"
17137 .cindex "envelope sender"
17138 When an untrusted user submits a message to Exim using the standard input, Exim
17139 normally creates an envelope sender address from the user's login and the
17140 default qualification domain. Data from the &%-f%& option (for setting envelope
17141 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17142 is used) is ignored.
17143
17144 However, untrusted users are permitted to set an empty envelope sender address,
17145 to declare that a message should never generate any bounces. For example:
17146 .code
17147 exim -f '<>' user@domain.example
17148 .endd
17149 .vindex "&$sender_ident$&"
17150 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17151 other envelope sender addresses in a controlled way. When it is set, untrusted
17152 users are allowed to set envelope sender addresses that match any of the
17153 patterns in the list. Like all address lists, the string is expanded. The
17154 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17155 users to setting senders that start with their login ids
17156 followed by a hyphen
17157 by a setting like this:
17158 .code
17159 untrusted_set_sender = ^$sender_ident-
17160 .endd
17161 If you want to allow untrusted users to set envelope sender addresses without
17162 restriction, you can use
17163 .code
17164 untrusted_set_sender = *
17165 .endd
17166 The &%untrusted_set_sender%& option applies to all forms of local input, but
17167 only to the setting of the envelope sender. It does not permit untrusted users
17168 to use the other options which trusted user can use to override message
17169 parameters. Furthermore, it does not stop Exim from removing an existing
17170 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17171 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17172 overriding these actions. The handling of the &'Sender:'& header is also
17173 described in section &<<SECTthesenhea>>&.
17174
17175 The log line for a message's arrival shows the envelope sender following
17176 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17177 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17178 envelope sender address, the user's login is shown in parentheses after the
17179 sender address.
17180
17181
17182 .option uucp_from_pattern main string "see below"
17183 .cindex "&""From""& line"
17184 .cindex "UUCP" "&""From""& line"
17185 Some applications that pass messages to an MTA via a command line interface use
17186 an initial line starting with &"From&~"& to pass the envelope sender. In
17187 particular, this is used by UUCP software. Exim recognizes such a line by means
17188 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17189 matches, the sender address is constructed by expanding the contents of
17190 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17191 default pattern recognizes lines in the following two forms:
17192 .code
17193 From ph10 Fri Jan  5 12:35 GMT 1996
17194 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17195 .endd
17196 The pattern can be seen by running
17197 .code
17198 exim -bP uucp_from_pattern
17199 .endd
17200 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17201 year in the second case. The first word after &"From&~"& is matched in the
17202 regular expression by a parenthesized subpattern. The default value for
17203 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17204 (&"ph10"& in the example above) as the message's sender. See also
17205 &%ignore_fromline_hosts%&.
17206
17207
17208 .option uucp_from_sender main string&!! &`$1`&
17209 See &%uucp_from_pattern%& above.
17210
17211
17212 .option warn_message_file main string unset
17213 .cindex "warning of delay" "customizing the message"
17214 .cindex "customizing" "warning message"
17215 This option defines a template file containing paragraphs of text to be used
17216 for constructing the warning message which is sent by Exim when a message has
17217 been on the queue for a specified amount of time, as specified by
17218 &%delay_warning%&. Details of the file's contents are given in chapter
17219 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17220
17221
17222 .option write_rejectlog main boolean true
17223 .cindex "reject log" "disabling"
17224 If this option is set false, Exim no longer writes anything to the reject log.
17225 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17226 .ecindex IIDconfima
17227 .ecindex IIDmaiconf
17228
17229
17230
17231
17232 . ////////////////////////////////////////////////////////////////////////////
17233 . ////////////////////////////////////////////////////////////////////////////
17234
17235 .chapter "Generic options for routers" "CHAProutergeneric"
17236 .scindex IIDgenoprou1 "options" "generic; for routers"
17237 .scindex IIDgenoprou2 "generic options" "router"
17238 This chapter describes the generic options that apply to all routers.
17239 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17240
17241 For a general description of how a router operates, see sections
17242 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17243 which the preconditions are tested. The order of expansion of the options that
17244 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17245 &%headers_remove%&, &%transport%&.
17246
17247
17248
17249 .option address_data routers string&!! unset
17250 .cindex "router" "data attached to address"
17251 The string is expanded just before the router is run, that is, after all the
17252 precondition tests have succeeded. If the expansion is forced to fail, the
17253 router declines, the value of &%address_data%& remains unchanged, and the
17254 &%more%& option controls what happens next. Other expansion failures cause
17255 delivery of the address to be deferred.
17256
17257 .vindex "&$address_data$&"
17258 When the expansion succeeds, the value is retained with the address, and can be
17259 accessed using the variable &$address_data$& in the current router, subsequent
17260 routers, and the eventual transport.
17261
17262 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17263 that runs a user's filter file, the contents of &$address_data$& are accessible
17264 in the filter. This is not normally a problem, because such data is usually
17265 either not confidential or it &"belongs"& to the current user, but if you do
17266 put confidential data into &$address_data$& you need to remember this point.
17267
17268 Even if the router declines or passes, the value of &$address_data$& remains
17269 with the address, though it can be changed by another &%address_data%& setting
17270 on a subsequent router. If a router generates child addresses, the value of
17271 &$address_data$& propagates to them. This also applies to the special kind of
17272 &"child"& that is generated by a router with the &%unseen%& option.
17273
17274 The idea of &%address_data%& is that you can use it to look up a lot of data
17275 for the address once, and then pick out parts of the data later. For example,
17276 you could use a single LDAP lookup to return a string of the form
17277 .code
17278 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17279 .endd
17280 In the transport you could pick out the mailbox by a setting such as
17281 .code
17282 file = ${extract{mailbox}{$address_data}}
17283 .endd
17284 This makes the configuration file less messy, and also reduces the number of
17285 lookups (though Exim does cache lookups).
17286
17287 .vindex "&$sender_address_data$&"
17288 .vindex "&$address_data$&"
17289 The &%address_data%& facility is also useful as a means of passing information
17290 from one router to another, and from a router to a transport. In addition, if
17291 &$address_data$& is set by a router when verifying a recipient address from an
17292 ACL, it remains available for use in the rest of the ACL statement. After
17293 verifying a sender, the value is transferred to &$sender_address_data$&.
17294
17295
17296
17297 .option address_test routers&!? boolean true
17298 .oindex "&%-bt%&"
17299 .cindex "router" "skipping when address testing"
17300 If this option is set false, the router is skipped when routing is being tested
17301 by means of the &%-bt%& command line option. This can be a convenience when
17302 your first router sends messages to an external scanner, because it saves you
17303 having to set the &"already scanned"& indicator when testing real address
17304 routing.
17305
17306
17307
17308 .option cannot_route_message routers string&!! unset
17309 .cindex "router" "customizing &""cannot route""& message"
17310 .cindex "customizing" "&""cannot route""& message"
17311 This option specifies a text message that is used when an address cannot be
17312 routed because Exim has run out of routers. The default message is
17313 &"Unrouteable address"&. This option is useful only on routers that have
17314 &%more%& set false, or on the very last router in a configuration, because the
17315 value that is used is taken from the last router that is considered. This
17316 includes a router that is skipped because its preconditions are not met, as
17317 well as a router that declines. For example, using the default configuration,
17318 you could put:
17319 .code
17320 cannot_route_message = Remote domain not found in DNS
17321 .endd
17322 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17323 and
17324 .code
17325 cannot_route_message = Unknown local user
17326 .endd
17327 on the final router that checks for local users. If string expansion fails for
17328 this option, the default message is used. Unless the expansion failure was
17329 explicitly forced, a message about the failure is written to the main and panic
17330 logs, in addition to the normal message about the routing failure.
17331
17332
17333 .option caseful_local_part routers boolean false
17334 .cindex "case of local parts"
17335 .cindex "router" "case of local parts"
17336 By default, routers handle the local parts of addresses in a case-insensitive
17337 manner, though the actual case is preserved for transmission with the message.
17338 If you want the case of letters to be significant in a router, you must set
17339 this option true. For individual router options that contain address or local
17340 part lists (for example, &%local_parts%&), case-sensitive matching can be
17341 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17342 more details.
17343
17344 .vindex "&$local_part$&"
17345 .vindex "&$original_local_part$&"
17346 .vindex "&$parent_local_part$&"
17347 The value of the &$local_part$& variable is forced to lower case while a
17348 router is running unless &%caseful_local_part%& is set. When a router assigns
17349 an address to a transport, the value of &$local_part$& when the transport runs
17350 is the same as it was in the router. Similarly, when a router generates child
17351 addresses by aliasing or forwarding, the values of &$original_local_part$&
17352 and &$parent_local_part$& are those that were used by the redirecting router.
17353
17354 This option applies to the processing of an address by a router. When a
17355 recipient address is being processed in an ACL, there is a separate &%control%&
17356 modifier that can be used to specify case-sensitive processing within the ACL
17357 (see section &<<SECTcontrols>>&).
17358
17359
17360
17361 .option check_local_user routers&!? boolean false
17362 .cindex "local user, checking in router"
17363 .cindex "router" "checking for local user"
17364 .cindex "&_/etc/passwd_&"
17365 .vindex "&$home$&"
17366 When this option is true, Exim checks that the local part of the recipient
17367 address (with affixes removed if relevant) is the name of an account on the
17368 local system. The check is done by calling the &[getpwnam()]& function rather
17369 than trying to read &_/etc/passwd_& directly. This means that other methods of
17370 holding password data (such as NIS) are supported. If the local part is a local
17371 user, &$home$& is set from the password data, and can be tested in other
17372 preconditions that are evaluated after this one (the order of evaluation is
17373 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17374 overridden by &%router_home_directory%&. If the local part is not a local user,
17375 the router is skipped.
17376
17377 If you want to check that the local part is either the name of a local user
17378 or matches something else, you cannot combine &%check_local_user%& with a
17379 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17380 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17381 setting to achieve this. For example:
17382 .code
17383 local_parts = passwd;$local_part : lsearch;/etc/other/users
17384 .endd
17385 Note, however, that the side effects of &%check_local_user%& (such as setting
17386 up a home directory) do not occur when a &(passwd)& lookup is used in a
17387 &%local_parts%& (or any other) precondition.
17388
17389
17390
17391 .option condition routers&!? string&!! unset
17392 .cindex "router" "customized precondition"
17393 This option specifies a general precondition test that has to succeed for the
17394 router to be called. The &%condition%& option is the last precondition to be
17395 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17396 result is a forced failure, or an empty string, or one of the strings &"0"& or
17397 &"no"& or &"false"& (checked without regard to the case of the letters), the
17398 router is skipped, and the address is offered to the next one.
17399
17400 If the result is any other value, the router is run (as this is the last
17401 precondition to be evaluated, all the other preconditions must be true).
17402
17403 This option is unusual in that multiple &%condition%& options may be present.
17404 All &%condition%& options must succeed.
17405
17406 The &%condition%& option provides a means of applying custom conditions to the
17407 running of routers. Note that in the case of a simple conditional expansion,
17408 the default expansion values are exactly what is wanted. For example:
17409 .code
17410 condition = ${if >{$message_age}{600}}
17411 .endd
17412 Because of the default behaviour of the string expansion, this is equivalent to
17413 .code
17414 condition = ${if >{$message_age}{600}{true}{}}
17415 .endd
17416
17417 A multiple condition example, which succeeds:
17418 .code
17419 condition = ${if >{$message_age}{600}}
17420 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17421 condition = foobar
17422 .endd
17423
17424 If the expansion fails (other than forced failure) delivery is deferred. Some
17425 of the other precondition options are common special cases that could in fact
17426 be specified using &%condition%&.
17427
17428 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17429 are far older, and use one set of semantics.  ACLs are newer and when
17430 they were created, the ACL &%condition%& process was given far stricter
17431 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17432 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17433 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17434 Router rules processing behavior.
17435
17436 This is best illustrated in an example:
17437 .code
17438 # If used in an ACL condition will fail with a syntax error, but
17439 # in a router condition any extra characters are treated as a string
17440
17441 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17442 true {yes} {no}}
17443
17444 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17445  {yes} {no}}
17446 .endd
17447 In each example above, the &%if%& statement actually ends after
17448 &"{google.com}}"&.  Since no true or false braces were defined, the
17449 default &%if%& behavior is to return a boolean true or a null answer
17450 (which evaluates to false). The rest of the line is then treated as a
17451 string. So the first example resulted in the boolean answer &"true"&
17452 with the string &" {yes} {no}}"& appended to it. The second example
17453 resulted in the null output (indicating false) with the string
17454 &" {yes} {no}}"& appended to it.
17455
17456 In fact you can put excess forward braces in too.  In the router
17457 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17458 mean something, like after a &"$"& or when required as part of a
17459 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17460 string characters.
17461
17462 Thus, in a Router, the above expansion strings will both always evaluate
17463 true, as the result of expansion is a non-empty string which doesn't
17464 match an explicit false value.  This can be tricky to debug.  By
17465 contrast, in an ACL either of those strings will always result in an
17466 expansion error because the result doesn't look sufficiently boolean.
17467
17468
17469 .option debug_print routers string&!! unset
17470 .cindex "testing" "variables in drivers"
17471 If this option is set and debugging is enabled (see the &%-d%& command line
17472 option) or in address-testing mode (see the &%-bt%& command line option),
17473 the string is expanded and included in the debugging output.
17474 If expansion of the string fails, the error message is written to the debugging
17475 output, and Exim carries on processing.
17476 This option is provided to help with checking out the values of variables and
17477 so on when debugging router configurations. For example, if a &%condition%&
17478 option appears not to be working, &%debug_print%& can be used to output the
17479 variables it references. The output happens after checks for &%domains%&,
17480 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17481 are tested. A newline is added to the text if it does not end with one.
17482 The variable &$router_name$& contains the name of the router.
17483
17484
17485
17486 .option disable_logging routers boolean false
17487 If this option is set true, nothing is logged for any routing errors
17488 or for any deliveries caused by this router. You should not set this option
17489 unless you really, really know what you are doing. See also the generic
17490 transport option of the same name.
17491
17492 .option dnssec_request_domains routers "domain list&!!" unset
17493 .cindex "MX record" "security"
17494 .cindex "DNSSEC" "MX lookup"
17495 .cindex "security" "MX lookup"
17496 .cindex "DNS" "DNSSEC"
17497 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17498 the dnssec request bit set.
17499 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17500
17501 .option dnssec_require_domains routers "domain list&!!" unset
17502 .cindex "MX record" "security"
17503 .cindex "DNSSEC" "MX lookup"
17504 .cindex "security" "MX lookup"
17505 .cindex "DNS" "DNSSEC"
17506 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17507 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17508 (AD bit) set will be ignored and logged as a host-lookup failure.
17509 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17510
17511
17512 .option domains routers&!? "domain list&!!" unset
17513 .cindex "router" "restricting to specific domains"
17514 .vindex "&$domain_data$&"
17515 If this option is set, the router is skipped unless the current domain matches
17516 the list. If the match is achieved by means of a file lookup, the data that the
17517 lookup returned for the domain is placed in &$domain_data$& for use in string
17518 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17519 a list of the order in which preconditions are evaluated.
17520
17521
17522
17523 .option driver routers string unset
17524 This option must always be set. It specifies which of the available routers is
17525 to be used.
17526
17527
17528 .option dsn_lasthop routers boolean false
17529 .cindex "DSN" "success"
17530 .cindex "Delivery Status Notification" "success"
17531 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17532 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17533 instead send a success DSN as if the next hop does not support DSN.
17534 Not effective on redirect routers.
17535
17536
17537
17538 .option errors_to routers string&!! unset
17539 .cindex "envelope sender"
17540 .cindex "router" "changing address for errors"
17541 If a router successfully handles an address, it may assign the address to a
17542 transport for delivery or it may generate child addresses. In both cases, if
17543 there is a delivery problem during later processing, the resulting bounce
17544 message is sent to the address that results from expanding this string,
17545 provided that the address verifies successfully. The &%errors_to%& option is
17546 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17547
17548 The &%errors_to%& setting associated with an address can be overridden if it
17549 subsequently passes through other routers that have their own &%errors_to%&
17550 settings, or if the message is delivered by a transport with a &%return_path%&
17551 setting.
17552
17553 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17554 the expansion fails to verify, the errors address associated with the incoming
17555 address is used. At top level, this is the envelope sender. A non-forced
17556 expansion failure causes delivery to be deferred.
17557
17558 If an address for which &%errors_to%& has been set ends up being delivered over
17559 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17560 any bounces that are generated by other MTAs on the delivery route are also
17561 sent there. You can set &%errors_to%& to the empty string by either of these
17562 settings:
17563 .code
17564 errors_to =
17565 errors_to = ""
17566 .endd
17567 An expansion item that yields an empty string has the same effect. If you do
17568 this, a locally detected delivery error for addresses processed by this router
17569 no longer gives rise to a bounce message; the error is discarded. If the
17570 address is delivered to a remote host, the return path is set to &`<>`&, unless
17571 overridden by the &%return_path%& option on the transport.
17572
17573 .vindex "&$address_data$&"
17574 If for some reason you want to discard local errors, but use a non-empty
17575 MAIL command for remote delivery, you can preserve the original return
17576 path in &$address_data$& in the router, and reinstate it in the transport by
17577 setting &%return_path%&.
17578
17579 The most common use of &%errors_to%& is to direct mailing list bounces to the
17580 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17581 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17582
17583
17584
17585 .option expn routers&!? boolean true
17586 .cindex "address" "testing"
17587 .cindex "testing" "addresses"
17588 .cindex "EXPN" "router skipping"
17589 .cindex "router" "skipping for EXPN"
17590 If this option is turned off, the router is skipped when testing an address
17591 as a result of processing an SMTP EXPN command. You might, for example,
17592 want to turn it off on a router for users' &_.forward_& files, while leaving it
17593 on for the system alias file.
17594 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17595 are evaluated.
17596
17597 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17598 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17599 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17600
17601
17602
17603 .option fail_verify routers boolean false
17604 .cindex "router" "forcing verification failure"
17605 Setting this option has the effect of setting both &%fail_verify_sender%& and
17606 &%fail_verify_recipient%& to the same value.
17607
17608
17609
17610 .option fail_verify_recipient routers boolean false
17611 If this option is true and an address is accepted by this router when
17612 verifying a recipient, verification fails.
17613
17614
17615
17616 .option fail_verify_sender routers boolean false
17617 If this option is true and an address is accepted by this router when
17618 verifying a sender, verification fails.
17619
17620
17621
17622 .option fallback_hosts routers "string list" unset
17623 .cindex "router" "fallback hosts"
17624 .cindex "fallback" "hosts specified on router"
17625 String expansion is not applied to this option. The argument must be a
17626 colon-separated list of host names or IP addresses. The list separator can be
17627 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17628 each name or address. In fact, the format of each item is exactly the same as
17629 defined for the list of hosts in a &(manualroute)& router (see section
17630 &<<SECTformatonehostitem>>&).
17631
17632 If a router queues an address for a remote transport, this host list is
17633 associated with the address, and used instead of the transport's fallback host
17634 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17635 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17636 transport for further details.
17637
17638
17639 .option group routers string&!! "see below"
17640 .cindex "gid (group id)" "local delivery"
17641 .cindex "local transports" "uid and gid"
17642 .cindex "transport" "local"
17643 .cindex "router" "setting group"
17644 When a router queues an address for a transport, and the transport does not
17645 specify a group, the group given here is used when running the delivery
17646 process.
17647 The group may be specified numerically or by name. If expansion fails, the
17648 error is logged and delivery is deferred.
17649 The default is unset, unless &%check_local_user%& is set, when the default
17650 is taken from the password information. See also &%initgroups%& and &%user%&
17651 and the discussion in chapter &<<CHAPenvironment>>&.
17652
17653
17654
17655 .option headers_add routers list&!! unset
17656 .cindex "header lines" "adding"
17657 .cindex "router" "adding header lines"
17658 This option specifies a list of text headers,
17659 newline-separated (by default, changeable in the usual way),
17660 that is associated with any addresses that are accepted by the router.
17661 Each item is separately expanded, at routing time.  However, this
17662 option has no effect when an address is just being verified. The way in which
17663 the text is used to add header lines at transport time is described in section
17664 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17665 message is in the process of being transported. This means that references to
17666 header lines in string expansions in the transport's configuration do not
17667 &"see"& the added header lines.
17668
17669 The &%headers_add%& option is expanded after &%errors_to%&, but before
17670 &%headers_remove%& and &%transport%&. If an item is empty, or if
17671 an item expansion is forced to fail, the item has no effect. Other expansion
17672 failures are treated as configuration errors.
17673
17674 Unlike most options, &%headers_add%& can be specified multiple times
17675 for a router; all listed headers are added.
17676
17677 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17678 router that has the &%one_time%& option set.
17679
17680 .cindex "duplicate addresses"
17681 .oindex "&%unseen%&"
17682 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17683 additions are deleted when the address is passed on to subsequent routers.
17684 For a &%redirect%& router, if a generated address is the same as the incoming
17685 address, this can lead to duplicate addresses with different header
17686 modifications. Exim does not do duplicate deliveries (except, in certain
17687 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17688 which of the duplicates is discarded, so this ambiguous situation should be
17689 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17690
17691
17692
17693 .option headers_remove routers list&!! unset
17694 .cindex "header lines" "removing"
17695 .cindex "router" "removing header lines"
17696 This option specifies a list of text headers,
17697 colon-separated (by default, changeable in the usual way),
17698 that is associated with any addresses that are accepted by the router.
17699 Each item is separately expanded, at routing time.  However, this
17700 option has no effect when an address is just being verified. The way in which
17701 the text is used to remove header lines at transport time is described in
17702 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17703 the message is in the process of being transported. This means that references
17704 to header lines in string expansions in the transport's configuration still
17705 &"see"& the original header lines.
17706
17707 The &%headers_remove%& option is expanded after &%errors_to%& and
17708 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17709 the item has no effect. Other expansion failures are treated as configuration
17710 errors.
17711
17712 Unlike most options, &%headers_remove%& can be specified multiple times
17713 for a router; all listed headers are removed.
17714
17715 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17716 router that has the &%one_time%& option set.
17717
17718 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17719 removal requests are deleted when the address is passed on to subsequent
17720 routers, and this can lead to problems with duplicates -- see the similar
17721 warning for &%headers_add%& above.
17722
17723 &*Warning 3*&: Because of the separate expansion of the list items,
17724 items that contain a list separator must have it doubled.
17725 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17726
17727
17728
17729 .option ignore_target_hosts routers "host list&!!" unset
17730 .cindex "IP address" "discarding"
17731 .cindex "router" "discarding IP addresses"
17732 Although this option is a host list, it should normally contain IP address
17733 entries rather than names. If any host that is looked up by the router has an
17734 IP address that matches an item in this list, Exim behaves as if that IP
17735 address did not exist. This option allows you to cope with rogue DNS entries
17736 like
17737 .code
17738 remote.domain.example.  A  127.0.0.1
17739 .endd
17740 by setting
17741 .code
17742 ignore_target_hosts = 127.0.0.1
17743 .endd
17744 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17745 discarded in this way, the router declines. In a conventional configuration, an
17746 attempt to mail to such a domain would normally provoke the &"unrouteable
17747 domain"& error, and an attempt to verify an address in the domain would fail.
17748 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17749 router declines if presented with one of the listed addresses.
17750
17751 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17752 means of the first or the second of the following settings, respectively:
17753 .code
17754 ignore_target_hosts = 0.0.0.0/0
17755 ignore_target_hosts = <; 0::0/0
17756 .endd
17757 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17758 in the second line matches all IPv6 addresses.
17759
17760 This option may also be useful for ignoring link-local and site-local IPv6
17761 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17762 is expanded before use as a list, it is possible to make it dependent on the
17763 domain that is being routed.
17764
17765 .vindex "&$host_address$&"
17766 During its expansion, &$host_address$& is set to the IP address that is being
17767 checked.
17768
17769 .option initgroups routers boolean false
17770 .cindex "additional groups"
17771 .cindex "groups" "additional"
17772 .cindex "local transports" "uid and gid"
17773 .cindex "transport" "local"
17774 If the router queues an address for a transport, and this option is true, and
17775 the uid supplied by the router is not overridden by the transport, the
17776 &[initgroups()]& function is called when running the transport to ensure that
17777 any additional groups associated with the uid are set up. See also &%group%&
17778 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17779
17780
17781
17782 .option local_part_prefix routers&!? "string list" unset
17783 .cindex "router" "prefix for local part"
17784 .cindex "prefix" "for local part, used in router"
17785 If this option is set, the router is skipped unless the local part starts with
17786 one of the given strings, or &%local_part_prefix_optional%& is true. See
17787 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17788 evaluated.
17789
17790 The list is scanned from left to right, and the first prefix that matches is
17791 used. A limited form of wildcard is available; if the prefix begins with an
17792 asterisk, it matches the longest possible sequence of arbitrary characters at
17793 the start of the local part. An asterisk should therefore always be followed by
17794 some character that does not occur in normal local parts.
17795 .cindex "multiple mailboxes"
17796 .cindex "mailbox" "multiple"
17797 Wildcarding can be used to set up multiple user mailboxes, as described in
17798 section &<<SECTmulbox>>&.
17799
17800 .vindex "&$local_part$&"
17801 .vindex "&$local_part_prefix$&"
17802 During the testing of the &%local_parts%& option, and while the router is
17803 running, the prefix is removed from the local part, and is available in the
17804 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17805 the router accepts the address, this remains true during subsequent delivery by
17806 a transport. In particular, the local part that is transmitted in the RCPT
17807 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17808 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17809 the relevant transport.
17810
17811 When an address is being verified, &%local_part_prefix%& affects only the
17812 behaviour of the router. If the callout feature of verification is in use, this
17813 means that the full address, including the prefix, will be used during the
17814 callout.
17815
17816 The prefix facility is commonly used to handle local parts of the form
17817 &%owner-something%&. Another common use is to support local parts of the form
17818 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17819 to tell a user their forwarding is broken &-- by placing a router like this one
17820 immediately before the router that handles &_.forward_& files:
17821 .code
17822 real_localuser:
17823   driver = accept
17824   local_part_prefix = real-
17825   check_local_user
17826   transport = local_delivery
17827 .endd
17828 For security, it would probably be a good idea to restrict the use of this
17829 router to locally-generated messages, using a condition such as this:
17830 .code
17831   condition = ${if match {$sender_host_address}\
17832                          {\N^(|127\.0\.0\.1)$\N}}
17833 .endd
17834
17835 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17836 both conditions must be met if not optional. Care must be taken if wildcards
17837 are used in both a prefix and a suffix on the same router. Different
17838 separator characters must be used to avoid ambiguity.
17839
17840
17841 .option local_part_prefix_optional routers boolean false
17842 See &%local_part_prefix%& above.
17843
17844
17845
17846 .option local_part_suffix routers&!? "string list" unset
17847 .cindex "router" "suffix for local part"
17848 .cindex "suffix for local part" "used in router"
17849 This option operates in the same way as &%local_part_prefix%&, except that the
17850 local part must end (rather than start) with the given string, the
17851 &%local_part_suffix_optional%& option determines whether the suffix is
17852 mandatory, and the wildcard * character, if present, must be the last
17853 character of the suffix. This option facility is commonly used to handle local
17854 parts of the form &%something-request%& and multiple user mailboxes of the form
17855 &%username-foo%&.
17856
17857
17858 .option local_part_suffix_optional routers boolean false
17859 See &%local_part_suffix%& above.
17860
17861
17862
17863 .option local_parts routers&!? "local part list&!!" unset
17864 .cindex "router" "restricting to specific local parts"
17865 .cindex "local part" "checking in router"
17866 The router is run only if the local part of the address matches the list.
17867 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17868 are evaluated, and
17869 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17870 string is expanded, it is possible to make it depend on the domain, for
17871 example:
17872 .code
17873 local_parts = dbm;/usr/local/specials/$domain
17874 .endd
17875 .vindex "&$local_part_data$&"
17876 If the match is achieved by a lookup, the data that the lookup returned
17877 for the local part is placed in the variable &$local_part_data$& for use in
17878 expansions of the router's private options. You might use this option, for
17879 example, if you have a large number of local virtual domains, and you want to
17880 send all postmaster mail to the same place without having to set up an alias in
17881 each virtual domain:
17882 .code
17883 postmaster:
17884   driver = redirect
17885   local_parts = postmaster
17886   data = postmaster@real.domain.example
17887 .endd
17888
17889
17890 .option log_as_local routers boolean "see below"
17891 .cindex "log" "delivery line"
17892 .cindex "delivery" "log line format"
17893 Exim has two logging styles for delivery, the idea being to make local
17894 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17895 recipient address is given just as the local part, without a domain. The use of
17896 this style is controlled by this option. It defaults to true for the &(accept)&
17897 router, and false for all the others. This option applies only when a
17898 router assigns an address to a transport. It has no effect on routers that
17899 redirect addresses.
17900
17901
17902
17903 .option more routers boolean&!! true
17904 The result of string expansion for this option must be a valid boolean value,
17905 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17906 result causes an error, and delivery is deferred. If the expansion is forced to
17907 fail, the default value for the option (true) is used. Other failures cause
17908 delivery to be deferred.
17909
17910 If this option is set false, and the router declines to handle the address, no
17911 further routers are tried, routing fails, and the address is bounced.
17912 .oindex "&%self%&"
17913 However, if the router explicitly passes an address to the following router by
17914 means of the setting
17915 .code
17916 self = pass
17917 .endd
17918 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17919 does not affect the behaviour if one of the precondition tests fails. In that
17920 case, the address is always passed to the next router.
17921
17922 Note that &%address_data%& is not considered to be a precondition. If its
17923 expansion is forced to fail, the router declines, and the value of &%more%&
17924 controls what happens next.
17925
17926
17927 .option pass_on_timeout routers boolean false
17928 .cindex "timeout" "of router"
17929 .cindex "router" "timeout"
17930 If a router times out during a host lookup, it normally causes deferral of the
17931 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17932 router, overriding &%no_more%&. This may be helpful for systems that are
17933 intermittently connected to the Internet, or those that want to pass to a smart
17934 host any messages that cannot immediately be delivered.
17935
17936 There are occasional other temporary errors that can occur while doing DNS
17937 lookups. They are treated in the same way as a timeout, and this option
17938 applies to all of them.
17939
17940
17941
17942 .option pass_router routers string unset
17943 .cindex "router" "go to after &""pass""&"
17944 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17945 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17946 routing to continue, and overriding a false setting of &%more%&. When one of
17947 these routers returns &"pass"&, the address is normally handed on to the next
17948 router in sequence. This can be changed by setting &%pass_router%& to the name
17949 of another router. However (unlike &%redirect_router%&) the named router must
17950 be below the current router, to avoid loops. Note that this option applies only
17951 to the special case of &"pass"&. It does not apply when a router returns
17952 &"decline"& because it cannot handle an address.
17953
17954
17955
17956 .option redirect_router routers string unset
17957 .cindex "router" "start at after redirection"
17958 Sometimes an administrator knows that it is pointless to reprocess addresses
17959 generated from alias or forward files with the same router again. For
17960 example, if an alias file translates real names into login ids there is no
17961 point searching the alias file a second time, especially if it is a large file.
17962
17963 The &%redirect_router%& option can be set to the name of any router instance.
17964 It causes the routing of any generated addresses to start at the named router
17965 instead of at the first router. This option has no effect if the router in
17966 which it is set does not generate new addresses.
17967
17968
17969
17970 .option require_files routers&!? "string list&!!" unset
17971 .cindex "file" "requiring for router"
17972 .cindex "router" "requiring file existence"
17973 This option provides a general mechanism for predicating the running of a
17974 router on the existence or non-existence of certain files or directories.
17975 Before running a router, as one of its precondition tests, Exim works its way
17976 through the &%require_files%& list, expanding each item separately.
17977
17978 Because the list is split before expansion, any colons in expansion items must
17979 be doubled, or the facility for using a different list separator must be used.
17980 If any expansion is forced to fail, the item is ignored. Other expansion
17981 failures cause routing of the address to be deferred.
17982
17983 If any expanded string is empty, it is ignored. Otherwise, except as described
17984 below, each string must be a fully qualified file path, optionally preceded by
17985 &"!"&. The paths are passed to the &[stat()]& function to test for the
17986 existence of the files or directories. The router is skipped if any paths not
17987 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17988
17989 .cindex "NFS"
17990 If &[stat()]& cannot determine whether a file exists or not, delivery of
17991 the message is deferred. This can happen when NFS-mounted filesystems are
17992 unavailable.
17993
17994 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17995 options, so you cannot use it to check for the existence of a file in which to
17996 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17997 full list of the order in which preconditions are evaluated.) However, as
17998 these options are all expanded, you can use the &%exists%& expansion condition
17999 to make such tests. The &%require_files%& option is intended for checking files
18000 that the router may be going to use internally, or which are needed by a
18001 transport (for example &_.procmailrc_&).
18002
18003 During delivery, the &[stat()]& function is run as root, but there is a
18004 facility for some checking of the accessibility of a file by another user.
18005 This is not a proper permissions check, but just a &"rough"& check that
18006 operates as follows:
18007
18008 If an item in a &%require_files%& list does not contain any forward slash
18009 characters, it is taken to be the user (and optional group, separated by a
18010 comma) to be checked for subsequent files in the list. If no group is specified
18011 but the user is specified symbolically, the gid associated with the uid is
18012 used. For example:
18013 .code
18014 require_files = mail:/some/file
18015 require_files = $local_part:$home/.procmailrc
18016 .endd
18017 If a user or group name in a &%require_files%& list does not exist, the
18018 &%require_files%& condition fails.
18019
18020 Exim performs the check by scanning along the components of the file path, and
18021 checking the access for the given uid and gid. It checks for &"x"& access on
18022 directories, and &"r"& access on the final file. Note that this means that file
18023 access control lists, if the operating system has them, are ignored.
18024
18025 &*Warning 1*&: When the router is being run to verify addresses for an
18026 incoming SMTP message, Exim is not running as root, but under its own uid. This
18027 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18028 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18029 user is not permitted to read one of the directories on the file's path.
18030
18031 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18032 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18033 without root access. In this case, if a check for access by a particular user
18034 is requested, Exim creates a subprocess that runs as that user, and tries the
18035 check again in that process.
18036
18037 The default action for handling an unresolved EACCES is to consider it to
18038 be caused by a configuration error, and routing is deferred because the
18039 existence or non-existence of the file cannot be determined. However, in some
18040 circumstances it may be desirable to treat this condition as if the file did
18041 not exist. If the file name (or the exclamation mark that precedes the file
18042 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18043 as if the file did not exist. For example:
18044 .code
18045 require_files = +/some/file
18046 .endd
18047 If the router is not an essential part of verification (for example, it
18048 handles users' &_.forward_& files), another solution is to set the &%verify%&
18049 option false so that the router is skipped when verifying.
18050
18051
18052
18053 .option retry_use_local_part routers boolean "see below"
18054 .cindex "hints database" "retry keys"
18055 .cindex "local part" "in retry keys"
18056 When a delivery suffers a temporary routing failure, a retry record is created
18057 in Exim's hints database. For addresses whose routing depends only on the
18058 domain, the key for the retry record should not involve the local part, but for
18059 other addresses, both the domain and the local part should be included.
18060 Usually, remote routing is of the former kind, and local routing is of the
18061 latter kind.
18062
18063 This option controls whether the local part is used to form the key for retry
18064 hints for addresses that suffer temporary errors while being handled by this
18065 router. The default value is true for any router that has &%check_local_user%&
18066 set, and false otherwise. Note that this option does not apply to hints keys
18067 for transport delays; they are controlled by a generic transport option of the
18068 same name.
18069
18070 The setting of &%retry_use_local_part%& applies only to the router on which it
18071 appears. If the router generates child addresses, they are routed
18072 independently; this setting does not become attached to them.
18073
18074
18075
18076 .option router_home_directory routers string&!! unset
18077 .cindex "router" "home directory for"
18078 .cindex "home directory" "for router"
18079 .vindex "&$home$&"
18080 This option sets a home directory for use while the router is running. (Compare
18081 &%transport_home_directory%&, which sets a home directory for later
18082 transporting.) In particular, if used on a &(redirect)& router, this option
18083 sets a value for &$home$& while a filter is running. The value is expanded;
18084 forced expansion failure causes the option to be ignored &-- other failures
18085 cause the router to defer.
18086
18087 Expansion of &%router_home_directory%& happens immediately after the
18088 &%check_local_user%& test (if configured), before any further expansions take
18089 place.
18090 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18091 are evaluated.)
18092 While the router is running, &%router_home_directory%& overrides the value of
18093 &$home$& that came from &%check_local_user%&.
18094
18095 When a router accepts an address and assigns it to a local transport (including
18096 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18097 delivery), the home directory setting for the transport is taken from the first
18098 of these values that is set:
18099
18100 .ilist
18101 The &%home_directory%& option on the transport;
18102 .next
18103 The &%transport_home_directory%& option on the router;
18104 .next
18105 The password data if &%check_local_user%& is set on the router;
18106 .next
18107 The &%router_home_directory%& option on the router.
18108 .endlist
18109
18110 In other words, &%router_home_directory%& overrides the password data for the
18111 router, but not for the transport.
18112
18113
18114
18115 .option self routers string freeze
18116 .cindex "MX record" "pointing to local host"
18117 .cindex "local host" "MX pointing to"
18118 This option applies to those routers that use a recipient address to find a
18119 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18120 and &(manualroute)& routers.
18121 Certain configurations of the &(queryprogram)& router can also specify a list
18122 of remote hosts.
18123 Usually such routers are configured to send the message to a remote host via an
18124 &(smtp)& transport. The &%self%& option specifies what happens when the first
18125 host on the list turns out to be the local host.
18126 The way in which Exim checks for the local host is described in section
18127 &<<SECTreclocipadd>>&.
18128
18129 Normally this situation indicates either an error in Exim's configuration (for
18130 example, the router should be configured not to process this domain), or an
18131 error in the DNS (for example, the MX should not point to this host). For this
18132 reason, the default action is to log the incident, defer the address, and
18133 freeze the message. The following alternatives are provided for use in special
18134 cases:
18135
18136 .vlist
18137 .vitem &%defer%&
18138 Delivery of the message is tried again later, but the message is not frozen.
18139
18140 .vitem "&%reroute%&: <&'domain'&>"
18141 The domain is changed to the given domain, and the address is passed back to
18142 be reprocessed by the routers. No rewriting of headers takes place. This
18143 behaviour is essentially a redirection.
18144
18145 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18146 The domain is changed to the given domain, and the address is passed back to be
18147 reprocessed by the routers. Any headers that contain the original domain are
18148 rewritten.
18149
18150 .vitem &%pass%&
18151 .oindex "&%more%&"
18152 .vindex "&$self_hostname$&"
18153 The router passes the address to the next router, or to the router named in the
18154 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18155 subsequent routing and delivery, the variable &$self_hostname$& contains the
18156 name of the local host that the router encountered. This can be used to
18157 distinguish between different cases for hosts with multiple names. The
18158 combination
18159 .code
18160 self = pass
18161 no_more
18162 .endd
18163 ensures that only those addresses that routed to the local host are passed on.
18164 Without &%no_more%&, addresses that were declined for other reasons would also
18165 be passed to the next router.
18166
18167 .vitem &%fail%&
18168 Delivery fails and an error report is generated.
18169
18170 .vitem &%send%&
18171 .cindex "local host" "sending to"
18172 The anomaly is ignored and the address is queued for the transport. This
18173 setting should be used with extreme caution. For an &(smtp)& transport, it
18174 makes sense only in cases where the program that is listening on the SMTP port
18175 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18176 different configuration file that handles the domain in another way.
18177 .endlist
18178
18179
18180
18181 .option senders routers&!? "address list&!!" unset
18182 .cindex "router" "checking senders"
18183 If this option is set, the router is skipped unless the message's sender
18184 address matches something on the list.
18185 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18186 are evaluated.
18187
18188 There are issues concerning verification when the running of routers is
18189 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18190 setting, it sets the sender to the null string. When using the &%-bt%& option
18191 to check a configuration file, it is necessary also to use the &%-f%& option to
18192 set an appropriate sender. For incoming mail, the sender is unset when
18193 verifying the sender, but is available when verifying any recipients. If the
18194 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18195 matters.
18196
18197
18198 .option translate_ip_address routers string&!! unset
18199 .cindex "IP address" "translating"
18200 .cindex "packet radio"
18201 .cindex "router" "IP address translation"
18202 There exist some rare networking situations (for example, packet radio) where
18203 it is helpful to be able to translate IP addresses generated by normal routing
18204 mechanisms into other IP addresses, thus performing a kind of manual IP
18205 routing. This should be done only if the normal IP routing of the TCP/IP stack
18206 is inadequate or broken. Because this is an extremely uncommon requirement, the
18207 code to support this option is not included in the Exim binary unless
18208 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18209
18210 .vindex "&$host_address$&"
18211 The &%translate_ip_address%& string is expanded for every IP address generated
18212 by the router, with the generated address set in &$host_address$&. If the
18213 expansion is forced to fail, no action is taken.
18214 For any other expansion error, delivery of the message is deferred.
18215 If the result of the expansion is an IP address, that replaces the original
18216 address; otherwise the result is assumed to be a host name &-- this is looked
18217 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18218 produce one or more replacement IP addresses. For example, to subvert all IP
18219 addresses in some specific networks, this could be added to a router:
18220 .code
18221 translate_ip_address = \
18222   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18223     {$value}fail}}
18224 .endd
18225 The file would contain lines like
18226 .code
18227 10.2.3.128/26    some.host
18228 10.8.4.34/26     10.44.8.15
18229 .endd
18230 You should not make use of this facility unless you really understand what you
18231 are doing.
18232
18233
18234
18235 .option transport routers string&!! unset
18236 This option specifies the transport to be used when a router accepts an address
18237 and sets it up for delivery. A transport is never needed if a router is used
18238 only for verification. The value of the option is expanded at routing time,
18239 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18240 and result must be the name of one of the configured transports. If it is not,
18241 delivery is deferred.
18242
18243 The &%transport%& option is not used by the &(redirect)& router, but it does
18244 have some private options that set up transports for pipe and file deliveries
18245 (see chapter &<<CHAPredirect>>&).
18246
18247
18248
18249 .option transport_current_directory routers string&!! unset
18250 .cindex "current directory for local transport"
18251 This option associates a current directory with any address that is routed
18252 to a local transport. This can happen either because a transport is
18253 explicitly configured for the router, or because it generates a delivery to a
18254 file or a pipe. During the delivery process (that is, at transport time), this
18255 option string is expanded and is set as the current directory, unless
18256 overridden by a setting on the transport.
18257 If the expansion fails for any reason, including forced failure, an error is
18258 logged, and delivery is deferred.
18259 See chapter &<<CHAPenvironment>>& for details of the local delivery
18260 environment.
18261
18262
18263
18264
18265 .option transport_home_directory routers string&!! "see below"
18266 .cindex "home directory" "for local transport"
18267 This option associates a home directory with any address that is routed to a
18268 local transport. This can happen either because a transport is explicitly
18269 configured for the router, or because it generates a delivery to a file or a
18270 pipe. During the delivery process (that is, at transport time), the option
18271 string is expanded and is set as the home directory, unless overridden by a
18272 setting of &%home_directory%& on the transport.
18273 If the expansion fails for any reason, including forced failure, an error is
18274 logged, and delivery is deferred.
18275
18276 If the transport does not specify a home directory, and
18277 &%transport_home_directory%& is not set for the router, the home directory for
18278 the transport is taken from the password data if &%check_local_user%& is set for
18279 the router. Otherwise it is taken from &%router_home_directory%& if that option
18280 is set; if not, no home directory is set for the transport.
18281
18282 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18283 environment.
18284
18285
18286
18287
18288 .option unseen routers boolean&!! false
18289 .cindex "router" "carrying on after success"
18290 The result of string expansion for this option must be a valid boolean value,
18291 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18292 result causes an error, and delivery is deferred. If the expansion is forced to
18293 fail, the default value for the option (false) is used. Other failures cause
18294 delivery to be deferred.
18295
18296 When this option is set true, routing does not cease if the router accepts the
18297 address. Instead, a copy of the incoming address is passed to the next router,
18298 overriding a false setting of &%more%&. There is little point in setting
18299 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18300 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18301 sometimes true and sometimes false).
18302
18303 .cindex "copy of message (&%unseen%& option)"
18304 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18305 qualifier in filter files. It can be used to cause copies of messages to be
18306 delivered to some other destination, while also carrying out a normal delivery.
18307 In effect, the current address is made into a &"parent"& that has two children
18308 &-- one that is delivered as specified by this router, and a clone that goes on
18309 to be routed further. For this reason, &%unseen%& may not be combined with the
18310 &%one_time%& option in a &(redirect)& router.
18311
18312 &*Warning*&: Header lines added to the address (or specified for removal) by
18313 this router or by previous routers affect the &"unseen"& copy of the message
18314 only. The clone that continues to be processed by further routers starts with
18315 no added headers and none specified for removal. For a &%redirect%& router, if
18316 a generated address is the same as the incoming address, this can lead to
18317 duplicate addresses with different header modifications. Exim does not do
18318 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18319 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18320 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18321 &%redirect%& router may be of help.
18322
18323 Unlike the handling of header modifications, any data that was set by the
18324 &%address_data%& option in the current or previous routers &'is'& passed on to
18325 subsequent routers.
18326
18327
18328 .option user routers string&!! "see below"
18329 .cindex "uid (user id)" "local delivery"
18330 .cindex "local transports" "uid and gid"
18331 .cindex "transport" "local"
18332 .cindex "router" "user for filter processing"
18333 .cindex "filter" "user for processing"
18334 When a router queues an address for a transport, and the transport does not
18335 specify a user, the user given here is used when running the delivery process.
18336 The user may be specified numerically or by name. If expansion fails, the
18337 error is logged and delivery is deferred.
18338 This user is also used by the &(redirect)& router when running a filter file.
18339 The default is unset, except when &%check_local_user%& is set. In this case,
18340 the default is taken from the password information. If the user is specified as
18341 a name, and &%group%& is not set, the group associated with the user is used.
18342 See also &%initgroups%& and &%group%& and the discussion in chapter
18343 &<<CHAPenvironment>>&.
18344
18345
18346
18347 .option verify routers&!? boolean true
18348 Setting this option has the effect of setting &%verify_sender%& and
18349 &%verify_recipient%& to the same value.
18350
18351
18352 .option verify_only routers&!? boolean false
18353 .cindex "EXPN" "with &%verify_only%&"
18354 .oindex "&%-bv%&"
18355 .cindex "router" "used only when verifying"
18356 If this option is set, the router is used only when verifying an address,
18357 delivering in cutthrough mode or
18358 testing with the &%-bv%& option, not when actually doing a delivery, testing
18359 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18360 restricted to verifying only senders or recipients by means of
18361 &%verify_sender%& and &%verify_recipient%&.
18362
18363 &*Warning*&: When the router is being run to verify addresses for an incoming
18364 SMTP message, Exim is not running as root, but under its own uid. If the router
18365 accesses any files, you need to make sure that they are accessible to the Exim
18366 user or group.
18367
18368
18369 .option verify_recipient routers&!? boolean true
18370 If this option is false, the router is skipped when verifying recipient
18371 addresses,
18372 delivering in cutthrough mode
18373 or testing recipient verification using &%-bv%&.
18374 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18375 are evaluated.
18376 See also the &$verify_mode$& variable.
18377
18378
18379 .option verify_sender routers&!? boolean true
18380 If this option is false, the router is skipped when verifying sender addresses
18381 or testing sender verification using &%-bvs%&.
18382 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18383 are evaluated.
18384 See also the &$verify_mode$& variable.
18385 .ecindex IIDgenoprou1
18386 .ecindex IIDgenoprou2
18387
18388
18389
18390
18391
18392
18393 . ////////////////////////////////////////////////////////////////////////////
18394 . ////////////////////////////////////////////////////////////////////////////
18395
18396 .chapter "The accept router" "CHID4"
18397 .cindex "&(accept)& router"
18398 .cindex "routers" "&(accept)&"
18399 The &(accept)& router has no private options of its own. Unless it is being
18400 used purely for verification (see &%verify_only%&) a transport is required to
18401 be defined by the generic &%transport%& option. If the preconditions that are
18402 specified by generic options are met, the router accepts the address and queues
18403 it for the given transport. The most common use of this router is for setting
18404 up deliveries to local mailboxes. For example:
18405 .code
18406 localusers:
18407   driver = accept
18408   domains = mydomain.example
18409   check_local_user
18410   transport = local_delivery
18411 .endd
18412 The &%domains%& condition in this example checks the domain of the address, and
18413 &%check_local_user%& checks that the local part is the login of a local user.
18414 When both preconditions are met, the &(accept)& router runs, and queues the
18415 address for the &(local_delivery)& transport.
18416
18417
18418
18419
18420
18421
18422 . ////////////////////////////////////////////////////////////////////////////
18423 . ////////////////////////////////////////////////////////////////////////////
18424
18425 .chapter "The dnslookup router" "CHAPdnslookup"
18426 .scindex IIDdnsrou1 "&(dnslookup)& router"
18427 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18428 The &(dnslookup)& router looks up the hosts that handle mail for the
18429 recipient's domain in the DNS. A transport must always be set for this router,
18430 unless &%verify_only%& is set.
18431
18432 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18433 SRV records. If none are found, or if SRV support is not configured,
18434 MX records are looked up. If no MX records exist, address records are sought.
18435 However, &%mx_domains%& can be set to disable the direct use of address
18436 records.
18437
18438 MX records of equal priority are sorted by Exim into a random order. Exim then
18439 looks for address records for the host names obtained from MX or SRV records.
18440 When a host has more than one IP address, they are sorted into a random order,
18441 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18442 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18443 generic option, the router declines.
18444
18445 Unless they have the highest priority (lowest MX value), MX records that point
18446 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18447 are discarded, together with any other MX records of equal or lower priority.
18448
18449 .cindex "MX record" "pointing to local host"
18450 .cindex "local host" "MX pointing to"
18451 .oindex "&%self%&" "in &(dnslookup)& router"
18452 If the host pointed to by the highest priority MX record, or looked up as an
18453 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18454 happens is controlled by the generic &%self%& option.
18455
18456
18457 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18458 There have been problems with DNS servers when SRV records are looked up.
18459 Some misbehaving servers return a DNS error or timeout when a non-existent
18460 SRV record is sought. Similar problems have in the past been reported for
18461 MX records. The global &%dns_again_means_nonexist%& option can help with this
18462 problem, but it is heavy-handed because it is a global option.
18463
18464 For this reason, there are two options, &%srv_fail_domains%& and
18465 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18466 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18467 an attempt to look up an SRV or MX record causes one of these results, and the
18468 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18469 such record"&. In the case of an SRV lookup, this means that the router
18470 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18471 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18472 case routing fails.
18473
18474
18475 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18476 .cindex "&(dnslookup)& router" "declines"
18477 There are a few cases where a &(dnslookup)& router will decline to accept
18478 an address; if such a router is expected to handle "all remaining non-local
18479 domains", then it is important to set &%no_more%&.
18480
18481 The router will defer rather than decline if the domain
18482 is found in the &%fail_defer_domains%& router option.
18483
18484 Reasons for a &(dnslookup)& router to decline currently include:
18485 .ilist
18486 The domain does not exist in DNS
18487 .next
18488 The domain exists but the MX record's host part is just "."; this is a common
18489 convention (borrowed from SRV) used to indicate that there is no such service
18490 for this domain and to not fall back to trying A/AAAA records.
18491 .next
18492 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18493 .next
18494 MX record points to a non-existent host.
18495 .next
18496 MX record points to an IP address and the main section option
18497 &%allow_mx_to_ip%& is not set.
18498 .next
18499 MX records exist and point to valid hosts, but all hosts resolve only to
18500 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18501 .next
18502 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18503 &%dns_check_names_pattern%& for handling one variant of this)
18504 .next
18505 &%check_secondary_mx%& is set on this router but the local host can
18506 not be found in the MX records (see below)
18507 .endlist
18508
18509
18510
18511
18512 .section "Private options for dnslookup" "SECID118"
18513 .cindex "options" "&(dnslookup)& router"
18514 The private options for the &(dnslookup)& router are as follows:
18515
18516 .option check_secondary_mx dnslookup boolean false
18517 .cindex "MX record" "checking for secondary"
18518 If this option is set, the router declines unless the local host is found in
18519 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18520 process domains for which the local host is a secondary mail exchanger
18521 differently to other domains. The way in which Exim decides whether a host is
18522 the local host is described in section &<<SECTreclocipadd>>&.
18523
18524
18525 .option check_srv dnslookup string&!! unset
18526 .cindex "SRV record" "enabling use of"
18527 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18528 addition to MX and address records. The support is disabled by default. To
18529 enable SRV support, set the &%check_srv%& option to the name of the service
18530 required. For example,
18531 .code
18532 check_srv = smtp
18533 .endd
18534 looks for SRV records that refer to the normal smtp service. The option is
18535 expanded, so the service name can vary from message to message or address
18536 to address. This might be helpful if SRV records are being used for a
18537 submission service. If the expansion is forced to fail, the &%check_srv%&
18538 option is ignored, and the router proceeds to look for MX records in the
18539 normal way.
18540
18541 When the expansion succeeds, the router searches first for SRV records for
18542 the given service (it assumes TCP protocol). A single SRV record with a
18543 host name that consists of just a single dot indicates &"no such service for
18544 this domain"&; if this is encountered, the router declines. If other kinds of
18545 SRV record are found, they are used to construct a host list for delivery
18546 according to the rules of RFC 2782. MX records are not sought in this case.
18547
18548 When no SRV records are found, MX records (and address records) are sought in
18549 the traditional way. In other words, SRV records take precedence over MX
18550 records, just as MX records take precedence over address records. Note that
18551 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18552 defined it. It is apparently believed that MX records are sufficient for email
18553 and that SRV records should not be used for this purpose. However, SRV records
18554 have an additional &"weight"& feature which some people might find useful when
18555 trying to split an SMTP load between hosts of different power.
18556
18557 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18558 when there is a DNS lookup error.
18559
18560
18561
18562
18563 .option fail_defer_domains dnslookup "domain list&!!" unset
18564 .cindex "MX record" "not found"
18565 DNS lookups for domains matching &%fail_defer_domains%&
18566 which find no matching record will cause the router to defer
18567 rather than the default behaviour of decline.
18568 This maybe be useful for queueing messages for a newly created
18569 domain while the DNS configuration is not ready.
18570 However, it will result in any message with mistyped domains
18571 also being queued.
18572
18573
18574 .option mx_domains dnslookup "domain list&!!" unset
18575 .cindex "MX record" "required to exist"
18576 .cindex "SRV record" "required to exist"
18577 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18578 record in order to be recognized. (The name of this option could be improved.)
18579 For example, if all the mail hosts in &'fict.example'& are known to have MX
18580 records, except for those in &'discworld.fict.example'&, you could use this
18581 setting:
18582 .code
18583 mx_domains = ! *.discworld.fict.example : *.fict.example
18584 .endd
18585 This specifies that messages addressed to a domain that matches the list but
18586 has no MX record should be bounced immediately instead of being routed using
18587 the address record.
18588
18589
18590 .option mx_fail_domains dnslookup "domain list&!!" unset
18591 If the DNS lookup for MX records for one of the domains in this list causes a
18592 DNS lookup error, Exim behaves as if no MX records were found. See section
18593 &<<SECTprowitdnsloo>>& for more discussion.
18594
18595
18596
18597
18598 .option qualify_single dnslookup boolean true
18599 .cindex "DNS" "resolver options"
18600 .cindex "DNS" "qualifying single-component names"
18601 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18602 lookups. Typically, but not standardly, this causes the resolver to qualify
18603 single-component names with the default domain. For example, on a machine
18604 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18605 &'thesaurus.ref.example'& inside the resolver. For details of what your
18606 resolver actually does, consult your man pages for &'resolver'& and
18607 &'resolv.conf'&.
18608
18609
18610
18611 .option rewrite_headers dnslookup boolean true
18612 .cindex "rewriting" "header lines"
18613 .cindex "header lines" "rewriting"
18614 If the domain name in the address that is being processed is not fully
18615 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18616 an address is specified as &'dormouse@teaparty'&, the domain might be
18617 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18618 occur as a result of setting the &%widen_domains%& option. If
18619 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18620 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18621 header lines of the message are rewritten with the full domain name.
18622
18623 This option should be turned off only when it is known that no message is
18624 ever going to be sent outside an environment where the abbreviation makes
18625 sense.
18626
18627 When an MX record is looked up in the DNS and matches a wildcard record, name
18628 servers normally return a record containing the name that has been looked up,
18629 making it impossible to detect whether a wildcard was present or not. However,
18630 some name servers have recently been seen to return the wildcard entry. If the
18631 name returned by a DNS lookup begins with an asterisk, it is not used for
18632 header rewriting.
18633
18634
18635 .option same_domain_copy_routing dnslookup boolean false
18636 .cindex "address" "copying routing"
18637 Addresses with the same domain are normally routed by the &(dnslookup)& router
18638 to the same list of hosts. However, this cannot be presumed, because the router
18639 options and preconditions may refer to the local part of the address. By
18640 default, therefore, Exim routes each address in a message independently. DNS
18641 servers run caches, so repeated DNS lookups are not normally expensive, and in
18642 any case, personal messages rarely have more than a few recipients.
18643
18644 If you are running mailing lists with large numbers of subscribers at the same
18645 domain, and you are using a &(dnslookup)& router which is independent of the
18646 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18647 lookups for identical domains in one message. In this case, when &(dnslookup)&
18648 routes an address to a remote transport, any other unrouted addresses in the
18649 message that have the same domain are automatically given the same routing
18650 without processing them independently,
18651 provided the following conditions are met:
18652
18653 .ilist
18654 No router that processed the address specified &%headers_add%& or
18655 &%headers_remove%&.
18656 .next
18657 The router did not change the address in any way, for example, by &"widening"&
18658 the domain.
18659 .endlist
18660
18661
18662
18663
18664 .option search_parents dnslookup boolean false
18665 .cindex "DNS" "resolver options"
18666 When this option is true, the resolver option RES_DNSRCH is set for DNS
18667 lookups. This is different from the &%qualify_single%& option in that it
18668 applies to domains containing dots. Typically, but not standardly, it causes
18669 the resolver to search for the name in the current domain and in parent
18670 domains. For example, on a machine in the &'fict.example'& domain, if looking
18671 up &'teaparty.wonderland'& failed, the resolver would try
18672 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18673 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18674
18675 Setting this option true can cause problems in domains that have a wildcard MX
18676 record, because any domain that does not have its own MX record matches the
18677 local wildcard.
18678
18679
18680
18681 .option srv_fail_domains dnslookup "domain list&!!" unset
18682 If the DNS lookup for SRV records for one of the domains in this list causes a
18683 DNS lookup error, Exim behaves as if no SRV records were found. See section
18684 &<<SECTprowitdnsloo>>& for more discussion.
18685
18686
18687
18688
18689 .option widen_domains dnslookup "string list" unset
18690 .cindex "domain" "partial; widening"
18691 If a DNS lookup fails and this option is set, each of its strings in turn is
18692 added onto the end of the domain, and the lookup is tried again. For example,
18693 if
18694 .code
18695 widen_domains = fict.example:ref.example
18696 .endd
18697 is set and a lookup of &'klingon.dictionary'& fails,
18698 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18699 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18700 and &%search_parents%& options can cause some widening to be undertaken inside
18701 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18702 when verifying, unless &%rewrite_headers%& is false (not the default).
18703
18704
18705 .section "Effect of qualify_single and search_parents" "SECID119"
18706 When a domain from an envelope recipient is changed by the resolver as a result
18707 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18708 corresponding address in the message's header lines unless &%rewrite_headers%&
18709 is set false. Exim then re-routes the address, using the full domain.
18710
18711 These two options affect only the DNS lookup that takes place inside the router
18712 for the domain of the address that is being routed. They do not affect lookups
18713 such as that implied by
18714 .code
18715 domains = @mx_any
18716 .endd
18717 that may happen while processing a router precondition before the router is
18718 entered. No widening ever takes place for these lookups.
18719 .ecindex IIDdnsrou1
18720 .ecindex IIDdnsrou2
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730 . ////////////////////////////////////////////////////////////////////////////
18731 . ////////////////////////////////////////////////////////////////////////////
18732
18733 .chapter "The ipliteral router" "CHID5"
18734 .cindex "&(ipliteral)& router"
18735 .cindex "domain literal" "routing"
18736 .cindex "routers" "&(ipliteral)&"
18737 This router has no private options. Unless it is being used purely for
18738 verification (see &%verify_only%&) a transport is required to be defined by the
18739 generic &%transport%& option. The router accepts the address if its domain part
18740 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18741 router handles the address
18742 .code
18743 root@[192.168.1.1]
18744 .endd
18745 by setting up delivery to the host with that IP address. IPv4 domain literals
18746 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18747 are similar, but the address is preceded by &`ipv6:`&. For example:
18748 .code
18749 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18750 .endd
18751 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18752 grounds that sooner or later somebody will try it.
18753
18754 .oindex "&%self%&" "in &(ipliteral)& router"
18755 If the IP address matches something in &%ignore_target_hosts%&, the router
18756 declines. If an IP literal turns out to refer to the local host, the generic
18757 &%self%& option determines what happens.
18758
18759 The RFCs require support for domain literals; however, their use is
18760 controversial in today's Internet. If you want to use this router, you must
18761 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18762 Exim will not recognize the domain literal syntax in addresses.
18763
18764
18765
18766 . ////////////////////////////////////////////////////////////////////////////
18767 . ////////////////////////////////////////////////////////////////////////////
18768
18769 .chapter "The iplookup router" "CHID6"
18770 .cindex "&(iplookup)& router"
18771 .cindex "routers" "&(iplookup)&"
18772 The &(iplookup)& router was written to fulfil a specific requirement in
18773 Cambridge University (which in fact no longer exists). For this reason, it is
18774 not included in the binary of Exim by default. If you want to include it, you
18775 must set
18776 .code
18777 ROUTER_IPLOOKUP=yes
18778 .endd
18779 in your &_Local/Makefile_& configuration file.
18780
18781 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18782 connection to one or more specific hosts. The host can then return the same or
18783 a different address &-- in effect rewriting the recipient address in the
18784 message's envelope. The new address is then passed on to subsequent routers. If
18785 this process fails, the address can be passed on to other routers, or delivery
18786 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18787 must not be specified for it.
18788
18789 .cindex "options" "&(iplookup)& router"
18790 .option hosts iplookup string unset
18791 This option must be supplied. Its value is a colon-separated list of host
18792 names. The hosts are looked up using &[gethostbyname()]&
18793 (or &[getipnodebyname()]& when available)
18794 and are tried in order until one responds to the query. If none respond, what
18795 happens is controlled by &%optional%&.
18796
18797
18798 .option optional iplookup boolean false
18799 If &%optional%& is true, if no response is obtained from any host, the address
18800 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18801 delivery to the address is deferred.
18802
18803
18804 .option port iplookup integer 0
18805 .cindex "port" "&(iplookup)& router"
18806 This option must be supplied. It specifies the port number for the TCP or UDP
18807 call.
18808
18809
18810 .option protocol iplookup string udp
18811 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18812 protocols is to be used.
18813
18814
18815 .option query iplookup string&!! "see below"
18816 This defines the content of the query that is sent to the remote hosts. The
18817 default value is:
18818 .code
18819 $local_part@$domain $local_part@$domain
18820 .endd
18821 The repetition serves as a way of checking that a response is to the correct
18822 query in the default case (see &%response_pattern%& below).
18823
18824
18825 .option reroute iplookup string&!! unset
18826 If this option is not set, the rerouted address is precisely the byte string
18827 returned by the remote host, up to the first white space, if any. If set, the
18828 string is expanded to form the rerouted address. It can include parts matched
18829 in the response by &%response_pattern%& by means of numeric variables such as
18830 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18831 whether or not a pattern is in use. In all cases, the rerouted address must end
18832 up in the form &'local_part@domain'&.
18833
18834
18835 .option response_pattern iplookup string unset
18836 This option can be set to a regular expression that is applied to the string
18837 returned from the remote host. If the pattern does not match the response, the
18838 router declines. If &%response_pattern%& is not set, no checking of the
18839 response is done, unless the query was defaulted, in which case there is a
18840 check that the text returned after the first white space is the original
18841 address. This checks that the answer that has been received is in response to
18842 the correct question. For example, if the response is just a new domain, the
18843 following could be used:
18844 .code
18845 response_pattern = ^([^@]+)$
18846 reroute = $local_part@$1
18847 .endd
18848
18849 .option timeout iplookup time 5s
18850 This specifies the amount of time to wait for a response from the remote
18851 machine. The same timeout is used for the &[connect()]& function for a TCP
18852 call. It does not apply to UDP.
18853
18854
18855
18856
18857 . ////////////////////////////////////////////////////////////////////////////
18858 . ////////////////////////////////////////////////////////////////////////////
18859
18860 .chapter "The manualroute router" "CHID7"
18861 .scindex IIDmanrou1 "&(manualroute)& router"
18862 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18863 .cindex "domain" "manually routing"
18864 The &(manualroute)& router is so-called because it provides a way of manually
18865 routing an address according to its domain. It is mainly used when you want to
18866 route addresses to remote hosts according to your own rules, bypassing the
18867 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18868 route to local transports, a facility that may be useful if you want to save
18869 messages for dial-in hosts in local files.
18870
18871 The &(manualroute)& router compares a list of domain patterns with the domain
18872 it is trying to route. If there is no match, the router declines. Each pattern
18873 has associated with it a list of hosts and some other optional data, which may
18874 include a transport. The combination of a pattern and its data is called a
18875 &"routing rule"&. For patterns that do not have an associated transport, the
18876 generic &%transport%& option must specify a transport, unless the router is
18877 being used purely for verification (see &%verify_only%&).
18878
18879 .vindex "&$host$&"
18880 In the case of verification, matching the domain pattern is sufficient for the
18881 router to accept the address. When actually routing an address for delivery,
18882 an address that matches a domain pattern is queued for the associated
18883 transport. If the transport is not a local one, a host list must be associated
18884 with the pattern; IP addresses are looked up for the hosts, and these are
18885 passed to the transport along with the mail address. For local transports, a
18886 host list is optional. If it is present, it is passed in &$host$& as a single
18887 text string.
18888
18889 The list of routing rules can be provided as an inline string in
18890 &%route_list%&, or the data can be obtained by looking up the domain in a file
18891 or database by setting &%route_data%&. Only one of these settings may appear in
18892 any one instance of &(manualroute)&. The format of routing rules is described
18893 below, following the list of private options.
18894
18895
18896 .section "Private options for manualroute" "SECTprioptman"
18897
18898 .cindex "options" "&(manualroute)& router"
18899 The private options for the &(manualroute)& router are as follows:
18900
18901 .option host_all_ignored manualroute string defer
18902 See &%host_find_failed%&.
18903
18904 .option host_find_failed manualroute string freeze
18905 This option controls what happens when &(manualroute)& tries to find an IP
18906 address for a host, and the host does not exist. The option can be set to one
18907 of the following values:
18908 .code
18909 decline
18910 defer
18911 fail
18912 freeze
18913 ignore
18914 pass
18915 .endd
18916 The default (&"freeze"&) assumes that this state is a serious configuration
18917 error. The difference between &"pass"& and &"decline"& is that the former
18918 forces the address to be passed to the next router (or the router defined by
18919 &%pass_router%&),
18920 .oindex "&%more%&"
18921 overriding &%no_more%&, whereas the latter passes the address to the next
18922 router only if &%more%& is true.
18923
18924 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18925 cannot be found. If all the hosts in the list are ignored, the behaviour is
18926 controlled by the &%host_all_ignored%& option. This takes the same values
18927 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18928
18929 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18930 state; if a host lookup gets a temporary error, delivery is deferred unless the
18931 generic &%pass_on_timeout%& option is set.
18932
18933
18934 .option hosts_randomize manualroute boolean false
18935 .cindex "randomized host list"
18936 .cindex "host" "list of; randomized"
18937 If this option is set, the order of the items in a host list in a routing rule
18938 is randomized each time the list is used, unless an option in the routing rule
18939 overrides (see below). Randomizing the order of a host list can be used to do
18940 crude load sharing. However, if more than one mail address is routed by the
18941 same router to the same host list, the host lists are considered to be the same
18942 (even though they may be randomized into different orders) for the purpose of
18943 deciding whether to batch the deliveries into a single SMTP transaction.
18944
18945 When &%hosts_randomize%& is true, a host list may be split
18946 into groups whose order is separately randomized. This makes it possible to
18947 set up MX-like behaviour. The boundaries between groups are indicated by an
18948 item that is just &`+`& in the host list. For example:
18949 .code
18950 route_list = * host1:host2:host3:+:host4:host5
18951 .endd
18952 The order of the first three hosts and the order of the last two hosts is
18953 randomized for each use, but the first three always end up before the last two.
18954 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18955 randomized host list is passed to an &(smtp)& transport that also has
18956 &%hosts_randomize set%&, the list is not re-randomized.
18957
18958
18959 .option route_data manualroute string&!! unset
18960 If this option is set, it must expand to yield the data part of a routing rule.
18961 Typically, the expansion string includes a lookup based on the domain. For
18962 example:
18963 .code
18964 route_data = ${lookup{$domain}dbm{/etc/routes}}
18965 .endd
18966 If the expansion is forced to fail, or the result is an empty string, the
18967 router declines. Other kinds of expansion failure cause delivery to be
18968 deferred.
18969
18970
18971 .option route_list manualroute "string list" unset
18972 This string is a list of routing rules, in the form defined below. Note that,
18973 unlike most string lists, the items are separated by semicolons. This is so
18974 that they may contain colon-separated host lists.
18975
18976
18977 .option same_domain_copy_routing manualroute boolean false
18978 .cindex "address" "copying routing"
18979 Addresses with the same domain are normally routed by the &(manualroute)&
18980 router to the same list of hosts. However, this cannot be presumed, because the
18981 router options and preconditions may refer to the local part of the address. By
18982 default, therefore, Exim routes each address in a message independently. DNS
18983 servers run caches, so repeated DNS lookups are not normally expensive, and in
18984 any case, personal messages rarely have more than a few recipients.
18985
18986 If you are running mailing lists with large numbers of subscribers at the same
18987 domain, and you are using a &(manualroute)& router which is independent of the
18988 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18989 lookups for identical domains in one message. In this case, when
18990 &(manualroute)& routes an address to a remote transport, any other unrouted
18991 addresses in the message that have the same domain are automatically given the
18992 same routing without processing them independently. However, this is only done
18993 if &%headers_add%& and &%headers_remove%& are unset.
18994
18995
18996
18997
18998 .section "Routing rules in route_list" "SECID120"
18999 The value of &%route_list%& is a string consisting of a sequence of routing
19000 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19001 entered as two semicolons. Alternatively, the list separator can be changed as
19002 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19003 Empty rules are ignored. The format of each rule is
19004 .display
19005 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19006 .endd
19007 The following example contains two rules, each with a simple domain pattern and
19008 no options:
19009 .code
19010 route_list = \
19011   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19012   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19013 .endd
19014 The three parts of a rule are separated by white space. The pattern and the
19015 list of hosts can be enclosed in quotes if necessary, and if they are, the
19016 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19017 single domain pattern, which is the only mandatory item in the rule. The
19018 pattern is in the same format as one item in a domain list (see section
19019 &<<SECTdomainlist>>&),
19020 except that it may not be the name of an interpolated file.
19021 That is, it may be wildcarded, or a regular expression, or a file or database
19022 lookup (with semicolons doubled, because of the use of semicolon as a separator
19023 in a &%route_list%&).
19024
19025 The rules in &%route_list%& are searched in order until one of the patterns
19026 matches the domain that is being routed. The list of hosts and then options are
19027 then used as described below. If there is no match, the router declines. When
19028 &%route_list%& is set, &%route_data%& must not be set.
19029
19030
19031
19032 .section "Routing rules in route_data" "SECID121"
19033 The use of &%route_list%& is convenient when there are only a small number of
19034 routing rules. For larger numbers, it is easier to use a file or database to
19035 hold the routing information, and use the &%route_data%& option instead.
19036 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19037 Most commonly, &%route_data%& is set as a string that contains an
19038 expansion lookup. For example, suppose we place two routing rules in a file
19039 like this:
19040 .code
19041 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19042 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19043 .endd
19044 This data can be accessed by setting
19045 .code
19046 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19047 .endd
19048 Failure of the lookup results in an empty string, causing the router to
19049 decline. However, you do not have to use a lookup in &%route_data%&. The only
19050 requirement is that the result of expanding the string is a list of hosts,
19051 possibly followed by options, separated by white space. The list of hosts must
19052 be enclosed in quotes if it contains white space.
19053
19054
19055
19056
19057 .section "Format of the list of hosts" "SECID122"
19058 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19059 always separately expanded before use. If the expansion fails, the router
19060 declines. The result of the expansion must be a colon-separated list of names
19061 and/or IP addresses, optionally also including ports. The format of each item
19062 in the list is described in the next section. The list separator can be changed
19063 as described in section &<<SECTlistconstruct>>&.
19064
19065 If the list of hosts was obtained from a &%route_list%& item, the following
19066 variables are set during its expansion:
19067
19068 .ilist
19069 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19070 If the domain was matched against a regular expression, the numeric variables
19071 &$1$&, &$2$&, etc. may be set. For example:
19072 .code
19073 route_list = ^domain(\d+)   host-$1.text.example
19074 .endd
19075 .next
19076 &$0$& is always set to the entire domain.
19077 .next
19078 &$1$& is also set when partial matching is done in a file lookup.
19079
19080 .next
19081 .vindex "&$value$&"
19082 If the pattern that matched the domain was a lookup item, the data that was
19083 looked up is available in the expansion variable &$value$&. For example:
19084 .code
19085 route_list = lsearch;;/some/file.routes  $value
19086 .endd
19087 .endlist
19088
19089 Note the doubling of the semicolon in the pattern that is necessary because
19090 semicolon is the default route list separator.
19091
19092
19093
19094 .section "Format of one host item" "SECTformatonehostitem"
19095 Each item in the list of hosts is either a host name or an IP address,
19096 optionally with an attached port number. When no port is given, an IP address
19097 is not enclosed in brackets. When a port is specified, it overrides the port
19098 specification on the transport. The port is separated from the name or address
19099 by a colon. This leads to some complications:
19100
19101 .ilist
19102 Because colon is the default separator for the list of hosts, either
19103 the colon that specifies a port must be doubled, or the list separator must
19104 be changed. The following two examples have the same effect:
19105 .code
19106 route_list = * "host1.tld::1225 : host2.tld::1226"
19107 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19108 .endd
19109 .next
19110 When IPv6 addresses are involved, it gets worse, because they contain
19111 colons of their own. To make this case easier, it is permitted to
19112 enclose an IP address (either v4 or v6) in square brackets if a port
19113 number follows. For example:
19114 .code
19115 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19116 .endd
19117 .endlist
19118
19119 .section "How the list of hosts is used" "SECThostshowused"
19120 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19121 the hosts is tried, in the order specified, when carrying out the SMTP
19122 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19123 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19124 transport.
19125
19126 Hosts may be listed by name or by IP address. An unadorned name in the list of
19127 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19128 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19129 records in the DNS. For example:
19130 .code
19131 route_list = *  x.y.z:p.q.r/MX:e.f.g
19132 .endd
19133 If this feature is used with a port specifier, the port must come last. For
19134 example:
19135 .code
19136 route_list = *  dom1.tld/mx::1225
19137 .endd
19138 If the &%hosts_randomize%& option is set, the order of the items in the list is
19139 randomized before any lookups are done. Exim then scans the list; for any name
19140 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19141 be an interface on the local host and the item is not the first in the list,
19142 Exim discards it and any subsequent items. If it is the first item, what
19143 happens is controlled by the
19144 .oindex "&%self%&" "in &(manualroute)& router"
19145 &%self%& option of the router.
19146
19147 A name on the list that is followed by &`/MX`& is replaced with the list of
19148 hosts obtained by looking up MX records for the name. This is always a DNS
19149 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19150 below) are not relevant here. The order of these hosts is determined by the
19151 preference values in the MX records, according to the usual rules. Because
19152 randomizing happens before the MX lookup, it does not affect the order that is
19153 defined by MX preferences.
19154
19155 If the local host is present in the sublist obtained from MX records, but is
19156 not the most preferred host in that list, it and any equally or less
19157 preferred hosts are removed before the sublist is inserted into the main list.
19158
19159 If the local host is the most preferred host in the MX list, what happens
19160 depends on where in the original list of hosts the &`/MX`& item appears. If it
19161 is not the first item (that is, there are previous hosts in the main list),
19162 Exim discards this name and any subsequent items in the main list.
19163
19164 If the MX item is first in the list of hosts, and the local host is the
19165 most preferred host, what happens is controlled by the &%self%& option of the
19166 router.
19167
19168 DNS failures when lookup up the MX records are treated in the same way as DNS
19169 failures when looking up IP addresses: &%pass_on_timeout%& and
19170 &%host_find_failed%& are used when relevant.
19171
19172 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19173 whether obtained from an MX lookup or not.
19174
19175
19176
19177 .section "How the options are used" "SECThowoptused"
19178 The options are a sequence of words; in practice no more than three are ever
19179 present. One of the words can be the name of a transport; this overrides the
19180 &%transport%& option on the router for this particular routing rule only. The
19181 other words (if present) control randomization of the list of hosts on a
19182 per-rule basis, and how the IP addresses of the hosts are to be found when
19183 routing to a remote transport. These options are as follows:
19184
19185 .ilist
19186 &%randomize%&: randomize the order of the hosts in this list, overriding the
19187 setting of &%hosts_randomize%& for this routing rule only.
19188 .next
19189 &%no_randomize%&: do not randomize the order of the hosts in this list,
19190 overriding the setting of &%hosts_randomize%& for this routing rule only.
19191 .next
19192 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19193 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19194 also look in &_/etc/hosts_& or other sources of information.
19195 .next
19196 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19197 no address records are found. If there is a temporary DNS error (such as a
19198 timeout), delivery is deferred.
19199 .endlist
19200
19201 For example:
19202 .code
19203 route_list = domain1  host1:host2:host3  randomize bydns;\
19204              domain2  host4:host5
19205 .endd
19206 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19207 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19208 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19209 or &[gethostbyname()]&, and the result of the lookup is the result of that
19210 call.
19211
19212 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19213 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19214 instead of TRY_AGAIN. That is why the default action is to try a DNS
19215 lookup first. Only if that gives a definite &"no such host"& is the local
19216 function called.
19217
19218
19219
19220 If no IP address for a host can be found, what happens is controlled by the
19221 &%host_find_failed%& option.
19222
19223 .vindex "&$host$&"
19224 When an address is routed to a local transport, IP addresses are not looked up.
19225 The host list is passed to the transport in the &$host$& variable.
19226
19227
19228
19229 .section "Manualroute examples" "SECID123"
19230 In some of the examples that follow, the presence of the &%remote_smtp%&
19231 transport, as defined in the default configuration file, is assumed:
19232
19233 .ilist
19234 .cindex "smart host" "example router"
19235 The &(manualroute)& router can be used to forward all external mail to a
19236 &'smart host'&. If you have set up, in the main part of the configuration, a
19237 named domain list that contains your local domains, for example:
19238 .code
19239 domainlist local_domains = my.domain.example
19240 .endd
19241 You can arrange for all other domains to be routed to a smart host by making
19242 your first router something like this:
19243 .code
19244 smart_route:
19245   driver = manualroute
19246   domains = !+local_domains
19247   transport = remote_smtp
19248   route_list = * smarthost.ref.example
19249 .endd
19250 This causes all non-local addresses to be sent to the single host
19251 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19252 they are tried in order
19253 (but you can use &%hosts_randomize%& to vary the order each time).
19254 Another way of configuring the same thing is this:
19255 .code
19256 smart_route:
19257   driver = manualroute
19258   transport = remote_smtp
19259   route_list = !+local_domains  smarthost.ref.example
19260 .endd
19261 There is no difference in behaviour between these two routers as they stand.
19262 However, they behave differently if &%no_more%& is added to them. In the first
19263 example, the router is skipped if the domain does not match the &%domains%&
19264 precondition; the following router is always tried. If the router runs, it
19265 always matches the domain and so can never decline. Therefore, &%no_more%&
19266 would have no effect. In the second case, the router is never skipped; it
19267 always runs. However, if it doesn't match the domain, it declines. In this case
19268 &%no_more%& would prevent subsequent routers from running.
19269
19270 .next
19271 .cindex "mail hub example"
19272 A &'mail hub'& is a host which receives mail for a number of domains via MX
19273 records in the DNS and delivers it via its own private routing mechanism. Often
19274 the final destinations are behind a firewall, with the mail hub being the one
19275 machine that can connect to machines both inside and outside the firewall. The
19276 &(manualroute)& router is usually used on a mail hub to route incoming messages
19277 to the correct hosts. For a small number of domains, the routing can be inline,
19278 using the &%route_list%& option, but for a larger number a file or database
19279 lookup is easier to manage.
19280
19281 If the domain names are in fact the names of the machines to which the mail is
19282 to be sent by the mail hub, the configuration can be quite simple. For
19283 example:
19284 .code
19285 hub_route:
19286   driver = manualroute
19287   transport = remote_smtp
19288   route_list = *.rhodes.tvs.example  $domain
19289 .endd
19290 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19291 whose names are the same as the mail domains. A similar approach can be taken
19292 if the host name can be obtained from the domain name by a string manipulation
19293 that the expansion facilities can handle. Otherwise, a lookup based on the
19294 domain can be used to find the host:
19295 .code
19296 through_firewall:
19297   driver = manualroute
19298   transport = remote_smtp
19299   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19300 .endd
19301 The result of the lookup must be the name or IP address of the host (or
19302 hosts) to which the address is to be routed. If the lookup fails, the route
19303 data is empty, causing the router to decline. The address then passes to the
19304 next router.
19305
19306 .next
19307 .cindex "batched SMTP output example"
19308 .cindex "SMTP" "batched outgoing; example"
19309 You can use &(manualroute)& to deliver messages to pipes or files in batched
19310 SMTP format for onward transportation by some other means. This is one way of
19311 storing mail for a dial-up host when it is not connected. The route list entry
19312 can be as simple as a single domain name in a configuration like this:
19313 .code
19314 save_in_file:
19315   driver = manualroute
19316   transport = batchsmtp_appendfile
19317   route_list = saved.domain.example
19318 .endd
19319 though often a pattern is used to pick up more than one domain. If there are
19320 several domains or groups of domains with different transport requirements,
19321 different transports can be listed in the routing information:
19322 .code
19323 save_in_file:
19324   driver = manualroute
19325   route_list = \
19326     *.saved.domain1.example  $domain  batch_appendfile; \
19327     *.saved.domain2.example  \
19328       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19329       batch_pipe
19330 .endd
19331 .vindex "&$domain$&"
19332 .vindex "&$host$&"
19333 The first of these just passes the domain in the &$host$& variable, which
19334 doesn't achieve much (since it is also in &$domain$&), but the second does a
19335 file lookup to find a value to pass, causing the router to decline to handle
19336 the address if the lookup fails.
19337
19338 .next
19339 .cindex "UUCP" "example of router for"
19340 Routing mail directly to UUCP software is a specific case of the use of
19341 &(manualroute)& in a gateway to another mail environment. This is an example of
19342 one way it can be done:
19343 .code
19344 # Transport
19345 uucp:
19346   driver = pipe
19347   user = nobody
19348   command = /usr/local/bin/uux -r - \
19349     ${substr_-5:$host}!rmail ${local_part}
19350   return_fail_output = true
19351
19352 # Router
19353 uucphost:
19354   transport = uucp
19355   driver = manualroute
19356   route_data = \
19357     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19358 .endd
19359 The file &_/usr/local/exim/uucphosts_& contains entries like
19360 .code
19361 darksite.ethereal.example:           darksite.UUCP
19362 .endd
19363 It can be set up more simply without adding and removing &".UUCP"& but this way
19364 makes clear the distinction between the domain name
19365 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19366 .endlist
19367 .ecindex IIDmanrou1
19368 .ecindex IIDmanrou2
19369
19370
19371
19372
19373
19374
19375
19376
19377 . ////////////////////////////////////////////////////////////////////////////
19378 . ////////////////////////////////////////////////////////////////////////////
19379
19380 .chapter "The queryprogram router" "CHAPdriverlast"
19381 .scindex IIDquerou1 "&(queryprogram)& router"
19382 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19383 .cindex "routing" "by external program"
19384 The &(queryprogram)& router routes an address by running an external command
19385 and acting on its output. This is an expensive way to route, and is intended
19386 mainly for use in lightly-loaded systems, or for performing experiments.
19387 However, if it is possible to use the precondition options (&%domains%&,
19388 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19389 be used in special cases, even on a busy host. There are the following private
19390 options:
19391 .cindex "options" "&(queryprogram)& router"
19392
19393 .option command queryprogram string&!! unset
19394 This option must be set. It specifies the command that is to be run. The
19395 command is split up into a command name and arguments, and then each is
19396 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19397 &<<CHAPpipetransport>>&).
19398
19399
19400 .option command_group queryprogram string unset
19401 .cindex "gid (group id)" "in &(queryprogram)& router"
19402 This option specifies a gid to be set when running the command while routing an
19403 address for deliver. It must be set if &%command_user%& specifies a numerical
19404 uid. If it begins with a digit, it is interpreted as the numerical value of the
19405 gid. Otherwise it is looked up using &[getgrnam()]&.
19406
19407
19408 .option command_user queryprogram string unset
19409 .cindex "uid (user id)" "for &(queryprogram)&"
19410 This option must be set. It specifies the uid which is set when running the
19411 command while routing an address for delivery. If the value begins with a digit,
19412 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19413 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19414 not set, a value for the gid also.
19415
19416 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19417 root, which it does during a normal delivery in a conventional configuration.
19418 However, when an address is being verified during message reception, Exim is
19419 usually running as the Exim user, not as root. If the &(queryprogram)& router
19420 is called from a non-root process, Exim cannot change uid or gid before running
19421 the command. In this circumstance the command runs under the current uid and
19422 gid.
19423
19424
19425 .option current_directory queryprogram string /
19426 This option specifies an absolute path which is made the current directory
19427 before running the command.
19428
19429
19430 .option timeout queryprogram time 1h
19431 If the command does not complete within the timeout period, its process group
19432 is killed and the message is frozen. A value of zero time specifies no
19433 timeout.
19434
19435
19436 The standard output of the command is connected to a pipe, which is read when
19437 the command terminates. It should consist of a single line of output,
19438 containing up to five fields, separated by white space. The maximum length of
19439 the line is 1023 characters. Longer lines are silently truncated. The first
19440 field is one of the following words (case-insensitive):
19441
19442 .ilist
19443 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19444 below).
19445 .next
19446 &'Decline'&: the router declines; pass the address to the next router, unless
19447 &%no_more%& is set.
19448 .next
19449 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19450 subsequent text on the line is an error message. If the router is run as part
19451 of address verification during an incoming SMTP message, the message is
19452 included in the SMTP response.
19453 .next
19454 &'Defer'&: routing could not be completed at this time; try again later. Any
19455 subsequent text on the line is an error message which is logged. It is not
19456 included in any SMTP response.
19457 .next
19458 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19459 .next
19460 &'Pass'&: pass the address to the next router (or the router specified by
19461 &%pass_router%&), overriding &%no_more%&.
19462 .next
19463 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19464 new addresses, which are routed independently, starting with the first router,
19465 or the router specified by &%redirect_router%&, if set.
19466 .endlist
19467
19468 When the first word is &'accept'&, the remainder of the line consists of a
19469 number of keyed data values, as follows (split into two lines here, to fit on
19470 the page):
19471 .code
19472 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19473 LOOKUP=byname|bydns DATA=<text>
19474 .endd
19475 The data items can be given in any order, and all are optional. If no transport
19476 is included, the transport specified by the generic &%transport%& option is
19477 used. The list of hosts and the lookup type are needed only if the transport is
19478 an &(smtp)& transport that does not itself supply a list of hosts.
19479
19480 The format of the list of hosts is the same as for the &(manualroute)& router.
19481 As well as host names and IP addresses with optional port numbers, as described
19482 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19483 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19484 (see section &<<SECThostshowused>>&).
19485
19486 If the lookup type is not specified, Exim behaves as follows when trying to
19487 find an IP address for each host: First, a DNS lookup is done. If this yields
19488 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19489 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19490 result of the lookup is the result of that call.
19491
19492 .vindex "&$address_data$&"
19493 If the DATA field is set, its value is placed in the &$address_data$&
19494 variable. For example, this return line
19495 .code
19496 accept hosts=x1.y.example:x2.y.example data="rule1"
19497 .endd
19498 routes the address to the default transport, passing a list of two hosts. When
19499 the transport runs, the string &"rule1"& is in &$address_data$&.
19500 .ecindex IIDquerou1
19501 .ecindex IIDquerou2
19502
19503
19504
19505
19506 . ////////////////////////////////////////////////////////////////////////////
19507 . ////////////////////////////////////////////////////////////////////////////
19508
19509 .chapter "The redirect router" "CHAPredirect"
19510 .scindex IIDredrou1 "&(redirect)& router"
19511 .scindex IIDredrou2 "routers" "&(redirect)&"
19512 .cindex "alias file" "in a &(redirect)& router"
19513 .cindex "address redirection" "&(redirect)& router"
19514 The &(redirect)& router handles several kinds of address redirection. Its most
19515 common uses are for resolving local part aliases from a central alias file
19516 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19517 files, but it has many other potential uses. The incoming address can be
19518 redirected in several different ways:
19519
19520 .ilist
19521 It can be replaced by one or more new addresses which are themselves routed
19522 independently.
19523 .next
19524 It can be routed to be delivered to a given file or directory.
19525 .next
19526 It can be routed to be delivered to a specified pipe command.
19527 .next
19528 It can cause an automatic reply to be generated.
19529 .next
19530 It can be forced to fail, optionally with a custom error message.
19531 .next
19532 It can be temporarily deferred, optionally with a custom message.
19533 .next
19534 It can be discarded.
19535 .endlist
19536
19537 The generic &%transport%& option must not be set for &(redirect)& routers.
19538 However, there are some private options which define transports for delivery to
19539 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19540 &%pipe_transport%& and &%reply_transport%& descriptions below.
19541
19542 If success DSNs have been requested
19543 .cindex "DSN" "success"
19544 .cindex "Delivery Status Notification" "success"
19545 redirection triggers one and the DSN options are not passed any further.
19546
19547
19548
19549 .section "Redirection data" "SECID124"
19550 The router operates by interpreting a text string which it obtains either by
19551 expanding the contents of the &%data%& option, or by reading the entire
19552 contents of a file whose name is given in the &%file%& option. These two
19553 options are mutually exclusive. The first is commonly used for handling system
19554 aliases, in a configuration like this:
19555 .code
19556 system_aliases:
19557   driver = redirect
19558   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19559 .endd
19560 If the lookup fails, the expanded string in this example is empty. When the
19561 expansion of &%data%& results in an empty string, the router declines. A forced
19562 expansion failure also causes the router to decline; other expansion failures
19563 cause delivery to be deferred.
19564
19565 A configuration using &%file%& is commonly used for handling users'
19566 &_.forward_& files, like this:
19567 .code
19568 userforward:
19569   driver = redirect
19570   check_local_user
19571   file = $home/.forward
19572   no_verify
19573 .endd
19574 If the file does not exist, or causes no action to be taken (for example, it is
19575 empty or consists only of comments), the router declines. &*Warning*&: This
19576 is not the case when the file contains syntactically valid items that happen to
19577 yield empty addresses, for example, items containing only RFC 2822 address
19578 comments.
19579
19580
19581
19582 .section "Forward files and address verification" "SECID125"
19583 .cindex "address redirection" "while verifying"
19584 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19585 &_.forward_& files, as in the example above. There are two reasons for this:
19586
19587 .ilist
19588 When Exim is receiving an incoming SMTP message from a remote host, it is
19589 running under the Exim uid, not as root. Exim is unable to change uid to read
19590 the file as the user, and it may not be able to read it as the Exim user. So in
19591 practice the router may not be able to operate.
19592 .next
19593 However, even when the router can operate, the existence of a &_.forward_& file
19594 is unimportant when verifying an address. What should be checked is whether the
19595 local part is a valid user name or not. Cutting out the redirection processing
19596 saves some resources.
19597 .endlist
19598
19599
19600
19601
19602
19603
19604 .section "Interpreting redirection data" "SECID126"
19605 .cindex "Sieve filter" "specifying in redirection data"
19606 .cindex "filter" "specifying in redirection data"
19607 The contents of the data string, whether obtained from &%data%& or &%file%&,
19608 can be interpreted in two different ways:
19609
19610 .ilist
19611 If the &%allow_filter%& option is set true, and the data begins with the text
19612 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19613 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19614 respectively. Details of the syntax and semantics of filter files are described
19615 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19616 document is intended for use by end users.
19617 .next
19618 Otherwise, the data must be a comma-separated list of redirection items, as
19619 described in the next section.
19620 .endlist
19621
19622 When a message is redirected to a file (a &"mail folder"&), the file name given
19623 in a non-filter redirection list must always be an absolute path. A filter may
19624 generate a relative path &-- how this is handled depends on the transport's
19625 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19626 for the &(appendfile)& transport.
19627
19628
19629
19630 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19631 .cindex "address redirection" "non-filter list items"
19632 When the redirection data is not an Exim or Sieve filter, for example, if it
19633 comes from a conventional alias or forward file, it consists of a list of
19634 addresses, file names, pipe commands, or certain special items (see section
19635 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19636 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19637 depending on their default values. The items in the list are separated by
19638 commas or newlines.
19639 If a comma is required in an item, the entire item must be enclosed in double
19640 quotes.
19641
19642 Lines starting with a # character are comments, and are ignored, and # may
19643 also appear following a comma, in which case everything between the # and the
19644 next newline character is ignored.
19645
19646 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19647 double quotes are retained because some forms of mail address require their use
19648 (but never to enclose the entire address). In the following description,
19649 &"item"& refers to what remains after any surrounding double quotes have been
19650 removed.
19651
19652 .vindex "&$local_part$&"
19653 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19654 and the expansion contains a reference to &$local_part$&, you should make use
19655 of the &%quote_local_part%& expansion operator, in case the local part contains
19656 special characters. For example, to redirect all mail for the domain
19657 &'obsolete.example'&, retaining the existing local part, you could use this
19658 setting:
19659 .code
19660 data = ${quote_local_part:$local_part}@newdomain.example
19661 .endd
19662
19663
19664 .section "Redirecting to a local mailbox" "SECTredlocmai"
19665 .cindex "routing" "loops in"
19666 .cindex "loop" "while routing, avoidance of"
19667 .cindex "address redirection" "to local mailbox"
19668 A redirection item may safely be the same as the address currently under
19669 consideration. This does not cause a routing loop, because a router is
19670 automatically skipped if any ancestor of the address that is being processed
19671 is the same as the current address and was processed by the current router.
19672 Such an address is therefore passed to the following routers, so it is handled
19673 as if there were no redirection. When making this loop-avoidance test, the
19674 complete local part, including any prefix or suffix, is used.
19675
19676 .cindex "address redirection" "local part without domain"
19677 Specifying the same local part without a domain is a common usage in personal
19678 filter files when the user wants to have messages delivered to the local
19679 mailbox and also forwarded elsewhere. For example, the user whose login is
19680 &'cleo'& might have a &_.forward_& file containing this:
19681 .code
19682 cleo, cleopatra@egypt.example
19683 .endd
19684 .cindex "backslash in alias file"
19685 .cindex "alias file" "backslash in"
19686 For compatibility with other MTAs, such unqualified local parts may be
19687 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19688 it does make a difference if more than one domain is being handled
19689 synonymously.
19690
19691 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19692 2822 address that does not include a domain, the item is qualified using the
19693 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19694 addresses are qualified using the value in &%qualify_recipient%&, but you can
19695 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19696
19697 Care must be taken if there are alias names for local users.
19698 Consider an MTA handling a single local domain where the system alias file
19699 contains:
19700 .code
19701 Sam.Reman: spqr
19702 .endd
19703 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19704 messages in the local mailbox, and also forward copies elsewhere. He creates
19705 this forward file:
19706 .code
19707 Sam.Reman, spqr@reme.elsewhere.example
19708 .endd
19709 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19710 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19711 second time round, because it has previously routed it,
19712 and the following routers presumably cannot handle the alias. The forward file
19713 should really contain
19714 .code
19715 spqr, spqr@reme.elsewhere.example
19716 .endd
19717 but because this is such a common error, the &%check_ancestor%& option (see
19718 below) exists to provide a way to get round it. This is normally set on a
19719 &(redirect)& router that is handling users' &_.forward_& files.
19720
19721
19722
19723 .section "Special items in redirection lists" "SECTspecitredli"
19724 In addition to addresses, the following types of item may appear in redirection
19725 lists (that is, in non-filter redirection data):
19726
19727 .ilist
19728 .cindex "pipe" "in redirection list"
19729 .cindex "address redirection" "to pipe"
19730 An item is treated as a pipe command if it begins with &"|"& and does not parse
19731 as a valid RFC 2822 address that includes a domain. A transport for running the
19732 command must be specified by the &%pipe_transport%& option.
19733 Normally, either the router or the transport specifies a user and a group under
19734 which to run the delivery. The default is to use the Exim user and group.
19735
19736 Single or double quotes can be used for enclosing the individual arguments of
19737 the pipe command; no interpretation of escapes is done for single quotes. If
19738 the command contains a comma character, it is necessary to put the whole item
19739 in double quotes, for example:
19740 .code
19741 "|/some/command ready,steady,go"
19742 .endd
19743 since items in redirection lists are terminated by commas. Do not, however,
19744 quote just the command. An item such as
19745 .code
19746 |"/some/command ready,steady,go"
19747 .endd
19748 is interpreted as a pipe with a rather strange command name, and no arguments.
19749
19750 Note that the above example assumes that the text comes from a lookup source
19751 of some sort, so that the quotes are part of the data.  If composing a
19752 redirect router with a &%data%& option directly specifying this command, the
19753 quotes will be used by the configuration parser to define the extent of one
19754 string, but will not be passed down into the redirect router itself.  There
19755 are two main approaches to get around this: escape quotes to be part of the
19756 data itself, or avoid using this mechanism and instead create a custom
19757 transport with the &%command%& option set and reference that transport from
19758 an &%accept%& router.
19759
19760 .next
19761 .cindex "file" "in redirection list"
19762 .cindex "address redirection" "to file"
19763 An item is interpreted as a path name if it begins with &"/"& and does not
19764 parse as a valid RFC 2822 address that includes a domain. For example,
19765 .code
19766 /home/world/minbari
19767 .endd
19768 is treated as a file name, but
19769 .code
19770 /s=molari/o=babylon/@x400gate.way
19771 .endd
19772 is treated as an address. For a file name, a transport must be specified using
19773 the &%file_transport%& option. However, if the generated path name ends with a
19774 forward slash character, it is interpreted as a directory name rather than a
19775 file name, and &%directory_transport%& is used instead.
19776
19777 Normally, either the router or the transport specifies a user and a group under
19778 which to run the delivery. The default is to use the Exim user and group.
19779
19780 .cindex "&_/dev/null_&"
19781 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19782 bypassed at a high level, and the log entry shows &"**bypassed**"&
19783 instead of a transport name. In this case the user and group are not used.
19784
19785 .next
19786 .cindex "included address list"
19787 .cindex "address redirection" "included external list"
19788 If an item is of the form
19789 .code
19790 :include:<path name>
19791 .endd
19792 a list of further items is taken from the given file and included at that
19793 point. &*Note*&: Such a file can not be a filter file; it is just an
19794 out-of-line addition to the list. The items in the included list are separated
19795 by commas or newlines and are not subject to expansion. If this is the first
19796 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19797 the alias name. This example is incorrect:
19798 .code
19799 list1    :include:/opt/lists/list1
19800 .endd
19801 It must be given as
19802 .code
19803 list1:   :include:/opt/lists/list1
19804 .endd
19805 .next
19806 .cindex "address redirection" "to black hole"
19807 Sometimes you want to throw away mail to a particular local part. Making the
19808 &%data%& option expand to an empty string does not work, because that causes
19809 the router to decline. Instead, the alias item
19810 .cindex "black hole"
19811 .cindex "abandoning mail"
19812 &':blackhole:'& can be used. It does what its name implies. No delivery is
19813 done, and no error message is generated. This has the same effect as specifying
19814 &_/dev/null_& as a destination, but it can be independently disabled.
19815
19816 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19817 delivery is done for the original local part, even if other redirection items
19818 are present. If you are generating a multi-item list (for example, by reading a
19819 database) and need the ability to provide a no-op item, you must use
19820 &_/dev/null_&.
19821
19822 .next
19823 .cindex "delivery" "forcing failure"
19824 .cindex "delivery" "forcing deferral"
19825 .cindex "failing delivery" "forcing"
19826 .cindex "deferred delivery, forcing"
19827 .cindex "customizing" "failure message"
19828 An attempt to deliver a particular address can be deferred or forced to fail by
19829 redirection items of the form
19830 .code
19831 :defer:
19832 :fail:
19833 .endd
19834 respectively. When a redirection list contains such an item, it applies
19835 to the entire redirection; any other items in the list are ignored. Any
19836 text following &':fail:'& or &':defer:'& is placed in the error text
19837 associated with the failure. For example, an alias file might contain:
19838 .code
19839 X.Employee:  :fail: Gone away, no forwarding address
19840 .endd
19841 In the case of an address that is being verified from an ACL or as the subject
19842 of a
19843 .cindex "VRFY" "error text, display of"
19844 VRFY command, the text is included in the SMTP error response by
19845 default.
19846 .cindex "EXPN" "error text, display of"
19847 The text is not included in the response to an EXPN command. In non-SMTP cases
19848 the text is included in the error message that Exim generates.
19849
19850 .cindex "SMTP" "error codes"
19851 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19852 &':fail:'&. However, if the message starts with three digits followed by a
19853 space, optionally followed by an extended code of the form &'n.n.n'&, also
19854 followed by a space, and the very first digit is the same as the default error
19855 code, the code from the message is used instead. If the very first digit is
19856 incorrect, a panic error is logged, and the default code is used. You can
19857 suppress the use of the supplied code in a redirect router by setting the
19858 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19859 ignored.
19860
19861 .vindex "&$acl_verify_message$&"
19862 In an ACL, an explicitly provided message overrides the default, but the
19863 default message is available in the variable &$acl_verify_message$& and can
19864 therefore be included in a custom message if this is desired.
19865
19866 Normally the error text is the rest of the redirection list &-- a comma does
19867 not terminate it &-- but a newline does act as a terminator. Newlines are not
19868 normally present in alias expansions. In &(lsearch)& lookups they are removed
19869 as part of the continuation process, but they may exist in other kinds of
19870 lookup and in &':include:'& files.
19871
19872 During routing for message delivery (as opposed to verification), a redirection
19873 containing &':fail:'& causes an immediate failure of the incoming address,
19874 whereas &':defer:'& causes the message to remain on the queue so that a
19875 subsequent delivery attempt can happen at a later time. If an address is
19876 deferred for too long, it will ultimately fail, because the normal retry
19877 rules still apply.
19878
19879 .next
19880 .cindex "alias file" "exception to default"
19881 Sometimes it is useful to use a single-key search type with a default (see
19882 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19883 for exceptions to the default. These can be handled by aliasing them to
19884 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19885 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19886 results in an empty redirection list has the same effect.
19887 .endlist
19888
19889
19890 .section "Duplicate addresses" "SECTdupaddr"
19891 .cindex "duplicate addresses"
19892 .cindex "address duplicate, discarding"
19893 .cindex "pipe" "duplicated"
19894 Exim removes duplicate addresses from the list to which it is delivering, so as
19895 to deliver just one copy to each address. This does not apply to deliveries
19896 routed to pipes by different immediate parent addresses, but an indirect
19897 aliasing scheme of the type
19898 .code
19899 pipe:       |/some/command $local_part
19900 localpart1: pipe
19901 localpart2: pipe
19902 .endd
19903 does not work with a message that is addressed to both local parts, because
19904 when the second is aliased to the intermediate local part &"pipe"& it gets
19905 discarded as being the same as a previously handled address. However, a scheme
19906 such as
19907 .code
19908 localpart1: |/some/command $local_part
19909 localpart2: |/some/command $local_part
19910 .endd
19911 does result in two different pipe deliveries, because the immediate parents of
19912 the pipes are distinct.
19913
19914
19915
19916 .section "Repeated redirection expansion" "SECID128"
19917 .cindex "repeated redirection expansion"
19918 .cindex "address redirection" "repeated for each delivery attempt"
19919 When a message cannot be delivered to all of its recipients immediately,
19920 leading to two or more delivery attempts, redirection expansion is carried out
19921 afresh each time for those addresses whose children were not all previously
19922 delivered. If redirection is being used as a mailing list, this can lead to new
19923 members of the list receiving copies of old messages. The &%one_time%& option
19924 can be used to avoid this.
19925
19926
19927 .section "Errors in redirection lists" "SECID129"
19928 .cindex "address redirection" "errors"
19929 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19930 error is skipped, and an entry is written to the main log. This may be useful
19931 for mailing lists that are automatically managed. Otherwise, if an error is
19932 detected while generating the list of new addresses, the original address is
19933 deferred. See also &%syntax_errors_to%&.
19934
19935
19936
19937 .section "Private options for the redirect router" "SECID130"
19938
19939 .cindex "options" "&(redirect)& router"
19940 The private options for the &(redirect)& router are as follows:
19941
19942
19943 .option allow_defer redirect boolean false
19944 Setting this option allows the use of &':defer:'& in non-filter redirection
19945 data, or the &%defer%& command in an Exim filter file.
19946
19947
19948 .option allow_fail redirect boolean false
19949 .cindex "failing delivery" "from filter"
19950 If this option is true, the &':fail:'& item can be used in a redirection list,
19951 and the &%fail%& command may be used in an Exim filter file.
19952
19953
19954 .option allow_filter redirect boolean false
19955 .cindex "filter" "enabling use of"
19956 .cindex "Sieve filter" "enabling use of"
19957 Setting this option allows Exim to interpret redirection data that starts with
19958 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19959 are some features of Exim filter files that some administrators may wish to
19960 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19961
19962 It is also possible to lock out Exim filters or Sieve filters while allowing
19963 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19964
19965
19966 The filter is run using the uid and gid set by the generic &%user%& and
19967 &%group%& options. These take their defaults from the password data if
19968 &%check_local_user%& is set, so in the normal case of users' personal filter
19969 files, the filter is run as the relevant user. When &%allow_filter%& is set
19970 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19971
19972
19973
19974 .option allow_freeze redirect boolean false
19975 .cindex "freezing messages" "allowing in filter"
19976 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19977 This command is more normally encountered in system filters, and is disabled by
19978 default for redirection filters because it isn't something you usually want to
19979 let ordinary users do.
19980
19981
19982
19983 .option check_ancestor redirect boolean false
19984 This option is concerned with handling generated addresses that are the same
19985 as some address in the list of redirection ancestors of the current address.
19986 Although it is turned off by default in the code, it is set in the default
19987 configuration file for handling users' &_.forward_& files. It is recommended
19988 for this use of the &(redirect)& router.
19989
19990 When &%check_ancestor%& is set, if a generated address (including the domain)
19991 is the same as any ancestor of the current address, it is replaced by a copy of
19992 the current address. This helps in the case where local part A is aliased to B,
19993 and B has a &_.forward_& file pointing back to A. For example, within a single
19994 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19995 &_&~jb/.forward_& contains:
19996 .code
19997 \Joe.Bloggs, <other item(s)>
19998 .endd
19999 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20000 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20001 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20002 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20003 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20004 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20005 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20006 original address. See also the &%repeat_use%& option below.
20007
20008
20009 .option check_group redirect boolean "see below"
20010 When the &%file%& option is used, the group owner of the file is checked only
20011 when this option is set. The permitted groups are those listed in the
20012 &%owngroups%& option, together with the user's default group if
20013 &%check_local_user%& is set. If the file has the wrong group, routing is
20014 deferred. The default setting for this option is true if &%check_local_user%&
20015 is set and the &%modemask%& option permits the group write bit, or if the
20016 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20017
20018
20019
20020 .option check_owner redirect boolean "see below"
20021 When the &%file%& option is used, the owner of the file is checked only when
20022 this option is set. If &%check_local_user%& is set, the local user is
20023 permitted; otherwise the owner must be one of those listed in the &%owners%&
20024 option. The default value for this option is true if &%check_local_user%& or
20025 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20026
20027
20028 .option data redirect string&!! unset
20029 This option is mutually exclusive with &%file%&. One or other of them must be
20030 set, but not both. The contents of &%data%& are expanded, and then used as the
20031 list of forwarding items, or as a set of filtering instructions. If the
20032 expansion is forced to fail, or the result is an empty string or a string that
20033 has no effect (consists entirely of comments), the router declines.
20034
20035 When filtering instructions are used, the string must begin with &"#Exim
20036 filter"&, and all comments in the string, including this initial one, must be
20037 terminated with newline characters. For example:
20038 .code
20039 data = #Exim filter\n\
20040        if $h_to: contains Exim then save $home/mail/exim endif
20041 .endd
20042 If you are reading the data from a database where newlines cannot be included,
20043 you can use the &${sg}$& expansion item to turn the escape string of your
20044 choice into a newline.
20045
20046
20047 .option directory_transport redirect string&!! unset
20048 A &(redirect)& router sets up a direct delivery to a directory when a path name
20049 ending with a slash is specified as a new &"address"&. The transport used is
20050 specified by this option, which, after expansion, must be the name of a
20051 configured transport. This should normally be an &(appendfile)& transport.
20052
20053
20054 .option file redirect string&!! unset
20055 This option specifies the name of a file that contains the redirection data. It
20056 is mutually exclusive with the &%data%& option. The string is expanded before
20057 use; if the expansion is forced to fail, the router declines. Other expansion
20058 failures cause delivery to be deferred. The result of a successful expansion
20059 must be an absolute path. The entire file is read and used as the redirection
20060 data. If the data is an empty string or a string that has no effect (consists
20061 entirely of comments), the router declines.
20062
20063 .cindex "NFS" "checking for file existence"
20064 If the attempt to open the file fails with a &"does not exist"& error, Exim
20065 runs a check on the containing directory,
20066 unless &%ignore_enotdir%& is true (see below).
20067 If the directory does not appear to exist, delivery is deferred. This can
20068 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20069 is a mount problem. If the containing directory does exist, but the file does
20070 not, the router declines.
20071
20072
20073 .option file_transport redirect string&!! unset
20074 .vindex "&$address_file$&"
20075 A &(redirect)& router sets up a direct delivery to a file when a path name not
20076 ending in a slash is specified as a new &"address"&. The transport used is
20077 specified by this option, which, after expansion, must be the name of a
20078 configured transport. This should normally be an &(appendfile)& transport. When
20079 it is running, the file name is in &$address_file$&.
20080
20081
20082 .option filter_prepend_home redirect boolean true
20083 When this option is true, if a &(save)& command in an Exim filter specifies a
20084 relative path, and &$home$& is defined, it is automatically prepended to the
20085 relative path. If this option is set false, this action does not happen. The
20086 relative path is then passed to the transport unmodified.
20087
20088
20089 .option forbid_blackhole redirect boolean false
20090 If this option is true, the &':blackhole:'& item may not appear in a
20091 redirection list.
20092
20093
20094 .option forbid_exim_filter redirect boolean false
20095 If this option is set true, only Sieve filters are permitted when
20096 &%allow_filter%& is true.
20097
20098
20099
20100
20101 .option forbid_file redirect boolean false
20102 .cindex "delivery" "to file; forbidding"
20103 .cindex "Sieve filter" "forbidding delivery to a file"
20104 .cindex "Sieve filter" "&""keep""& facility; disabling"
20105 If this option is true, this router may not generate a new address that
20106 specifies delivery to a local file or directory, either from a filter or from a
20107 conventional forward file. This option is forced to be true if &%one_time%& is
20108 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20109 locks out the Sieve's &"keep"& facility.
20110
20111
20112 .option forbid_filter_dlfunc redirect boolean false
20113 .cindex "filter" "locking out certain features"
20114 If this option is true, string expansions in Exim filters are not allowed to
20115 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20116 functions.
20117
20118 .option forbid_filter_existstest redirect boolean false
20119 .cindex "expansion" "statting a file"
20120 If this option is true, string expansions in Exim filters are not allowed to
20121 make use of the &%exists%& condition or the &%stat%& expansion item.
20122
20123 .option forbid_filter_logwrite redirect boolean false
20124 If this option is true, use of the logging facility in Exim filters is not
20125 permitted. Logging is in any case available only if the filter is being run
20126 under some unprivileged uid (which is normally the case for ordinary users'
20127 &_.forward_& files).
20128
20129
20130 .option forbid_filter_lookup redirect boolean false
20131 If this option is true, string expansions in Exim filter files are not allowed
20132 to make use of &%lookup%& items.
20133
20134
20135 .option forbid_filter_perl redirect boolean false
20136 This option has an effect only if Exim is built with embedded Perl support. If
20137 it is true, string expansions in Exim filter files are not allowed to make use
20138 of the embedded Perl support.
20139
20140
20141 .option forbid_filter_readfile redirect boolean false
20142 If this option is true, string expansions in Exim filter files are not allowed
20143 to make use of &%readfile%& items.
20144
20145
20146 .option forbid_filter_readsocket redirect boolean false
20147 If this option is true, string expansions in Exim filter files are not allowed
20148 to make use of &%readsocket%& items.
20149
20150
20151 .option forbid_filter_reply redirect boolean false
20152 If this option is true, this router may not generate an automatic reply
20153 message. Automatic replies can be generated only from Exim or Sieve filter
20154 files, not from traditional forward files. This option is forced to be true if
20155 &%one_time%& is set.
20156
20157
20158 .option forbid_filter_run redirect boolean false
20159 If this option is true, string expansions in Exim filter files are not allowed
20160 to make use of &%run%& items.
20161
20162
20163 .option forbid_include redirect boolean false
20164 If this option is true, items of the form
20165 .code
20166 :include:<path name>
20167 .endd
20168 are not permitted in non-filter redirection lists.
20169
20170
20171 .option forbid_pipe redirect boolean false
20172 .cindex "delivery" "to pipe; forbidding"
20173 If this option is true, this router may not generate a new address which
20174 specifies delivery to a pipe, either from an Exim filter or from a conventional
20175 forward file. This option is forced to be true if &%one_time%& is set.
20176
20177
20178 .option forbid_sieve_filter redirect boolean false
20179 If this option is set true, only Exim filters are permitted when
20180 &%allow_filter%& is true.
20181
20182
20183 .cindex "SMTP" "error codes"
20184 .option forbid_smtp_code redirect boolean false
20185 If this option is set true, any SMTP error codes that are present at the start
20186 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20187 the default codes (451 and 550, respectively) are always used.
20188
20189
20190
20191
20192 .option hide_child_in_errmsg redirect boolean false
20193 .cindex "bounce message" "redirection details; suppressing"
20194 If this option is true, it prevents Exim from quoting a child address if it
20195 generates a bounce or delay message for it. Instead it says &"an address
20196 generated from <&'the top level address'&>"&. Of course, this applies only to
20197 bounces generated locally. If a message is forwarded to another host, &'its'&
20198 bounce may well quote the generated address.
20199
20200
20201 .option ignore_eacces redirect boolean false
20202 .cindex "EACCES"
20203 If this option is set and an attempt to open a redirection file yields the
20204 EACCES error (permission denied), the &(redirect)& router behaves as if the
20205 file did not exist.
20206
20207
20208 .option ignore_enotdir redirect boolean false
20209 .cindex "ENOTDIR"
20210 If this option is set and an attempt to open a redirection file yields the
20211 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20212 router behaves as if the file did not exist.
20213
20214 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20215 router that has the &%file%& option set discovers that the file does not exist
20216 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20217 against unmounted NFS directories. If the parent can not be statted, delivery
20218 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20219 is set, because that option tells Exim to ignore &"something on the path is not
20220 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20221 that some operating systems give ENOENT where others give ENOTDIR.
20222
20223
20224
20225 .option include_directory redirect string unset
20226 If this option is set, the path names of any &':include:'& items in a
20227 redirection list must start with this directory.
20228
20229
20230 .option modemask redirect "octal integer" 022
20231 This specifies mode bits which must not be set for a file specified by the
20232 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20233
20234
20235 .option one_time redirect boolean false
20236 .cindex "one-time aliasing/forwarding expansion"
20237 .cindex "alias file" "one-time expansion"
20238 .cindex "forward file" "one-time expansion"
20239 .cindex "mailing lists" "one-time expansion"
20240 .cindex "address redirection" "one-time expansion"
20241 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20242 files each time it tries to deliver a message causes a problem when one or more
20243 of the generated addresses fails be delivered at the first attempt. The problem
20244 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20245 but of what happens when the redirection list changes during the time that the
20246 message is on Exim's queue. This is particularly true in the case of mailing
20247 lists, where new subscribers might receive copies of messages that were posted
20248 before they subscribed.
20249
20250 If &%one_time%& is set and any addresses generated by the router fail to
20251 deliver at the first attempt, the failing addresses are added to the message as
20252 &"top level"& addresses, and the parent address that generated them is marked
20253 &"delivered"&. Thus, redirection does not happen again at the next delivery
20254 attempt.
20255
20256 &*Warning 1*&: Any header line addition or removal that is specified by this
20257 router would be lost if delivery did not succeed at the first attempt. For this
20258 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20259 permitted when &%one_time%& is set.
20260
20261 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20262 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20263 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20264
20265 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20266 &%one_time%&.
20267
20268 The original top-level address is remembered with each of the generated
20269 addresses, and is output in any log messages. However, any intermediate parent
20270 addresses are not recorded. This makes a difference to the log only if
20271 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20272 typically be used for mailing lists, where there is normally just one level of
20273 expansion.
20274
20275
20276 .option owners redirect "string list" unset
20277 .cindex "ownership" "alias file"
20278 .cindex "ownership" "forward file"
20279 .cindex "alias file" "ownership"
20280 .cindex "forward file" "ownership"
20281 This specifies a list of permitted owners for the file specified by &%file%&.
20282 This list is in addition to the local user when &%check_local_user%& is set.
20283 See &%check_owner%& above.
20284
20285
20286 .option owngroups redirect "string list" unset
20287 This specifies a list of permitted groups for the file specified by &%file%&.
20288 The list is in addition to the local user's primary group when
20289 &%check_local_user%& is set. See &%check_group%& above.
20290
20291
20292 .option pipe_transport redirect string&!! unset
20293 .vindex "&$address_pipe$&"
20294 A &(redirect)& router sets up a direct delivery to a pipe when a string
20295 starting with a vertical bar character is specified as a new &"address"&. The
20296 transport used is specified by this option, which, after expansion, must be the
20297 name of a configured transport. This should normally be a &(pipe)& transport.
20298 When the transport is run, the pipe command is in &$address_pipe$&.
20299
20300
20301 .option qualify_domain redirect string&!! unset
20302 .vindex "&$qualify_recipient$&"
20303 If this option is set, and an unqualified address (one without a domain) is
20304 generated, and that address would normally be qualified by the global setting
20305 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20306 expanding this string. If the expansion fails, the router declines. If you want
20307 to revert to the default, you can have the expansion generate
20308 &$qualify_recipient$&.
20309
20310 This option applies to all unqualified addresses generated by Exim filters,
20311 but for traditional &_.forward_& files, it applies only to addresses that are
20312 not preceded by a backslash. Sieve filters cannot generate unqualified
20313 addresses.
20314
20315 .option qualify_preserve_domain redirect boolean false
20316 .cindex "domain" "in redirection; preserving"
20317 .cindex "preserving domain in redirection"
20318 .cindex "address redirection" "domain; preserving"
20319 If this option is set, the router's local &%qualify_domain%& option must not be
20320 set (a configuration error occurs if it is). If an unqualified address (one
20321 without a domain) is generated, it is qualified with the domain of the parent
20322 address (the immediately preceding ancestor) instead of the global
20323 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20324 this applies whether or not the address is preceded by a backslash.
20325
20326
20327 .option repeat_use redirect boolean true
20328 If this option is set false, the router is skipped for a child address that has
20329 any ancestor that was routed by this router. This test happens before any of
20330 the other preconditions are tested. Exim's default anti-looping rules skip
20331 only when the ancestor is the same as the current address. See also
20332 &%check_ancestor%& above and the generic &%redirect_router%& option.
20333
20334
20335 .option reply_transport redirect string&!! unset
20336 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20337 &%vacation%& command is used in a filter file. The transport used is specified
20338 by this option, which, after expansion, must be the name of a configured
20339 transport. This should normally be an &(autoreply)& transport. Other transports
20340 are unlikely to do anything sensible or useful.
20341
20342
20343 .option rewrite redirect boolean true
20344 .cindex "address redirection" "disabling rewriting"
20345 If this option is set false, addresses generated by the router are not
20346 subject to address rewriting. Otherwise, they are treated like new addresses
20347 and are rewritten according to the global rewriting rules.
20348
20349
20350 .option sieve_subaddress redirect string&!! unset
20351 The value of this option is passed to a Sieve filter to specify the
20352 :subaddress part of an address.
20353
20354 .option sieve_useraddress redirect string&!! unset
20355 The value of this option is passed to a Sieve filter to specify the :user part
20356 of an address. However, if it is unset, the entire original local part
20357 (including any prefix or suffix) is used for :user.
20358
20359
20360 .option sieve_vacation_directory redirect string&!! unset
20361 .cindex "Sieve filter" "vacation directory"
20362 To enable the &"vacation"& extension for Sieve filters, you must set
20363 &%sieve_vacation_directory%& to the directory where vacation databases are held
20364 (do not put anything else in that directory), and ensure that the
20365 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20366 needs their own directory; Exim will create it if necessary.
20367
20368
20369
20370 .option skip_syntax_errors redirect boolean false
20371 .cindex "forward file" "broken"
20372 .cindex "address redirection" "broken files"
20373 .cindex "alias file" "broken"
20374 .cindex "broken alias or forward files"
20375 .cindex "ignoring faulty addresses"
20376 .cindex "skipping faulty addresses"
20377 .cindex "error" "skipping bad syntax"
20378 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20379 non-filter redirection data are skipped, and each failing address is logged. If
20380 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20381 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20382 are expanded and placed at the head of the error message generated by
20383 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20384 be the same address as the generic &%errors_to%& option. The
20385 &%skip_syntax_errors%& option is often used when handling mailing lists.
20386
20387 If all the addresses in a redirection list are skipped because of syntax
20388 errors, the router declines to handle the original address, and it is passed to
20389 the following routers.
20390
20391 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20392 error in the filter causes filtering to be abandoned without any action being
20393 taken. The incident is logged, and the router declines to handle the address,
20394 so it is passed to the following routers.
20395
20396 .cindex "Sieve filter" "syntax errors in"
20397 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20398 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20399 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20400
20401 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20402 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20403 option, used with an address that does not get redirected, can be used to
20404 notify users of these errors, by means of a router like this:
20405 .code
20406 userforward:
20407   driver = redirect
20408   allow_filter
20409   check_local_user
20410   file = $home/.forward
20411   file_transport = address_file
20412   pipe_transport = address_pipe
20413   reply_transport = address_reply
20414   no_verify
20415   skip_syntax_errors
20416   syntax_errors_to = real-$local_part@$domain
20417   syntax_errors_text = \
20418    This is an automatically generated message. An error has\n\
20419    been found in your .forward file. Details of the error are\n\
20420    reported below. While this error persists, you will receive\n\
20421    a copy of this message for every message that is addressed\n\
20422    to you. If your .forward file is a filter file, or if it is\n\
20423    a non-filter file containing no valid forwarding addresses,\n\
20424    a copy of each incoming message will be put in your normal\n\
20425    mailbox. If a non-filter file contains at least one valid\n\
20426    forwarding address, forwarding to the valid addresses will\n\
20427    happen, and those will be the only deliveries that occur.
20428 .endd
20429 You also need a router to ensure that local addresses that are prefixed by
20430 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20431 put this immediately before the &(userforward)& router:
20432 .code
20433 real_localuser:
20434   driver = accept
20435   check_local_user
20436   local_part_prefix = real-
20437   transport = local_delivery
20438 .endd
20439 For security, it would probably be a good idea to restrict the use of this
20440 router to locally-generated messages, using a condition such as this:
20441 .code
20442   condition = ${if match {$sender_host_address}\
20443                          {\N^(|127\.0\.0\.1)$\N}}
20444 .endd
20445
20446
20447 .option syntax_errors_text redirect string&!! unset
20448 See &%skip_syntax_errors%& above.
20449
20450
20451 .option syntax_errors_to redirect string unset
20452 See &%skip_syntax_errors%& above.
20453 .ecindex IIDredrou1
20454 .ecindex IIDredrou2
20455
20456
20457
20458
20459
20460
20461 . ////////////////////////////////////////////////////////////////////////////
20462 . ////////////////////////////////////////////////////////////////////////////
20463
20464 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20465          "Environment for local transports"
20466 .scindex IIDenvlotra1 "local transports" "environment for"
20467 .scindex IIDenvlotra2 "environment" "local transports"
20468 .scindex IIDenvlotra3 "transport" "local; environment for"
20469 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20470 transport can be thought of as similar to a pipe.) Exim always runs transports
20471 in subprocesses, under specified uids and gids. Typical deliveries to local
20472 mailboxes run under the uid and gid of the local user.
20473
20474 Exim also sets a specific current directory while running the transport; for
20475 some transports a home directory setting is also relevant. The &(pipe)&
20476 transport is the only one that sets up environment variables; see section
20477 &<<SECTpipeenv>>& for details.
20478
20479 The values used for the uid, gid, and the directories may come from several
20480 different places. In many cases, the router that handles the address associates
20481 settings with that address as a result of its &%check_local_user%&, &%group%&,
20482 or &%user%& options. However, values may also be given in the transport's own
20483 configuration, and these override anything that comes from the router.
20484
20485
20486
20487 .section "Concurrent deliveries" "SECID131"
20488 .cindex "concurrent deliveries"
20489 .cindex "simultaneous deliveries"
20490 If two different messages for the same local recipient arrive more or less
20491 simultaneously, the two delivery processes are likely to run concurrently. When
20492 the &(appendfile)& transport is used to write to a file, Exim applies locking
20493 rules to stop concurrent processes from writing to the same file at the same
20494 time.
20495
20496 However, when you use a &(pipe)& transport, it is up to you to arrange any
20497 locking that is needed. Here is a silly example:
20498 .code
20499 my_transport:
20500   driver = pipe
20501   command = /bin/sh -c 'cat >>/some/file'
20502 .endd
20503 This is supposed to write the message at the end of the file. However, if two
20504 messages arrive at the same time, the file will be scrambled. You can use the
20505 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20506 file using the same algorithm that Exim itself uses.
20507
20508
20509
20510
20511 .section "Uids and gids" "SECTenvuidgid"
20512 .cindex "local transports" "uid and gid"
20513 .cindex "transport" "local; uid and gid"
20514 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20515 overrides any group that the router set in the address, even if &%user%& is not
20516 set for the transport. This makes it possible, for example, to run local mail
20517 delivery under the uid of the recipient (set by the router), but in a special
20518 group (set by the transport). For example:
20519 .code
20520 # Routers ...
20521 # User/group are set by check_local_user in this router
20522 local_users:
20523   driver = accept
20524   check_local_user
20525   transport = group_delivery
20526
20527 # Transports ...
20528 # This transport overrides the group
20529 group_delivery:
20530   driver = appendfile
20531   file = /var/spool/mail/$local_part
20532   group = mail
20533 .endd
20534 If &%user%& is set for a transport, its value overrides what is set in the
20535 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20536 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20537 set.
20538
20539 .oindex "&%initgroups%&"
20540 When the uid is taken from the transport's configuration, the &[initgroups()]&
20541 function is called for the groups associated with that uid if the
20542 &%initgroups%& option is set for the transport. When the uid is not specified
20543 by the transport, but is associated with the address by a router, the option
20544 for calling &[initgroups()]& is taken from the router configuration.
20545
20546 .cindex "&(pipe)& transport" "uid for"
20547 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20548 is set and &%user%& is not set, the uid of the process that called Exim to
20549 receive the message is used, and if &%group%& is not set, the corresponding
20550 original gid is also used.
20551
20552 This is the detailed preference order for obtaining a gid; the first of the
20553 following that is set is used:
20554
20555 .ilist
20556 A &%group%& setting of the transport;
20557 .next
20558 A &%group%& setting of the router;
20559 .next
20560 A gid associated with a user setting of the router, either as a result of
20561 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20562 .next
20563 The group associated with a non-numeric &%user%& setting of the transport;
20564 .next
20565 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20566 the uid is the creator's uid;
20567 .next
20568 The Exim gid if the Exim uid is being used as a default.
20569 .endlist
20570
20571 If, for example, the user is specified numerically on the router and there are
20572 no group settings, no gid is available. In this situation, an error occurs.
20573 This is different for the uid, for which there always is an ultimate default.
20574 The first of the following that is set is used:
20575
20576 .ilist
20577 A &%user%& setting of the transport;
20578 .next
20579 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20580 .next
20581 A &%user%& setting of the router;
20582 .next
20583 A &%check_local_user%& setting of the router;
20584 .next
20585 The Exim uid.
20586 .endlist
20587
20588 Of course, an error will still occur if the uid that is chosen is on the
20589 &%never_users%& list.
20590
20591
20592
20593
20594
20595 .section "Current and home directories" "SECID132"
20596 .cindex "current directory for local transport"
20597 .cindex "home directory" "for local transport"
20598 .cindex "transport" "local; home directory for"
20599 .cindex "transport" "local; current directory for"
20600 Routers may set current and home directories for local transports by means of
20601 the &%transport_current_directory%& and &%transport_home_directory%& options.
20602 However, if the transport's &%current_directory%& or &%home_directory%& options
20603 are set, they override the router's values. In detail, the home directory
20604 for a local transport is taken from the first of these values that is set:
20605
20606 .ilist
20607 The &%home_directory%& option on the transport;
20608 .next
20609 The &%transport_home_directory%& option on the router;
20610 .next
20611 The password data if &%check_local_user%& is set on the router;
20612 .next
20613 The &%router_home_directory%& option on the router.
20614 .endlist
20615
20616 The current directory is taken from the first of these values that is set:
20617
20618 .ilist
20619 The &%current_directory%& option on the transport;
20620 .next
20621 The &%transport_current_directory%& option on the router.
20622 .endlist
20623
20624
20625 If neither the router nor the transport sets a current directory, Exim uses the
20626 value of the home directory, if it is set. Otherwise it sets the current
20627 directory to &_/_& before running a local transport.
20628
20629
20630
20631 .section "Expansion variables derived from the address" "SECID133"
20632 .vindex "&$domain$&"
20633 .vindex "&$local_part$&"
20634 .vindex "&$original_domain$&"
20635 Normally a local delivery is handling a single address, and in that case the
20636 variables such as &$domain$& and &$local_part$& are set during local
20637 deliveries. However, in some circumstances more than one address may be handled
20638 at once (for example, while writing batch SMTP for onward transmission by some
20639 other means). In this case, the variables associated with the local part are
20640 never set, &$domain$& is set only if all the addresses have the same domain,
20641 and &$original_domain$& is never set.
20642 .ecindex IIDenvlotra1
20643 .ecindex IIDenvlotra2
20644 .ecindex IIDenvlotra3
20645
20646
20647
20648
20649
20650
20651
20652 . ////////////////////////////////////////////////////////////////////////////
20653 . ////////////////////////////////////////////////////////////////////////////
20654
20655 .chapter "Generic options for transports" "CHAPtransportgeneric"
20656 .scindex IIDgenoptra1 "generic options" "transport"
20657 .scindex IIDgenoptra2 "options" "generic; for transports"
20658 .scindex IIDgenoptra3 "transport" "generic options for"
20659 The following generic options apply to all transports:
20660
20661
20662 .option body_only transports boolean false
20663 .cindex "transport" "body only"
20664 .cindex "message" "transporting body only"
20665 .cindex "body of message" "transporting"
20666 If this option is set, the message's headers are not transported. It is
20667 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20668 or &(pipe)& transports, the settings of &%message_prefix%& and
20669 &%message_suffix%& should be checked, because this option does not
20670 automatically suppress them.
20671
20672
20673 .option current_directory transports string&!! unset
20674 .cindex "transport" "current directory for"
20675 This specifies the current directory that is to be set while running the
20676 transport, overriding any value that may have been set by the router.
20677 If the expansion fails for any reason, including forced failure, an error is
20678 logged, and delivery is deferred.
20679
20680
20681 .option disable_logging transports boolean false
20682 If this option is set true, nothing is logged for any
20683 deliveries by the transport or for any
20684 transport errors. You should not set this option unless you really, really know
20685 what you are doing.
20686
20687
20688 .option debug_print transports string&!! unset
20689 .cindex "testing" "variables in drivers"
20690 If this option is set and debugging is enabled (see the &%-d%& command line
20691 option), the string is expanded and included in the debugging output when the
20692 transport is run.
20693 If expansion of the string fails, the error message is written to the debugging
20694 output, and Exim carries on processing.
20695 This facility is provided to help with checking out the values of variables and
20696 so on when debugging driver configurations. For example, if a &%headers_add%&
20697 option is not working properly, &%debug_print%& could be used to output the
20698 variables it references. A newline is added to the text if it does not end with
20699 one.
20700 The variables &$transport_name$& and &$router_name$& contain the name of the
20701 transport and the router that called it.
20702
20703 .option delivery_date_add transports boolean false
20704 .cindex "&'Delivery-date:'& header line"
20705 If this option is true, a &'Delivery-date:'& header is added to the message.
20706 This gives the actual time the delivery was made. As this is not a standard
20707 header, Exim has a configuration option (&%delivery_date_remove%&) which
20708 requests its removal from incoming messages, so that delivered messages can
20709 safely be resent to other recipients.
20710
20711
20712 .option driver transports string unset
20713 This specifies which of the available transport drivers is to be used.
20714 There is no default, and this option must be set for every transport.
20715
20716
20717 .option envelope_to_add transports boolean false
20718 .cindex "&'Envelope-to:'& header line"
20719 If this option is true, an &'Envelope-to:'& header is added to the message.
20720 This gives the original address(es) in the incoming envelope that caused this
20721 delivery to happen. More than one address may be present if the transport is
20722 configured to handle several addresses at once, or if more than one original
20723 address was redirected to the same final address. As this is not a standard
20724 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20725 its removal from incoming messages, so that delivered messages can safely be
20726 resent to other recipients.
20727
20728
20729 .option event_action transports string&!! unset
20730 .cindex events
20731 This option declares a string to be expanded for Exim's events mechanism.
20732 For details see &<<CHAPevents>>&.
20733
20734
20735 .option group transports string&!! "Exim group"
20736 .cindex "transport" "group; specifying"
20737 This option specifies a gid for running the transport process, overriding any
20738 value that the router supplies, and also overriding any value associated with
20739 &%user%& (see below).
20740
20741
20742 .option headers_add transports list&!! unset
20743 .cindex "header lines" "adding in transport"
20744 .cindex "transport" "header lines; adding"
20745 This option specifies a list of text headers,
20746 newline-separated (by default, changeable in the usual way),
20747 which are (separately) expanded and added to the header
20748 portion of a message as it is transported, as described in section
20749 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20750 routers. If the result of the expansion is an empty string, or if the expansion
20751 is forced to fail, no action is taken. Other expansion failures are treated as
20752 errors and cause the delivery to be deferred.
20753
20754 Unlike most options, &%headers_add%& can be specified multiple times
20755 for a transport; all listed headers are added.
20756
20757
20758 .option headers_only transports boolean false
20759 .cindex "transport" "header lines only"
20760 .cindex "message" "transporting headers only"
20761 .cindex "header lines" "transporting"
20762 If this option is set, the message's body is not transported. It is mutually
20763 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20764 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20765 checked, since this option does not automatically suppress them.
20766
20767
20768 .option headers_remove transports list&!! unset
20769 .cindex "header lines" "removing"
20770 .cindex "transport" "header lines; removing"
20771 This option specifies a list of header names,
20772 colon-separated (by default, changeable in the usual way);
20773 these headers are omitted from the message as it is transported, as described
20774 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20775 routers.
20776 Each list item is separately expanded.
20777 If the result of the expansion is an empty string, or if the expansion
20778 is forced to fail, no action is taken. Other expansion failures are treated as
20779 errors and cause the delivery to be deferred.
20780
20781 Unlike most options, &%headers_remove%& can be specified multiple times
20782 for a router; all listed headers are removed.
20783
20784 &*Warning*&: Because of the separate expansion of the list items,
20785 items that contain a list separator must have it doubled.
20786 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20787
20788
20789
20790 .option headers_rewrite transports string unset
20791 .cindex "transport" "header lines; rewriting"
20792 .cindex "rewriting" "at transport time"
20793 This option allows addresses in header lines to be rewritten at transport time,
20794 that is, as the message is being copied to its destination. The contents of the
20795 option are a colon-separated list of rewriting rules. Each rule is in exactly
20796 the same form as one of the general rewriting rules that are applied when a
20797 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20798 example,
20799 .code
20800 headers_rewrite = a@b c@d f : \
20801                   x@y w@z
20802 .endd
20803 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20804 &'w@z'& in all address-bearing header lines. The rules are applied to the
20805 header lines just before they are written out at transport time, so they affect
20806 only those copies of the message that pass through the transport. However, only
20807 the message's original header lines, and any that were added by a system
20808 filter, are rewritten. If a router or transport adds header lines, they are not
20809 affected by this option. These rewriting rules are &'not'& applied to the
20810 envelope. You can change the return path using &%return_path%&, but you cannot
20811 change envelope recipients at this time.
20812
20813
20814 .option home_directory transports string&!! unset
20815 .cindex "transport" "home directory for"
20816 .vindex "&$home$&"
20817 This option specifies a home directory setting for a local transport,
20818 overriding any value that may be set by the router. The home directory is
20819 placed in &$home$& while expanding the transport's private options. It is also
20820 used as the current directory if no current directory is set by the
20821 &%current_directory%& option on the transport or the
20822 &%transport_current_directory%& option on the router. If the expansion fails
20823 for any reason, including forced failure, an error is logged, and delivery is
20824 deferred.
20825
20826
20827 .option initgroups transports boolean false
20828 .cindex "additional groups"
20829 .cindex "groups" "additional"
20830 .cindex "transport" "group; additional"
20831 If this option is true and the uid for the delivery process is provided by the
20832 transport, the &[initgroups()]& function is called when running the transport
20833 to ensure that any additional groups associated with the uid are set up.
20834
20835
20836 .option max_parallel transports integer&!! unset
20837 .cindex limit "transport parallelism"
20838 .cindex transport "parallel processes"
20839 .cindex transport "concurrency limit"
20840 .cindex "delivery" "parallelism for transport"
20841 If this option is set and expands to an integer greater than zero
20842 it limits the number of concurrent runs of the transport.
20843 The control does not apply to shadow transports.
20844
20845 .cindex "hints database" "transport concurrency control"
20846 Exim implements this control by means of a hints database in which a record is
20847 incremented whenever a transport process is beaing created. The record
20848 is decremented and possibly removed when the process terminates.
20849 Obviously there is scope for
20850 records to get left lying around if there is a system or program crash. To
20851 guard against this, Exim ignores any records that are more than six hours old.
20852
20853 If you use this option, you should also arrange to delete the
20854 relevant hints database whenever your system reboots. The names of the files
20855 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20856 may be one or two files, depending on the type of DBM in use. The same files
20857 are used for ETRN and smtp transport serialization.
20858
20859
20860 .option message_size_limit transports string&!! 0
20861 .cindex "limit" "message size per transport"
20862 .cindex "size" "of message, limit"
20863 .cindex "transport" "message size; limiting"
20864 This option controls the size of messages passed through the transport. It is
20865 expanded before use; the result of the expansion must be a sequence of decimal
20866 digits, optionally followed by K or M. If the expansion fails for any reason,
20867 including forced failure, or if the result is not of the required form,
20868 delivery is deferred. If the value is greater than zero and the size of a
20869 message exceeds this limit, the address is failed. If there is any chance that
20870 the resulting bounce message could be routed to the same transport, you should
20871 ensure that &%return_size_limit%& is less than the transport's
20872 &%message_size_limit%&, as otherwise the bounce message will fail to get
20873 delivered.
20874
20875
20876
20877 .option rcpt_include_affixes transports boolean false
20878 .cindex "prefix" "for local part, including in envelope"
20879 .cindex "suffix for local part" "including in envelope"
20880 .cindex "local part" "prefix"
20881 .cindex "local part" "suffix"
20882 When this option is false (the default), and an address that has had any
20883 affixes (prefixes or suffixes) removed from the local part is delivered by any
20884 form of SMTP or LMTP, the affixes are not included. For example, if a router
20885 that contains
20886 .code
20887 local_part_prefix = *-
20888 .endd
20889 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20890 is delivered with
20891 .code
20892 RCPT TO:<xyz@some.domain>
20893 .endd
20894 This is also the case when an ACL-time callout is being used to verify a
20895 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20896 whole local part is included in the RCPT command. This option applies to BSMTP
20897 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20898 &(lmtp)& and &(smtp)& transports.
20899
20900
20901 .option retry_use_local_part transports boolean "see below"
20902 .cindex "hints database" "retry keys"
20903 When a delivery suffers a temporary failure, a retry record is created
20904 in Exim's hints database. For remote deliveries, the key for the retry record
20905 is based on the name and/or IP address of the failing remote host. For local
20906 deliveries, the key is normally the entire address, including both the local
20907 part and the domain. This is suitable for most common cases of local delivery
20908 temporary failure &-- for example, exceeding a mailbox quota should delay only
20909 deliveries to that mailbox, not to the whole domain.
20910
20911 However, in some special cases you may want to treat a temporary local delivery
20912 as a failure associated with the domain, and not with a particular local part.
20913 (For example, if you are storing all mail for some domain in files.) You can do
20914 this by setting &%retry_use_local_part%& false.
20915
20916 For all the local transports, its default value is true. For remote transports,
20917 the default value is false for tidiness, but changing the value has no effect
20918 on a remote transport in the current implementation.
20919
20920
20921 .option return_path transports string&!! unset
20922 .cindex "envelope sender"
20923 .cindex "transport" "return path; changing"
20924 .cindex "return path" "changing in transport"
20925 If this option is set, the string is expanded at transport time and replaces
20926 the existing return path (envelope sender) value in the copy of the message
20927 that is being delivered. An empty return path is permitted. This feature is
20928 designed for remote deliveries, where the value of this option is used in the
20929 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20930 only effect is to change the address that is placed in the &'Return-path:'&
20931 header line, if one is added to the message (see the next option).
20932
20933 &*Note:*& A changed return path is not logged unless you add
20934 &%return_path_on_delivery%& to the log selector.
20935
20936 .vindex "&$return_path$&"
20937 The expansion can refer to the existing value via &$return_path$&. This is
20938 either the message's envelope sender, or an address set by the
20939 &%errors_to%& option on a router. If the expansion is forced to fail, no
20940 replacement occurs; if it fails for another reason, delivery is deferred. This
20941 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20942 section &<<SECTverp>>&.
20943
20944 &*Note*&: If a delivery error is detected locally, including the case when a
20945 remote server rejects a message at SMTP time, the bounce message is not sent to
20946 the value of this option. It is sent to the previously set errors address.
20947 This defaults to the incoming sender address, but can be changed by setting
20948 &%errors_to%& in a router.
20949
20950
20951
20952 .option return_path_add transports boolean false
20953 .cindex "&'Return-path:'& header line"
20954 If this option is true, a &'Return-path:'& header is added to the message.
20955 Although the return path is normally available in the prefix line of BSD
20956 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20957 have easy access to it.
20958
20959 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20960 the delivery SMTP server makes the final delivery"&. This implies that this
20961 header should not be present in incoming messages. Exim has a configuration
20962 option, &%return_path_remove%&, which requests removal of this header from
20963 incoming messages, so that delivered messages can safely be resent to other
20964 recipients.
20965
20966
20967 .option shadow_condition transports string&!! unset
20968 See &%shadow_transport%& below.
20969
20970
20971 .option shadow_transport transports string unset
20972 .cindex "shadow transport"
20973 .cindex "transport" "shadow"
20974 A local transport may set the &%shadow_transport%& option to the name of
20975 another local transport. Shadow remote transports are not supported.
20976
20977 Whenever a delivery to the main transport succeeds, and either
20978 &%shadow_condition%& is unset, or its expansion does not result in the empty
20979 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20980 passed to the shadow transport, with the same delivery address or addresses. If
20981 expansion fails, no action is taken except that non-forced expansion failures
20982 cause a log line to be written.
20983
20984 The result of the shadow transport is discarded and does not affect the
20985 subsequent processing of the message. Only a single level of shadowing is
20986 provided; the &%shadow_transport%& option is ignored on any transport when it
20987 is running as a shadow. Options concerned with output from pipes are also
20988 ignored. The log line for the successful delivery has an item added on the end,
20989 of the form
20990 .code
20991 ST=<shadow transport name>
20992 .endd
20993 If the shadow transport did not succeed, the error message is put in
20994 parentheses afterwards. Shadow transports can be used for a number of different
20995 purposes, including keeping more detailed log information than Exim normally
20996 provides, and implementing automatic acknowledgment policies based on message
20997 headers that some sites insist on.
20998
20999
21000 .option transport_filter transports string&!! unset
21001 .cindex "transport" "filter"
21002 .cindex "filter" "transport filter"
21003 This option sets up a filtering (in the Unix shell sense) process for messages
21004 at transport time. It should not be confused with mail filtering as set up by
21005 individual users or via a system filter.
21006 If unset, or expanding to an empty string, no filtering is done.
21007
21008 When the message is about to be written out, the command specified by
21009 &%transport_filter%& is started up in a separate, parallel process, and
21010 the entire message, including the header lines, is passed to it on its standard
21011 input (this in fact is done from a third process, to avoid deadlock). The
21012 command must be specified as an absolute path.
21013
21014 The lines of the message that are written to the transport filter are
21015 terminated by newline (&"\n"&). The message is passed to the filter before any
21016 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21017 lines beginning with a dot, and also before any processing implied by the
21018 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21019 &(pipe)& transports.
21020
21021 The standard error for the filter process is set to the same destination as its
21022 standard output; this is read and written to the message's ultimate
21023 destination. The process that writes the message to the filter, the
21024 filter itself, and the original process that reads the result and delivers it
21025 are all run in parallel, like a shell pipeline.
21026
21027 The filter can perform any transformations it likes, but of course should take
21028 care not to break RFC 2822 syntax. Exim does not check the result, except to
21029 test for a final newline when SMTP is in use. All messages transmitted over
21030 SMTP must end with a newline, so Exim supplies one if it is missing.
21031
21032 .cindex "content scanning" "per user"
21033 A transport filter can be used to provide content-scanning on a per-user basis
21034 at delivery time if the only required effect of the scan is to modify the
21035 message. For example, a content scan could insert a new header line containing
21036 a spam score. This could be interpreted by a filter in the user's MUA. It is
21037 not possible to discard a message at this stage.
21038
21039 .cindex "SMTP" "SIZE"
21040 A problem might arise if the filter increases the size of a message that is
21041 being sent down an SMTP connection. If the receiving SMTP server has indicated
21042 support for the SIZE parameter, Exim will have sent the size of the message
21043 at the start of the SMTP session. If what is actually sent is substantially
21044 more, the server might reject the message. This can be worked round by setting
21045 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21046 additions to the message, or to disable the use of SIZE altogether.
21047
21048 .vindex "&$pipe_addresses$&"
21049 The value of the &%transport_filter%& option is the command string for starting
21050 the filter, which is run directly from Exim, not under a shell. The string is
21051 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21052 Exim breaks it up into arguments and then expands each argument separately (see
21053 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21054 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21055 of arguments, one for each address that applies to this delivery. (This isn't
21056 an ideal name for this feature here, but as it was already implemented for the
21057 &(pipe)& transport, it seemed sensible not to change it.)
21058
21059 .vindex "&$host$&"
21060 .vindex "&$host_address$&"
21061 The expansion variables &$host$& and &$host_address$& are available when the
21062 transport is a remote one. They contain the name and IP address of the host to
21063 which the message is being sent. For example:
21064 .code
21065 transport_filter = /some/directory/transport-filter.pl \
21066   $host $host_address $sender_address $pipe_addresses
21067 .endd
21068
21069 Two problems arise if you want to use more complicated expansion items to
21070 generate transport filter commands, both of which due to the fact that the
21071 command is split up &'before'& expansion.
21072 .ilist
21073 If an expansion item contains white space, you must quote it, so that it is all
21074 part of the same command item. If the entire option setting is one such
21075 expansion item, you have to take care what kind of quoting you use. For
21076 example:
21077 .code
21078 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21079 .endd
21080 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21081 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21082 stripped by Exim when it read the option's value. When the value is used, if
21083 the single quotes were missing, the line would be split into two items,
21084 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21085 Exim tried to expand the first one.
21086 .next
21087 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21088 expansion cannot generate multiple arguments, or a command name followed by
21089 arguments. Consider this example:
21090 .code
21091 transport_filter = ${lookup{$host}lsearch{/a/file}\
21092                     {$value}{/bin/cat}}
21093 .endd
21094 The result of the lookup is interpreted as the name of the command, even
21095 if it contains white space. The simplest way round this is to use a shell:
21096 .code
21097 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21098                                {$value}{/bin/cat}}
21099 .endd
21100 .endlist
21101
21102 The filter process is run under the same uid and gid as the normal delivery.
21103 For remote deliveries this is the Exim uid/gid by default. The command should
21104 normally yield a zero return code. Transport filters are not supposed to fail.
21105 A non-zero code is taken to mean that the transport filter encountered some
21106 serious problem. Delivery of the message is deferred; the message remains on
21107 the queue and is tried again later. It is not possible to cause a message to be
21108 bounced from a transport filter.
21109
21110 If a transport filter is set on an autoreply transport, the original message is
21111 passed through the filter as it is being copied into the newly generated
21112 message, which happens if the &%return_message%& option is set.
21113
21114
21115 .option transport_filter_timeout transports time 5m
21116 .cindex "transport" "filter, timeout"
21117 When Exim is reading the output of a transport filter, it applies a timeout
21118 that can be set by this option. Exceeding the timeout is normally treated as a
21119 temporary delivery failure. However, if a transport filter is used with a
21120 &(pipe)& transport, a timeout in the transport filter is treated in the same
21121 way as a timeout in the pipe command itself. By default, a timeout is a hard
21122 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21123 becomes a temporary error.
21124
21125
21126 .option user transports string&!! "Exim user"
21127 .cindex "uid (user id)" "local delivery"
21128 .cindex "transport" "user, specifying"
21129 This option specifies the user under whose uid the delivery process is to be
21130 run, overriding any uid that may have been set by the router. If the user is
21131 given as a name, the uid is looked up from the password data, and the
21132 associated group is taken as the value of the gid to be used if the &%group%&
21133 option is not set.
21134
21135 For deliveries that use local transports, a user and group are normally
21136 specified explicitly or implicitly (for example, as a result of
21137 &%check_local_user%&) by the router or transport.
21138
21139 .cindex "hints database" "access by remote transport"
21140 For remote transports, you should leave this option unset unless you really are
21141 sure you know what you are doing. When a remote transport is running, it needs
21142 to be able to access Exim's hints databases, because each host may have its own
21143 retry data.
21144 .ecindex IIDgenoptra1
21145 .ecindex IIDgenoptra2
21146 .ecindex IIDgenoptra3
21147
21148
21149
21150
21151
21152
21153 . ////////////////////////////////////////////////////////////////////////////
21154 . ////////////////////////////////////////////////////////////////////////////
21155
21156 .chapter "Address batching in local transports" "CHAPbatching" &&&
21157          "Address batching"
21158 .cindex "transport" "local; address batching in"
21159 The only remote transport (&(smtp)&) is normally configured to handle more than
21160 one address at a time, so that when several addresses are routed to the same
21161 remote host, just one copy of the message is sent. Local transports, however,
21162 normally handle one address at a time. That is, a separate instance of the
21163 transport is run for each address that is routed to the transport. A separate
21164 copy of the message is delivered each time.
21165
21166 .cindex "batched local delivery"
21167 .oindex "&%batch_max%&"
21168 .oindex "&%batch_id%&"
21169 In special cases, it may be desirable to handle several addresses at once in a
21170 local transport, for example:
21171
21172 .ilist
21173 In an &(appendfile)& transport, when storing messages in files for later
21174 delivery by some other means, a single copy of the message with multiple
21175 recipients saves space.
21176 .next
21177 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21178 a single copy saves time, and is the normal way LMTP is expected to work.
21179 .next
21180 In a &(pipe)& transport, when passing the message
21181 to a scanner program or
21182 to some other delivery mechanism such as UUCP, multiple recipients may be
21183 acceptable.
21184 .endlist
21185
21186 These three local transports all have the same options for controlling multiple
21187 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21188 repeating the information for each transport, these options are described here.
21189
21190 The &%batch_max%& option specifies the maximum number of addresses that can be
21191 delivered together in a single run of the transport. Its default value is one
21192 (no batching). When more than one address is routed to a transport that has a
21193 &%batch_max%& value greater than one, the addresses are delivered in a batch
21194 (that is, in a single run of the transport with multiple recipients), subject
21195 to certain conditions:
21196
21197 .ilist
21198 .vindex "&$local_part$&"
21199 If any of the transport's options contain a reference to &$local_part$&, no
21200 batching is possible.
21201 .next
21202 .vindex "&$domain$&"
21203 If any of the transport's options contain a reference to &$domain$&, only
21204 addresses with the same domain are batched.
21205 .next
21206 .cindex "customizing" "batching condition"
21207 If &%batch_id%& is set, it is expanded for each address, and only those
21208 addresses with the same expanded value are batched. This allows you to specify
21209 customized batching conditions. Failure of the expansion for any reason,
21210 including forced failure, disables batching, but it does not stop the delivery
21211 from taking place.
21212 .next
21213 Batched addresses must also have the same errors address (where to send
21214 delivery errors), the same header additions and removals, the same user and
21215 group for the transport, and if a host list is present, the first host must
21216 be the same.
21217 .endlist
21218
21219 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21220 both when the file or pipe command is specified in the transport, and when it
21221 is specified by a &(redirect)& router, but all the batched addresses must of
21222 course be routed to the same file or pipe command. These two transports have an
21223 option called &%use_bsmtp%&, which causes them to deliver the message in
21224 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21225 &%check_string%& and &%escape_string%& options are forced to the values
21226 .code
21227 check_string = "."
21228 escape_string = ".."
21229 .endd
21230 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21231 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21232 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21233
21234 .cindex "&'Envelope-to:'& header line"
21235 If the generic &%envelope_to_add%& option is set for a batching transport, the
21236 &'Envelope-to:'& header that is added to the message contains all the addresses
21237 that are being processed together. If you are using a batching &(appendfile)&
21238 transport without &%use_bsmtp%&, the only way to preserve the recipient
21239 addresses is to set the &%envelope_to_add%& option.
21240
21241 .cindex "&(pipe)& transport" "with multiple addresses"
21242 .vindex "&$pipe_addresses$&"
21243 If you are using a &(pipe)& transport without BSMTP, and setting the
21244 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21245 the command. This is not a true variable; it is a bit of magic that causes each
21246 of the recipient addresses to be inserted into the command as a separate
21247 argument. This provides a way of accessing all the addresses that are being
21248 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21249 are specified by a &(redirect)& router.
21250
21251
21252
21253
21254 . ////////////////////////////////////////////////////////////////////////////
21255 . ////////////////////////////////////////////////////////////////////////////
21256
21257 .chapter "The appendfile transport" "CHAPappendfile"
21258 .scindex IIDapptra1 "&(appendfile)& transport"
21259 .scindex IIDapptra2 "transports" "&(appendfile)&"
21260 .cindex "directory creation"
21261 .cindex "creating directories"
21262 The &(appendfile)& transport delivers a message by appending it to an existing
21263 file, or by creating an entirely new file in a specified directory. Single
21264 files to which messages are appended can be in the traditional Unix mailbox
21265 format, or optionally in the MBX format supported by the Pine MUA and
21266 University of Washington IMAP daemon, &'inter alia'&. When each message is
21267 being delivered as a separate file, &"maildir"& format can optionally be used
21268 to give added protection against failures that happen part-way through the
21269 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21270 supported. For all file formats, Exim attempts to create as many levels of
21271 directory as necessary, provided that &%create_directory%& is set.
21272
21273 The code for the optional formats is not included in the Exim binary by
21274 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21275 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21276 included.
21277
21278 .cindex "quota" "system"
21279 Exim recognizes system quota errors, and generates an appropriate message. Exim
21280 also supports its own quota control within the transport, for use when the
21281 system facility is unavailable or cannot be used for some reason.
21282
21283 If there is an error while appending to a file (for example, quota exceeded or
21284 partition filled), Exim attempts to reset the file's length and last
21285 modification time back to what they were before. If there is an error while
21286 creating an entirely new file, the new file is removed.
21287
21288 Before appending to a file, a number of security checks are made, and the
21289 file is locked. A detailed description is given below, after the list of
21290 private options.
21291
21292 The &(appendfile)& transport is most commonly used for local deliveries to
21293 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21294 putting messages into files for remote delivery by some means other than Exim.
21295 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21296 option).
21297
21298
21299
21300 .section "The file and directory options" "SECTfildiropt"
21301 The &%file%& option specifies a single file, to which the message is appended;
21302 the &%directory%& option specifies a directory, in which a new file containing
21303 the message is created. Only one of these two options can be set, and for
21304 normal deliveries to mailboxes, one of them &'must'& be set.
21305
21306 .vindex "&$address_file$&"
21307 .vindex "&$local_part$&"
21308 However, &(appendfile)& is also used for delivering messages to files or
21309 directories whose names (or parts of names) are obtained from alias,
21310 forwarding, or filtering operations (for example, a &%save%& command in a
21311 user's Exim filter). When such a transport is running, &$local_part$& contains
21312 the local part that was aliased or forwarded, and &$address_file$& contains the
21313 name (or partial name) of the file or directory generated by the redirection
21314 operation. There are two cases:
21315
21316 .ilist
21317 If neither &%file%& nor &%directory%& is set, the redirection operation
21318 must specify an absolute path (one that begins with &`/`&). This is the most
21319 common case when users with local accounts use filtering to sort mail into
21320 different folders. See for example, the &(address_file)& transport in the
21321 default configuration. If the path ends with a slash, it is assumed to be the
21322 name of a directory. A delivery to a directory can also be forced by setting
21323 &%maildir_format%& or &%mailstore_format%&.
21324 .next
21325 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21326 used to determine the file or directory name for the delivery. Normally, the
21327 contents of &$address_file$& are used in some way in the string expansion.
21328 .endlist
21329
21330
21331 .cindex "Sieve filter" "configuring &(appendfile)&"
21332 .cindex "Sieve filter" "relative mailbox path handling"
21333 As an example of the second case, consider an environment where users do not
21334 have home directories. They may be permitted to use Exim filter commands of the
21335 form:
21336 .code
21337 save folder23
21338 .endd
21339 or Sieve filter commands of the form:
21340 .code
21341 require "fileinto";
21342 fileinto "folder23";
21343 .endd
21344 In this situation, the expansion of &%file%& or &%directory%& in the transport
21345 must transform the relative path into an appropriate absolute file name. In the
21346 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21347 is used as a result of a &"keep"& action in the filter. This example shows one
21348 way of handling this requirement:
21349 .code
21350 file = ${if eq{$address_file}{inbox} \
21351             {/var/mail/$local_part} \
21352             {${if eq{${substr_0_1:$address_file}}{/} \
21353                   {$address_file} \
21354                   {$home/mail/$address_file} \
21355             }} \
21356        }
21357 .endd
21358 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21359 location, absolute paths are used without change, and other folders are in the
21360 &_mail_& directory within the home directory.
21361
21362 &*Note 1*&: While processing an Exim filter, a relative path such as
21363 &_folder23_& is turned into an absolute path if a home directory is known to
21364 the router. In particular, this is the case if &%check_local_user%& is set. If
21365 you want to prevent this happening at routing time, you can set
21366 &%router_home_directory%& empty. This forces the router to pass the relative
21367 path to the transport.
21368
21369 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21370 the &%file%& or &%directory%& option is still used if it is set.
21371
21372
21373
21374
21375 .section "Private options for appendfile" "SECID134"
21376 .cindex "options" "&(appendfile)& transport"
21377
21378
21379
21380 .option allow_fifo appendfile boolean false
21381 .cindex "fifo (named pipe)"
21382 .cindex "named pipe (fifo)"
21383 .cindex "pipe" "named (fifo)"
21384 Setting this option permits delivery to named pipes (FIFOs) as well as to
21385 regular files. If no process is reading the named pipe at delivery time, the
21386 delivery is deferred.
21387
21388
21389 .option allow_symlink appendfile boolean false
21390 .cindex "symbolic link" "to mailbox"
21391 .cindex "mailbox" "symbolic link"
21392 By default, &(appendfile)& will not deliver if the path name for the file is
21393 that of a symbolic link. Setting this option relaxes that constraint, but there
21394 are security issues involved in the use of symbolic links. Be sure you know
21395 what you are doing if you set this. Details of exactly what this option affects
21396 are included in the discussion which follows this list of options.
21397
21398
21399 .option batch_id appendfile string&!! unset
21400 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21401 However, batching is automatically disabled for &(appendfile)& deliveries that
21402 happen as a result of forwarding or aliasing or other redirection directly to a
21403 file.
21404
21405
21406 .option batch_max appendfile integer 1
21407 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21408
21409
21410 .option check_group appendfile boolean false
21411 When this option is set, the group owner of the file defined by the &%file%&
21412 option is checked to see that it is the same as the group under which the
21413 delivery process is running. The default setting is false because the default
21414 file mode is 0600, which means that the group is irrelevant.
21415
21416
21417 .option check_owner appendfile boolean true
21418 When this option is set, the owner of the file defined by the &%file%& option
21419 is checked to ensure that it is the same as the user under which the delivery
21420 process is running.
21421
21422
21423 .option check_string appendfile string "see below"
21424 .cindex "&""From""& line"
21425 As &(appendfile)& writes the message, the start of each line is tested for
21426 matching &%check_string%&, and if it does, the initial matching characters are
21427 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21428 a literal string, not a regular expression, and the case of any letters it
21429 contains is significant.
21430
21431 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21432 are forced to &"."& and &".."& respectively, and any settings in the
21433 configuration are ignored. Otherwise, they default to &"From&~"& and
21434 &">From&~"& when the &%file%& option is set, and unset when any of the
21435 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21436
21437 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21438 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21439 &"From&~"& indicates the start of a new message. All four options need changing
21440 if another format is used. For example, to deliver to mailboxes in MMDF format:
21441 .cindex "MMDF format mailbox"
21442 .cindex "mailbox" "MMDF format"
21443 .code
21444 check_string = "\1\1\1\1\n"
21445 escape_string = "\1\1\1\1 \n"
21446 message_prefix = "\1\1\1\1\n"
21447 message_suffix = "\1\1\1\1\n"
21448 .endd
21449 .option create_directory appendfile boolean true
21450 .cindex "directory creation"
21451 When this option is true, Exim attempts to create any missing superior
21452 directories for the file that it is about to write. A created directory's mode
21453 is given by the &%directory_mode%& option.
21454
21455 The group ownership of a newly created directory is highly dependent on the
21456 operating system (and possibly the file system) that is being used. For
21457 example, in Solaris, if the parent directory has the setgid bit set, its group
21458 is propagated to the child; if not, the currently set group is used. However,
21459 in FreeBSD, the parent's group is always used.
21460
21461
21462
21463 .option create_file appendfile string anywhere
21464 This option constrains the location of files and directories that are created
21465 by this transport. It applies to files defined by the &%file%& option and
21466 directories defined by the &%directory%& option. In the case of maildir
21467 delivery, it applies to the top level directory, not the maildir directories
21468 beneath.
21469
21470 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21471 &"belowhome"&. In the second and third cases, a home directory must have been
21472 set for the transport. This option is not useful when an explicit file name is
21473 given for normal mailbox deliveries. It is intended for the case when file
21474 names are generated from users' &_.forward_& files. These are usually handled
21475 by an &(appendfile)& transport called &%address_file%&. See also
21476 &%file_must_exist%&.
21477
21478
21479 .option directory appendfile string&!! unset
21480 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21481 or &%directory%& must be set, unless the delivery is the direct result of a
21482 redirection (see section &<<SECTfildiropt>>&).
21483
21484 When &%directory%& is set, the string is expanded, and the message is delivered
21485 into a new file or files in or below the given directory, instead of being
21486 appended to a single mailbox file. A number of different formats are provided
21487 (see &%maildir_format%& and &%mailstore_format%&), and see section
21488 &<<SECTopdir>>& for further details of this form of delivery.
21489
21490
21491 .option directory_file appendfile string&!! "see below"
21492 .cindex "base62"
21493 .vindex "&$inode$&"
21494 When &%directory%& is set, but neither &%maildir_format%& nor
21495 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21496 whose name is obtained by expanding this string. The default value is:
21497 .code
21498 q${base62:$tod_epoch}-$inode
21499 .endd
21500 This generates a unique name from the current time, in base 62 form, and the
21501 inode of the file. The variable &$inode$& is available only when expanding this
21502 option.
21503
21504
21505 .option directory_mode appendfile "octal integer" 0700
21506 If &(appendfile)& creates any directories as a result of the
21507 &%create_directory%& option, their mode is specified by this option.
21508
21509
21510 .option escape_string appendfile string "see description"
21511 See &%check_string%& above.
21512
21513
21514 .option file appendfile string&!! unset
21515 This option is mutually exclusive with the &%directory%& option, but one of
21516 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21517 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21518 specifies a single file, to which the message is appended. One or more of
21519 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21520 &%file%&.
21521
21522 .cindex "NFS" "lock file"
21523 .cindex "locking files"
21524 .cindex "lock files"
21525 If you are using more than one host to deliver over NFS into the same
21526 mailboxes, you should always use lock files.
21527
21528 The string value is expanded for each delivery, and must yield an absolute
21529 path. The most common settings of this option are variations on one of these
21530 examples:
21531 .code
21532 file = /var/spool/mail/$local_part
21533 file = /home/$local_part/inbox
21534 file = $home/inbox
21535 .endd
21536 .cindex "&""sticky""& bit"
21537 In the first example, all deliveries are done into the same directory. If Exim
21538 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21539 create a file in the directory, so the &"sticky"& bit must be turned on for
21540 deliveries to be possible, or alternatively the &%group%& option can be used to
21541 run the delivery under a group id which has write access to the directory.
21542
21543
21544
21545 .option file_format appendfile string unset
21546 .cindex "file" "mailbox; checking existing format"
21547 This option requests the transport to check the format of an existing file
21548 before adding to it. The check consists of matching a specific string at the
21549 start of the file. The value of the option consists of an even number of
21550 colon-separated strings. The first of each pair is the test string, and the
21551 second is the name of a transport. If the transport associated with a matched
21552 string is not the current transport, control is passed over to the other
21553 transport. For example, suppose the standard &(local_delivery)& transport has
21554 this added to it:
21555 .code
21556 file_format = "From       : local_delivery :\
21557                \1\1\1\1\n : local_mmdf_delivery"
21558 .endd
21559 Mailboxes that begin with &"From"& are still handled by this transport, but if
21560 a mailbox begins with four binary ones followed by a newline, control is passed
21561 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21562 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21563 is assumed to match the current transport. If the start of a mailbox doesn't
21564 match any string, or if the transport named for a given string is not defined,
21565 delivery is deferred.
21566
21567
21568 .option file_must_exist appendfile boolean false
21569 If this option is true, the file specified by the &%file%& option must exist.
21570 A temporary error occurs if it does not, causing delivery to be deferred.
21571 If this option is false, the file is created if it does not exist.
21572
21573
21574 .option lock_fcntl_timeout appendfile time 0s
21575 .cindex "timeout" "mailbox locking"
21576 .cindex "mailbox" "locking, blocking and non-blocking"
21577 .cindex "locking files"
21578 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21579 when locking an open mailbox file. If the call fails, the delivery process
21580 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21581 Non-blocking calls are used so that the file is not kept open during the wait
21582 for the lock; the reason for this is to make it as safe as possible for
21583 deliveries over NFS in the case when processes might be accessing an NFS
21584 mailbox without using a lock file. This should not be done, but
21585 misunderstandings and hence misconfigurations are not unknown.
21586
21587 On a busy system, however, the performance of a non-blocking lock approach is
21588 not as good as using a blocking lock with a timeout. In this case, the waiting
21589 is done inside the system call, and Exim's delivery process acquires the lock
21590 and can proceed as soon as the previous lock holder releases it.
21591
21592 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21593 timeout, are used. There may still be some retrying: the maximum number of
21594 retries is
21595 .code
21596 (lock_retries * lock_interval) / lock_fcntl_timeout
21597 .endd
21598 rounded up to the next whole number. In other words, the total time during
21599 which &(appendfile)& is trying to get a lock is roughly the same, unless
21600 &%lock_fcntl_timeout%& is set very large.
21601
21602 You should consider setting this option if you are getting a lot of delayed
21603 local deliveries because of errors of the form
21604 .code
21605 failed to lock mailbox /some/file (fcntl)
21606 .endd
21607
21608 .option lock_flock_timeout appendfile time 0s
21609 This timeout applies to file locking when using &[flock()]& (see
21610 &%use_flock%&); the timeout operates in a similar manner to
21611 &%lock_fcntl_timeout%&.
21612
21613
21614 .option lock_interval appendfile time 3s
21615 This specifies the time to wait between attempts to lock the file. See below
21616 for details of locking.
21617
21618
21619 .option lock_retries appendfile integer 10
21620 This specifies the maximum number of attempts to lock the file. A value of zero
21621 is treated as 1. See below for details of locking.
21622
21623
21624 .option lockfile_mode appendfile "octal integer" 0600
21625 This specifies the mode of the created lock file, when a lock file is being
21626 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21627
21628
21629 .option lockfile_timeout appendfile time 30m
21630 .cindex "timeout" "mailbox locking"
21631 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21632 exists and is older than this value, it is assumed to have been left behind by
21633 accident, and Exim attempts to remove it.
21634
21635
21636 .option mailbox_filecount appendfile string&!! unset
21637 .cindex "mailbox" "specifying size of"
21638 .cindex "size" "of mailbox"
21639 If this option is set, it is expanded, and the result is taken as the current
21640 number of files in the mailbox. It must be a decimal number, optionally
21641 followed by K or M. This provides a way of obtaining this information from an
21642 external source that maintains the data.
21643
21644
21645 .option mailbox_size appendfile string&!! unset
21646 .cindex "mailbox" "specifying size of"
21647 .cindex "size" "of mailbox"
21648 If this option is set, it is expanded, and the result is taken as the current
21649 size the mailbox. It must be a decimal number, optionally followed by K or M.
21650 This provides a way of obtaining this information from an external source that
21651 maintains the data. This is likely to be helpful for maildir deliveries where
21652 it is computationally expensive to compute the size of a mailbox.
21653
21654
21655
21656 .option maildir_format appendfile boolean false
21657 .cindex "maildir format" "specifying"
21658 If this option is set with the &%directory%& option, the delivery is into a new
21659 file, in the &"maildir"& format that is used by other mail software. When the
21660 transport is activated directly from a &(redirect)& router (for example, the
21661 &(address_file)& transport in the default configuration), setting
21662 &%maildir_format%& causes the path received from the router to be treated as a
21663 directory, whether or not it ends with &`/`&. This option is available only if
21664 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21665 &<<SECTmaildirdelivery>>& below for further details.
21666
21667
21668 .option maildir_quota_directory_regex appendfile string "See below"
21669 .cindex "maildir format" "quota; directories included in"
21670 .cindex "quota" "maildir; directories included in"
21671 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21672 a regular expression for specifying directories, relative to the quota
21673 directory (see &%quota_directory%&), that should be included in the quota
21674 calculation. The default value is:
21675 .code
21676 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21677 .endd
21678 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21679 (directories whose names begin with a dot). If you want to exclude the
21680 &_Trash_&
21681 folder from the count (as some sites do), you need to change this setting to
21682 .code
21683 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21684 .endd
21685 This uses a negative lookahead in the regular expression to exclude the
21686 directory whose name is &_.Trash_&. When a directory is excluded from quota
21687 calculations, quota processing is bypassed for any messages that are delivered
21688 directly into that directory.
21689
21690
21691 .option maildir_retries appendfile integer 10
21692 This option specifies the number of times to retry when writing a file in
21693 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21694
21695
21696 .option maildir_tag appendfile string&!! unset
21697 This option applies only to deliveries in maildir format, and is described in
21698 section &<<SECTmaildirdelivery>>& below.
21699
21700
21701 .option maildir_use_size_file appendfile&!! boolean false
21702 .cindex "maildir format" "&_maildirsize_& file"
21703 The result of string expansion for this option must be a valid boolean value.
21704 If it is true, it enables support for &_maildirsize_& files. Exim
21705 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21706 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21707 value is zero. See &%maildir_quota_directory_regex%& above and section
21708 &<<SECTmaildirdelivery>>& below for further details.
21709
21710 .option maildirfolder_create_regex appendfile string unset
21711 .cindex "maildir format" "&_maildirfolder_& file"
21712 .cindex "&_maildirfolder_&, creating"
21713 The value of this option is a regular expression. If it is unset, it has no
21714 effect. Otherwise, before a maildir delivery takes place, the pattern is
21715 matched against the name of the maildir directory, that is, the directory
21716 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21717 delivery. If there is a match, Exim checks for the existence of a file called
21718 &_maildirfolder_& in the directory, and creates it if it does not exist.
21719 See section &<<SECTmaildirdelivery>>& for more details.
21720
21721
21722 .option mailstore_format appendfile boolean false
21723 .cindex "mailstore format" "specifying"
21724 If this option is set with the &%directory%& option, the delivery is into two
21725 new files in  &"mailstore"& format. The option is available only if
21726 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21727 below for further details.
21728
21729
21730 .option mailstore_prefix appendfile string&!! unset
21731 This option applies only to deliveries in mailstore format, and is described in
21732 section &<<SECTopdir>>& below.
21733
21734
21735 .option mailstore_suffix appendfile string&!! unset
21736 This option applies only to deliveries in mailstore format, and is described in
21737 section &<<SECTopdir>>& below.
21738
21739
21740 .option mbx_format appendfile boolean false
21741 .cindex "locking files"
21742 .cindex "file" "locking"
21743 .cindex "file" "MBX format"
21744 .cindex "MBX format, specifying"
21745 This option is available only if Exim has been compiled with SUPPORT_MBX
21746 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21747 the message is appended to the mailbox file in MBX format instead of
21748 traditional Unix format. This format is supported by Pine4 and its associated
21749 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21750
21751 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21752 automatically changed by the use of &%mbx_format%&. They should normally be set
21753 empty when using MBX format, so this option almost always appears in this
21754 combination:
21755 .code
21756 mbx_format = true
21757 message_prefix =
21758 message_suffix =
21759 .endd
21760 If none of the locking options are mentioned in the configuration,
21761 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21762 is possible to specify the other kinds of locking with &%mbx_format%&, but
21763 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21764 interworks with &'c-client'&, providing for shared access to the mailbox. It
21765 should not be used if any program that does not use this form of locking is
21766 going to access the mailbox, nor should it be used if the mailbox file is NFS
21767 mounted, because it works only when the mailbox is accessed from a single host.
21768
21769 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21770 the standard version of &'c-client'&, because as long as it has a mailbox open
21771 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21772 append messages to it.
21773
21774
21775 .option message_prefix appendfile string&!! "see below"
21776 .cindex "&""From""& line"
21777 The string specified here is expanded and output at the start of every message.
21778 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21779 in which case it is:
21780 .code
21781 message_prefix = "From ${if def:return_path{$return_path}\
21782   {MAILER-DAEMON}} $tod_bsdinbox\n"
21783 .endd
21784 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21785 &`\n`& to &`\r\n`& in &%message_prefix%&.
21786
21787 .option message_suffix appendfile string&!! "see below"
21788 The string specified here is expanded and output at the end of every message.
21789 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21790 in which case it is a single newline character. The suffix can be suppressed by
21791 setting
21792 .code
21793 message_suffix =
21794 .endd
21795 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21796 &`\n`& to &`\r\n`& in &%message_suffix%&.
21797
21798 .option mode appendfile "octal integer" 0600
21799 If the output file is created, it is given this mode. If it already exists and
21800 has wider permissions, they are reduced to this mode. If it has narrower
21801 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21802 if the delivery is the result of a &%save%& command in a filter file specifying
21803 a particular mode, the mode of the output file is always forced to take that
21804 value, and this option is ignored.
21805
21806
21807 .option mode_fail_narrower appendfile boolean true
21808 This option applies in the case when an existing mailbox file has a narrower
21809 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21810 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21811 continues with the delivery attempt, using the existing mode of the file.
21812
21813
21814 .option notify_comsat appendfile boolean false
21815 If this option is true, the &'comsat'& daemon is notified after every
21816 successful delivery to a user mailbox. This is the daemon that notifies logged
21817 on users about incoming mail.
21818
21819
21820 .option quota appendfile string&!! unset
21821 .cindex "quota" "imposed by Exim"
21822 This option imposes a limit on the size of the file to which Exim is appending,
21823 or to the total space used in the directory tree when the &%directory%& option
21824 is set. In the latter case, computation of the space used is expensive, because
21825 all the files in the directory (and any sub-directories) have to be
21826 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21827 &%maildir_use_size_file%& for ways to avoid this in environments where users
21828 have no shell access to their mailboxes).
21829
21830 As there is no interlock against two simultaneous deliveries into a
21831 multi-file mailbox, it is possible for the quota to be overrun in this case.
21832 For single-file mailboxes, of course, an interlock is a necessity.
21833
21834 A file's size is taken as its &'used'& value. Because of blocking effects, this
21835 may be a lot less than the actual amount of disk space allocated to the file.
21836 If the sizes of a number of files are being added up, the rounding effect can
21837 become quite noticeable, especially on systems that have large block sizes.
21838 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21839 the obvious value which users understand most easily.
21840
21841 The value of the option is expanded, and must then be a numerical value
21842 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21843 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21844 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21845 be handled.
21846
21847 &*Note*&: A value of zero is interpreted as &"no quota"&.
21848
21849 The expansion happens while Exim is running as root, before it changes uid for
21850 the delivery. This means that files that are inaccessible to the end user can
21851 be used to hold quota values that are looked up in the expansion. When delivery
21852 fails because this quota is exceeded, the handling of the error is as for
21853 system quota failures.
21854
21855 By default, Exim's quota checking mimics system quotas, and restricts the
21856 mailbox to the specified maximum size, though the value is not accurate to the
21857 last byte, owing to separator lines and additional headers that may get added
21858 during message delivery. When a mailbox is nearly full, large messages may get
21859 refused even though small ones are accepted, because the size of the current
21860 message is added to the quota when the check is made. This behaviour can be
21861 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21862 for exceeding the quota does not include the current message. Thus, deliveries
21863 continue until the quota has been exceeded; thereafter, no further messages are
21864 delivered. See also &%quota_warn_threshold%&.
21865
21866
21867 .option quota_directory appendfile string&!! unset
21868 This option defines the directory to check for quota purposes when delivering
21869 into individual files. The default is the delivery directory, or, if a file
21870 called &_maildirfolder_& exists in a maildir directory, the parent of the
21871 delivery directory.
21872
21873
21874 .option quota_filecount appendfile string&!! 0
21875 This option applies when the &%directory%& option is set. It limits the total
21876 number of files in the directory (compare the inode limit in system quotas). It
21877 can only be used if &%quota%& is also set. The value is expanded; an expansion
21878 failure causes delivery to be deferred. A value of zero is interpreted as
21879 &"no quota"&.
21880
21881
21882 .option quota_is_inclusive appendfile boolean true
21883 See &%quota%& above.
21884
21885
21886 .option quota_size_regex appendfile string unset
21887 This option applies when one of the delivery modes that writes a separate file
21888 for each message is being used. When Exim wants to find the size of one of
21889 these files in order to test the quota, it first checks &%quota_size_regex%&.
21890 If this is set to a regular expression that matches the file name, and it
21891 captures one string, that string is interpreted as a representation of the
21892 file's size. The value of &%quota_size_regex%& is not expanded.
21893
21894 This feature is useful only when users have no shell access to their mailboxes
21895 &-- otherwise they could defeat the quota simply by renaming the files. This
21896 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21897 the file length to the file name. For example:
21898 .code
21899 maildir_tag = ,S=$message_size
21900 quota_size_regex = ,S=(\d+)
21901 .endd
21902 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21903 number of lines in the message.
21904
21905 The regular expression should not assume that the length is at the end of the
21906 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21907 sometimes add other information onto the ends of message file names.
21908
21909 Section &<<SECID136>>& contains further information.
21910
21911
21912 .option quota_warn_message appendfile string&!! "see below"
21913 See below for the use of this option. If it is not set when
21914 &%quota_warn_threshold%& is set, it defaults to
21915 .code
21916 quota_warn_message = "\
21917   To: $local_part@$domain\n\
21918   Subject: Your mailbox\n\n\
21919   This message is automatically created \
21920   by mail delivery software.\n\n\
21921   The size of your mailbox has exceeded \
21922   a warning threshold that is\n\
21923   set by the system administrator.\n"
21924 .endd
21925
21926
21927 .option quota_warn_threshold appendfile string&!! 0
21928 .cindex "quota" "warning threshold"
21929 .cindex "mailbox" "size warning"
21930 .cindex "size" "of mailbox"
21931 This option is expanded in the same way as &%quota%& (see above). If the
21932 resulting value is greater than zero, and delivery of the message causes the
21933 size of the file or total space in the directory tree to cross the given
21934 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21935 may be specified as a percentage of it by following the value with a percent
21936 sign. For example:
21937 .code
21938 quota = 10M
21939 quota_warn_threshold = 75%
21940 .endd
21941 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21942 percent sign is ignored.
21943
21944 The warning message itself is specified by the &%quota_warn_message%& option,
21945 and it must start with a &'To:'& header line containing the recipient(s) of the
21946 warning message. These do not necessarily have to include the recipient(s) of
21947 the original message. A &'Subject:'& line should also normally be supplied. You
21948 can include any other header lines that you want. If you do not include a
21949 &'From:'& line, the default is:
21950 .code
21951 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21952 .endd
21953 .oindex &%errors_reply_to%&
21954 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21955 option.
21956
21957 The &%quota%& option does not have to be set in order to use this option; they
21958 are independent of one another except when the threshold is specified as a
21959 percentage.
21960
21961
21962 .option use_bsmtp appendfile boolean false
21963 .cindex "envelope sender"
21964 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21965 format, with the envelope sender and recipient(s) included as SMTP commands. If
21966 you want to include a leading HELO command with such messages, you can do
21967 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21968 for details of batch SMTP.
21969
21970
21971 .option use_crlf appendfile boolean false
21972 .cindex "carriage return"
21973 .cindex "linefeed"
21974 This option causes lines to be terminated with the two-character CRLF sequence
21975 (carriage return, linefeed) instead of just a linefeed character. In the case
21976 of batched SMTP, the byte sequence written to the file is then an exact image
21977 of what would be sent down a real SMTP connection.
21978
21979 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21980 (which are used to supply the traditional &"From&~"& and blank line separators
21981 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21982 carriage return characters if these are needed. In cases where these options
21983 have non-empty defaults, the values end with a single linefeed, so they must be
21984 changed to end with &`\r\n`& if &%use_crlf%& is set.
21985
21986
21987 .option use_fcntl_lock appendfile boolean "see below"
21988 This option controls the use of the &[fcntl()]& function to lock a file for
21989 exclusive use when a message is being appended. It is set by default unless
21990 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21991 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21992 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21993
21994
21995 .option use_flock_lock appendfile boolean false
21996 This option is provided to support the use of &[flock()]& for file locking, for
21997 the few situations where it is needed. Most modern operating systems support
21998 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21999 each other. Exim uses &[fcntl()]& locking by default.
22000
22001 This option is required only if you are using an operating system where
22002 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22003 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22004 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22005
22006 .cindex "Solaris" "&[flock()]& support"
22007 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22008 have it (and some, I think, provide a not quite right version built on top of
22009 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22010 the ability to use it, and any attempt to do so will cause a configuration
22011 error.
22012
22013 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22014 is just being mapped onto &[fcntl()]& by the OS).
22015
22016
22017 .option use_lockfile appendfile boolean "see below"
22018 If this option is turned off, Exim does not attempt to create a lock file when
22019 appending to a mailbox file. In this situation, the only locking is by
22020 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22021 sure that every MUA that is ever going to look at your users' mailboxes uses
22022 &[fcntl()]& rather than a lock file, and even then only when you are not
22023 delivering over NFS from more than one host.
22024
22025 .cindex "NFS" "lock file"
22026 In order to append to an NFS file safely from more than one host, it is
22027 necessary to take out a lock &'before'& opening the file, and the lock file
22028 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22029 file corruption.
22030
22031 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22032 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22033 except when &%mbx_format%& is set.
22034
22035
22036 .option use_mbx_lock appendfile boolean "see below"
22037 This option is available only if Exim has been compiled with SUPPORT_MBX
22038 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22039 locking rules be used. It is set by default if &%mbx_format%& is set and none
22040 of the locking options are mentioned in the configuration. The locking rules
22041 are the same as are used by the &'c-client'& library that underlies Pine and
22042 the IMAP4 and POP daemons that come with it (see the discussion below). The
22043 rules allow for shared access to the mailbox. However, this kind of locking
22044 does not work when the mailbox is NFS mounted.
22045
22046 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22047 &%use_flock_lock%& to control what kind of locking is used in implementing the
22048 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22049 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22050
22051
22052
22053
22054 .section "Operational details for appending" "SECTopappend"
22055 .cindex "appending to a file"
22056 .cindex "file" "appending"
22057 Before appending to a file, the following preparations are made:
22058
22059 .ilist
22060 If the name of the file is &_/dev/null_&, no action is taken, and a success
22061 return is given.
22062
22063 .next
22064 .cindex "directory creation"
22065 If any directories on the file's path are missing, Exim creates them if the
22066 &%create_directory%& option is set. A created directory's mode is given by the
22067 &%directory_mode%& option.
22068
22069 .next
22070 If &%file_format%& is set, the format of an existing file is checked. If this
22071 indicates that a different transport should be used, control is passed to that
22072 transport.
22073
22074 .next
22075 .cindex "file" "locking"
22076 .cindex "locking files"
22077 .cindex "NFS" "lock file"
22078 If &%use_lockfile%& is set, a lock file is built in a way that will work
22079 reliably over NFS, as follows:
22080
22081 .olist
22082 Create a &"hitching post"& file whose name is that of the lock file with the
22083 current time, primary host name, and process id added, by opening for writing
22084 as a new file. If this fails with an access error, delivery is deferred.
22085 .next
22086 Close the hitching post file, and hard link it to the lock file name.
22087 .next
22088 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22089 Unlink the hitching post name.
22090 .next
22091 Otherwise, use &[stat()]& to get information about the hitching post file, and
22092 then unlink hitching post name. If the number of links is exactly two, creation
22093 of the lock file succeeded but something (for example, an NFS server crash and
22094 restart) caused this fact not to be communicated to the &[link()]& call.
22095 .next
22096 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22097 up to &%lock_retries%& times. However, since any program that writes to a
22098 mailbox should complete its task very quickly, it is reasonable to time out old
22099 lock files that are normally the result of user agent and system crashes. If an
22100 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22101 it before trying again.
22102 .endlist olist
22103
22104 .next
22105 A call is made to &[lstat()]& to discover whether the main file exists, and if
22106 so, what its characteristics are. If &[lstat()]& fails for any reason other
22107 than non-existence, delivery is deferred.
22108
22109 .next
22110 .cindex "symbolic link" "to mailbox"
22111 .cindex "mailbox" "symbolic link"
22112 If the file does exist and is a symbolic link, delivery is deferred, unless the
22113 &%allow_symlink%& option is set, in which case the ownership of the link is
22114 checked, and then &[stat()]& is called to find out about the real file, which
22115 is then subjected to the checks below. The check on the top-level link
22116 ownership prevents one user creating a link for another's mailbox in a sticky
22117 directory, though allowing symbolic links in this case is definitely not a good
22118 idea. If there is a chain of symbolic links, the intermediate ones are not
22119 checked.
22120
22121 .next
22122 If the file already exists but is not a regular file, or if the file's owner
22123 and group (if the group is being checked &-- see &%check_group%& above) are
22124 different from the user and group under which the delivery is running,
22125 delivery is deferred.
22126
22127 .next
22128 If the file's permissions are more generous than specified, they are reduced.
22129 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22130 is set false, in which case the delivery is tried using the existing
22131 permissions.
22132
22133 .next
22134 The file's inode number is saved, and the file is then opened for appending.
22135 If this fails because the file has vanished, &(appendfile)& behaves as if it
22136 hadn't existed (see below). For any other failures, delivery is deferred.
22137
22138 .next
22139 If the file is opened successfully, check that the inode number hasn't
22140 changed, that it is still a regular file, and that the owner and permissions
22141 have not changed. If anything is wrong, defer delivery and freeze the message.
22142
22143 .next
22144 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22145 option is set. Otherwise, check that the file is being created in a permitted
22146 directory if the &%create_file%& option is set (deferring on failure), and then
22147 open for writing as a new file, with the O_EXCL and O_CREAT options,
22148 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22149 set). In this case, which can happen if the link points to a non-existent file,
22150 the file is opened for writing using O_CREAT but not O_EXCL, because
22151 that prevents link following.
22152
22153 .next
22154 .cindex "loop" "while file testing"
22155 If opening fails because the file exists, obey the tests given above for
22156 existing files. However, to avoid looping in a situation where the file is
22157 being continuously created and destroyed, the exists/not-exists loop is broken
22158 after 10 repetitions, and the message is then frozen.
22159
22160 .next
22161 If opening fails with any other error, defer delivery.
22162
22163 .next
22164 .cindex "file" "locking"
22165 .cindex "locking files"
22166 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22167 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22168 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22169 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22170 file, and an exclusive lock on the file whose name is
22171 .code
22172 /tmp/.<device-number>.<inode-number>
22173 .endd
22174 using the device and inode numbers of the open mailbox file, in accordance with
22175 the MBX locking rules. This file is created with a mode that is specified by
22176 the &%lockfile_mode%& option.
22177
22178 If Exim fails to lock the file, there are two possible courses of action,
22179 depending on the value of the locking timeout. This is obtained from
22180 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22181
22182 If the timeout value is zero, the file is closed, Exim waits for
22183 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22184 to lock it again. This happens up to &%lock_retries%& times, after which the
22185 delivery is deferred.
22186
22187 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22188 &[flock()]& are used (with the given timeout), so there has already been some
22189 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22190 immediately. It retries up to
22191 .code
22192 (lock_retries * lock_interval) / <timeout>
22193 .endd
22194 times (rounded up).
22195 .endlist
22196
22197 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22198 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22199
22200
22201 .section "Operational details for delivery to a new file" "SECTopdir"
22202 .cindex "delivery" "to single file"
22203 .cindex "&""From""& line"
22204 When the &%directory%& option is set instead of &%file%&, each message is
22205 delivered into a newly-created file or set of files. When &(appendfile)& is
22206 activated directly from a &(redirect)& router, neither &%file%& nor
22207 &%directory%& is normally set, because the path for delivery is supplied by the
22208 router. (See for example, the &(address_file)& transport in the default
22209 configuration.) In this case, delivery is to a new file if either the path name
22210 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22211
22212 No locking is required while writing the message to a new file, so the various
22213 locking options of the transport are ignored. The &"From"& line that by default
22214 separates messages in a single file is not normally needed, nor is the escaping
22215 of message lines that start with &"From"&, and there is no need to ensure a
22216 newline at the end of each message. Consequently, the default values for
22217 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22218 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22219
22220 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22221 the files in the delivery directory by default. However, you can specify a
22222 different directory by setting &%quota_directory%&. Also, for maildir
22223 deliveries (see below) the &_maildirfolder_& convention is honoured.
22224
22225
22226 .cindex "maildir format"
22227 .cindex "mailstore format"
22228 There are three different ways in which delivery to individual files can be
22229 done, controlled by the settings of the &%maildir_format%& and
22230 &%mailstore_format%& options. Note that code to support maildir or mailstore
22231 formats is not included in the binary unless SUPPORT_MAILDIR or
22232 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22233
22234 .cindex "directory creation"
22235 In all three cases an attempt is made to create the directory and any necessary
22236 sub-directories if they do not exist, provided that the &%create_directory%&
22237 option is set (the default). The location of a created directory can be
22238 constrained by setting &%create_file%&. A created directory's mode is given by
22239 the &%directory_mode%& option. If creation fails, or if the
22240 &%create_directory%& option is not set when creation is required, delivery is
22241 deferred.
22242
22243
22244
22245 .section "Maildir delivery" "SECTmaildirdelivery"
22246 .cindex "maildir format" "description of"
22247 If the &%maildir_format%& option is true, Exim delivers each message by writing
22248 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22249 directory that is defined by the &%directory%& option (the &"delivery
22250 directory"&). If the delivery is successful, the file is renamed into the
22251 &_new_& subdirectory.
22252
22253 In the file name, <&'stime'&> is the current time of day in seconds, and
22254 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22255 Exim checks that the time-of-day clock has moved on by at least one microsecond
22256 before terminating the delivery process. This guarantees uniqueness for the
22257 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22258 opening it. If any response other than ENOENT (does not exist) is given,
22259 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22260
22261 Before Exim carries out a maildir delivery, it ensures that subdirectories
22262 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22263 do not exist, Exim tries to create them and any superior directories in their
22264 path, subject to the &%create_directory%& and &%create_file%& options. If the
22265 &%maildirfolder_create_regex%& option is set, and the regular expression it
22266 contains matches the delivery directory, Exim also ensures that a file called
22267 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22268 &_maildirfolder_& file cannot be created, delivery is deferred.
22269
22270 These features make it possible to use Exim to create all the necessary files
22271 and directories in a maildir mailbox, including subdirectories for maildir++
22272 folders. Consider this example:
22273 .code
22274 maildir_format = true
22275 directory = /var/mail/$local_part\
22276            ${if eq{$local_part_suffix}{}{}\
22277            {/.${substr_1:$local_part_suffix}}}
22278 maildirfolder_create_regex = /\.[^/]+$
22279 .endd
22280 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22281 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22282 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22283 not match this name, so Exim will not look for or create the file
22284 &_/var/mail/pimbo/maildirfolder_&, though it will create
22285 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22286
22287 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22288 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22289 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22290 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22291 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22292
22293 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22294 not inadvertently match the toplevel maildir directory, because a
22295 &_maildirfolder_& file at top level would completely break quota calculations.
22296
22297 .cindex "quota" "in maildir delivery"
22298 .cindex "maildir++"
22299 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22300 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22301 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22302 Exim assumes the directory is a maildir++ folder directory, which is one level
22303 down from the user's top level mailbox directory. This causes it to start at
22304 the parent directory instead of the current directory when calculating the
22305 amount of space used.
22306
22307 One problem with delivering into a multi-file mailbox is that it is
22308 computationally expensive to compute the size of the mailbox for quota
22309 checking. Various approaches have been taken to reduce the amount of work
22310 needed. The next two sections describe two of them. A third alternative is to
22311 use some external process for maintaining the size data, and use the expansion
22312 of the &%mailbox_size%& option as a way of importing it into Exim.
22313
22314
22315
22316
22317 .section "Using tags to record message sizes" "SECID135"
22318 If &%maildir_tag%& is set, the string is expanded for each delivery.
22319 When the maildir file is renamed into the &_new_& sub-directory, the
22320 tag is added to its name. However, if adding the tag takes the length of the
22321 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22322 the tag is dropped and the maildir file is created with no tag.
22323
22324
22325 .vindex "&$message_size$&"
22326 Tags can be used to encode the size of files in their names; see
22327 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22328 happens after the message has been written. The value of the &$message_size$&
22329 variable is set to the number of bytes actually written. If the expansion is
22330 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22331 be deferred. The expanded tag may contain any printing characters except &"/"&.
22332 Non-printing characters in the string are ignored; if the resulting string is
22333 empty, it is ignored. If it starts with an alphanumeric character, a leading
22334 colon is inserted; this default has not proven to be the path that popular
22335 maildir implementations have chosen (but changing it in Exim would break
22336 backwards compatibility).
22337
22338 For one common implementation, you might set:
22339 .code
22340 maildir_tag = ,S=${message_size}
22341 .endd
22342 but you should check the documentation of the other software to be sure.
22343
22344 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22345 as this allows Exim to extract the size from your tag, instead of having to
22346 &[stat()]& each message file.
22347
22348
22349 .section "Using a maildirsize file" "SECID136"
22350 .cindex "quota" "in maildir delivery"
22351 .cindex "maildir format" "&_maildirsize_& file"
22352 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22353 storing quota and message size information in a file called &_maildirsize_&
22354 within the toplevel maildir directory. If this file does not exist, Exim
22355 creates it, setting the quota from the &%quota%& option of the transport. If
22356 the maildir directory itself does not exist, it is created before any attempt
22357 to write a &_maildirsize_& file.
22358
22359 The &_maildirsize_& file is used to hold information about the sizes of
22360 messages in the maildir, thus speeding up quota calculations. The quota value
22361 in the file is just a cache; if the quota is changed in the transport, the new
22362 value overrides the cached value when the next message is delivered. The cache
22363 is maintained for the benefit of other programs that access the maildir and
22364 need to know the quota.
22365
22366 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22367 file is maintained (with a zero quota setting), but no quota is imposed.
22368
22369 A regular expression is available for controlling which directories in the
22370 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22371 See the description of the &%maildir_quota_directory_regex%& option above for
22372 details.
22373
22374
22375 .section "Mailstore delivery" "SECID137"
22376 .cindex "mailstore format" "description of"
22377 If the &%mailstore_format%& option is true, each message is written as two
22378 files in the given directory. A unique base name is constructed from the
22379 message id and the current delivery process, and the files that are written use
22380 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22381 contains the message's envelope, and the &_.msg_& file contains the message
22382 itself. The base name is placed in the variable &$mailstore_basename$&.
22383
22384 During delivery, the envelope is first written to a file with the suffix
22385 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22386 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22387 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22388 file before accessing either of them. An alternative approach is to wait for
22389 the absence of a &_.tmp_& file.
22390
22391 The envelope file starts with any text defined by the &%mailstore_prefix%&
22392 option, expanded and terminated by a newline if there isn't one. Then follows
22393 the sender address on one line, then all the recipient addresses, one per line.
22394 There can be more than one recipient only if the &%batch_max%& option is set
22395 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22396 appended to the file, followed by a newline if it does not end with one.
22397
22398 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22399 failure, it is ignored. Other expansion errors are treated as serious
22400 configuration errors, and delivery is deferred. The variable
22401 &$mailstore_basename$& is available for use during these expansions.
22402
22403
22404 .section "Non-special new file delivery" "SECID138"
22405 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22406 file is created directly in the named directory. For example, when delivering
22407 messages into files in batched SMTP format for later delivery to some host (see
22408 section &<<SECTbatchSMTP>>&), a setting such as
22409 .code
22410 directory = /var/bsmtp/$host
22411 .endd
22412 might be used. A message is written to a file with a temporary name, which is
22413 then renamed when the delivery is complete. The final name is obtained by
22414 expanding the contents of the &%directory_file%& option.
22415 .ecindex IIDapptra1
22416 .ecindex IIDapptra2
22417
22418
22419
22420
22421
22422
22423 . ////////////////////////////////////////////////////////////////////////////
22424 . ////////////////////////////////////////////////////////////////////////////
22425
22426 .chapter "The autoreply transport" "CHID8"
22427 .scindex IIDauttra1 "transports" "&(autoreply)&"
22428 .scindex IIDauttra2 "&(autoreply)& transport"
22429 The &(autoreply)& transport is not a true transport in that it does not cause
22430 the message to be transmitted. Instead, it generates a new mail message as an
22431 automatic reply to the incoming message. &'References:'& and
22432 &'Auto-Submitted:'& header lines are included. These are constructed according
22433 to the rules in RFCs 2822 and 3834, respectively.
22434
22435 If the router that passes the message to this transport does not have the
22436 &%unseen%& option set, the original message (for the current recipient) is not
22437 delivered anywhere. However, when the &%unseen%& option is set on the router
22438 that passes the message to this transport, routing of the address continues, so
22439 another router can set up a normal message delivery.
22440
22441
22442 The &(autoreply)& transport is usually run as the result of mail filtering, a
22443 &"vacation"& message being the standard example. However, it can also be run
22444 directly from a router like any other transport. To reduce the possibility of
22445 message cascades, messages created by the &(autoreply)& transport always have
22446 empty envelope sender addresses, like bounce messages.
22447
22448 The parameters of the message to be sent can be specified in the configuration
22449 by options described below. However, these are used only when the address
22450 passed to the transport does not contain its own reply information. When the
22451 transport is run as a consequence of a
22452 &%mail%&
22453 or &%vacation%& command in a filter file, the parameters of the message are
22454 supplied by the filter, and passed with the address. The transport's options
22455 that define the message are then ignored (so they are not usually set in this
22456 case). The message is specified entirely by the filter or by the transport; it
22457 is never built from a mixture of options. However, the &%file_optional%&,
22458 &%mode%&, and &%return_message%& options apply in all cases.
22459
22460 &(Autoreply)& is implemented as a local transport. When used as a result of a
22461 command in a user's filter file, &(autoreply)& normally runs under the uid and
22462 gid of the user, and with appropriate current and home directories (see chapter
22463 &<<CHAPenvironment>>&).
22464
22465 There is a subtle difference between routing a message to a &(pipe)& transport
22466 that generates some text to be returned to the sender, and routing it to an
22467 &(autoreply)& transport. This difference is noticeable only if more than one
22468 address from the same message is so handled. In the case of a pipe, the
22469 separate outputs from the different addresses are gathered up and returned to
22470 the sender in a single message, whereas if &(autoreply)& is used, a separate
22471 message is generated for each address that is passed to it.
22472
22473 Non-printing characters are not permitted in the header lines generated for the
22474 message that &(autoreply)& creates, with the exception of newlines that are
22475 immediately followed by white space. If any non-printing characters are found,
22476 the transport defers.
22477 Whether characters with the top bit set count as printing characters or not is
22478 controlled by the &%print_topbitchars%& global option.
22479
22480 If any of the generic options for manipulating headers (for example,
22481 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22482 of the original message that is included in the generated message when
22483 &%return_message%& is set. They do not apply to the generated message itself.
22484
22485 .vindex "&$sender_address$&"
22486 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22487 the message, indicating that there were no recipients, it does not treat this
22488 as an error. This means that autoreplies sent to &$sender_address$& when this
22489 is empty (because the incoming message is a bounce message) do not cause
22490 problems. They are just discarded.
22491
22492
22493
22494 .section "Private options for autoreply" "SECID139"
22495 .cindex "options" "&(autoreply)& transport"
22496
22497 .option bcc autoreply string&!! unset
22498 This specifies the addresses that are to receive &"blind carbon copies"& of the
22499 message when the message is specified by the transport.
22500
22501
22502 .option cc autoreply string&!! unset
22503 This specifies recipients of the message and the contents of the &'Cc:'& header
22504 when the message is specified by the transport.
22505
22506
22507 .option file autoreply string&!! unset
22508 The contents of the file are sent as the body of the message when the message
22509 is specified by the transport. If both &%file%& and &%text%& are set, the text
22510 string comes first.
22511
22512
22513 .option file_expand autoreply boolean false
22514 If this is set, the contents of the file named by the &%file%& option are
22515 subjected to string expansion as they are added to the message.
22516
22517
22518 .option file_optional autoreply boolean false
22519 If this option is true, no error is generated if the file named by the &%file%&
22520 option or passed with the address does not exist or cannot be read.
22521
22522
22523 .option from autoreply string&!! unset
22524 This specifies the contents of the &'From:'& header when the message is
22525 specified by the transport.
22526
22527
22528 .option headers autoreply string&!! unset
22529 This specifies additional RFC 2822 headers that are to be added to the message
22530 when the message is specified by the transport. Several can be given by using
22531 &"\n"& to separate them. There is no check on the format.
22532
22533
22534 .option log autoreply string&!! unset
22535 This option names a file in which a record of every message sent is logged when
22536 the message is specified by the transport.
22537
22538
22539 .option mode autoreply "octal integer" 0600
22540 If either the log file or the &"once"& file has to be created, this mode is
22541 used.
22542
22543
22544 .option never_mail autoreply "address list&!!" unset
22545 If any run of the transport creates a message with a recipient that matches any
22546 item in the list, that recipient is quietly discarded. If all recipients are
22547 discarded, no message is created. This applies both when the recipients are
22548 generated by a filter and when they are specified in the transport.
22549
22550
22551
22552 .option once autoreply string&!! unset
22553 This option names a file or DBM database in which a record of each &'To:'&
22554 recipient is kept when the message is specified by the transport. &*Note*&:
22555 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22556
22557 If &%once%& is unset, or is set to an empty string, the message is always sent.
22558 By default, if &%once%& is set to a non-empty file name, the message
22559 is not sent if a potential recipient is already listed in the database.
22560 However, if the &%once_repeat%& option specifies a time greater than zero, the
22561 message is sent if that much time has elapsed since a message was last sent to
22562 this recipient. A setting of zero time for &%once_repeat%& (the default)
22563 prevents a message from being sent a second time &-- in this case, zero means
22564 infinity.
22565
22566 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22567 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22568 greater than zero, it changes the way Exim implements the &%once%& option.
22569 Instead of using a DBM file to record every recipient it sends to, it uses a
22570 regular file, whose size will never get larger than the given value.
22571
22572 In the file, Exim keeps a linear list of recipient addresses and the times at
22573 which they were sent messages. If the file is full when a new address needs to
22574 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22575 means that a given recipient may receive multiple messages, but at
22576 unpredictable intervals that depend on the rate of turnover of addresses in the
22577 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22578
22579
22580 .option once_file_size autoreply integer 0
22581 See &%once%& above.
22582
22583
22584 .option once_repeat autoreply time&!! 0s
22585 See &%once%& above.
22586 After expansion, the value of this option must be a valid time value.
22587
22588
22589 .option reply_to autoreply string&!! unset
22590 This specifies the contents of the &'Reply-To:'& header when the message is
22591 specified by the transport.
22592
22593
22594 .option return_message autoreply boolean false
22595 If this is set, a copy of the original message is returned with the new
22596 message, subject to the maximum size set in the &%return_size_limit%& global
22597 configuration option.
22598
22599
22600 .option subject autoreply string&!! unset
22601 This specifies the contents of the &'Subject:'& header when the message is
22602 specified by the transport. It is tempting to quote the original subject in
22603 automatic responses. For example:
22604 .code
22605 subject = Re: $h_subject:
22606 .endd
22607 There is a danger in doing this, however. It may allow a third party to
22608 subscribe your users to an opt-in mailing list, provided that the list accepts
22609 bounce messages as subscription confirmations. Well-managed lists require a
22610 non-bounce message to confirm a subscription, so the danger is relatively
22611 small.
22612
22613
22614
22615 .option text autoreply string&!! unset
22616 This specifies a single string to be used as the body of the message when the
22617 message is specified by the transport. If both &%text%& and &%file%& are set,
22618 the text comes first.
22619
22620
22621 .option to autoreply string&!! unset
22622 This specifies recipients of the message and the contents of the &'To:'& header
22623 when the message is specified by the transport.
22624 .ecindex IIDauttra1
22625 .ecindex IIDauttra2
22626
22627
22628
22629
22630 . ////////////////////////////////////////////////////////////////////////////
22631 . ////////////////////////////////////////////////////////////////////////////
22632
22633 .chapter "The lmtp transport" "CHAPLMTP"
22634 .cindex "transports" "&(lmtp)&"
22635 .cindex "&(lmtp)& transport"
22636 .cindex "LMTP" "over a pipe"
22637 .cindex "LMTP" "over a socket"
22638 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22639 specified command
22640 or by interacting with a Unix domain socket.
22641 This transport is something of a cross between the &(pipe)& and &(smtp)&
22642 transports. Exim also has support for using LMTP over TCP/IP; this is
22643 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22644 to be of minority interest, the default build-time configure in &_src/EDITME_&
22645 has it commented out. You need to ensure that
22646 .code
22647 TRANSPORT_LMTP=yes
22648 .endd
22649 .cindex "options" "&(lmtp)& transport"
22650 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22651 included in the Exim binary. The private options of the &(lmtp)& transport are
22652 as follows:
22653
22654 .option batch_id lmtp string&!! unset
22655 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22656
22657
22658 .option batch_max lmtp integer 1
22659 This limits the number of addresses that can be handled in a single delivery.
22660 Most LMTP servers can handle several addresses at once, so it is normally a
22661 good idea to increase this value. See the description of local delivery
22662 batching in chapter &<<CHAPbatching>>&.
22663
22664
22665 .option command lmtp string&!! unset
22666 This option must be set if &%socket%& is not set. The string is a command which
22667 is run in a separate process. It is split up into a command name and list of
22668 arguments, each of which is separately expanded (so expansion cannot change the
22669 number of arguments). The command is run directly, not via a shell. The message
22670 is passed to the new process using the standard input and output to operate the
22671 LMTP protocol.
22672
22673 .option ignore_quota lmtp boolean false
22674 .cindex "LMTP" "ignoring quota errors"
22675 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22676 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22677 in its response to the LHLO command.
22678
22679 .option socket lmtp string&!! unset
22680 This option must be set if &%command%& is not set. The result of expansion must
22681 be the name of a Unix domain socket. The transport connects to the socket and
22682 delivers the message to it using the LMTP protocol.
22683
22684
22685 .option timeout lmtp time 5m
22686 The transport is aborted if the created process or Unix domain socket does not
22687 respond to LMTP commands or message input within this timeout. Delivery
22688 is deferred, and will be tried again later. Here is an example of a typical
22689 LMTP transport:
22690 .code
22691 lmtp:
22692   driver = lmtp
22693   command = /some/local/lmtp/delivery/program
22694   batch_max = 20
22695   user = exim
22696 .endd
22697 This delivers up to 20 addresses at a time, in a mixture of domains if
22698 necessary, running as the user &'exim'&.
22699
22700
22701
22702 . ////////////////////////////////////////////////////////////////////////////
22703 . ////////////////////////////////////////////////////////////////////////////
22704
22705 .chapter "The pipe transport" "CHAPpipetransport"
22706 .scindex IIDpiptra1 "transports" "&(pipe)&"
22707 .scindex IIDpiptra2 "&(pipe)& transport"
22708 The &(pipe)& transport is used to deliver messages via a pipe to a command
22709 running in another process. One example is the use of &(pipe)& as a
22710 pseudo-remote transport for passing messages to some other delivery mechanism
22711 (such as UUCP). Another is the use by individual users to automatically process
22712 their incoming messages. The &(pipe)& transport can be used in one of the
22713 following ways:
22714
22715 .ilist
22716 .vindex "&$local_part$&"
22717 A router routes one address to a transport in the normal way, and the
22718 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22719 contains the local part of the address (as usual), and the command that is run
22720 is specified by the &%command%& option on the transport.
22721 .next
22722 .vindex "&$pipe_addresses$&"
22723 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22724 transport can handle more than one address in a single run. In this case, when
22725 more than one address is routed to the transport, &$local_part$& is not set
22726 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22727 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22728 that are routed to the transport.
22729 .next
22730 .vindex "&$address_pipe$&"
22731 A router redirects an address directly to a pipe command (for example, from an
22732 alias or forward file). In this case, &$address_pipe$& contains the text of the
22733 pipe command, and the &%command%& option on the transport is ignored unless
22734 &%force_command%& is set. If only one address is being transported
22735 (&%batch_max%& is not greater than one, or only one address was redirected to
22736 this pipe command), &$local_part$& contains the local part that was redirected.
22737 .endlist
22738
22739
22740 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22741 deliver messages over pipes using the LMTP interactive protocol. This is
22742 implemented by the &(lmtp)& transport.
22743
22744 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22745 &_.forward_& file, the command runs under the uid and gid of that user. In
22746 other cases, the uid and gid have to be specified explicitly, either on the
22747 transport or on the router that handles the address. Current and &"home"&
22748 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22749 details of the local delivery environment and chapter &<<CHAPbatching>>&
22750 for a discussion of local delivery batching.
22751
22752
22753 .section "Concurrent delivery" "SECID140"
22754 If two messages arrive at almost the same time, and both are routed to a pipe
22755 delivery, the two pipe transports may be run concurrently. You must ensure that
22756 any pipe commands you set up are robust against this happening. If the commands
22757 write to a file, the &%exim_lock%& utility might be of use.
22758 Alternatively the &%max_parallel%& option could be used with a value
22759 of "1" to enforce serialization.
22760
22761
22762
22763
22764 .section "Returned status and data" "SECID141"
22765 .cindex "&(pipe)& transport" "returned data"
22766 If the command exits with a non-zero return code, the delivery is deemed to
22767 have failed, unless either the &%ignore_status%& option is set (in which case
22768 the return code is treated as zero), or the return code is one of those listed
22769 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22770 later"&. In this case, delivery is deferred. Details of a permanent failure are
22771 logged, but are not included in the bounce message, which merely contains
22772 &"local delivery failed"&.
22773
22774 If the command exits on a signal and the &%freeze_signal%& option is set then
22775 the message will be frozen in the queue. If that option is not set, a bounce
22776 will be sent as normal.
22777
22778 If the return code is greater than 128 and the command being run is a shell
22779 script, it normally means that the script was terminated by a signal whose
22780 value is the return code minus 128. The &%freeze_signal%& option does not
22781 apply in this case.
22782
22783 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22784 return code is set to 127. This is the value that a shell returns if it is
22785 asked to run a non-existent command. The wording for the log line suggests that
22786 a non-existent command may be the problem.
22787
22788 The &%return_output%& option can affect the result of a pipe delivery. If it is
22789 set and the command produces any output on its standard output or standard
22790 error streams, the command is considered to have failed, even if it gave a zero
22791 return code or if &%ignore_status%& is set. The output from the command is
22792 included as part of the bounce message. The &%return_fail_output%& option is
22793 similar, except that output is returned only when the command exits with a
22794 failure return code, that is, a value other than zero or a code that matches
22795 &%temp_errors%&.
22796
22797
22798
22799 .section "How the command is run" "SECThowcommandrun"
22800 .cindex "&(pipe)& transport" "path for command"
22801 The command line is (by default) broken down into a command name and arguments
22802 by the &(pipe)& transport itself. The &%allow_commands%& and
22803 &%restrict_to_path%& options can be used to restrict the commands that may be
22804 run.
22805
22806 .cindex "quoting" "in pipe command"
22807 Unquoted arguments are delimited by white space. If an argument appears in
22808 double quotes, backslash is interpreted as an escape character in the usual
22809 way. If an argument appears in single quotes, no escaping is done.
22810
22811 String expansion is applied to the command line except when it comes from a
22812 traditional &_.forward_& file (commands from a filter file are expanded). The
22813 expansion is applied to each argument in turn rather than to the whole line.
22814 For this reason, any string expansion item that contains white space must be
22815 quoted so as to be contained within a single argument. A setting such as
22816 .code
22817 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22818 .endd
22819 will not work, because the expansion item gets split between several
22820 arguments. You have to write
22821 .code
22822 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22823 .endd
22824 to ensure that it is all in one argument. The expansion is done in this way,
22825 argument by argument, so that the number of arguments cannot be changed as a
22826 result of expansion, and quotes or backslashes in inserted variables do not
22827 interact with external quoting. However, this leads to problems if you want to
22828 generate multiple arguments (or the command name plus arguments) from a single
22829 expansion. In this situation, the simplest solution is to use a shell. For
22830 example:
22831 .code
22832 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22833 .endd
22834
22835 .cindex "transport" "filter"
22836 .cindex "filter" "transport filter"
22837 .vindex "&$pipe_addresses$&"
22838 Special handling takes place when an argument consists of precisely the text
22839 &`$pipe_addresses`&. This is not a general expansion variable; the only
22840 place this string is recognized is when it appears as an argument for a pipe or
22841 transport filter command. It causes each address that is being handled to be
22842 inserted in the argument list at that point &'as a separate argument'&. This
22843 avoids any problems with spaces or shell metacharacters, and is of use when a
22844 &(pipe)& transport is handling groups of addresses in a batch.
22845
22846 If &%force_command%& is enabled on the transport, Special handling takes place
22847 for an argument that consists of precisely the text &`$address_pipe`&.  It
22848 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22849 argument is inserted in the argument list at that point
22850 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22851 the only item in the argument; in fact, if it were then &%force_command%&
22852 should behave as a no-op.  Rather, it should be used to adjust the command
22853 run while preserving the argument vector separation.
22854
22855 After splitting up into arguments and expansion, the resulting command is run
22856 in a subprocess directly from the transport, &'not'& under a shell. The
22857 message that is being delivered is supplied on the standard input, and the
22858 standard output and standard error are both connected to a single pipe that is
22859 read by Exim. The &%max_output%& option controls how much output the command
22860 may produce, and the &%return_output%& and &%return_fail_output%& options
22861 control what is done with it.
22862
22863 Not running the command under a shell (by default) lessens the security risks
22864 in cases when a command from a user's filter file is built out of data that was
22865 taken from an incoming message. If a shell is required, it can of course be
22866 explicitly specified as the command to be run. However, there are circumstances
22867 where existing commands (for example, in &_.forward_& files) expect to be run
22868 under a shell and cannot easily be modified. To allow for these cases, there is
22869 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22870 works. Instead of breaking up the command line as just described, it expands it
22871 as a single string and passes the result to &_/bin/sh_&. The
22872 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22873 with &%use_shell%&, and the whole mechanism is inherently less secure.
22874
22875
22876
22877 .section "Environment variables" "SECTpipeenv"
22878 .cindex "&(pipe)& transport" "environment for command"
22879 .cindex "environment" "&(pipe)& transport"
22880 The environment variables listed below are set up when the command is invoked.
22881 This list is a compromise for maximum compatibility with other MTAs. Note that
22882 the &%environment%& option can be used to add additional variables to this
22883 environment. The environment for the &(pipe)& transport is not subject
22884 to the &%add_environment%& and &%keep_environment%& main config options.
22885 .display
22886 &`DOMAIN            `&   the domain of the address
22887 &`HOME              `&   the home directory, if set
22888 &`HOST              `&   the host name when called from a router (see below)
22889 &`LOCAL_PART        `&   see below
22890 &`LOCAL_PART_PREFIX `&   see below
22891 &`LOCAL_PART_SUFFIX `&   see below
22892 &`LOGNAME           `&   see below
22893 &`MESSAGE_ID        `&   Exim's local ID for the message
22894 &`PATH              `&   as specified by the &%path%& option below
22895 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22896 &`RECIPIENT         `&   the complete recipient address
22897 &`SENDER            `&   the sender of the message (empty if a bounce)
22898 &`SHELL             `&   &`/bin/sh`&
22899 &`TZ                `&   the value of the &%timezone%& option, if set
22900 &`USER              `&   see below
22901 .endd
22902 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22903 router, LOCAL_PART is set to the local part of the address. When it is
22904 called as a result of a forward or alias expansion, LOCAL_PART is set to
22905 the local part of the address that was expanded. In both cases, any affixes are
22906 removed from the local part, and made available in LOCAL_PART_PREFIX and
22907 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22908 same value as LOCAL_PART for compatibility with other MTAs.
22909
22910 .cindex "HOST"
22911 HOST is set only when a &(pipe)& transport is called from a router that
22912 associates hosts with an address, typically when using &(pipe)& as a
22913 pseudo-remote transport. HOST is set to the first host name specified by
22914 the router.
22915
22916 .cindex "HOME"
22917 If the transport's generic &%home_directory%& option is set, its value is used
22918 for the HOME environment variable. Otherwise, a home directory may be set
22919 by the router's &%transport_home_directory%& option, which defaults to the
22920 user's home directory if &%check_local_user%& is set.
22921
22922
22923 .section "Private options for pipe" "SECID142"
22924 .cindex "options" "&(pipe)& transport"
22925
22926
22927
22928 .option allow_commands pipe "string list&!!" unset
22929 .cindex "&(pipe)& transport" "permitted commands"
22930 The string is expanded, and is then interpreted as a colon-separated list of
22931 permitted commands. If &%restrict_to_path%& is not set, the only commands
22932 permitted are those in the &%allow_commands%& list. They need not be absolute
22933 paths; the &%path%& option is still used for relative paths. If
22934 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22935 in the &%allow_commands%& list, or a name without any slashes that is found on
22936 the path. In other words, if neither &%allow_commands%& nor
22937 &%restrict_to_path%& is set, there is no restriction on the command, but
22938 otherwise only commands that are permitted by one or the other are allowed. For
22939 example, if
22940 .code
22941 allow_commands = /usr/bin/vacation
22942 .endd
22943 and &%restrict_to_path%& is not set, the only permitted command is
22944 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22945 &%use_shell%& is set.
22946
22947
22948 .option batch_id pipe string&!! unset
22949 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22950
22951
22952 .option batch_max pipe integer 1
22953 This limits the number of addresses that can be handled in a single delivery.
22954 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22955
22956
22957 .option check_string pipe string unset
22958 As &(pipe)& writes the message, the start of each line is tested for matching
22959 &%check_string%&, and if it does, the initial matching characters are replaced
22960 by the contents of &%escape_string%&, provided both are set. The value of
22961 &%check_string%& is a literal string, not a regular expression, and the case of
22962 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22963 of &%check_string%& and &%escape_string%& are forced to values that implement
22964 the SMTP escaping protocol. Any settings made in the configuration file are
22965 ignored.
22966
22967
22968 .option command pipe string&!! unset
22969 This option need not be set when &(pipe)& is being used to deliver to pipes
22970 obtained directly from address redirections. In other cases, the option must be
22971 set, to provide a command to be run. It need not yield an absolute path (see
22972 the &%path%& option below). The command is split up into separate arguments by
22973 Exim, and each argument is separately expanded, as described in section
22974 &<<SECThowcommandrun>>& above.
22975
22976
22977 .option environment pipe string&!! unset
22978 .cindex "&(pipe)& transport" "environment for command"
22979 .cindex "environment" "&(pipe)& transport"
22980 This option is used to add additional variables to the environment in which the
22981 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22982 a string which is expanded, and then interpreted as a colon-separated list of
22983 environment settings of the form <&'name'&>=<&'value'&>.
22984
22985
22986 .option escape_string pipe string unset
22987 See &%check_string%& above.
22988
22989
22990 .option freeze_exec_fail pipe boolean false
22991 .cindex "exec failure"
22992 .cindex "failure of exec"
22993 .cindex "&(pipe)& transport" "failure of exec"
22994 Failure to exec the command in a pipe transport is by default treated like
22995 any other failure while running the command. However, if &%freeze_exec_fail%&
22996 is set, failure to exec is treated specially, and causes the message to be
22997 frozen, whatever the setting of &%ignore_status%&.
22998
22999
23000 .option freeze_signal pipe boolean false
23001 .cindex "signal exit"
23002 .cindex "&(pipe)& transport", "signal exit"
23003 Normally if the process run by a command in a pipe transport exits on a signal,
23004 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23005 frozen in Exim's queue instead.
23006
23007
23008 .option force_command pipe boolean false
23009 .cindex "force command"
23010 .cindex "&(pipe)& transport", "force command"
23011 Normally when a router redirects an address directly to a pipe command
23012 the &%command%& option on the transport is ignored.  If &%force_command%&
23013 is set, the &%command%& option will used. This is especially
23014 useful for forcing a wrapper or additional argument to be added to the
23015 command. For example:
23016 .code
23017 command = /usr/bin/remote_exec myhost -- $address_pipe
23018 force_command
23019 .endd
23020
23021 Note that &$address_pipe$& is handled specially in &%command%& when
23022 &%force_command%& is set, expanding out to the original argument vector as
23023 separate items, similarly to a Unix shell &`"$@"`& construct.
23024
23025
23026 .option ignore_status pipe boolean false
23027 If this option is true, the status returned by the subprocess that is set up to
23028 run the command is ignored, and Exim behaves as if zero had been returned.
23029 Otherwise, a non-zero status or termination by signal causes an error return
23030 from the transport unless the status value is one of those listed in
23031 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23032
23033 &*Note*&: This option does not apply to timeouts, which do not return a status.
23034 See the &%timeout_defer%& option for how timeouts are handled.
23035
23036
23037 .option log_defer_output pipe boolean false
23038 .cindex "&(pipe)& transport" "logging output"
23039 If this option is set, and the status returned by the command is
23040 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23041 and any output was produced on stdout or stderr, the first line of it is
23042 written to the main log.
23043
23044
23045 .option log_fail_output pipe boolean false
23046 If this option is set, and the command returns any output on stdout or
23047 stderr, and also ends with a return code that is neither zero nor one of
23048 the return codes listed in &%temp_errors%& (that is, the delivery
23049 failed), the first line of output is written to the main log. This
23050 option and &%log_output%& are mutually exclusive.  Only one of them may
23051 be set.
23052
23053
23054 .option log_output pipe boolean false
23055 If this option is set and the command returns any output on stdout or
23056 stderr, the first line of output is written to the main log, whatever
23057 the return code. This option and &%log_fail_output%& are mutually
23058 exclusive. Only one of them may be set.
23059
23060
23061 .option max_output pipe integer 20K
23062 This specifies the maximum amount of output that the command may produce on its
23063 standard output and standard error file combined. If the limit is exceeded, the
23064 process running the command is killed. This is intended as a safety measure to
23065 catch runaway processes. The limit is applied independently of the settings of
23066 the options that control what is done with such output (for example,
23067 &%return_output%&). Because of buffering effects, the amount of output may
23068 exceed the limit by a small amount before Exim notices.
23069
23070
23071 .option message_prefix pipe string&!! "see below"
23072 The string specified here is expanded and output at the start of every message.
23073 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23074 .code
23075 message_prefix = \
23076   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23077   ${tod_bsdinbox}\n
23078 .endd
23079 .cindex "Cyrus"
23080 .cindex "&%tmail%&"
23081 .cindex "&""From""& line"
23082 This is required by the commonly used &_/usr/bin/vacation_& program.
23083 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23084 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23085 setting
23086 .code
23087 message_prefix =
23088 .endd
23089 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23090 &`\n`& to &`\r\n`& in &%message_prefix%&.
23091
23092
23093 .option message_suffix pipe string&!! "see below"
23094 The string specified here is expanded and output at the end of every message.
23095 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23096 The suffix can be suppressed by setting
23097 .code
23098 message_suffix =
23099 .endd
23100 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23101 &`\n`& to &`\r\n`& in &%message_suffix%&.
23102
23103
23104 .option path pipe string "see below"
23105 This option specifies the string that is set up in the PATH environment
23106 variable of the subprocess. The default is:
23107 .code
23108 /bin:/usr/bin
23109 .endd
23110 If the &%command%& option does not yield an absolute path name, the command is
23111 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23112 apply to a command specified as a transport filter.
23113
23114
23115 .option permit_coredump pipe boolean false
23116 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23117 a core-dump of a pipe command, enable this command.  This enables core-dumps
23118 during delivery and affects both the Exim binary and the pipe command run.
23119 It is recommended that this option remain off unless and until you have a need
23120 for it and that this only be enabled when needed, as the risk of excessive
23121 resource consumption can be quite high.  Note also that Exim is typically
23122 installed as a setuid binary and most operating systems will inhibit coredumps
23123 of these by default, so further OS-specific action may be required.
23124
23125
23126 .option pipe_as_creator pipe boolean false
23127 .cindex "uid (user id)" "local delivery"
23128 If the generic &%user%& option is not set and this option is true, the delivery
23129 process is run under the uid that was in force when Exim was originally called
23130 to accept the message. If the group id is not otherwise set (via the generic
23131 &%group%& option), the gid that was in force when Exim was originally called to
23132 accept the message is used.
23133
23134
23135 .option restrict_to_path pipe boolean false
23136 When this option is set, any command name not listed in &%allow_commands%& must
23137 contain no slashes. The command is searched for only in the directories listed
23138 in the &%path%& option. This option is intended for use in the case when a pipe
23139 command has been generated from a user's &_.forward_& file. This is usually
23140 handled by a &(pipe)& transport called &%address_pipe%&.
23141
23142
23143 .option return_fail_output pipe boolean false
23144 If this option is true, and the command produced any output and ended with a
23145 return code other than zero or one of the codes listed in &%temp_errors%& (that
23146 is, the delivery failed), the output is returned in the bounce message.
23147 However, if the message has a null sender (that is, it is itself a bounce
23148 message), output from the command is discarded. This option and
23149 &%return_output%& are mutually exclusive. Only one of them may be set.
23150
23151
23152
23153 .option return_output pipe boolean false
23154 If this option is true, and the command produced any output, the delivery is
23155 deemed to have failed whatever the return code from the command, and the output
23156 is returned in the bounce message. Otherwise, the output is just discarded.
23157 However, if the message has a null sender (that is, it is a bounce message),
23158 output from the command is always discarded, whatever the setting of this
23159 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23160 of them may be set.
23161
23162
23163
23164 .option temp_errors pipe "string list" "see below"
23165 .cindex "&(pipe)& transport" "temporary failure"
23166 This option contains either a colon-separated list of numbers, or a single
23167 asterisk. If &%ignore_status%& is false
23168 and &%return_output%& is not set,
23169 and the command exits with a non-zero return code, the failure is treated as
23170 temporary and the delivery is deferred if the return code matches one of the
23171 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23172 codes are treated as permanent errors. The default setting contains the codes
23173 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23174 compiled on a system that does not define these macros, it assumes values of 75
23175 and 73, respectively.
23176
23177
23178 .option timeout pipe time 1h
23179 If the command fails to complete within this time, it is killed. This normally
23180 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23181 specifies no timeout. In order to ensure that any subprocesses created by the
23182 command are also killed, Exim makes the initial process a process group leader,
23183 and kills the whole process group on a timeout. However, this can be defeated
23184 if one of the processes starts a new process group.
23185
23186 .option timeout_defer pipe boolean false
23187 A timeout in a &(pipe)& transport, either in the command that the transport
23188 runs, or in a transport filter that is associated with it, is by default
23189 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23190 is set true, both kinds of timeout become temporary errors, causing the
23191 delivery to be deferred.
23192
23193 .option umask pipe "octal integer" 022
23194 This specifies the umask setting for the subprocess that runs the command.
23195
23196
23197 .option use_bsmtp pipe boolean false
23198 .cindex "envelope sender"
23199 If this option is set true, the &(pipe)& transport writes messages in &"batch
23200 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23201 commands. If you want to include a leading HELO command with such messages,
23202 you can do so by setting the &%message_prefix%& option. See section
23203 &<<SECTbatchSMTP>>& for details of batch SMTP.
23204
23205 .option use_classresources pipe boolean false
23206 .cindex "class resources (BSD)"
23207 This option is available only when Exim is running on FreeBSD, NetBSD, or
23208 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23209 resource limits when a &(pipe)& transport is run to perform a delivery. The
23210 limits for the uid under which the pipe is to run are obtained from the login
23211 class database.
23212
23213
23214 .option use_crlf pipe boolean false
23215 .cindex "carriage return"
23216 .cindex "linefeed"
23217 This option causes lines to be terminated with the two-character CRLF sequence
23218 (carriage return, linefeed) instead of just a linefeed character. In the case
23219 of batched SMTP, the byte sequence written to the pipe is then an exact image
23220 of what would be sent down a real SMTP connection.
23221
23222 The contents of the &%message_prefix%& and &%message_suffix%& options are
23223 written verbatim, so must contain their own carriage return characters if these
23224 are needed. When &%use_bsmtp%& is not set, the default values for both
23225 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23226 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23227
23228
23229 .option use_shell pipe boolean false
23230 .vindex "&$pipe_addresses$&"
23231 If this option is set, it causes the command to be passed to &_/bin/sh_&
23232 instead of being run directly from the transport, as described in section
23233 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23234 where the command is expected to be run under a shell and cannot easily be
23235 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23236 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23237 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23238 its &%-c%& option.
23239
23240
23241
23242 .section "Using an external local delivery agent" "SECID143"
23243 .cindex "local delivery" "using an external agent"
23244 .cindex "&'procmail'&"
23245 .cindex "external local delivery"
23246 .cindex "delivery" "&'procmail'&"
23247 .cindex "delivery" "by external agent"
23248 The &(pipe)& transport can be used to pass all messages that require local
23249 delivery to a separate local delivery agent such as &%procmail%&. When doing
23250 this, care must be taken to ensure that the pipe is run under an appropriate
23251 uid and gid. In some configurations one wants this to be a uid that is trusted
23252 by the delivery agent to supply the correct sender of the message. It may be
23253 necessary to recompile or reconfigure the delivery agent so that it trusts an
23254 appropriate user. The following is an example transport and router
23255 configuration for &%procmail%&:
23256 .code
23257 # transport
23258 procmail_pipe:
23259   driver = pipe
23260   command = /usr/local/bin/procmail -d $local_part
23261   return_path_add
23262   delivery_date_add
23263   envelope_to_add
23264   check_string = "From "
23265   escape_string = ">From "
23266   umask = 077
23267   user = $local_part
23268   group = mail
23269
23270 # router
23271 procmail:
23272   driver = accept
23273   check_local_user
23274   transport = procmail_pipe
23275 .endd
23276 In this example, the pipe is run as the local user, but with the group set to
23277 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23278 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23279 user to supply a correct sender address. If you do not specify either a
23280 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23281 home directory is the user's home directory by default.
23282
23283 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23284 .code
23285 IFS=" "
23286 .endd
23287 as shown in some &%procmail%& documentation, because Exim does not by default
23288 use a shell to run pipe commands.
23289
23290 .cindex "Cyrus"
23291 The next example shows a transport and a router for a system where local
23292 deliveries are handled by the Cyrus IMAP server.
23293 .code
23294 # transport
23295 local_delivery_cyrus:
23296   driver = pipe
23297   command = /usr/cyrus/bin/deliver \
23298             -m ${substr_1:$local_part_suffix} -- $local_part
23299   user = cyrus
23300   group = mail
23301   return_output
23302   log_output
23303   message_prefix =
23304   message_suffix =
23305
23306 # router
23307 local_user_cyrus:
23308   driver = accept
23309   check_local_user
23310   local_part_suffix = .*
23311   transport = local_delivery_cyrus
23312 .endd
23313 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23314 &%return_output%& to cause any text written by Cyrus to be returned to the
23315 sender.
23316 .ecindex IIDpiptra1
23317 .ecindex IIDpiptra2
23318
23319
23320 . ////////////////////////////////////////////////////////////////////////////
23321 . ////////////////////////////////////////////////////////////////////////////
23322
23323 .chapter "The smtp transport" "CHAPsmtptrans"
23324 .scindex IIDsmttra1 "transports" "&(smtp)&"
23325 .scindex IIDsmttra2 "&(smtp)& transport"
23326 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23327 or LMTP protocol. The list of hosts to try can either be taken from the address
23328 that is being processed (having been set up by the router), or specified
23329 explicitly for the transport. Timeout and retry processing (see chapter
23330 &<<CHAPretry>>&) is applied to each IP address independently.
23331
23332
23333 .section "Multiple messages on a single connection" "SECID144"
23334 The sending of multiple messages over a single TCP/IP connection can arise in
23335 two ways:
23336
23337 .ilist
23338 If a message contains more than &%max_rcpt%& (see below) addresses that are
23339 routed to the same host, more than one copy of the message has to be sent to
23340 that host. In this situation, multiple copies may be sent in a single run of
23341 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23342 does when it has too many addresses to send in one message also depends on the
23343 value of the global &%remote_max_parallel%& option. Details are given in
23344 section &<<SECToutSMTPTCP>>&.)
23345 .next
23346 .cindex "hints database" "remembering routing"
23347 When a message has been successfully delivered over a TCP/IP connection, Exim
23348 looks in its hints database to see if there are any other messages awaiting a
23349 connection to the same host. If there are, a new delivery process is started
23350 for one of them, and the current TCP/IP connection is passed on to it. The new
23351 process may in turn send multiple copies and possibly create yet another
23352 process.
23353 .endlist
23354
23355
23356 For each copy sent over the same TCP/IP connection, a sequence counter is
23357 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23358 no further messages are sent over that connection.
23359
23360
23361
23362 .section "Use of the $host and $host_address variables" "SECID145"
23363 .vindex "&$host$&"
23364 .vindex "&$host_address$&"
23365 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23366 &$host_address$& are the name and IP address of the first host on the host list
23367 passed by the router. However, when the transport is about to connect to a
23368 specific host, and while it is connected to that host, &$host$& and
23369 &$host_address$& are set to the values for that host. These are the values
23370 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23371 &%serialize_hosts%&, and the various TLS options are expanded.
23372
23373
23374 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23375 .vindex &$tls_bits$&
23376 .vindex &$tls_cipher$&
23377 .vindex &$tls_peerdn$&
23378 .vindex &$tls_sni$&
23379 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23380 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23381 are the values that were set when the message was received.
23382 These are the values that are used for options that are expanded before any
23383 SMTP connections are made. Just before each connection is made, these four
23384 variables are emptied. If TLS is subsequently started, they are set to the
23385 appropriate values for the outgoing connection, and these are the values that
23386 are in force when any authenticators are run and when the
23387 &%authenticated_sender%& option is expanded.
23388
23389 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23390 and will be removed in a future release.
23391
23392
23393 .section "Private options for smtp" "SECID146"
23394 .cindex "options" "&(smtp)& transport"
23395 The private options of the &(smtp)& transport are as follows:
23396
23397
23398 .option address_retry_include_sender smtp boolean true
23399 .cindex "4&'xx'& responses" "retrying after"
23400 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23401 is the combination of sender and recipient that is delayed in subsequent queue
23402 runs until the retry time is reached. You can delay the recipient without
23403 reference to the sender (which is what earlier versions of Exim did), by
23404 setting &%address_retry_include_sender%& false. However, this can lead to
23405 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23406
23407 .option allow_localhost smtp boolean false
23408 .cindex "local host" "sending to"
23409 .cindex "fallback" "hosts specified on transport"
23410 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23411 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23412 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23413 the delivery anyway. This should be used only in special cases when the
23414 configuration ensures that no looping will result (for example, a differently
23415 configured Exim is listening on the port to which the message is sent).
23416
23417
23418 .option authenticated_sender smtp string&!! unset
23419 .cindex "Cyrus"
23420 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23421 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23422 overriding any existing authenticated sender value. If the string expansion is
23423 forced to fail, the option is ignored. Other expansion failures cause delivery
23424 to be deferred. If the result of expansion is an empty string, that is also
23425 ignored.
23426
23427 The expansion happens after the outgoing connection has been made and TLS
23428 started, if required. This means that the &$host$&, &$host_address$&,
23429 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23430 particular connection.
23431
23432 If the SMTP session is not authenticated, the expansion of
23433 &%authenticated_sender%& still happens (and can cause the delivery to be
23434 deferred if it fails), but no AUTH= item is added to MAIL commands
23435 unless &%authenticated_sender_force%& is true.
23436
23437 This option allows you to use the &(smtp)& transport in LMTP mode to
23438 deliver mail to Cyrus IMAP and provide the proper local part as the
23439 &"authenticated sender"&, via a setting such as:
23440 .code
23441 authenticated_sender = $local_part
23442 .endd
23443 This removes the need for IMAP subfolders to be assigned special ACLs to
23444 allow direct delivery to those subfolders.
23445
23446 Because of expected uses such as that just described for Cyrus (when no
23447 domain is involved), there is no checking on the syntax of the provided
23448 value.
23449
23450
23451 .option authenticated_sender_force smtp boolean false
23452 If this option is set true, the &%authenticated_sender%& option's value
23453 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23454 authenticated as a client.
23455
23456
23457 .option command_timeout smtp time 5m
23458 This sets a timeout for receiving a response to an SMTP command that has been
23459 sent out. It is also used when waiting for the initial banner line from the
23460 remote host. Its value must not be zero.
23461
23462
23463 .option connect_timeout smtp time 5m
23464 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23465 to a remote host. A setting of zero allows the system timeout (typically
23466 several minutes) to act. To have any effect, the value of this option must be
23467 less than the system timeout. However, it has been observed that on some
23468 systems there is no system timeout, which is why the default value for this
23469 option is 5 minutes, a value recommended by RFC 1123.
23470
23471
23472 .option connection_max_messages smtp integer 500
23473 .cindex "SMTP" "passed connection"
23474 .cindex "SMTP" "multiple deliveries"
23475 .cindex "multiple SMTP deliveries"
23476 This controls the maximum number of separate message deliveries that are sent
23477 over a single TCP/IP connection. If the value is zero, there is no limit.
23478 For testing purposes, this value can be overridden by the &%-oB%& command line
23479 option.
23480
23481
23482 .option data_timeout smtp time 5m
23483 This sets a timeout for the transmission of each block in the data portion of
23484 the message. As a result, the overall timeout for a message depends on the size
23485 of the message. Its value must not be zero. See also &%final_timeout%&.
23486
23487
23488 .option dkim_domain smtp string&!! unset
23489 .option dkim_selector smtp string&!! unset
23490 .option dkim_private_key smtp string&!! unset
23491 .option dkim_canon smtp string&!! unset
23492 .option dkim_strict smtp string&!! unset
23493 .option dkim_sign_headers smtp string&!! unset
23494 DKIM signing options.  For details see &<<SECDKIMSIGN>>&.
23495
23496
23497 .option delay_after_cutoff smtp boolean true
23498 This option controls what happens when all remote IP addresses for a given
23499 domain have been inaccessible for so long that they have passed their retry
23500 cutoff times.
23501
23502 In the default state, if the next retry time has not been reached for any of
23503 them, the address is bounced without trying any deliveries. In other words,
23504 Exim delays retrying an IP address after the final cutoff time until a new
23505 retry time is reached, and can therefore bounce an address without ever trying
23506 a delivery, when machines have been down for a long time. Some people are
23507 unhappy at this prospect, so...
23508
23509 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23510 addresses are past their final cutoff time, Exim tries to deliver to those
23511 IP addresses that have not been tried since the message arrived. If there are
23512 none, of if they all fail, the address is bounced. In other words, it does not
23513 delay when a new message arrives, but immediately tries those expired IP
23514 addresses that haven't been tried since the message arrived. If there is a
23515 continuous stream of messages for the dead hosts, unsetting
23516 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23517 to them.
23518
23519
23520 .option dns_qualify_single smtp boolean true
23521 If the &%hosts%& or &%fallback_hosts%& option is being used,
23522 and the &%gethostbyname%& option is false,
23523 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23524 in chapter &<<CHAPdnslookup>>& for more details.
23525
23526
23527 .option dns_search_parents smtp boolean false
23528 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23529 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23530 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23531 details.
23532
23533
23534 .option dnssec_request_domains smtp "domain list&!!" unset
23535 .cindex "MX record" "security"
23536 .cindex "DNSSEC" "MX lookup"
23537 .cindex "security" "MX lookup"
23538 .cindex "DNS" "DNSSEC"
23539 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23540 the dnssec request bit set.
23541 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23542
23543
23544
23545 .option dnssec_require_domains smtp "domain list&!!" unset
23546 .cindex "MX record" "security"
23547 .cindex "DNSSEC" "MX lookup"
23548 .cindex "security" "MX lookup"
23549 .cindex "DNS" "DNSSEC"
23550 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23551 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23552 (AD bit) set will be ignored and logged as a host-lookup failure.
23553 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23554
23555
23556
23557 .option dscp smtp string&!! unset
23558 .cindex "DCSP" "outbound"
23559 This option causes the DSCP value associated with a socket to be set to one
23560 of a number of fixed strings or to numeric value.
23561 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23562 Common values include &`throughput`&, &`mincost`&, and on newer systems
23563 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23564
23565 The outbound packets from Exim will be marked with this value in the header
23566 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23567 that these values will have any effect, not be stripped by networking
23568 equipment, or do much of anything without cooperation with your Network
23569 Engineer and those of all network operators between the source and destination.
23570
23571
23572 .option fallback_hosts smtp "string list" unset
23573 .cindex "fallback" "hosts specified on transport"
23574 String expansion is not applied to this option. The argument must be a
23575 colon-separated list of host names or IP addresses, optionally also including
23576 port numbers, though the separator can be changed, as described in section
23577 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23578 item in a &%route_list%& setting for the &(manualroute)& router, as described
23579 in section &<<SECTformatonehostitem>>&.
23580
23581 Fallback hosts can also be specified on routers, which associate them with the
23582 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23583 &%fallback_hosts%& specified on the transport is used only if the address does
23584 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23585 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23586 However, &%hosts_randomize%& does apply to fallback host lists.
23587
23588 If Exim is unable to deliver to any of the hosts for a particular address, and
23589 the errors are not permanent rejections, the address is put on a separate
23590 transport queue with its host list replaced by the fallback hosts, unless the
23591 address was routed via MX records and the current host was in the original MX
23592 list. In that situation, the fallback host list is not used.
23593
23594 Once normal deliveries are complete, the fallback queue is delivered by
23595 re-running the same transports with the new host lists. If several failing
23596 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23597 copy of the message is sent.
23598
23599 The resolution of the host names on the fallback list is controlled by the
23600 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23601 both to cases when the host list comes with the address and when it is taken
23602 from &%hosts%&. This option provides a &"use a smart host only if delivery
23603 fails"& facility.
23604
23605
23606 .option final_timeout smtp time 10m
23607 This is the timeout that applies while waiting for the response to the final
23608 line containing just &"."& that terminates a message. Its value must not be
23609 zero.
23610
23611 .option gethostbyname smtp boolean false
23612 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23613 being used, names are looked up using &[gethostbyname()]&
23614 (or &[getipnodebyname()]& when available)
23615 instead of using the DNS. Of course, that function may in fact use the DNS, but
23616 it may also consult other sources of information such as &_/etc/hosts_&.
23617
23618 .option gnutls_compat_mode smtp boolean unset
23619 This option controls whether GnuTLS is used in compatibility mode in an Exim
23620 server. This reduces security slightly, but improves interworking with older
23621 implementations of TLS.
23622
23623 .option helo_data smtp string&!! "see below"
23624 .cindex "HELO" "argument, setting"
23625 .cindex "EHLO" "argument, setting"
23626 .cindex "LHLO argument setting"
23627 The value of this option is expanded after a connection to a another host has
23628 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23629 command that starts the outgoing SMTP or LMTP session. The default value of the
23630 option is:
23631 .code
23632 $primary_hostname
23633 .endd
23634 During the expansion, the variables &$host$& and &$host_address$& are set to
23635 the identity of the remote host, and the variables &$sending_ip_address$& and
23636 &$sending_port$& are set to the local IP address and port number that are being
23637 used. These variables can be used to generate different values for different
23638 servers or different local IP addresses. For example, if you want the string
23639 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23640 interface address, you could use this:
23641 .code
23642 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23643   {$primary_hostname}}
23644 .endd
23645 The use of &%helo_data%& applies both to sending messages and when doing
23646 callouts.
23647
23648 .option hosts smtp "string list&!!" unset
23649 Hosts are associated with an address by a router such as &(dnslookup)&, which
23650 finds the hosts by looking up the address domain in the DNS, or by
23651 &(manualroute)&, which has lists of hosts in its configuration. However,
23652 email addresses can be passed to the &(smtp)& transport by any router, and not
23653 all of them can provide an associated list of hosts.
23654
23655 The &%hosts%& option specifies a list of hosts to be used if the address being
23656 processed does not have any hosts associated with it. The hosts specified by
23657 &%hosts%& are also used, whether or not the address has its own hosts, if
23658 &%hosts_override%& is set.
23659
23660 The string is first expanded, before being interpreted as a colon-separated
23661 list of host names or IP addresses, possibly including port numbers. The
23662 separator may be changed to something other than colon, as described in section
23663 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23664 item in a &%route_list%& setting for the &(manualroute)& router, as described
23665 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23666 of the &(manualroute)& router is not available here.
23667
23668 If the expansion fails, delivery is deferred. Unless the failure was caused by
23669 the inability to complete a lookup, the error is logged to the panic log as
23670 well as the main log. Host names are looked up either by searching directly for
23671 address records in the DNS or by calling &[gethostbyname()]& (or
23672 &[getipnodebyname()]& when available), depending on the setting of the
23673 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23674 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23675 address are used.
23676
23677 During delivery, the hosts are tried in order, subject to their retry status,
23678 unless &%hosts_randomize%& is set.
23679
23680
23681 .option hosts_avoid_esmtp smtp "host list&!!" unset
23682 .cindex "ESMTP, avoiding use of"
23683 .cindex "HELO" "forcing use of"
23684 .cindex "EHLO" "avoiding use of"
23685 .cindex "PIPELINING" "avoiding the use of"
23686 This option is for use with broken hosts that announce ESMTP facilities (for
23687 example, PIPELINING) and then fail to implement them properly. When a host
23688 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23689 start of the SMTP session. This means that it cannot use any of the ESMTP
23690 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23691
23692
23693 .option hosts_avoid_pipelining smtp "host list&!!" unset
23694 .cindex "PIPELINING" "avoiding the use of"
23695 Exim will not use the SMTP PIPELINING extension when delivering to any host
23696 that matches this list, even if the server host advertises PIPELINING support.
23697
23698
23699 .option hosts_avoid_tls smtp "host list&!!" unset
23700 .cindex "TLS" "avoiding for certain hosts"
23701 Exim will not try to start a TLS session when delivering to any host that
23702 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23703
23704 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23705 .cindex "TLS" "avoiding for certain hosts"
23706 Exim will not try to start a TLS session for a verify callout,
23707 or when delivering in cutthrough mode,
23708 to any host that matches this list.
23709
23710
23711 .option hosts_max_try smtp integer 5
23712 .cindex "host" "maximum number to try"
23713 .cindex "limit" "number of hosts tried"
23714 .cindex "limit" "number of MX tried"
23715 .cindex "MX record" "maximum tried"
23716 This option limits the number of IP addresses that are tried for any one
23717 delivery in cases where there are temporary delivery errors. Section
23718 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23719
23720
23721 .option hosts_max_try_hardlimit smtp integer 50
23722 This is an additional check on the maximum number of IP addresses that Exim
23723 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23724 why it exists.
23725
23726
23727
23728 .option hosts_nopass_tls smtp "host list&!!" unset
23729 .cindex "TLS" "passing connection"
23730 .cindex "multiple SMTP deliveries"
23731 .cindex "TLS" "multiple message deliveries"
23732 For any host that matches this list, a connection on which a TLS session has
23733 been started will not be passed to a new delivery process for sending another
23734 message on the same connection. See section &<<SECTmulmessam>>& for an
23735 explanation of when this might be needed.
23736
23737
23738 .option hosts_override smtp boolean false
23739 If this option is set and the &%hosts%& option is also set, any hosts that are
23740 attached to the address are ignored, and instead the hosts specified by the
23741 &%hosts%& option are always used. This option does not apply to
23742 &%fallback_hosts%&.
23743
23744
23745 .option hosts_randomize smtp boolean false
23746 .cindex "randomized host list"
23747 .cindex "host" "list of; randomized"
23748 .cindex "fallback" "randomized hosts"
23749 If this option is set, and either the list of hosts is taken from the
23750 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23751 were not obtained from MX records (this includes fallback hosts from the
23752 router), and were not randomized by the router, the order of trying the hosts
23753 is randomized each time the transport runs. Randomizing the order of a host
23754 list can be used to do crude load sharing.
23755
23756 When &%hosts_randomize%& is true, a host list may be split into groups whose
23757 order is separately randomized. This makes it possible to set up MX-like
23758 behaviour. The boundaries between groups are indicated by an item that is just
23759 &`+`& in the host list. For example:
23760 .code
23761 hosts = host1:host2:host3:+:host4:host5
23762 .endd
23763 The order of the first three hosts and the order of the last two hosts is
23764 randomized for each use, but the first three always end up before the last two.
23765 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23766
23767 .option hosts_require_auth smtp "host list&!!" unset
23768 .cindex "authentication" "required by client"
23769 This option provides a list of servers for which authentication must succeed
23770 before Exim will try to transfer a message. If authentication fails for
23771 servers which are not in this list, Exim tries to send unauthenticated. If
23772 authentication fails for one of these servers, delivery is deferred. This
23773 temporary error is detectable in the retry rules, so it can be turned into a
23774 hard failure if required. See also &%hosts_try_auth%&, and chapter
23775 &<<CHAPSMTPAUTH>>& for details of authentication.
23776
23777
23778 .option hosts_request_ocsp smtp "host list&!!" *
23779 .cindex "TLS" "requiring for certain servers"
23780 Exim will request a Certificate Status on a
23781 TLS session for any host that matches this list.
23782 &%tls_verify_certificates%& should also be set for the transport.
23783
23784 .option hosts_require_ocsp smtp "host list&!!" unset
23785 .cindex "TLS" "requiring for certain servers"
23786 Exim will request, and check for a valid Certificate Status being given, on a
23787 TLS session for any host that matches this list.
23788 &%tls_verify_certificates%& should also be set for the transport.
23789
23790 .option hosts_require_tls smtp "host list&!!" unset
23791 .cindex "TLS" "requiring for certain servers"
23792 Exim will insist on using a TLS session when delivering to any host that
23793 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23794 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23795 incoming messages, use an appropriate ACL.
23796
23797 .option hosts_try_auth smtp "host list&!!" unset
23798 .cindex "authentication" "optional in client"
23799 This option provides a list of servers to which, provided they announce
23800 authentication support, Exim will attempt to authenticate as a client when it
23801 connects. If authentication fails, Exim will try to transfer the message
23802 unauthenticated. See also &%hosts_require_auth%&, and chapter
23803 &<<CHAPSMTPAUTH>>& for details of authentication.
23804
23805 .option hosts_try_prdr smtp "host list&!!" *
23806 .cindex "PRDR" "enabling, optional in client"
23807 This option provides a list of servers to which, provided they announce
23808 PRDR support, Exim will attempt to negotiate PRDR
23809 for multi-recipient messages.
23810 The option can usually be left as default.
23811
23812 .option interface smtp "string list&!!" unset
23813 .cindex "bind IP address"
23814 .cindex "IP address" "binding"
23815 .vindex "&$host$&"
23816 .vindex "&$host_address$&"
23817 This option specifies which interface to bind to when making an outgoing SMTP
23818 call. The value is an IP address, not an interface name such as
23819 &`eth0`&. Do not confuse this with the interface address that was used when a
23820 message was received, which is in &$received_ip_address$&, formerly known as
23821 &$interface_address$&. The name was changed to minimize confusion with the
23822 outgoing interface address. There is no variable that contains an outgoing
23823 interface address because, unless it is set by this option, its value is
23824 unknown.
23825
23826 During the expansion of the &%interface%& option the variables &$host$& and
23827 &$host_address$& refer to the host to which a connection is about to be made
23828 during the expansion of the string. Forced expansion failure, or an empty
23829 string result causes the option to be ignored. Otherwise, after expansion, the
23830 string must be a list of IP addresses, colon-separated by default, but the
23831 separator can be changed in the usual way. For example:
23832 .code
23833 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23834 .endd
23835 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23836 connection. If none of them are the correct type, the option is ignored. If
23837 &%interface%& is not set, or is ignored, the system's IP functions choose which
23838 interface to use if the host has more than one.
23839
23840
23841 .option keepalive smtp boolean true
23842 .cindex "keepalive" "on outgoing connection"
23843 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23844 connections. When set, it causes the kernel to probe idle connections
23845 periodically, by sending packets with &"old"& sequence numbers. The other end
23846 of the connection should send a acknowledgment if the connection is still okay
23847 or a reset if the connection has been aborted. The reason for doing this is
23848 that it has the beneficial effect of freeing up certain types of connection
23849 that can get stuck when the remote host is disconnected without tidying up the
23850 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23851 unreachable hosts.
23852
23853
23854 .option lmtp_ignore_quota smtp boolean false
23855 .cindex "LMTP" "ignoring quota errors"
23856 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23857 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23858 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23859
23860 .option max_rcpt smtp integer 100
23861 .cindex "RCPT" "maximum number of outgoing"
23862 This option limits the number of RCPT commands that are sent in a single
23863 SMTP message transaction. Each set of addresses is treated independently, and
23864 so can cause parallel connections to the same host if &%remote_max_parallel%&
23865 permits this.
23866
23867
23868 .option multi_domain smtp boolean&!! true
23869 .vindex "&$domain$&"
23870 When this option is set, the &(smtp)& transport can handle a number of
23871 addresses containing a mixture of different domains provided they all resolve
23872 to the same list of hosts. Turning the option off restricts the transport to
23873 handling only one domain at a time. This is useful if you want to use
23874 &$domain$& in an expansion for the transport, because it is set only when there
23875 is a single domain involved in a remote delivery.
23876
23877 It is expanded per-address and can depend on any of
23878 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23879 &$host$&, &$host_address$& and &$host_port$&.
23880
23881 .option port smtp string&!! "see below"
23882 .cindex "port" "sending TCP/IP"
23883 .cindex "TCP/IP" "setting outgoing port"
23884 This option specifies the TCP/IP port on the server to which Exim connects.
23885 &*Note:*& Do not confuse this with the port that was used when a message was
23886 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23887 The name was changed to minimize confusion with the outgoing port. There is no
23888 variable that contains an outgoing port.
23889
23890 If the value of this option begins with a digit it is taken as a port number;
23891 otherwise it is looked up using &[getservbyname()]&. The default value is
23892 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23893 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23894 is deferred.
23895
23896
23897
23898 .option protocol smtp string smtp
23899 .cindex "LMTP" "over TCP/IP"
23900 .cindex "ssmtp protocol" "outbound"
23901 .cindex "TLS" "SSL-on-connect outbound"
23902 .vindex "&$port$&"
23903 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23904 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23905 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23906 deliveries into closed message stores. Exim also has support for running LMTP
23907 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23908
23909 If this option is set to &"smtps"&, the default value for the &%port%& option
23910 changes to &"smtps"&, and the transport initiates TLS immediately after
23911 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23912 The Internet standards bodies strongly discourage use of this mode.
23913
23914
23915 .option retry_include_ip_address smtp boolean&!! true
23916 Exim normally includes both the host name and the IP address in the key it
23917 constructs for indexing retry data after a temporary delivery failure. This
23918 means that when one of several IP addresses for a host is failing, it gets
23919 tried periodically (controlled by the retry rules), but use of the other IP
23920 addresses is not affected.
23921
23922 However, in some dialup environments hosts are assigned a different IP address
23923 each time they connect. In this situation the use of the IP address as part of
23924 the retry key leads to undesirable behaviour. Setting this option false causes
23925 Exim to use only the host name.
23926 Since it is expanded it can be made to depend on the host or domain.
23927
23928
23929 .option serialize_hosts smtp "host list&!!" unset
23930 .cindex "serializing connections"
23931 .cindex "host" "serializing connections"
23932 Because Exim operates in a distributed manner, if several messages for the same
23933 host arrive at around the same time, more than one simultaneous connection to
23934 the remote host can occur. This is not usually a problem except when there is a
23935 slow link between the hosts. In that situation it may be helpful to restrict
23936 Exim to one connection at a time. This can be done by setting
23937 &%serialize_hosts%& to match the relevant hosts.
23938
23939 .cindex "hints database" "serializing deliveries to a host"
23940 Exim implements serialization by means of a hints database in which a record is
23941 written whenever a process connects to one of the restricted hosts. The record
23942 is deleted when the connection is completed. Obviously there is scope for
23943 records to get left lying around if there is a system or program crash. To
23944 guard against this, Exim ignores any records that are more than six hours old.
23945
23946 If you set up this kind of serialization, you should also arrange to delete the
23947 relevant hints database whenever your system reboots. The names of the files
23948 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23949 may be one or two files, depending on the type of DBM in use. The same files
23950 are used for ETRN serialization.
23951
23952 See also the &%max_parallel%& generic transport option.
23953
23954
23955 .option size_addition smtp integer 1024
23956 .cindex "SMTP" "SIZE"
23957 .cindex "message" "size issue for transport filter"
23958 .cindex "size" "of message"
23959 .cindex "transport" "filter"
23960 .cindex "filter" "transport filter"
23961 If a remote SMTP server indicates that it supports the SIZE option of the
23962 MAIL command, Exim uses this to pass over the message size at the start of
23963 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23964 sends, to allow for headers and other text that may be added during delivery by
23965 configuration options or in a transport filter. It may be necessary to increase
23966 this if a lot of text is added to messages.
23967
23968 Alternatively, if the value of &%size_addition%& is set negative, it disables
23969 the use of the SIZE option altogether.
23970
23971
23972 .option socks_proxy smtp string&!! unset
23973 .cindex proxy SOCKS
23974 This option enables use of SOCKS proxies for connections made by the
23975 transport.  For details see &<<SECTproxySOCKS>>&.
23976
23977
23978 .option tls_certificate smtp string&!! unset
23979 .cindex "TLS" "client certificate, location of"
23980 .cindex "certificate" "client, location of"
23981 .vindex "&$host$&"
23982 .vindex "&$host_address$&"
23983 The value of this option must be the absolute path to a file which contains the
23984 client's certificate, for possible use when sending a message over an encrypted
23985 connection. The values of &$host$& and &$host_address$& are set to the name and
23986 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23987 details of TLS.
23988
23989 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23990 certificate when sending messages as a client. The global option of the same
23991 name specifies the certificate for Exim as a server; it is not automatically
23992 assumed that the same certificate should be used when Exim is operating as a
23993 client.
23994
23995
23996 .option tls_crl smtp string&!! unset
23997 .cindex "TLS" "client certificate revocation list"
23998 .cindex "certificate" "revocation list for client"
23999 This option specifies a certificate revocation list. The expanded value must
24000 be the name of a file that contains a CRL in PEM format.
24001
24002
24003 .option tls_dh_min_bits smtp integer 1024
24004 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24005 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24006 key agreement is negotiated, the server will provide a large prime number
24007 for use.  This option establishes the minimum acceptable size of that number.
24008 If the parameter offered by the server is too small, then the TLS handshake
24009 will fail.
24010
24011 Only supported when using GnuTLS.
24012
24013
24014 .option tls_privatekey smtp string&!! unset
24015 .cindex "TLS" "client private key, location of"
24016 .vindex "&$host$&"
24017 .vindex "&$host_address$&"
24018 The value of this option must be the absolute path to a file which contains the
24019 client's private key. This is used when sending a message over an encrypted
24020 connection using a client certificate. The values of &$host$& and
24021 &$host_address$& are set to the name and address of the server during the
24022 expansion. If this option is unset, or the expansion is forced to fail, or the
24023 result is an empty string, the private key is assumed to be in the same file as
24024 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24025
24026
24027 .option tls_require_ciphers smtp string&!! unset
24028 .cindex "TLS" "requiring specific ciphers"
24029 .cindex "cipher" "requiring specific"
24030 .vindex "&$host$&"
24031 .vindex "&$host_address$&"
24032 The value of this option must be a list of permitted cipher suites, for use
24033 when setting up an outgoing encrypted connection. (There is a global option of
24034 the same name for controlling incoming connections.) The values of &$host$& and
24035 &$host_address$& are set to the name and address of the server during the
24036 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24037 is used in different ways by OpenSSL and GnuTLS (see sections
24038 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24039 ciphers is a preference order.
24040
24041
24042
24043 .option tls_sni smtp string&!! unset
24044 .cindex "TLS" "Server Name Indication"
24045 .vindex "&$tls_sni$&"
24046 If this option is set then it sets the $tls_out_sni variable and causes any
24047 TLS session to pass this value as the Server Name Indication extension to
24048 the remote side, which can be used by the remote side to select an appropriate
24049 certificate and private key for the session.
24050
24051 See &<<SECTtlssni>>& for more information.
24052
24053 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24054 TLS extensions.
24055
24056
24057
24058
24059 .option tls_tempfail_tryclear smtp boolean true
24060 .cindex "4&'xx'& responses" "to STARTTLS"
24061 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24062 setting up a TLS session, this option determines whether or not Exim should try
24063 to deliver the message unencrypted. If it is set false, delivery to the
24064 current host is deferred; if there are other hosts, they are tried. If this
24065 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24066 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24067 TLS negotiation fails, Exim closes the current connection (because it is in an
24068 unknown state), opens a new one to the same host, and then tries the delivery
24069 in clear.
24070
24071
24072 .option tls_try_verify_hosts smtp "host list&!!" *
24073 .cindex "TLS" "server certificate verification"
24074 .cindex "certificate" "verification of server"
24075 This option gives a list of hosts for which, on encrypted connections,
24076 certificate verification will be tried but need not succeed.
24077 The &%tls_verify_certificates%& option must also be set.
24078 Note that unless the host is in this list
24079 TLS connections will be denied to hosts using self-signed certificates
24080 when &%tls_verify_certificates%& is matched.
24081 The &$tls_out_certificate_verified$& variable is set when
24082 certificate verification succeeds.
24083
24084
24085 .option tls_verify_cert_hostnames smtp "host list&!!" *
24086 .cindex "TLS" "server certificate hostname verification"
24087 .cindex "certificate" "verification of server"
24088 This option give a list of hosts for which,
24089 while verifying the server certificate,
24090 checks will be included on the host name
24091 (note that this will generally be the result of a DNS MX lookup)
24092 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24093 limited to being the initial component of a 3-or-more component FQDN.
24094
24095 There is no equivalent checking on client certificates.
24096
24097
24098 .option tls_verify_certificates smtp string&!! system
24099 .cindex "TLS" "server certificate verification"
24100 .cindex "certificate" "verification of server"
24101 .vindex "&$host$&"
24102 .vindex "&$host_address$&"
24103 The value of this option must be either the
24104 word "system"
24105 or the absolute path to
24106 a file or directory containing permitted certificates for servers,
24107 for use when setting up an encrypted connection.
24108
24109 The "system" value for the option will use a location compiled into the SSL library.
24110 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24111 is taken as empty and an explicit location
24112 must be specified.
24113
24114 The use of a directory for the option value is not available for GnuTLS versions
24115 preceding 3.3.6 and a single file must be used.
24116
24117 With OpenSSL the certificates specified
24118 explicitly
24119 either by file or directory
24120 are added to those given by the system default location.
24121
24122 The values of &$host$& and
24123 &$host_address$& are set to the name and address of the server during the
24124 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24125
24126 For back-compatibility,
24127 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24128 (a single-colon empty list counts as being set)
24129 and certificate verification fails the TLS connection is closed.
24130
24131
24132 .option tls_verify_hosts smtp "host list&!!" unset
24133 .cindex "TLS" "server certificate verification"
24134 .cindex "certificate" "verification of server"
24135 This option gives a list of hosts for which, on encrypted connections,
24136 certificate verification must succeed.
24137 The &%tls_verify_certificates%& option must also be set.
24138 If both this option and &%tls_try_verify_hosts%& are unset
24139 operation is as if this option selected all hosts.
24140
24141
24142
24143
24144 .section "How the limits for the number of hosts to try are used" &&&
24145          "SECTvalhosmax"
24146 .cindex "host" "maximum number to try"
24147 .cindex "limit" "hosts; maximum number tried"
24148 There are two options that are concerned with the number of hosts that are
24149 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24150 &%hosts_max_try_hardlimit%&.
24151
24152
24153 The &%hosts_max_try%& option limits the number of hosts that are tried
24154 for a single delivery. However, despite the term &"host"& in its name, the
24155 option actually applies to each IP address independently. In other words, a
24156 multihomed host is treated as several independent hosts, just as it is for
24157 retrying.
24158
24159 Many of the larger ISPs have multiple MX records which often point to
24160 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24161 created as a result of routing one of these domains.
24162
24163 Trying every single IP address on such a long list does not seem sensible; if
24164 several at the top of the list fail, it is reasonable to assume there is some
24165 problem that is likely to affect all of them. Roughly speaking, the value of
24166 &%hosts_max_try%& is the maximum number that are tried before deferring the
24167 delivery. However, the logic cannot be quite that simple.
24168
24169 Firstly, IP addresses that are skipped because their retry times have not
24170 arrived do not count, and in addition, addresses that are past their retry
24171 limits are also not counted, even when they are tried. This means that when
24172 some IP addresses are past their retry limits, more than the value of
24173 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24174 that all IP addresses are considered before timing out an email address (but
24175 see below for an exception).
24176
24177 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24178 list to see if there is a subsequent host with a different (higher valued) MX.
24179 If there is, that host is considered next, and the current IP address is used
24180 but not counted. This behaviour helps in the case of a domain with a retry rule
24181 that hardly ever delays any hosts, as is now explained:
24182
24183 Consider the case of a long list of hosts with one MX value, and a few with a
24184 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24185 hosts at the top of the list are tried at first. With the default retry rule,
24186 which specifies increasing retry times, the higher MX hosts are eventually
24187 tried when those at the top of the list are skipped because they have not
24188 reached their retry times.
24189
24190 However, it is common practice to put a fixed short retry time on domains for
24191 large ISPs, on the grounds that their servers are rarely down for very long.
24192 Unfortunately, these are exactly the domains that tend to resolve to long lists
24193 of hosts. The short retry time means that the lowest MX hosts are tried every
24194 time. The attempts may be in a different order because of random sorting, but
24195 without the special MX check, the higher MX hosts would never be tried until
24196 all the lower MX hosts had timed out (which might be several days), because
24197 there are always some lower MX hosts that have reached their retry times. With
24198 the special check, Exim considers at least one IP address from each MX value at
24199 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24200 reached.
24201
24202 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24203 particular, Exim normally eventually tries all the IP addresses before timing
24204 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24205 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24206 been set up with hundreds of IP addresses for some domains. It can
24207 take a very long time indeed for an address to time out in these cases.
24208
24209 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24210 Exim never tries more than this number of IP addresses; if it hits this limit
24211 and they are all timed out, the email address is bounced, even though not all
24212 possible IP addresses have been tried.
24213 .ecindex IIDsmttra1
24214 .ecindex IIDsmttra2
24215
24216
24217
24218
24219
24220 . ////////////////////////////////////////////////////////////////////////////
24221 . ////////////////////////////////////////////////////////////////////////////
24222
24223 .chapter "Address rewriting" "CHAPrewrite"
24224 .scindex IIDaddrew "rewriting" "addresses"
24225 There are some circumstances in which Exim automatically rewrites domains in
24226 addresses. The two most common are when an address is given without a domain
24227 (referred to as an &"unqualified address"&) or when an address contains an
24228 abbreviated domain that is expanded by DNS lookup.
24229
24230 Unqualified envelope addresses are accepted only for locally submitted
24231 messages, or for messages that are received from hosts matching
24232 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24233 appropriate. Unqualified addresses in header lines are qualified if they are in
24234 locally submitted messages, or messages from hosts that are permitted to send
24235 unqualified envelope addresses. Otherwise, unqualified addresses in header
24236 lines are neither qualified nor rewritten.
24237
24238 One situation in which Exim does &'not'& automatically rewrite a domain is
24239 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24240 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24241 do this. The new RFCs do not contain this suggestion.
24242
24243
24244 .section "Explicitly configured address rewriting" "SECID147"
24245 This chapter describes the rewriting rules that can be used in the
24246 main rewrite section of the configuration file, and also in the generic
24247 &%headers_rewrite%& option that can be set on any transport.
24248
24249 Some people believe that configured address rewriting is a Mortal Sin.
24250 Others believe that life is not possible without it. Exim provides the
24251 facility; you do not have to use it.
24252
24253 The main rewriting rules that appear in the &"rewrite"& section of the
24254 configuration file are applied to addresses in incoming messages, both envelope
24255 addresses and addresses in header lines. Each rule specifies the types of
24256 address to which it applies.
24257
24258 Whether or not addresses in header lines are rewritten depends on the origin of
24259 the headers and the type of rewriting. Global rewriting, that is, rewriting
24260 rules from the rewrite section of the configuration file, is applied only to
24261 those headers that were received with the message. Header lines that are added
24262 by ACLs or by a system filter or by individual routers or transports (which
24263 are specific to individual recipient addresses) are not rewritten by the global
24264 rules.
24265
24266 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24267 applies all headers except those added by routers and transports. That is, as
24268 well as the headers that were received with the message, it also applies to
24269 headers that were added by an ACL or a system filter.
24270
24271
24272 In general, rewriting addresses from your own system or domain has some
24273 legitimacy. Rewriting other addresses should be done only with great care and
24274 in special circumstances. The author of Exim believes that rewriting should be
24275 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24276 Although it can sometimes be used as a routing tool, this is very strongly
24277 discouraged.
24278
24279 There are two commonly encountered circumstances where rewriting is used, as
24280 illustrated by these examples:
24281
24282 .ilist
24283 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24284 exchange mail with each other behind a firewall, but there is only a single
24285 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24286 &'hitch.fict.example'& when sending mail off-site.
24287 .next
24288 A host rewrites the local parts of its own users so that, for example,
24289 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24290 .endlist
24291
24292
24293
24294 .section "When does rewriting happen?" "SECID148"
24295 .cindex "rewriting" "timing of"
24296 .cindex "&ACL;" "rewriting addresses in"
24297 Configured address rewriting can take place at several different stages of a
24298 message's processing.
24299
24300 .vindex "&$sender_address$&"
24301 At the start of an ACL for MAIL, the sender address may have been rewritten
24302 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24303 ordinary rewrite rules have yet been applied. If, however, the sender address
24304 is verified in the ACL, it is rewritten before verification, and remains
24305 rewritten thereafter. The subsequent value of &$sender_address$& is the
24306 rewritten address. This also applies if sender verification happens in a
24307 RCPT ACL. Otherwise, when the sender address is not verified, it is
24308 rewritten as soon as a message's header lines have been received.
24309
24310 .vindex "&$domain$&"
24311 .vindex "&$local_part$&"
24312 Similarly, at the start of an ACL for RCPT, the current recipient's address
24313 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24314 rewrite rules have yet been applied to it. However, the behaviour is different
24315 from the sender address when a recipient is verified. The address is rewritten
24316 for the verification, but the rewriting is not remembered at this stage. The
24317 value of &$local_part$& and &$domain$& after verification are always the same
24318 as they were before (that is, they contain the unrewritten &-- except for
24319 SMTP-time rewriting &-- address).
24320
24321 As soon as a message's header lines have been received, all the envelope
24322 recipient addresses are permanently rewritten, and rewriting is also applied to
24323 the addresses in the header lines (if configured). This happens before adding
24324 any header lines that were specified in MAIL or RCPT ACLs, and
24325 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24326 before the DATA ACL and &[local_scan()]& functions are run.
24327
24328 When an address is being routed, either for delivery or for verification,
24329 rewriting is applied immediately to child addresses that are generated by
24330 redirection, unless &%no_rewrite%& is set on the router.
24331
24332 .cindex "envelope sender" "rewriting at transport time"
24333 .cindex "rewriting" "at transport time"
24334 .cindex "header lines" "rewriting at transport time"
24335 At transport time, additional rewriting of addresses in header lines can be
24336 specified by setting the generic &%headers_rewrite%& option on a transport.
24337 This option contains rules that are identical in form to those in the rewrite
24338 section of the configuration file. They are applied to the original message
24339 header lines and any that were added by ACLs or a system filter. They are not
24340 applied to header lines that are added by routers or the transport.
24341
24342 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24343 transport option. However, it is not possible to rewrite envelope recipients at
24344 transport time.
24345
24346
24347
24348
24349 .section "Testing the rewriting rules that apply on input" "SECID149"
24350 .cindex "rewriting" "testing"
24351 .cindex "testing" "rewriting"
24352 Exim's input rewriting configuration appears in a part of the run time
24353 configuration file headed by &"begin rewrite"&. It can be tested by the
24354 &%-brw%& command line option. This takes an address (which can be a full RFC
24355 2822 address) as its argument. The output is a list of how the address would be
24356 transformed by the rewriting rules for each of the different places it might
24357 appear in an incoming message, that is, for each different header and for the
24358 envelope sender and recipient fields. For example,
24359 .code
24360 exim -brw ph10@exim.workshop.example
24361 .endd
24362 might produce the output
24363 .code
24364 sender: Philip.Hazel@exim.workshop.example
24365 from: Philip.Hazel@exim.workshop.example
24366 to: ph10@exim.workshop.example
24367 cc: ph10@exim.workshop.example
24368 bcc: ph10@exim.workshop.example
24369 reply-to: Philip.Hazel@exim.workshop.example
24370 env-from: Philip.Hazel@exim.workshop.example
24371 env-to: ph10@exim.workshop.example
24372 .endd
24373 which shows that rewriting has been set up for that address when used in any of
24374 the source fields, but not when it appears as a recipient address. At the
24375 present time, there is no equivalent way of testing rewriting rules that are
24376 set for a particular transport.
24377
24378
24379 .section "Rewriting rules" "SECID150"
24380 .cindex "rewriting" "rules"
24381 The rewrite section of the configuration file consists of lines of rewriting
24382 rules in the form
24383 .display
24384 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24385 .endd
24386 Rewriting rules that are specified for the &%headers_rewrite%& generic
24387 transport option are given as a colon-separated list. Each item in the list
24388 takes the same form as a line in the main rewriting configuration (except that
24389 any colons must be doubled, of course).
24390
24391 The formats of source patterns and replacement strings are described below.
24392 Each is terminated by white space, unless enclosed in double quotes, in which
24393 case normal quoting conventions apply inside the quotes. The flags are single
24394 characters which may appear in any order. Spaces and tabs between them are
24395 ignored.
24396
24397 For each address that could potentially be rewritten, the rules are scanned in
24398 order, and replacements for the address from earlier rules can themselves be
24399 replaced by later rules (but see the &"q"& and &"R"& flags).
24400
24401 The order in which addresses are rewritten is undefined, may change between
24402 releases, and must not be relied on, with one exception: when a message is
24403 received, the envelope sender is always rewritten first, before any header
24404 lines are rewritten. For example, the replacement string for a rewrite of an
24405 address in &'To:'& must not assume that the message's address in &'From:'& has
24406 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24407 that the envelope sender has already been rewritten.
24408
24409 .vindex "&$domain$&"
24410 .vindex "&$local_part$&"
24411 The variables &$local_part$& and &$domain$& can be used in the replacement
24412 string to refer to the address that is being rewritten. Note that lookup-driven
24413 rewriting can be done by a rule of the form
24414 .code
24415 *@*   ${lookup ...
24416 .endd
24417 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24418 refer to the address that is being rewritten.
24419
24420
24421 .section "Rewriting patterns" "SECID151"
24422 .cindex "rewriting" "patterns"
24423 .cindex "address list" "in a rewriting pattern"
24424 The source pattern in a rewriting rule is any item which may appear in an
24425 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24426 single-item address list, which means that it is expanded before being tested
24427 against the address. As always, if you use a regular expression as a pattern,
24428 you must take care to escape dollar and backslash characters, or use the &`\N`&
24429 facility to suppress string expansion within the regular expression.
24430
24431 Domains in patterns should be given in lower case. Local parts in patterns are
24432 case-sensitive. If you want to do case-insensitive matching of local parts, you
24433 can use a regular expression that starts with &`^(?i)`&.
24434
24435 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24436 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24437 depending on the type of match which occurred. These can be used in the
24438 replacement string to insert portions of the incoming address. &$0$& always
24439 refers to the complete incoming address. When a regular expression is used, the
24440 numerical variables are set from its capturing subexpressions. For other types
24441 of pattern they are set as follows:
24442
24443 .ilist
24444 If a local part or domain starts with an asterisk, the numerical variables
24445 refer to the character strings matched by asterisks, with &$1$& associated with
24446 the first asterisk, and &$2$& with the second, if present. For example, if the
24447 pattern
24448 .code
24449 *queen@*.fict.example
24450 .endd
24451 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24452 .code
24453 $0 = hearts-queen@wonderland.fict.example
24454 $1 = hearts-
24455 $2 = wonderland
24456 .endd
24457 Note that if the local part does not start with an asterisk, but the domain
24458 does, it is &$1$& that contains the wild part of the domain.
24459
24460 .next
24461 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24462 of the domain are placed in the next available numerical variables. Suppose,
24463 for example, that the address &'foo@bar.baz.example'& is processed by a
24464 rewriting rule of the form
24465 .display
24466 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24467 .endd
24468 and the key in the file that matches the domain is &`*.baz.example`&. Then
24469 .code
24470 $1 = foo
24471 $2 = bar
24472 $3 = baz.example
24473 .endd
24474 If the address &'foo@baz.example'& is looked up, this matches the same
24475 wildcard file entry, and in this case &$2$& is set to the empty string, but
24476 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24477 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24478 whole domain. For non-partial domain lookups, no numerical variables are set.
24479 .endlist
24480
24481
24482 .section "Rewriting replacements" "SECID152"
24483 .cindex "rewriting" "replacements"
24484 If the replacement string for a rule is a single asterisk, addresses that
24485 match the pattern and the flags are &'not'& rewritten, and no subsequent
24486 rewriting rules are scanned. For example,
24487 .code
24488 hatta@lookingglass.fict.example  *  f
24489 .endd
24490 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24491 &'From:'& headers.
24492
24493 .vindex "&$domain$&"
24494 .vindex "&$local_part$&"
24495 If the replacement string is not a single asterisk, it is expanded, and must
24496 yield a fully qualified address. Within the expansion, the variables
24497 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24498 Any letters they contain retain their original case &-- they are not lower
24499 cased. The numerical variables are set up according to the type of pattern that
24500 matched the address, as described above. If the expansion is forced to fail by
24501 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24502 current rule is abandoned, but subsequent rules may take effect. Any other
24503 expansion failure causes the entire rewriting operation to be abandoned, and an
24504 entry written to the panic log.
24505
24506
24507
24508 .section "Rewriting flags" "SECID153"
24509 There are three different kinds of flag that may appear on rewriting rules:
24510
24511 .ilist
24512 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24513 c, f, h, r, s, t.
24514 .next
24515 A flag that specifies rewriting at SMTP time: S.
24516 .next
24517 Flags that control the rewriting process: Q, q, R, w.
24518 .endlist
24519
24520 For rules that are part of the &%headers_rewrite%& generic transport option,
24521 E, F, T, and S are not permitted.
24522
24523
24524
24525 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24526          "SECID154"
24527 .cindex "rewriting" "flags"
24528 If none of the following flag letters, nor the &"S"& flag (see section
24529 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24530 and to both the sender and recipient fields of the envelope, whereas a
24531 transport-time rewriting rule just applies to all headers. Otherwise, the
24532 rewriting rule is skipped unless the relevant addresses are being processed.
24533 .display
24534 &`E`&       rewrite all envelope fields
24535 &`F`&       rewrite the envelope From field
24536 &`T`&       rewrite the envelope To field
24537 &`b`&       rewrite the &'Bcc:'& header
24538 &`c`&       rewrite the &'Cc:'& header
24539 &`f`&       rewrite the &'From:'& header
24540 &`h`&       rewrite all headers
24541 &`r`&       rewrite the &'Reply-To:'& header
24542 &`s`&       rewrite the &'Sender:'& header
24543 &`t`&       rewrite the &'To:'& header
24544 .endd
24545 "All headers" means all of the headers listed above that can be selected
24546 individually, plus their &'Resent-'& versions. It does not include
24547 other headers such as &'Subject:'& etc.
24548
24549 You should be particularly careful about rewriting &'Sender:'& headers, and
24550 restrict this to special known cases in your own domains.
24551
24552
24553 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24554 .cindex "SMTP" "rewriting malformed addresses"
24555 .cindex "RCPT" "rewriting argument of"
24556 .cindex "MAIL" "rewriting argument of"
24557 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24558 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24559 before any other processing; even before syntax checking. The pattern is
24560 required to be a regular expression, and it is matched against the whole of the
24561 data for the command, including any surrounding angle brackets.
24562
24563 .vindex "&$domain$&"
24564 .vindex "&$local_part$&"
24565 This form of rewrite rule allows for the handling of addresses that are not
24566 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24567 input). Because the input is not required to be a syntactically valid address,
24568 the variables &$local_part$& and &$domain$& are not available during the
24569 expansion of the replacement string. The result of rewriting replaces the
24570 original address in the MAIL or RCPT command.
24571
24572
24573 .section "Flags controlling the rewriting process" "SECID155"
24574 There are four flags which control the way the rewriting process works. These
24575 take effect only when a rule is invoked, that is, when the address is of the
24576 correct type (matches the flags) and matches the pattern:
24577
24578 .ilist
24579 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24580 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24581 absence of &"Q"& the rewritten address must always include a domain.
24582 .next
24583 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24584 even if no rewriting actually takes place because of a &"fail"& in the
24585 expansion. The &"q"& flag is not effective if the address is of the wrong type
24586 (does not match the flags) or does not match the pattern.
24587 .next
24588 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24589 address, up to ten times. It can be combined with the &"q"& flag, to stop
24590 rewriting once it fails to match (after at least one successful rewrite).
24591 .next
24592 .cindex "rewriting" "whole addresses"
24593 When an address in a header is rewritten, the rewriting normally applies only
24594 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24595 left unchanged. For example, rewriting might change
24596 .code
24597 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24598 .endd
24599 into
24600 .code
24601 From: Ford Prefect <prefectf@hitch.fict.example>
24602 .endd
24603 .cindex "RFC 2047"
24604 Sometimes there is a need to replace the whole address item, and this can be
24605 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24606 causes an address in a header line to be rewritten, the entire address is
24607 replaced, not just the working part. The replacement must be a complete RFC
24608 2822 address, including the angle brackets if necessary. If text outside angle
24609 brackets contains a character whose value is greater than 126 or less than 32
24610 (except for tab), the text is encoded according to RFC 2047. The character set
24611 is taken from &%headers_charset%&, which gets its default at build time.
24612
24613 When the &"w"& flag is set on a rule that causes an envelope address to be
24614 rewritten, all but the working part of the replacement address is discarded.
24615 .endlist
24616
24617
24618 .section "Rewriting examples" "SECID156"
24619 Here is an example of the two common rewriting paradigms:
24620 .code
24621 *@*.hitch.fict.example  $1@hitch.fict.example
24622 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24623                      {$value}fail}@hitch.fict.example bctfrF
24624 .endd
24625 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24626 the string expansion to fail if the lookup does not succeed. In this context it
24627 has the effect of leaving the original address unchanged, but Exim goes on to
24628 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24629 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24630 explicitly, which would cause the rewritten address to be the same as before,
24631 at the cost of a small bit of processing. Not supplying either of these is an
24632 error, since the rewritten address would then contain no local part.
24633
24634 The first example above replaces the domain with a superior, more general
24635 domain. This may not be desirable for certain local parts. If the rule
24636 .code
24637 root@*.hitch.fict.example  *
24638 .endd
24639 were inserted before the first rule, rewriting would be suppressed for the
24640 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24641
24642 Rewriting can be made conditional on a number of tests, by making use of
24643 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24644 messages that originate outside the local host:
24645 .code
24646 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24647                          {$1@hitch.fict.example}fail}"
24648 .endd
24649 The replacement string is quoted in this example because it contains white
24650 space.
24651
24652 .cindex "rewriting" "bang paths"
24653 .cindex "bang paths" "rewriting"
24654 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24655 an address it treats it as an unqualified local part which it qualifies with
24656 the local qualification domain (if the source of the message is local or if the
24657 remote host is permitted to send unqualified addresses). Rewriting can
24658 sometimes be used to handle simple bang paths with a fixed number of
24659 components. For example, the rule
24660 .code
24661 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24662 .endd
24663 rewrites a two-component bang path &'host.name!user'& as the domain address
24664 &'user@host.name'&. However, there is a security implication in using this as
24665 a global rewriting rule for envelope addresses. It can provide a backdoor
24666 method for using your system as a relay, because the incoming addresses appear
24667 to be local. If the bang path addresses are received via SMTP, it is safer to
24668 use the &"S"& flag to rewrite them as they are received, so that relay checking
24669 can be done on the rewritten addresses.
24670 .ecindex IIDaddrew
24671
24672
24673
24674
24675
24676 . ////////////////////////////////////////////////////////////////////////////
24677 . ////////////////////////////////////////////////////////////////////////////
24678
24679 .chapter "Retry configuration" "CHAPretry"
24680 .scindex IIDretconf1 "retry" "configuration, description of"
24681 .scindex IIDregconf2 "configuration file" "retry section"
24682 The &"retry"& section of the runtime configuration file contains a list of
24683 retry rules that control how often Exim tries to deliver messages that cannot
24684 be delivered at the first attempt. If there are no retry rules (the section is
24685 empty or not present), there are no retries. In this situation, temporary
24686 errors are treated as permanent. The default configuration contains a single,
24687 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24688 line option can be used to test which retry rule will be used for a given
24689 address, domain and error.
24690
24691 The most common cause of retries is temporary failure to deliver to a remote
24692 host because the host is down, or inaccessible because of a network problem.
24693 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24694 address) basis, not on a per-message basis. Thus, if one message has recently
24695 been delayed, delivery of a new message to the same host is not immediately
24696 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24697 log selector is set, the message
24698 .cindex "retry" "time not reached"
24699 &"retry time not reached"& is written to the main log whenever a delivery is
24700 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24701 the handling of errors during remote deliveries.
24702
24703 Retry processing applies to routing as well as to delivering, except as covered
24704 in the next paragraph. The retry rules do not distinguish between these
24705 actions. It is not possible, for example, to specify different behaviour for
24706 failures to route the domain &'snark.fict.example'& and failures to deliver to
24707 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24708 added complication, so did not implement it. However, although they share the
24709 same retry rule, the actual retry times for routing and transporting a given
24710 domain are maintained independently.
24711
24712 When a delivery is not part of a queue run (typically an immediate delivery on
24713 receipt of a message), the routers are always run, and local deliveries are
24714 always attempted, even if retry times are set for them. This makes for better
24715 behaviour if one particular message is causing problems (for example, causing
24716 quota overflow, or provoking an error in a filter file). If such a delivery
24717 suffers a temporary failure, the retry data is updated as normal, and
24718 subsequent delivery attempts from queue runs occur only when the retry time for
24719 the local address is reached.
24720
24721 .section "Changing retry rules" "SECID157"
24722 If you change the retry rules in your configuration, you should consider
24723 whether or not to delete the retry data that is stored in Exim's spool area in
24724 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24725 always safe; that is why they are called &"hints"&.
24726
24727 The hints retry data contains suggested retry times based on the previous
24728 rules. In the case of a long-running problem with a remote host, it might
24729 record the fact that the host has timed out. If your new rules increase the
24730 timeout time for such a host, you should definitely remove the old retry data
24731 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24732 messages that it should now be retaining.
24733
24734
24735
24736 .section "Format of retry rules" "SECID158"
24737 .cindex "retry" "rules"
24738 Each retry rule occupies one line and consists of three or four parts,
24739 separated by white space: a pattern, an error name, an optional list of sender
24740 addresses, and a list of retry parameters. The pattern and sender lists must be
24741 enclosed in double quotes if they contain white space. The rules are searched
24742 in order until one is found where the pattern, error name, and sender list (if
24743 present) match the failing host or address, the error that occurred, and the
24744 message's sender, respectively.
24745
24746
24747 The pattern is any single item that may appear in an address list (see section
24748 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24749 which means that it is expanded before being tested against the address that
24750 has been delayed. A negated address list item is permitted. Address
24751 list processing treats a plain domain name as if it were preceded by &"*@"&,
24752 which makes it possible for many retry rules to start with just a domain. For
24753 example,
24754 .code
24755 lookingglass.fict.example        *  F,24h,30m;
24756 .endd
24757 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24758 whereas
24759 .code
24760 alice@lookingglass.fict.example  *  F,24h,30m;
24761 .endd
24762 applies only to temporary failures involving the local part &%alice%&.
24763 In practice, almost all rules start with a domain name pattern without a local
24764 part.
24765
24766 .cindex "regular expressions" "in retry rules"
24767 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24768 must match a complete address, not just a domain, because that is how regular
24769 expressions work in address lists.
24770 .display
24771 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24772 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24773 .endd
24774
24775
24776 .section "Choosing which retry rule to use for address errors" "SECID159"
24777 When Exim is looking for a retry rule after a routing attempt has failed (for
24778 example, after a DNS timeout), each line in the retry configuration is tested
24779 against the complete address only if &%retry_use_local_part%& is set for the
24780 router. Otherwise, only the domain is used, except when matching against a
24781 regular expression, when the local part of the address is replaced with &"*"&.
24782 A domain on its own can match a domain pattern, or a pattern that starts with
24783 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24784 &%check_local_user%& is true, and false for other routers.
24785
24786 Similarly, when Exim is looking for a retry rule after a local delivery has
24787 failed (for example, after a mailbox full error), each line in the retry
24788 configuration is tested against the complete address only if
24789 &%retry_use_local_part%& is set for the transport (it defaults true for all
24790 local transports).
24791
24792 .cindex "4&'xx'& responses" "retry rules for"
24793 However, when Exim is looking for a retry rule after a remote delivery attempt
24794 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24795 whole address is always used as the key when searching the retry rules. The
24796 rule that is found is used to create a retry time for the combination of the
24797 failing address and the message's sender. It is the combination of sender and
24798 recipient that is delayed in subsequent queue runs until its retry time is
24799 reached. You can delay the recipient without regard to the sender by setting
24800 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24801 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24802 commands.
24803
24804
24805
24806 .section "Choosing which retry rule to use for host and message errors" &&&
24807          "SECID160"
24808 For a temporary error that is not related to an individual address (for
24809 example, a connection timeout), each line in the retry configuration is checked
24810 twice. First, the name of the remote host is used as a domain name (preceded by
24811 &"*@"& when matching a regular expression). If this does not match the line,
24812 the domain from the email address is tried in a similar fashion. For example,
24813 suppose the MX records for &'a.b.c.example'& are
24814 .code
24815 a.b.c.example  MX  5  x.y.z.example
24816                MX  6  p.q.r.example
24817                MX  7  m.n.o.example
24818 .endd
24819 and the retry rules are
24820 .code
24821 p.q.r.example    *      F,24h,30m;
24822 a.b.c.example    *      F,4d,45m;
24823 .endd
24824 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24825 first rule matches neither the host nor the domain, so Exim looks at the second
24826 rule. This does not match the host, but it does match the domain, so it is used
24827 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24828 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24829 first retry rule is used, because it matches the host.
24830
24831 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24832 first rule to determine retry times, but for all the other hosts for the domain
24833 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24834 routing to &'a.b.c.example'& suffers a temporary failure.
24835
24836 &*Note*&: The host name is used when matching the patterns, not its IP address.
24837 However, if a message is routed directly to an IP address without the use of a
24838 host name, for example, if a &(manualroute)& router contains a setting such as:
24839 .code
24840 route_list = *.a.example  192.168.34.23
24841 .endd
24842 then the &"host name"& that is used when searching for a retry rule is the
24843 textual form of the IP address.
24844
24845 .section "Retry rules for specific errors" "SECID161"
24846 .cindex "retry" "specific errors; specifying"
24847 The second field in a retry rule is the name of a particular error, or an
24848 asterisk, which matches any error. The errors that can be tested for are:
24849
24850 .vlist
24851 .vitem &%auth_failed%&
24852 Authentication failed when trying to send to a host in the
24853 &%hosts_require_auth%& list in an &(smtp)& transport.
24854
24855 .vitem &%data_4xx%&
24856 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24857 after the command, or after sending the message's data.
24858
24859 .vitem &%mail_4xx%&
24860 A 4&'xx'& error was received for an outgoing MAIL command.
24861
24862 .vitem &%rcpt_4xx%&
24863 A 4&'xx'& error was received for an outgoing RCPT command.
24864 .endlist
24865
24866 For the three 4&'xx'& errors, either the first or both of the x's can be given
24867 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24868 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24869 and have retries every ten minutes with a one-hour timeout, you could set up a
24870 retry rule of this form:
24871 .code
24872 the.domain.name  rcpt_452   F,1h,10m
24873 .endd
24874 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24875 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24876
24877 .vlist
24878 .vitem &%lost_connection%&
24879 A server unexpectedly closed the SMTP connection. There may, of course,
24880 legitimate reasons for this (host died, network died), but if it repeats a lot
24881 for the same host, it indicates something odd.
24882
24883 .vitem &%lookup%&
24884 A DNS lookup for a host failed.
24885 Note that a &%dnslookup%& router will need to have matched
24886 its &%fail_defer_domains%& option for this retry type to be usable.
24887 Also note that a &%manualroute%& router will probably need
24888 its &%host_find_failed%& option set to &%defer%&.
24889
24890 .vitem &%refused_MX%&
24891 A connection to a host obtained from an MX record was refused.
24892
24893 .vitem &%refused_A%&
24894 A connection to a host not obtained from an MX record was refused.
24895
24896 .vitem &%refused%&
24897 A connection was refused.
24898
24899 .vitem &%timeout_connect_MX%&
24900 A connection attempt to a host obtained from an MX record timed out.
24901
24902 .vitem &%timeout_connect_A%&
24903 A connection attempt to a host not obtained from an MX record timed out.
24904
24905 .vitem &%timeout_connect%&
24906 A connection attempt timed out.
24907
24908 .vitem &%timeout_MX%&
24909 There was a timeout while connecting or during an SMTP session with a host
24910 obtained from an MX record.
24911
24912 .vitem &%timeout_A%&
24913 There was a timeout while connecting or during an SMTP session with a host not
24914 obtained from an MX record.
24915
24916 .vitem &%timeout%&
24917 There was a timeout while connecting or during an SMTP session.
24918
24919 .vitem &%tls_required%&
24920 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24921 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24922 to STARTTLS, or there was a problem setting up the TLS connection.
24923
24924 .vitem &%quota%&
24925 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24926 transport.
24927
24928 .vitem &%quota_%&<&'time'&>
24929 .cindex "quota" "error testing in retry rule"
24930 .cindex "retry" "quota error testing"
24931 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24932 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24933 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24934 for four days.
24935 .endlist
24936
24937 .cindex "mailbox" "time of last read"
24938 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24939 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24940 it should be based on the last time that the user accessed the mailbox.
24941 However, it is not always possible to determine this. Exim uses the following
24942 heuristic rules:
24943
24944 .ilist
24945 If the mailbox is a single file, the time of last access (the &"atime"&) is
24946 used. As no new messages are being delivered (because the mailbox is over
24947 quota), Exim does not access the file, so this is the time of last user access.
24948 .next
24949 .cindex "maildir format" "time of last read"
24950 For a maildir delivery, the time of last modification of the &_new_&
24951 subdirectory is used. As the mailbox is over quota, no new files are created in
24952 the &_new_& subdirectory, because no new messages are being delivered. Any
24953 change to the &_new_& subdirectory is therefore assumed to be the result of an
24954 MUA moving a new message to the &_cur_& directory when it is first read. The
24955 time that is used is therefore the last time that the user read a new message.
24956 .next
24957 For other kinds of multi-file mailbox, the time of last access cannot be
24958 obtained, so a retry rule that uses this type of error field is never matched.
24959 .endlist
24960
24961 The quota errors apply both to system-enforced quotas and to Exim's own quota
24962 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24963 when a local delivery is deferred because a partition is full (the ENOSPC
24964 error).
24965
24966
24967
24968 .section "Retry rules for specified senders" "SECID162"
24969 .cindex "retry" "rules; sender-specific"
24970 You can specify retry rules that apply only when the failing message has a
24971 specific sender. In particular, this can be used to define retry rules that
24972 apply only to bounce messages. The third item in a retry rule can be of this
24973 form:
24974 .display
24975 &`senders=`&<&'address list'&>
24976 .endd
24977 The retry timings themselves are then the fourth item. For example:
24978 .code
24979 *   rcpt_4xx   senders=:   F,1h,30m
24980 .endd
24981 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24982 host. If the address list contains white space, it must be enclosed in quotes.
24983 For example:
24984 .code
24985 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24986 .endd
24987 &*Warning*&: This facility can be unhelpful if it is used for host errors
24988 (which do not depend on the recipient). The reason is that the sender is used
24989 only to match the retry rule. Once the rule has been found for a host error,
24990 its contents are used to set a retry time for the host, and this will apply to
24991 all messages, not just those with specific senders.
24992
24993 When testing retry rules using &%-brt%&, you can supply a sender using the
24994 &%-f%& command line option, like this:
24995 .code
24996 exim -f "" -brt user@dom.ain
24997 .endd
24998 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24999 list is never matched.
25000
25001
25002
25003
25004
25005 .section "Retry parameters" "SECID163"
25006 .cindex "retry" "parameters in rules"
25007 The third (or fourth, if a senders list is present) field in a retry rule is a
25008 sequence of retry parameter sets, separated by semicolons. Each set consists of
25009 .display
25010 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25011 .endd
25012 The letter identifies the algorithm for computing a new retry time; the cutoff
25013 time is the time beyond which this algorithm no longer applies, and the
25014 arguments vary the algorithm's action. The cutoff time is measured from the
25015 time that the first failure for the domain (combined with the local part if
25016 relevant) was detected, not from the time the message was received.
25017
25018 .cindex "retry" "algorithms"
25019 .cindex "retry" "fixed intervals"
25020 .cindex "retry" "increasing intervals"
25021 .cindex "retry" "random intervals"
25022 The available algorithms are:
25023
25024 .ilist
25025 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25026 the interval.
25027 .next
25028 &'G'&: retry at geometrically increasing intervals. The first argument
25029 specifies a starting value for the interval, and the second a multiplier, which
25030 is used to increase the size of the interval at each retry.
25031 .next
25032 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25033 retry, the previous interval is multiplied by the factor in order to get a
25034 maximum for the next interval. The minimum interval is the first argument of
25035 the parameter, and an actual interval is chosen randomly between them. Such a
25036 rule has been found to be helpful in cluster configurations when all the
25037 members of the cluster restart at once, and may therefore synchronize their
25038 queue processing times.
25039 .endlist
25040
25041 When computing the next retry time, the algorithm definitions are scanned in
25042 order until one whose cutoff time has not yet passed is reached. This is then
25043 used to compute a new retry time that is later than the current time. In the
25044 case of fixed interval retries, this simply means adding the interval to the
25045 current time. For geometrically increasing intervals, retry intervals are
25046 computed from the rule's parameters until one that is greater than the previous
25047 interval is found. The main configuration variable
25048 .cindex "limit" "retry interval"
25049 .cindex "retry" "interval, maximum"
25050 .oindex "&%retry_interval_max%&"
25051 &%retry_interval_max%& limits the maximum interval between retries. It
25052 cannot be set greater than &`24h`&, which is its default value.
25053
25054 A single remote domain may have a number of hosts associated with it, and each
25055 host may have more than one IP address. Retry algorithms are selected on the
25056 basis of the domain name, but are applied to each IP address independently. If,
25057 for example, a host has two IP addresses and one is unusable, Exim will
25058 generate retry times for it and will not try to use it until its next retry
25059 time comes. Thus the good IP address is likely to be tried first most of the
25060 time.
25061
25062 .cindex "hints database" "use for retrying"
25063 Retry times are hints rather than promises. Exim does not make any attempt to
25064 run deliveries exactly at the computed times. Instead, a queue runner process
25065 starts delivery processes for delayed messages periodically, and these attempt
25066 new deliveries only for those addresses that have passed their next retry time.
25067 If a new message arrives for a deferred address, an immediate delivery attempt
25068 occurs only if the address has passed its retry time. In the absence of new
25069 messages, the minimum time between retries is the interval between queue runner
25070 processes. There is not much point in setting retry times of five minutes if
25071 your queue runners happen only once an hour, unless there are a significant
25072 number of incoming messages (which might be the case on a system that is
25073 sending everything to a smart host, for example).
25074
25075 The data in the retry hints database can be inspected by using the
25076 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25077 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25078 &'exinext'& utility script can be used to find out what the next retry times
25079 are for the hosts associated with a particular mail domain, and also for local
25080 deliveries that have been deferred.
25081
25082
25083 .section "Retry rule examples" "SECID164"
25084 Here are some example retry rules:
25085 .code
25086 alice@wonderland.fict.example quota_5d  F,7d,3h
25087 wonderland.fict.example       quota_5d
25088 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25089 lookingglass.fict.example     *         F,24h,30m;
25090 *                 refused_A   F,2h,20m;
25091 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25092 .endd
25093 The first rule sets up special handling for mail to
25094 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25095 mailbox has not been read for at least 5 days. Retries continue every three
25096 hours for 7 days. The second rule handles over-quota errors for all other local
25097 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25098 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25099 fail are bounced immediately if the mailbox has not been read for at least 5
25100 days.
25101
25102 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25103 happen every 15 minutes for an hour, then with geometrically increasing
25104 intervals until two days have passed since a delivery first failed. After the
25105 first hour there is a delay of one hour, then two hours, then four hours, and
25106 so on (this is a rather extreme example).
25107
25108 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25109 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25110 all other domains, with special action for connection refusal from hosts that
25111 were not obtained from an MX record.
25112
25113 The final rule in a retry configuration should always have asterisks in the
25114 first two fields so as to provide a general catch-all for any addresses that do
25115 not have their own special handling. This example tries every 15 minutes for 2
25116 hours, then with intervals starting at one hour and increasing by a factor of
25117 1.5 up to 16 hours, then every 8 hours up to 5 days.
25118
25119
25120
25121 .section "Timeout of retry data" "SECID165"
25122 .cindex "timeout" "of retry data"
25123 .oindex "&%retry_data_expire%&"
25124 .cindex "hints database" "data expiry"
25125 .cindex "retry" "timeout of data"
25126 Exim timestamps the data that it writes to its retry hints database. When it
25127 consults the data during a delivery it ignores any that is older than the value
25128 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25129 been tried for 7 days, Exim will try to deliver to it immediately a message
25130 arrives, and if that fails, it will calculate a retry time as if it were
25131 failing for the first time.
25132
25133 This improves the behaviour for messages routed to rarely-used hosts such as MX
25134 backups. If such a host was down at one time, and happens to be down again when
25135 Exim tries a month later, using the old retry data would imply that it had been
25136 down all the time, which is not a justified assumption.
25137
25138 If a host really is permanently dead, this behaviour causes a burst of retries
25139 every now and again, but only if messages routed to it are rare. If there is a
25140 message at least once every 7 days the retry data never expires.
25141
25142
25143
25144
25145 .section "Long-term failures" "SECID166"
25146 .cindex "delivery failure, long-term"
25147 .cindex "retry" "after long-term failure"
25148 Special processing happens when an email address has been failing for so long
25149 that the cutoff time for the last algorithm is reached. For example, using the
25150 default retry rule:
25151 .code
25152 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25153 .endd
25154 the cutoff time is four days. Reaching the retry cutoff is independent of how
25155 long any specific message has been failing; it is the length of continuous
25156 failure for the recipient address that counts.
25157
25158 When the cutoff time is reached for a local delivery, or for all the IP
25159 addresses associated with a remote delivery, a subsequent delivery failure
25160 causes Exim to give up on the address, and a bounce message is generated.
25161 In order to cater for new messages that use the failing address, a next retry
25162 time is still computed from the final algorithm, and is used as follows:
25163
25164 For local deliveries, one delivery attempt is always made for any subsequent
25165 messages. If this delivery fails, the address fails immediately. The
25166 post-cutoff retry time is not used.
25167
25168 If the delivery is remote, there are two possibilities, controlled by the
25169 .oindex "&%delay_after_cutoff%&"
25170 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25171 default. Until the post-cutoff retry time for one of the IP addresses is
25172 reached, the failing email address is bounced immediately, without a delivery
25173 attempt taking place. After that time, one new delivery attempt is made to
25174 those IP addresses that are past their retry times, and if that still fails,
25175 the address is bounced and new retry times are computed.
25176
25177 In other words, when all the hosts for a given email address have been failing
25178 for a long time, Exim bounces rather then defers until one of the hosts' retry
25179 times is reached. Then it tries once, and bounces if that attempt fails. This
25180 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25181 to a broken destination, but if the host does recover, Exim will eventually
25182 notice.
25183
25184 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25185 addresses are past their final cutoff time, Exim tries to deliver to those IP
25186 addresses that have not been tried since the message arrived. If there are
25187 no suitable IP addresses, or if they all fail, the address is bounced. In other
25188 words, it does not delay when a new message arrives, but tries the expired
25189 addresses immediately, unless they have been tried since the message arrived.
25190 If there is a continuous stream of messages for the failing domains, setting
25191 &%delay_after_cutoff%& false means that there will be many more attempts to
25192 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25193 true.
25194
25195 .section "Deliveries that work intermittently" "SECID167"
25196 .cindex "retry" "intermittently working deliveries"
25197 Some additional logic is needed to cope with cases where a host is
25198 intermittently available, or when a message has some attribute that prevents
25199 its delivery when others to the same address get through. In this situation,
25200 because some messages are successfully delivered, the &"retry clock"& for the
25201 host or address keeps getting reset by the successful deliveries, and so
25202 failing messages remain on the queue for ever because the cutoff time is never
25203 reached.
25204
25205 Two exceptional actions are applied to prevent this happening. The first
25206 applies to errors that are related to a message rather than a remote host.
25207 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25208 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25209 commands, and quota failures. For this type of error, if a message's arrival
25210 time is earlier than the &"first failed"& time for the error, the earlier time
25211 is used when scanning the retry rules to decide when to try next and when to
25212 time out the address.
25213
25214 The exceptional second action applies in all cases. If a message has been on
25215 the queue for longer than the cutoff time of any applicable retry rule for a
25216 given address, a delivery is attempted for that address, even if it is not yet
25217 time, and if this delivery fails, the address is timed out. A new retry time is
25218 not computed in this case, so that other messages for the same address are
25219 considered immediately.
25220 .ecindex IIDretconf1
25221 .ecindex IIDregconf2
25222
25223
25224
25225
25226
25227
25228 . ////////////////////////////////////////////////////////////////////////////
25229 . ////////////////////////////////////////////////////////////////////////////
25230
25231 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25232 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25233 .scindex IIDauthconf2 "authentication"
25234 The &"authenticators"& section of Exim's run time configuration is concerned
25235 with SMTP authentication. This facility is an extension to the SMTP protocol,
25236 described in RFC 2554, which allows a client SMTP host to authenticate itself
25237 to a server. This is a common way for a server to recognize clients that are
25238 permitted to use it as a relay. SMTP authentication is not of relevance to the
25239 transfer of mail between servers that have no managerial connection with each
25240 other.
25241
25242 .cindex "AUTH" "description of"
25243 Very briefly, the way SMTP authentication works is as follows:
25244
25245 .ilist
25246 The server advertises a number of authentication &'mechanisms'& in response to
25247 the client's EHLO command.
25248 .next
25249 The client issues an AUTH command, naming a specific mechanism. The command
25250 may, optionally, contain some authentication data.
25251 .next
25252 The server may issue one or more &'challenges'&, to which the client must send
25253 appropriate responses. In simple authentication mechanisms, the challenges are
25254 just prompts for user names and passwords. The server does not have to issue
25255 any challenges &-- in some mechanisms the relevant data may all be transmitted
25256 with the AUTH command.
25257 .next
25258 The server either accepts or denies authentication.
25259 .next
25260 If authentication succeeds, the client may optionally make use of the AUTH
25261 option on the MAIL command to pass an authenticated sender in subsequent
25262 mail transactions. Authentication lasts for the remainder of the SMTP
25263 connection.
25264 .next
25265 If authentication fails, the client may give up, or it may try a different
25266 authentication mechanism, or it may try transferring mail over the
25267 unauthenticated connection.
25268 .endlist
25269
25270 If you are setting up a client, and want to know which authentication
25271 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25272 SMTP port) on the server, and issue an EHLO command. The response to this
25273 includes the list of supported mechanisms. For example:
25274 .display
25275 &`$ `&&*&`telnet server.example 25`&*&
25276 &`Trying 192.168.34.25...`&
25277 &`Connected to server.example.`&
25278 &`Escape character is &#x0027;^]&#x0027;.`&
25279 &`220 server.example ESMTP Exim 4.20 ...`&
25280 &*&`ehlo client.example`&*&
25281 &`250-server.example Hello client.example [10.8.4.5]`&
25282 &`250-SIZE 52428800`&
25283 &`250-PIPELINING`&
25284 &`250-AUTH PLAIN`&
25285 &`250 HELP`&
25286 .endd
25287 The second-last line of this example output shows that the server supports
25288 authentication using the PLAIN mechanism. In Exim, the different authentication
25289 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25290 routers and transports, which authenticators are included in the binary is
25291 controlled by build-time definitions. The following are currently available,
25292 included by setting
25293 .code
25294 AUTH_CRAM_MD5=yes
25295 AUTH_CYRUS_SASL=yes
25296 AUTH_DOVECOT=yes
25297 AUTH_GSASL=yes
25298 AUTH_HEIMDAL_GSSAPI=yes
25299 AUTH_PLAINTEXT=yes
25300 AUTH_SPA=yes
25301 AUTH_TLS=yes
25302 .endd
25303 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25304 authentication mechanism (RFC 2195), and the second provides an interface to
25305 the Cyrus SASL authentication library.
25306 The third is an interface to Dovecot's authentication system, delegating the
25307 work via a socket interface.
25308 The fourth provides an interface to the GNU SASL authentication library, which
25309 provides mechanisms but typically not data sources.
25310 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25311 supporting setting a server keytab.
25312 The sixth can be configured to support
25313 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25314 not formally documented, but used by several MUAs. The seventh authenticator
25315 supports Microsoft's &'Secure Password Authentication'& mechanism.
25316 The eighth is an Exim authenticator but not an SMTP one;
25317 instead it can use information from a TLS negotiation.
25318
25319 The authenticators are configured using the same syntax as other drivers (see
25320 section &<<SECTfordricon>>&). If no authenticators are required, no
25321 authentication section need be present in the configuration file. Each
25322 authenticator can in principle have both server and client functions. When Exim
25323 is receiving SMTP mail, it is acting as a server; when it is sending out
25324 messages over SMTP, it is acting as a client. Authenticator configuration
25325 options are provided for use in both these circumstances.
25326
25327 To make it clear which options apply to which situation, the prefixes
25328 &%server_%& and &%client_%& are used on option names that are specific to
25329 either the server or the client function, respectively. Server and client
25330 functions are disabled if none of their options are set. If an authenticator is
25331 to be used for both server and client functions, a single definition, using
25332 both sets of options, is required. For example:
25333 .code
25334 cram:
25335   driver = cram_md5
25336   public_name = CRAM-MD5
25337   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25338   client_name = ph10
25339   client_secret = secret2
25340 .endd
25341 The &%server_%& option is used when Exim is acting as a server, and the
25342 &%client_%& options when it is acting as a client.
25343
25344 Descriptions of the individual authenticators are given in subsequent chapters.
25345 The remainder of this chapter covers the generic options for the
25346 authenticators, followed by general discussion of the way authentication works
25347 in Exim.
25348
25349 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25350 per-mechanism basis.  Please read carefully to determine which variables hold
25351 account labels such as usercodes and which hold passwords or other
25352 authenticating data.
25353
25354 Note that some mechanisms support two different identifiers for accounts: the
25355 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25356 and &'authz'& are commonly encountered.  The American spelling is standard here.
25357 Conceptually, authentication data such as passwords are tied to the identifier
25358 used to authenticate; servers may have rules to permit one user to act as a
25359 second user, so that after login the session is treated as though that second
25360 user had logged in.  That second user is the &'authorization id'&.  A robust
25361 configuration might confirm that the &'authz'& field is empty or matches the
25362 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25363 as verified data, the &'authz'& as an unverified request which the server might
25364 choose to honour.
25365
25366 A &'realm'& is a text string, typically a domain name, presented by a server
25367 to a client to help it select an account and credentials to use.  In some
25368 mechanisms, the client and server provably agree on the realm, but clients
25369 typically can not treat the realm as secure data to be blindly trusted.
25370
25371
25372
25373 .section "Generic options for authenticators" "SECID168"
25374 .cindex "authentication" "generic options"
25375 .cindex "options" "generic; for authenticators"
25376
25377 .option client_condition authenticators string&!! unset
25378 When Exim is authenticating as a client, it skips any authenticator whose
25379 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25380 used, for example, to skip plain text authenticators when the connection is not
25381 encrypted by a setting such as:
25382 .code
25383 client_condition = ${if !eq{$tls_out_cipher}{}}
25384 .endd
25385
25386
25387 .option client_set_id authenticators string&!! unset
25388 When client authentication succeeds, this condition is expanded; the
25389 result is used in the log lines for outbound messages.
25390 Typically it will be the user name used for authentication.
25391
25392
25393 .option driver authenticators string unset
25394 This option must always be set. It specifies which of the available
25395 authenticators is to be used.
25396
25397
25398 .option public_name authenticators string unset
25399 This option specifies the name of the authentication mechanism that the driver
25400 implements, and by which it is known to the outside world. These names should
25401 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25402 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25403 defaults to the driver's instance name.
25404
25405
25406 .option server_advertise_condition authenticators string&!! unset
25407 When a server is about to advertise an authentication mechanism, the condition
25408 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25409 mechanism is not advertised.
25410 If the expansion fails, the mechanism is not advertised. If the failure was not
25411 forced, and was not caused by a lookup defer, the incident is logged.
25412 See section &<<SECTauthexiser>>& below for further discussion.
25413
25414
25415 .option server_condition authenticators string&!! unset
25416 This option must be set for a &%plaintext%& server authenticator, where it
25417 is used directly to control authentication. See section &<<SECTplainserver>>&
25418 for details.
25419
25420 For the &(gsasl)& authenticator, this option is required for various
25421 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25422
25423 For the other authenticators, &%server_condition%& can be used as an additional
25424 authentication or authorization mechanism that is applied after the other
25425 authenticator conditions succeed. If it is set, it is expanded when the
25426 authenticator would otherwise return a success code. If the expansion is forced
25427 to fail, authentication fails. Any other expansion failure causes a temporary
25428 error code to be returned. If the result of a successful expansion is an empty
25429 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25430 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25431 other result, a temporary error code is returned, with the expanded string as
25432 the error text.
25433
25434
25435 .option server_debug_print authenticators string&!! unset
25436 If this option is set and authentication debugging is enabled (see the &%-d%&
25437 command line option), the string is expanded and included in the debugging
25438 output when the authenticator is run as a server. This can help with checking
25439 out the values of variables.
25440 If expansion of the string fails, the error message is written to the debugging
25441 output, and Exim carries on processing.
25442
25443
25444 .option server_set_id authenticators string&!! unset
25445 .vindex "&$authenticated_id$&"
25446 When an Exim server successfully authenticates a client, this string is
25447 expanded using data from the authentication, and preserved for any incoming
25448 messages in the variable &$authenticated_id$&. It is also included in the log
25449 lines for incoming messages. For example, a user/password authenticator
25450 configuration might preserve the user name that was used to authenticate, and
25451 refer to it subsequently during delivery of the message.
25452 If expansion fails, the option is ignored.
25453
25454
25455 .option server_mail_auth_condition authenticators string&!! unset
25456 This option allows a server to discard authenticated sender addresses supplied
25457 as part of MAIL commands in SMTP connections that are authenticated by the
25458 driver on which &%server_mail_auth_condition%& is set. The option is not used
25459 as part of the authentication process; instead its (unexpanded) value is
25460 remembered for later use.
25461 How it is used is described in the following section.
25462
25463
25464
25465
25466
25467 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25468 .cindex "authentication" "sender; authenticated"
25469 .cindex "AUTH" "on MAIL command"
25470 When a client supplied an AUTH= item on a MAIL command, Exim applies
25471 the following checks before accepting it as the authenticated sender of the
25472 message:
25473
25474 .ilist
25475 If the connection is not using extended SMTP (that is, HELO was used rather
25476 than EHLO), the use of AUTH= is a syntax error.
25477 .next
25478 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25479 .next
25480 .vindex "&$authenticated_sender$&"
25481 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25482 running, the value of &$authenticated_sender$& is set to the value obtained
25483 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25484 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25485 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25486 given for the MAIL command.
25487 .next
25488 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25489 is accepted and placed in &$authenticated_sender$& only if the client has
25490 authenticated.
25491 .next
25492 If the AUTH= value was accepted by either of the two previous rules, and
25493 the client has authenticated, and the authenticator has a setting for the
25494 &%server_mail_auth_condition%&, the condition is checked at this point. The
25495 valued that was saved from the authenticator is expanded. If the expansion
25496 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25497 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25498 the value of &$authenticated_sender$& is retained and passed on with the
25499 message.
25500 .endlist
25501
25502
25503 When &$authenticated_sender$& is set for a message, it is passed on to other
25504 hosts to which Exim authenticates as a client. Do not confuse this value with
25505 &$authenticated_id$&, which is a string obtained from the authentication
25506 process, and which is not usually a complete email address.
25507
25508 .vindex "&$sender_address$&"
25509 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25510 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25511 therefore make use of &$authenticated_sender$&. The converse is not true: the
25512 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25513 ACL is run.
25514
25515
25516
25517 .section "Authentication on an Exim server" "SECTauthexiser"
25518 .cindex "authentication" "on an Exim server"
25519 When Exim receives an EHLO command, it advertises the public names of those
25520 authenticators that are configured as servers, subject to the following
25521 conditions:
25522
25523 .ilist
25524 The client host must match &%auth_advertise_hosts%& (default *).
25525 .next
25526 It the &%server_advertise_condition%& option is set, its expansion must not
25527 yield the empty string, &"0"&, &"no"&, or &"false"&.
25528 .endlist
25529
25530 The order in which the authenticators are defined controls the order in which
25531 the mechanisms are advertised.
25532
25533 Some mail clients (for example, some versions of Netscape) require the user to
25534 provide a name and password for authentication whenever AUTH is advertised,
25535 even though authentication may not in fact be needed (for example, Exim may be
25536 set up to allow unconditional relaying from the client by an IP address check).
25537 You can make such clients more friendly by not advertising AUTH to them.
25538 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25539 that runs for RCPT) to relay without authentication, you should set
25540 .code
25541 auth_advertise_hosts = ! 10.9.8.0/24
25542 .endd
25543 so that no authentication mechanisms are advertised to them.
25544
25545 The &%server_advertise_condition%& controls the advertisement of individual
25546 authentication mechanisms. For example, it can be used to restrict the
25547 advertisement of a particular mechanism to encrypted connections, by a setting
25548 such as:
25549 .code
25550 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25551 .endd
25552 .vindex "&$tls_in_cipher$&"
25553 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25554 yields &"yes"&, which allows the advertisement to happen.
25555
25556 When an Exim server receives an AUTH command from a client, it rejects it
25557 immediately if AUTH was not advertised in response to an earlier EHLO
25558 command. This is the case if
25559
25560 .ilist
25561 The client host does not match &%auth_advertise_hosts%&; or
25562 .next
25563 No authenticators are configured with server options; or
25564 .next
25565 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25566 server authenticators.
25567 .endlist
25568
25569
25570 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25571 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25572 AUTH is accepted from any client host.
25573
25574 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25575 server authentication mechanism that was advertised in response to EHLO and
25576 that matches the one named in the AUTH command. If it finds one, it runs
25577 the appropriate authentication protocol, and authentication either succeeds or
25578 fails. If there is no matching advertised mechanism, the AUTH command is
25579 rejected with a 504 error.
25580
25581 .vindex "&$received_protocol$&"
25582 .vindex "&$sender_host_authenticated$&"
25583 When a message is received from an authenticated host, the value of
25584 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25585 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25586 public name) of the authenticator driver that successfully authenticated the
25587 client from which the message was received. This variable is empty if there was
25588 no successful authentication.
25589
25590
25591
25592
25593 .section "Testing server authentication" "SECID169"
25594 .cindex "authentication" "testing a server"
25595 .cindex "AUTH" "testing a server"
25596 .cindex "base64 encoding" "creating authentication test data"
25597 Exim's &%-bh%& option can be useful for testing server authentication
25598 configurations. The data for the AUTH command has to be sent using base64
25599 encoding. A quick way to produce such data for testing is the following Perl
25600 script:
25601 .code
25602 use MIME::Base64;
25603 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25604 .endd
25605 .cindex "binary zero" "in authentication data"
25606 This interprets its argument as a Perl string, and then encodes it. The
25607 interpretation as a Perl string allows binary zeros, which are required for
25608 some kinds of authentication, to be included in the data. For example, a
25609 command line to run this script on such data might be
25610 .code
25611 encode '\0user\0password'
25612 .endd
25613 Note the use of single quotes to prevent the shell interpreting the
25614 backslashes, so that they can be interpreted by Perl to specify characters
25615 whose code value is zero.
25616
25617 &*Warning 1*&: If either of the user or password strings starts with an octal
25618 digit, you must use three zeros instead of one after the leading backslash. If
25619 you do not, the octal digit that starts your string will be incorrectly
25620 interpreted as part of the code for the first character.
25621
25622 &*Warning 2*&: If there are characters in the strings that Perl interprets
25623 specially, you must use a Perl escape to prevent them being misinterpreted. For
25624 example, a command such as
25625 .code
25626 encode '\0user@domain.com\0pas$$word'
25627 .endd
25628 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25629
25630 If you have the &%mimencode%& command installed, another way to do produce
25631 base64-encoded strings is to run the command
25632 .code
25633 echo -e -n `\0user\0password' | mimencode
25634 .endd
25635 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25636 in the argument, and the &%-n%& option specifies no newline at the end of its
25637 output. However, not all versions of &%echo%& recognize these options, so you
25638 should check your version before relying on this suggestion.
25639
25640
25641
25642 .section "Authentication by an Exim client" "SECID170"
25643 .cindex "authentication" "on an Exim client"
25644 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25645 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25646 announces support for authentication, and the host matches an entry in either
25647 of these options, Exim (as a client) tries to authenticate as follows:
25648
25649 .ilist
25650 For each authenticator that is configured as a client, in the order in which
25651 they are defined in the configuration, it searches the authentication
25652 mechanisms announced by the server for one whose name matches the public name
25653 of the authenticator.
25654 .next
25655 .vindex "&$host$&"
25656 .vindex "&$host_address$&"
25657 When it finds one that matches, it runs the authenticator's client code. The
25658 variables &$host$& and &$host_address$& are available for any string expansions
25659 that the client might do. They are set to the server's name and IP address. If
25660 any expansion is forced to fail, the authentication attempt is abandoned, and
25661 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25662 delivery to be deferred.
25663 .next
25664 If the result of the authentication attempt is a temporary error or a timeout,
25665 Exim abandons trying to send the message to the host for the moment. It will
25666 try again later. If there are any backup hosts available, they are tried in the
25667 usual way.
25668 .next
25669 If the response to authentication is a permanent error (5&'xx'& code), Exim
25670 carries on searching the list of authenticators and tries another one if
25671 possible. If all authentication attempts give permanent errors, or if there are
25672 no attempts because no mechanisms match (or option expansions force failure),
25673 what happens depends on whether the host matches &%hosts_require_auth%& or
25674 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25675 delivery is deferred. The error can be detected in the retry rules, and thereby
25676 turned into a permanent error if you wish. In the second case, Exim tries to
25677 deliver the message unauthenticated.
25678 .endlist
25679
25680 .cindex "AUTH" "on MAIL command"
25681 When Exim has authenticated itself to a remote server, it adds the AUTH
25682 parameter to the MAIL commands it sends, if it has an authenticated sender for
25683 the message. If the message came from a remote host, the authenticated sender
25684 is the one that was receiving on an incoming MAIL command, provided that the
25685 incoming connection was authenticated and the &%server_mail_auth%& condition
25686 allowed the authenticated sender to be retained. If a local process calls Exim
25687 to send a message, the sender address that is built from the login name and
25688 &%qualify_domain%& is treated as authenticated. However, if the
25689 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25690 the authenticated sender that was received with the message.
25691 .ecindex IIDauthconf1
25692 .ecindex IIDauthconf2
25693
25694
25695
25696
25697
25698
25699 . ////////////////////////////////////////////////////////////////////////////
25700 . ////////////////////////////////////////////////////////////////////////////
25701
25702 .chapter "The plaintext authenticator" "CHAPplaintext"
25703 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25704 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25705 The &(plaintext)& authenticator can be configured to support the PLAIN and
25706 LOGIN authentication mechanisms, both of which transfer authentication data as
25707 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25708 security risk; you are strongly advised to insist on the use of SMTP encryption
25709 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25710 use unencrypted plain text, you should not use the same passwords for SMTP
25711 connections as you do for login accounts.
25712
25713 .section "Plaintext options" "SECID171"
25714 .cindex "options" "&(plaintext)& authenticator (server)"
25715 When configured as a server, &(plaintext)& uses the following options:
25716
25717 .option server_condition authenticators string&!! unset
25718 This is actually a global authentication option, but it must be set in order to
25719 configure the &(plaintext)& driver as a server. Its use is described below.
25720
25721 .option server_prompts plaintext string&!! unset
25722 The contents of this option, after expansion, must be a colon-separated list of
25723 prompt strings. If expansion fails, a temporary authentication rejection is
25724 given.
25725
25726 .section "Using plaintext in a server" "SECTplainserver"
25727 .cindex "AUTH" "in &(plaintext)& authenticator"
25728 .cindex "binary zero" "in &(plaintext)& authenticator"
25729 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25730         "in &(plaintext)& authenticator"
25731 .vindex "&$auth1$&, &$auth2$&, etc"
25732 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25733
25734 When running as a server, &(plaintext)& performs the authentication test by
25735 expanding a string. The data sent by the client with the AUTH command, or in
25736 response to subsequent prompts, is base64 encoded, and so may contain any byte
25737 values when decoded. If any data is supplied with the command, it is treated as
25738 a list of strings, separated by NULs (binary zeros), the first three of which
25739 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25740 (neither LOGIN nor PLAIN uses more than three strings).
25741
25742 For compatibility with previous releases of Exim, the values are also placed in
25743 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25744 variables for this purpose is now deprecated, as it can lead to confusion in
25745 string expansions that also use them for other things.
25746
25747 If there are more strings in &%server_prompts%& than the number of strings
25748 supplied with the AUTH command, the remaining prompts are used to obtain more
25749 data. Each response from the client may be a list of NUL-separated strings.
25750
25751 .vindex "&$authenticated_id$&"
25752 Once a sufficient number of data strings have been received,
25753 &%server_condition%& is expanded. If the expansion is forced to fail,
25754 authentication fails. Any other expansion failure causes a temporary error code
25755 to be returned. If the result of a successful expansion is an empty string,
25756 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25757 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25758 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25759 For any other result, a temporary error code is returned, with the expanded
25760 string as the error text
25761
25762 &*Warning*&: If you use a lookup in the expansion to find the user's
25763 password, be sure to make the authentication fail if the user is unknown.
25764 There are good and bad examples at the end of the next section.
25765
25766
25767
25768 .section "The PLAIN authentication mechanism" "SECID172"
25769 .cindex "PLAIN authentication mechanism"
25770 .cindex "authentication" "PLAIN mechanism"
25771 .cindex "binary zero" "in &(plaintext)& authenticator"
25772 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25773 sent as one item of data (that is, one combined string containing two NUL
25774 separators). The data is sent either as part of the AUTH command, or
25775 subsequently in response to an empty prompt from the server.
25776
25777 The second and third strings are a user name and a corresponding password.
25778 Using a single fixed user name and password as an example, this could be
25779 configured as follows:
25780 .code
25781 fixed_plain:
25782   driver = plaintext
25783   public_name = PLAIN
25784   server_prompts = :
25785   server_condition = \
25786     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25787   server_set_id = $auth2
25788 .endd
25789 Note that the default result strings from &%if%& (&"true"& or an empty string)
25790 are exactly what we want here, so they need not be specified. Obviously, if the
25791 password contains expansion-significant characters such as dollar, backslash,
25792 or closing brace, they have to be escaped.
25793
25794 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25795 the end of a string list are ignored). If all the data comes as part of the
25796 AUTH command, as is commonly the case, the prompt is not used. This
25797 authenticator is advertised in the response to EHLO as
25798 .code
25799 250-AUTH PLAIN
25800 .endd
25801 and a client host can authenticate itself by sending the command
25802 .code
25803 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25804 .endd
25805 As this contains three strings (more than the number of prompts), no further
25806 data is required from the client. Alternatively, the client may just send
25807 .code
25808 AUTH PLAIN
25809 .endd
25810 to initiate authentication, in which case the server replies with an empty
25811 prompt. The client must respond with the combined data string.
25812
25813 The data string is base64 encoded, as required by the RFC. This example,
25814 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25815 represents a zero byte. This is split up into three strings, the first of which
25816 is empty. The &%server_condition%& option in the authenticator checks that the
25817 second two are &`username`& and &`mysecret`& respectively.
25818
25819 Having just one fixed user name and password, as in this example, is not very
25820 realistic, though for a small organization with only a handful of
25821 authenticating clients it could make sense.
25822
25823 A more sophisticated instance of this authenticator could use the user name in
25824 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25825 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25826 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25827 This is an incorrect example:
25828 .code
25829 server_condition = \
25830   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25831 .endd
25832 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25833 which it then compares to the supplied password (&$auth3$&). Why is this example
25834 incorrect? It works fine for existing users, but consider what happens if a
25835 non-existent user name is given. The lookup fails, but as no success/failure
25836 strings are given for the lookup, it yields an empty string. Thus, to defeat
25837 the authentication, all a client has to do is to supply a non-existent user
25838 name and an empty password. The correct way of writing this test is:
25839 .code
25840 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25841   {${if eq{$value}{$auth3}}} {false}}
25842 .endd
25843 In this case, if the lookup succeeds, the result is checked; if the lookup
25844 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25845 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25846 always fails if its second argument is empty. However, the second way of
25847 writing the test makes the logic clearer.
25848
25849
25850 .section "The LOGIN authentication mechanism" "SECID173"
25851 .cindex "LOGIN authentication mechanism"
25852 .cindex "authentication" "LOGIN mechanism"
25853 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25854 in a number of programs. No data is sent with the AUTH command. Instead, a
25855 user name and password are supplied separately, in response to prompts. The
25856 plaintext authenticator can be configured to support this as in this example:
25857 .code
25858 fixed_login:
25859   driver = plaintext
25860   public_name = LOGIN
25861   server_prompts = User Name : Password
25862   server_condition = \
25863     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25864   server_set_id = $auth1
25865 .endd
25866 Because of the way plaintext operates, this authenticator accepts data supplied
25867 with the AUTH command (in contravention of the specification of LOGIN), but
25868 if the client does not supply it (as is the case for LOGIN clients), the prompt
25869 strings are used to obtain two data items.
25870
25871 Some clients are very particular about the precise text of the prompts. For
25872 example, Outlook Express is reported to recognize only &"Username:"& and
25873 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25874 strings. It uses the &%ldapauth%& expansion condition to check the user
25875 name and password by binding to an LDAP server:
25876 .code
25877 login:
25878   driver = plaintext
25879   public_name = LOGIN
25880   server_prompts = Username:: : Password::
25881   server_condition = ${if and{{ \
25882     !eq{}{$auth1} }{ \
25883     ldapauth{\
25884       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25885       pass=${quote:$auth2} \
25886       ldap://ldap.example.org/} }} }
25887   server_set_id = uid=$auth1,ou=people,o=example.org
25888 .endd
25889 We have to check that the username is not empty before using it, because LDAP
25890 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25891 operator to correctly quote the DN for authentication. However, the basic
25892 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25893 correct one to use for the password, because quoting is needed only to make
25894 the password conform to the Exim syntax. At the LDAP level, the password is an
25895 uninterpreted string.
25896
25897
25898 .section "Support for different kinds of authentication" "SECID174"
25899 A number of string expansion features are provided for the purpose of
25900 interfacing to different ways of user authentication. These include checking
25901 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25902 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25903 &<<SECTexpcond>>&.
25904
25905
25906
25907
25908 .section "Using plaintext in a client" "SECID175"
25909 .cindex "options" "&(plaintext)& authenticator (client)"
25910 The &(plaintext)& authenticator has two client options:
25911
25912 .option client_ignore_invalid_base64 plaintext boolean false
25913 If the client receives a server prompt that is not a valid base64 string,
25914 authentication is abandoned by default. However, if this option is set true,
25915 the error in the challenge is ignored and the client sends the response as
25916 usual.
25917
25918 .option client_send plaintext string&!! unset
25919 The string is a colon-separated list of authentication data strings. Each
25920 string is independently expanded before being sent to the server. The first
25921 string is sent with the AUTH command; any more strings are sent in response
25922 to prompts from the server. Before each string is expanded, the value of the
25923 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25924 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25925 way. Thus, the prompt that is received in response to sending the first string
25926 (with the AUTH command) can be used in the expansion of the second string, and
25927 so on. If an invalid base64 string is received when
25928 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25929 &$auth$&<&'n'&> variable.
25930
25931 &*Note*&: You cannot use expansion to create multiple strings, because
25932 splitting takes priority and happens first.
25933
25934 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25935 the data, further processing is applied to each string before it is sent. If
25936 there are any single circumflex characters in the string, they are converted to
25937 NULs. Should an actual circumflex be required as data, it must be doubled in
25938 the string.
25939
25940 This is an example of a client configuration that implements the PLAIN
25941 authentication mechanism with a fixed user name and password:
25942 .code
25943 fixed_plain:
25944   driver = plaintext
25945   public_name = PLAIN
25946   client_send = ^username^mysecret
25947 .endd
25948 The lack of colons means that the entire text is sent with the AUTH
25949 command, with the circumflex characters converted to NULs. A similar example
25950 that uses the LOGIN mechanism is:
25951 .code
25952 fixed_login:
25953   driver = plaintext
25954   public_name = LOGIN
25955   client_send = : username : mysecret
25956 .endd
25957 The initial colon means that the first string is empty, so no data is sent with
25958 the AUTH command itself. The remaining strings are sent in response to
25959 prompts.
25960 .ecindex IIDplaiauth1
25961 .ecindex IIDplaiauth2
25962
25963
25964
25965
25966 . ////////////////////////////////////////////////////////////////////////////
25967 . ////////////////////////////////////////////////////////////////////////////
25968
25969 .chapter "The cram_md5 authenticator" "CHID9"
25970 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25971 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25972 .cindex "CRAM-MD5 authentication mechanism"
25973 .cindex "authentication" "CRAM-MD5 mechanism"
25974 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25975 sends a challenge string to the client, and the response consists of a user
25976 name and the CRAM-MD5 digest of the challenge string combined with a secret
25977 string (password) which is known to both server and client. Thus, the secret
25978 is not sent over the network as plain text, which makes this authenticator more
25979 secure than &(plaintext)&. However, the downside is that the secret has to be
25980 available in plain text at either end.
25981
25982
25983 .section "Using cram_md5 as a server" "SECID176"
25984 .cindex "options" "&(cram_md5)& authenticator (server)"
25985 This authenticator has one server option, which must be set to configure the
25986 authenticator as a server:
25987
25988 .option server_secret cram_md5 string&!! unset
25989 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25990 When the server receives the client's response, the user name is placed in
25991 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25992 obtain the password for that user. The server then computes the CRAM-MD5 digest
25993 that the client should have sent, and checks that it received the correct
25994 string. If the expansion of &%server_secret%& is forced to fail, authentication
25995 fails. If the expansion fails for some other reason, a temporary error code is
25996 returned to the client.
25997
25998 For compatibility with previous releases of Exim, the user name is also placed
25999 in &$1$&. However, the use of this variables for this purpose is now
26000 deprecated, as it can lead to confusion in string expansions that also use
26001 numeric variables for other things.
26002
26003 For example, the following authenticator checks that the user name given by the
26004 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26005 user name, authentication fails.
26006 .code
26007 fixed_cram:
26008   driver = cram_md5
26009   public_name = CRAM-MD5
26010   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26011   server_set_id = $auth1
26012 .endd
26013 .vindex "&$authenticated_id$&"
26014 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26015 name in &$authenticated_id$&. A more typical configuration might look up the
26016 secret string in a file, using the user name as the key. For example:
26017 .code
26018 lookup_cram:
26019   driver = cram_md5
26020   public_name = CRAM-MD5
26021   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26022                   {$value}fail}
26023   server_set_id = $auth1
26024 .endd
26025 Note that this expansion explicitly forces failure if the lookup fails
26026 because &$auth1$& contains an unknown user name.
26027
26028 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26029 using the relevant libraries, you need to know the realm to specify in the
26030 lookup and then ask for the &"userPassword"& attribute for that user in that
26031 realm, with:
26032 .code
26033 cyrusless_crammd5:
26034   driver = cram_md5
26035   public_name = CRAM-MD5
26036   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26037                   dbmjz{/etc/sasldb2}{$value}fail}
26038   server_set_id = $auth1
26039 .endd
26040
26041 .section "Using cram_md5 as a client" "SECID177"
26042 .cindex "options" "&(cram_md5)& authenticator (client)"
26043 When used as a client, the &(cram_md5)& authenticator has two options:
26044
26045
26046
26047 .option client_name cram_md5 string&!! "the primary host name"
26048 This string is expanded, and the result used as the user name data when
26049 computing the response to the server's challenge.
26050
26051
26052 .option client_secret cram_md5 string&!! unset
26053 This option must be set for the authenticator to work as a client. Its value is
26054 expanded and the result used as the secret string when computing the response.
26055
26056
26057 .vindex "&$host$&"
26058 .vindex "&$host_address$&"
26059 Different user names and secrets can be used for different servers by referring
26060 to &$host$& or &$host_address$& in the options. Forced failure of either
26061 expansion string is treated as an indication that this authenticator is not
26062 prepared to handle this case. Exim moves on to the next configured client
26063 authenticator. Any other expansion failure causes Exim to give up trying to
26064 send the message to the current server.
26065
26066 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26067 strings, is:
26068 .code
26069 fixed_cram:
26070   driver = cram_md5
26071   public_name = CRAM-MD5
26072   client_name = ph10
26073   client_secret = secret
26074 .endd
26075 .ecindex IIDcramauth1
26076 .ecindex IIDcramauth2
26077
26078
26079
26080 . ////////////////////////////////////////////////////////////////////////////
26081 . ////////////////////////////////////////////////////////////////////////////
26082
26083 .chapter "The cyrus_sasl authenticator" "CHID10"
26084 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26085 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26086 .cindex "Cyrus" "SASL library"
26087 .cindex "Kerberos"
26088 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26089 Digital Ltd (&url(http://www.aldigital.co.uk)).
26090
26091 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26092 library implementation of the RFC 2222 (&"Simple Authentication and Security
26093 Layer"&). This library supports a number of authentication mechanisms,
26094 including PLAIN and LOGIN, but also several others that Exim does not support
26095 directly. In particular, there is support for Kerberos authentication.
26096
26097 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26098 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26099 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26100 name of the driver to determine which mechanism to support.
26101
26102 Where access to some kind of secret file is required, for example in GSSAPI
26103 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26104 user, and that the Cyrus SASL library has no way of escalating privileges
26105 by default. You may also find you need to set environment variables,
26106 depending on the driver you are using.
26107
26108 The application name provided by Exim is &"exim"&, so various SASL options may
26109 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26110 Kerberos, note that because of limitations in the GSSAPI interface,
26111 changing the server keytab might need to be communicated down to the Kerberos
26112 layer independently. The mechanism for doing so is dependent upon the Kerberos
26113 implementation.
26114
26115 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26116 may be set to point to an alternative keytab file. Exim will pass this
26117 variable through from its own inherited environment when started as root or the
26118 Exim user. The keytab file needs to be readable by the Exim user.
26119 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26120 environment variable.  In practice, for those releases, the Cyrus authenticator
26121 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26122 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26123
26124
26125 .section "Using cyrus_sasl as a server" "SECID178"
26126 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26127 (on a successful authentication) into &$auth1$&. For compatibility with
26128 previous releases of Exim, the username is also placed in &$1$&. However, the
26129 use of this variable for this purpose is now deprecated, as it can lead to
26130 confusion in string expansions that also use numeric variables for other
26131 things.
26132
26133
26134 .option server_hostname cyrus_sasl string&!! "see below"
26135 This option selects the hostname that is used when communicating with the
26136 library. The default value is &`$primary_hostname`&. It is up to the underlying
26137 SASL plug-in what it does with this data.
26138
26139
26140 .option server_mech cyrus_sasl string "see below"
26141 This option selects the authentication mechanism this driver should use. The
26142 default is the value of the generic &%public_name%& option. This option allows
26143 you to use a different underlying mechanism from the advertised name. For
26144 example:
26145 .code
26146 sasl:
26147   driver = cyrus_sasl
26148   public_name = X-ANYTHING
26149   server_mech = CRAM-MD5
26150   server_set_id = $auth1
26151 .endd
26152
26153 .option server_realm cyrus_sasl string&!! unset
26154 This specifies the SASL realm that the server claims to be in.
26155
26156
26157 .option server_service cyrus_sasl string &`smtp`&
26158 This is the SASL service that the server claims to implement.
26159
26160
26161 For straightforward cases, you do not need to set any of the authenticator's
26162 private options. All you need to do is to specify an appropriate mechanism as
26163 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26164 PLAIN, you could have two authenticators as follows:
26165 .code
26166 sasl_cram_md5:
26167   driver = cyrus_sasl
26168   public_name = CRAM-MD5
26169   server_set_id = $auth1
26170
26171 sasl_plain:
26172   driver = cyrus_sasl
26173   public_name = PLAIN
26174   server_set_id = $auth2
26175 .endd
26176 Cyrus SASL does implement the LOGIN authentication method, even though it is
26177 not a standard method. It is disabled by default in the source distribution,
26178 but it is present in many binary distributions.
26179 .ecindex IIDcyrauth1
26180 .ecindex IIDcyrauth2
26181
26182
26183
26184
26185 . ////////////////////////////////////////////////////////////////////////////
26186 . ////////////////////////////////////////////////////////////////////////////
26187 .chapter "The dovecot authenticator" "CHAPdovecot"
26188 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26189 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26190 This authenticator is an interface to the authentication facility of the
26191 Dovecot POP/IMAP server, which can support a number of authentication methods.
26192 Note that Dovecot must be configured to use auth-client not auth-userdb.
26193 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26194 to use the same mechanisms for SMTP authentication. This is a server
26195 authenticator only. There is only one option:
26196
26197 .option server_socket dovecot string unset
26198
26199 This option must specify the socket that is the interface to Dovecot
26200 authentication. The &%public_name%& option must specify an authentication
26201 mechanism that Dovecot is configured to support. You can have several
26202 authenticators for different mechanisms. For example:
26203 .code
26204 dovecot_plain:
26205   driver = dovecot
26206   public_name = PLAIN
26207   server_socket = /var/run/dovecot/auth-client
26208   server_set_id = $auth1
26209
26210 dovecot_ntlm:
26211   driver = dovecot
26212   public_name = NTLM
26213   server_socket = /var/run/dovecot/auth-client
26214   server_set_id = $auth1
26215 .endd
26216 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26217 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26218 option is passed in the Dovecot authentication command. If, for a TLS
26219 connection, a client certificate has been verified, the &"valid-client-cert"&
26220 option is passed. When authentication succeeds, the identity of the user
26221 who authenticated is placed in &$auth1$&.
26222 .ecindex IIDdcotauth1
26223 .ecindex IIDdcotauth2
26224
26225
26226 . ////////////////////////////////////////////////////////////////////////////
26227 . ////////////////////////////////////////////////////////////////////////////
26228 .chapter "The gsasl authenticator" "CHAPgsasl"
26229 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26230 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26231 .cindex "authentication" "GNU SASL"
26232 .cindex "authentication" "SASL"
26233 .cindex "authentication" "EXTERNAL"
26234 .cindex "authentication" "ANONYMOUS"
26235 .cindex "authentication" "PLAIN"
26236 .cindex "authentication" "LOGIN"
26237 .cindex "authentication" "DIGEST-MD5"
26238 .cindex "authentication" "CRAM-MD5"
26239 .cindex "authentication" "SCRAM-SHA-1"
26240 The &(gsasl)& authenticator provides server integration for the GNU SASL
26241 library and the mechanisms it provides.  This is new as of the 4.80 release
26242 and there are a few areas where the library does not let Exim smoothly
26243 scale to handle future authentication mechanisms, so no guarantee can be
26244 made that any particular new authentication mechanism will be supported
26245 without code changes in Exim.
26246
26247
26248 .option server_channelbinding gsasl boolean false
26249 Some authentication mechanisms are able to use external context at both ends
26250 of the session to bind the authentication to that context, and fail the
26251 authentication process if that context differs.  Specifically, some TLS
26252 ciphersuites can provide identifying information about the cryptographic
26253 context.
26254
26255 This means that certificate identity and verification becomes a non-issue,
26256 as a man-in-the-middle attack will cause the correct client and server to
26257 see different identifiers and authentication will fail.
26258
26259 This is currently only supported when using the GnuTLS library.  This is
26260 only usable by mechanisms which support "channel binding"; at time of
26261 writing, that's the SCRAM family.
26262
26263 This defaults off to ensure smooth upgrade across Exim releases, in case
26264 this option causes some clients to start failing.  Some future release
26265 of Exim may switch the default to be true.
26266
26267
26268 .option server_hostname gsasl string&!! "see below"
26269 This option selects the hostname that is used when communicating with the
26270 library. The default value is &`$primary_hostname`&.
26271 Some mechanisms will use this data.
26272
26273
26274 .option server_mech gsasl string "see below"
26275 This option selects the authentication mechanism this driver should use. The
26276 default is the value of the generic &%public_name%& option. This option allows
26277 you to use a different underlying mechanism from the advertised name. For
26278 example:
26279 .code
26280 sasl:
26281   driver = gsasl
26282   public_name = X-ANYTHING
26283   server_mech = CRAM-MD5
26284   server_set_id = $auth1
26285 .endd
26286
26287
26288 .option server_password gsasl string&!! unset
26289 Various mechanisms need access to the cleartext password on the server, so
26290 that proof-of-possession can be demonstrated on the wire, without sending
26291 the password itself.
26292
26293 The data available for lookup varies per mechanism.
26294 In all cases, &$auth1$& is set to the &'authentication id'&.
26295 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26296 if available, else the empty string.
26297 The &$auth3$& variable will always be the &'realm'& if available,
26298 else the empty string.
26299
26300 A forced failure will cause authentication to defer.
26301
26302 If using this option, it may make sense to set the &%server_condition%&
26303 option to be simply "true".
26304
26305
26306 .option server_realm gsasl string&!! unset
26307 This specifies the SASL realm that the server claims to be in.
26308 Some mechanisms will use this data.
26309
26310
26311 .option server_scram_iter gsasl string&!! unset
26312 This option provides data for the SCRAM family of mechanisms.
26313 &$auth1$& is not available at evaluation time.
26314 (This may change, as we receive feedback on use)
26315
26316
26317 .option server_scram_salt gsasl string&!! unset
26318 This option provides data for the SCRAM family of mechanisms.
26319 &$auth1$& is not available at evaluation time.
26320 (This may change, as we receive feedback on use)
26321
26322
26323 .option server_service gsasl string &`smtp`&
26324 This is the SASL service that the server claims to implement.
26325 Some mechanisms will use this data.
26326
26327
26328 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26329 .vindex "&$auth1$&, &$auth2$&, etc"
26330 These may be set when evaluating specific options, as detailed above.
26331 They will also be set when evaluating &%server_condition%&.
26332
26333 Unless otherwise stated below, the &(gsasl)& integration will use the following
26334 meanings for these variables:
26335
26336 .ilist
26337 .vindex "&$auth1$&"
26338 &$auth1$&: the &'authentication id'&
26339 .next
26340 .vindex "&$auth2$&"
26341 &$auth2$&: the &'authorization id'&
26342 .next
26343 .vindex "&$auth3$&"
26344 &$auth3$&: the &'realm'&
26345 .endlist
26346
26347 On a per-mechanism basis:
26348
26349 .ilist
26350 .cindex "authentication" "EXTERNAL"
26351 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26352 the &%server_condition%& option must be present.
26353 .next
26354 .cindex "authentication" "ANONYMOUS"
26355 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26356 the &%server_condition%& option must be present.
26357 .next
26358 .cindex "authentication" "GSSAPI"
26359 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26360 &$auth2$& will be set to the &'authorization id'&,
26361 the &%server_condition%& option must be present.
26362 .endlist
26363
26364 An &'anonymous token'& is something passed along as an unauthenticated
26365 identifier; this is analogous to FTP anonymous authentication passing an
26366 email address, or software-identifier@, as the "password".
26367
26368
26369 An example showing the password having the realm specified in the callback
26370 and demonstrating a Cyrus SASL to GSASL migration approach is:
26371 .code
26372 gsasl_cyrusless_crammd5:
26373   driver = gsasl
26374   public_name = CRAM-MD5
26375   server_realm = imap.example.org
26376   server_password = ${lookup{$auth1:$auth3:userPassword}\
26377                     dbmjz{/etc/sasldb2}{$value}fail}
26378   server_set_id = ${quote:$auth1}
26379   server_condition = yes
26380 .endd
26381
26382
26383 . ////////////////////////////////////////////////////////////////////////////
26384 . ////////////////////////////////////////////////////////////////////////////
26385
26386 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26387 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26388 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26389 .cindex "authentication" "GSSAPI"
26390 .cindex "authentication" "Kerberos"
26391 The &(heimdal_gssapi)& authenticator provides server integration for the
26392 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26393 reliably.
26394
26395 .option server_hostname heimdal_gssapi string&!! "see below"
26396 This option selects the hostname that is used, with &%server_service%&,
26397 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26398 identifier.  The default value is &`$primary_hostname`&.
26399
26400 .option server_keytab heimdal_gssapi string&!! unset
26401 If set, then Heimdal will not use the system default keytab (typically
26402 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26403 The value should be a pathname, with no &"file:"& prefix.
26404
26405 .option server_service heimdal_gssapi string&!! "smtp"
26406 This option specifies the service identifier used, in conjunction with
26407 &%server_hostname%&, for building the identifier for finding credentials
26408 from the keytab.
26409
26410
26411 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26412 Beware that these variables will typically include a realm, thus will appear
26413 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26414 not verified, so a malicious client can set it to anything.
26415
26416 The &$auth1$& field should be safely trustable as a value from the Key
26417 Distribution Center.  Note that these are not quite email addresses.
26418 Each identifier is for a role, and so the left-hand-side may include a
26419 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26420
26421 .vindex "&$auth1$&, &$auth2$&, etc"
26422 .ilist
26423 .vindex "&$auth1$&"
26424 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26425 .next
26426 .vindex "&$auth2$&"
26427 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26428 authentication.  If that was empty, this will also be set to the
26429 GSS Display Name.
26430 .endlist
26431
26432
26433 . ////////////////////////////////////////////////////////////////////////////
26434 . ////////////////////////////////////////////////////////////////////////////
26435
26436 .chapter "The spa authenticator" "CHAPspa"
26437 .scindex IIDspaauth1 "&(spa)& authenticator"
26438 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26439 .cindex "authentication" "Microsoft Secure Password"
26440 .cindex "authentication" "NTLM"
26441 .cindex "Microsoft Secure Password Authentication"
26442 .cindex "NTLM authentication"
26443 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26444 Password Authentication'& mechanism,
26445 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26446 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26447 taken from the Samba project (&url(http://www.samba.org)). The code for the
26448 server side was subsequently contributed by Tom Kistner. The mechanism works as
26449 follows:
26450
26451 .ilist
26452 After the AUTH command has been accepted, the client sends an SPA
26453 authentication request based on the user name and optional domain.
26454 .next
26455 The server sends back a challenge.
26456 .next
26457 The client builds a challenge response which makes use of the user's password
26458 and sends it to the server, which then accepts or rejects it.
26459 .endlist
26460
26461 Encryption is used to protect the password in transit.
26462
26463
26464
26465 .section "Using spa as a server" "SECID179"
26466 .cindex "options" "&(spa)& authenticator (server)"
26467 The &(spa)& authenticator has just one server option:
26468
26469 .option server_password spa string&!! unset
26470 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26471 This option is expanded, and the result must be the cleartext password for the
26472 authenticating user, whose name is at this point in &$auth1$&. For
26473 compatibility with previous releases of Exim, the user name is also placed in
26474 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26475 it can lead to confusion in string expansions that also use numeric variables
26476 for other things. For example:
26477 .code
26478 spa:
26479   driver = spa
26480   public_name = NTLM
26481   server_password = \
26482     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26483 .endd
26484 If the expansion is forced to fail, authentication fails. Any other expansion
26485 failure causes a temporary error code to be returned.
26486
26487
26488
26489
26490
26491 .section "Using spa as a client" "SECID180"
26492 .cindex "options" "&(spa)& authenticator (client)"
26493 The &(spa)& authenticator has the following client options:
26494
26495
26496
26497 .option client_domain spa string&!! unset
26498 This option specifies an optional domain for the authentication.
26499
26500
26501 .option client_password spa string&!! unset
26502 This option specifies the user's password, and must be set.
26503
26504
26505 .option client_username spa string&!! unset
26506 This option specifies the user name, and must be set. Here is an example of a
26507 configuration of this authenticator for use with the mail servers at
26508 &'msn.com'&:
26509 .code
26510 msn:
26511   driver = spa
26512   public_name = MSN
26513   client_username = msn/msn_username
26514   client_password = msn_plaintext_password
26515   client_domain = DOMAIN_OR_UNSET
26516 .endd
26517 .ecindex IIDspaauth1
26518 .ecindex IIDspaauth2
26519
26520
26521
26522
26523
26524 . ////////////////////////////////////////////////////////////////////////////
26525 . ////////////////////////////////////////////////////////////////////////////
26526
26527 .chapter "The tls authenticator" "CHAPtlsauth"
26528 .scindex IIDtlsauth1 "&(tls)& authenticator"
26529 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26530 .cindex "authentication" "Client Certificate"
26531 .cindex "authentication" "X509"
26532 .cindex "Certificate-based authentication"
26533 The &(tls)& authenticator provides server support for
26534 authentication based on client certificates.
26535
26536 It is not an SMTP authentication mechanism and is not
26537 advertised by the server as part of the SMTP EHLO response.
26538 It is an Exim authenticator in the sense that it affects
26539 the protocol element of the log line, can be tested for
26540 by the &%authenticated%& ACL condition, and can set
26541 the &$authenticated_id$& variable.
26542
26543 The client must present a verifiable certificate,
26544 for which it must have been requested via the
26545 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26546 (see &<<CHAPTLS>>&).
26547
26548 If an authenticator of this type is configured it is
26549 run before any SMTP-level communication is done,
26550 and can authenticate the connection.
26551 If it does, SMTP authentication is not offered.
26552
26553 A maximum of one authenticator of this type may be present.
26554
26555
26556 .cindex "options" "&(tls)& authenticator (server)"
26557 The &(tls)& authenticator has three server options:
26558
26559 .option server_param1 tls string&!! unset
26560 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26561 This option is expanded after the TLS negotiation and
26562 the result is placed in &$auth1$&.
26563 If the expansion is forced to fail, authentication fails. Any other expansion
26564 failure causes a temporary error code to be returned.
26565
26566 .option server_param2 tls string&!! unset
26567 .option server_param3 tls string&!! unset
26568 As above, for &$auth2$& and &$auth3$&.
26569
26570 &%server_param1%& may also be spelled &%server_param%&.
26571
26572
26573 Example:
26574 .code
26575 tls:
26576   driver = tls
26577   server_param1 =     ${certextract {subj_altname,mail,>:} \
26578                                     {$tls_in_peercert}}
26579   server_condition =  ${if forany {$auth1} \
26580                             {!= {0} \
26581                                 {${lookup ldap{ldap:///\
26582                          mailname=${quote_ldap_dn:${lc:$item}},\
26583                          ou=users,LDAP_DC?mailid} {$value}{0} \
26584                        }    }   } }
26585   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26586 .endd
26587 This accepts a client certificate that is verifiable against any
26588 of your configured trust-anchors
26589 which usually means the full set of public CAs)
26590 and which has a SAN with a good account name.
26591 Note that the client cert is on the wire in-clear, including the SAN,
26592 whereas a plaintext SMTP AUTH done inside TLS is not.
26593
26594 . An alternative might use
26595 . .code
26596 .   server_param1 = ${sha256:$tls_in_peercert}
26597 . .endd
26598 . to require one of a set of specific certs that define a given account
26599 . (the verification is still required, but mostly irrelevant).
26600 . This would help for per-device use.
26601 .
26602 . However, for the future we really need support for checking a
26603 . user cert in LDAP - which probably wants a base-64 DER.
26604
26605 .ecindex IIDtlsauth1
26606 .ecindex IIDtlsauth2
26607
26608
26609 Note that because authentication is traditionally an SMTP operation,
26610 the &%authenticated%& ACL condition cannot be used in
26611 a connect- or helo-ACL.
26612
26613
26614
26615 . ////////////////////////////////////////////////////////////////////////////
26616 . ////////////////////////////////////////////////////////////////////////////
26617
26618 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26619          "Encrypted SMTP connections"
26620 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26621 .scindex IIDencsmtp2 "SMTP" "encryption"
26622 .cindex "TLS" "on SMTP connection"
26623 .cindex "OpenSSL"
26624 .cindex "GnuTLS"
26625 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26626 Sockets Layer), is implemented by making use of the OpenSSL library or the
26627 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26628 cryptographic code in the Exim distribution itself for implementing TLS. In
26629 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26630 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26631 You also need to understand the basic concepts of encryption at a managerial
26632 level, and in particular, the way that public keys, private keys, and
26633 certificates are used.
26634
26635 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26636 connection is established, the client issues a STARTTLS command. If the
26637 server accepts this, the client and the server negotiate an encryption
26638 mechanism. If the negotiation succeeds, the data that subsequently passes
26639 between them is encrypted.
26640
26641 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26642 and if so, what cipher suite is in use, whether the client supplied a
26643 certificate, and whether or not that certificate was verified. This makes it
26644 possible for an Exim server to deny or accept certain commands based on the
26645 encryption state.
26646
26647 &*Warning*&: Certain types of firewall and certain anti-virus products can
26648 disrupt TLS connections. You need to turn off SMTP scanning for these products
26649 in order to get TLS to work.
26650
26651
26652
26653 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26654          "SECID284"
26655 .cindex "ssmtp protocol"
26656 .cindex "smtps protocol"
26657 .cindex "SMTP" "ssmtp protocol"
26658 .cindex "SMTP" "smtps protocol"
26659 Early implementations of encrypted SMTP used a different TCP port from normal
26660 SMTP, and expected an encryption negotiation to start immediately, instead of
26661 waiting for a STARTTLS command from the client using the standard SMTP
26662 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26663 allocated for this purpose.
26664
26665 This approach was abandoned when encrypted SMTP was standardized, but there are
26666 still some legacy clients that use it. Exim supports these clients by means of
26667 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26668 numbers; the most common use is expected to be:
26669 .code
26670 tls_on_connect_ports = 465
26671 .endd
26672 The port numbers specified by this option apply to all SMTP connections, both
26673 via the daemon and via &'inetd'&. You still need to specify all the ports that
26674 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26675 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26676 an extra port &-- rather, it specifies different behaviour on a port that is
26677 defined elsewhere.
26678
26679 There is also a &%-tls-on-connect%& command line option. This overrides
26680 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26681
26682
26683
26684
26685
26686
26687 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26688 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26689 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26690 followed later, when the first versions of GnuTLS were released. To build Exim
26691 to use GnuTLS, you need to set
26692 .code
26693 USE_GNUTLS=yes
26694 .endd
26695 in Local/Makefile, in addition to
26696 .code
26697 SUPPORT_TLS=yes
26698 .endd
26699 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26700 include files and libraries for GnuTLS can be found.
26701
26702 There are some differences in usage when using GnuTLS instead of OpenSSL:
26703
26704 .ilist
26705 The &%tls_verify_certificates%& option
26706 cannot be the path of a directory
26707 for GnuTLS versions before 3.3.6
26708 (for later versions, or OpenSSL, it can be either).
26709 .next
26710 The default value for &%tls_dhparam%& differs for historical reasons.
26711 .next
26712 .vindex "&$tls_in_peerdn$&"
26713 .vindex "&$tls_out_peerdn$&"
26714 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26715 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26716 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26717 .next
26718 OpenSSL identifies cipher suites using hyphens as separators, for example:
26719 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26720 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26721 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26722 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26723 to handle its own older variants) when processing lists of cipher suites in the
26724 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26725 option).
26726 .next
26727 The &%tls_require_ciphers%& options operate differently, as described in the
26728 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26729 .next
26730 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26731 When using OpenSSL, this option is ignored.
26732 (If an API is found to let OpenSSL be configured in this way,
26733 let the Exim Maintainers know and we'll likely use it).
26734 .next
26735 Some other recently added features may only be available in one or the other.
26736 This should be documented with the feature.  If the documentation does not
26737 explicitly state that the feature is infeasible in the other TLS
26738 implementation, then patches are welcome.
26739 .endlist
26740
26741
26742 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26743 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26744 an explicit path; if the latter, then the text about generation still applies,
26745 but not the chosen filename.
26746 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26747 See the documentation of &%tls_dhparam%& for more information.
26748
26749 GnuTLS uses D-H parameters that may take a substantial amount of time
26750 to compute. It is unreasonable to re-compute them for every TLS session.
26751 Therefore, Exim keeps this data in a file in its spool directory, called
26752 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26753 of bits requested.
26754 The file is owned by the Exim user and is readable only by
26755 its owner. Every Exim process that start up GnuTLS reads the D-H
26756 parameters from this file. If the file does not exist, the first Exim process
26757 that needs it computes the data and writes it to a temporary file which is
26758 renamed once it is complete. It does not matter if several Exim processes do
26759 this simultaneously (apart from wasting a few resources). Once a file is in
26760 place, new Exim processes immediately start using it.
26761
26762 For maximum security, the parameters that are stored in this file should be
26763 recalculated periodically, the frequency depending on your paranoia level.
26764 If you are avoiding using the fixed D-H primes published in RFCs, then you
26765 are concerned about some advanced attacks and will wish to do this; if you do
26766 not regenerate then you might as well stick to the standard primes.
26767
26768 Arranging this is easy in principle; just delete the file when you want new
26769 values to be computed. However, there may be a problem. The calculation of new
26770 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26771 If the system is not very active, &_/dev/random_& may delay returning data
26772 until enough randomness (entropy) is available. This may cause Exim to hang for
26773 a substantial amount of time, causing timeouts on incoming connections.
26774
26775 The solution is to generate the parameters externally to Exim. They are stored
26776 in &_gnutls-params-N_& in PEM format, which means that they can be
26777 generated externally using the &(certtool)& command that is part of GnuTLS.
26778
26779 To replace the parameters with new ones, instead of deleting the file
26780 and letting Exim re-create it, you can generate new parameters using
26781 &(certtool)& and, when this has been done, replace Exim's cache file by
26782 renaming. The relevant commands are something like this:
26783 .code
26784 # ls
26785 [ look for file; assume gnutls-params-2236 is the most recent ]
26786 # rm -f new-params
26787 # touch new-params
26788 # chown exim:exim new-params
26789 # chmod 0600 new-params
26790 # certtool --generate-dh-params --bits 2236 >>new-params
26791 # openssl dhparam -noout -text -in new-params | head
26792 [ check the first line, make sure it's not more than 2236;
26793   if it is, then go back to the start ("rm") and repeat
26794   until the size generated is at most the size requested ]
26795 # chmod 0400 new-params
26796 # mv new-params gnutls-params-2236
26797 .endd
26798 If Exim never has to generate the parameters itself, the possibility of
26799 stalling is removed.
26800
26801 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26802 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26803 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26804 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26805 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26806 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26807 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26808 which applies to all D-H usage, client or server.  If the value returned by
26809 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26810 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26811 limit, which is still much higher than Exim historically used.
26812
26813 The filename and bits used will change as the GnuTLS maintainers change the
26814 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26815 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26816 2432 bits, while NSS is limited to 2236 bits.
26817
26818 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26819 increase the chance of the generated prime actually being within acceptable
26820 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26821 procedure above.  There is no sane procedure available to Exim to double-check
26822 the size of the generated prime, so it might still be too large.
26823
26824
26825 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26826 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26827 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26828 There is a function in the OpenSSL library that can be passed a list of cipher
26829 suites before the cipher negotiation takes place. This specifies which ciphers
26830 are acceptable. The list is colon separated and may contain names like
26831 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26832 directly to this function call.
26833 Many systems will install the OpenSSL manual-pages, so you may have
26834 &'ciphers(1)'& available to you.
26835 The following quotation from the OpenSSL
26836 documentation specifies what forms of item are allowed in the cipher string:
26837
26838 .ilist
26839 It can consist of a single cipher suite such as RC4-SHA.
26840 .next
26841 It can represent a list of cipher suites containing a certain algorithm,
26842 or cipher suites of a certain type. For example SHA1 represents all
26843 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26844 SSL v3 algorithms.
26845 .next
26846 Lists of cipher suites can be combined in a single cipher string using
26847 the + character. This is used as a logical and operation. For example
26848 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26849 algorithms.
26850 .endlist
26851
26852 Each cipher string can be optionally preceded by one of the characters &`!`&,
26853 &`-`& or &`+`&.
26854 .ilist
26855 If &`!`& is used, the ciphers are permanently deleted from the list. The
26856 ciphers deleted can never reappear in the list even if they are explicitly
26857 stated.
26858 .next
26859 If &`-`& is used, the ciphers are deleted from the list, but some or all
26860 of the ciphers can be added again by later options.
26861 .next
26862 If &`+`& is used, the ciphers are moved to the end of the list. This
26863 option does not add any new ciphers; it just moves matching existing ones.
26864 .endlist
26865
26866 If none of these characters is present, the string is interpreted as
26867 a list of ciphers to be appended to the current preference list. If the list
26868 includes any ciphers already present they will be ignored: that is, they will
26869 not be moved to the end of the list.
26870 .endlist
26871
26872 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26873 string:
26874 .code
26875 # note single-quotes to get ! past any shell history expansion
26876 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26877 .endd
26878
26879 This example will let the library defaults be permitted on the MX port, where
26880 there's probably no identity verification anyway, but ups the ante on the
26881 submission ports where the administrator might have some influence on the
26882 choice of clients used:
26883 .code
26884 # OpenSSL variant; see man ciphers(1)
26885 tls_require_ciphers = ${if =={$received_port}{25}\
26886                            {DEFAULT}\
26887                            {HIGH:!MD5:!SHA1}}
26888 .endd
26889
26890
26891
26892 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26893          "SECTreqciphgnu"
26894 .cindex "GnuTLS" "specifying parameters for"
26895 .cindex "TLS" "specifying ciphers (GnuTLS)"
26896 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26897 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26898 .cindex "TLS" "specifying protocols (GnuTLS)"
26899 .cindex "TLS" "specifying priority string (GnuTLS)"
26900 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26901 The GnuTLS library allows the caller to provide a "priority string", documented
26902 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26903 ciphersuite specification in OpenSSL.
26904
26905 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26906 and controls both protocols and ciphers.
26907
26908 The &%tls_require_ciphers%& option is available both as an global option,
26909 controlling how Exim behaves as a server, and also as an option of the
26910 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26911 the value is string expanded.  The resulting string is not an Exim list and
26912 the string is given to the GnuTLS library, so that Exim does not need to be
26913 aware of future feature enhancements of GnuTLS.
26914
26915 Documentation of the strings accepted may be found in the GnuTLS manual, under
26916 "Priority strings".  This is online as
26917 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26918 but beware that this relates to GnuTLS 3, which may be newer than the version
26919 installed on your system.  If you are using GnuTLS 3,
26920 then the example code
26921 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
26922 on that site can be used to test a given string.
26923
26924 For example:
26925 .code
26926 # Disable older versions of protocols
26927 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26928 .endd
26929
26930 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26931 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26932 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26933
26934 This example will let the library defaults be permitted on the MX port, where
26935 there's probably no identity verification anyway, and lowers security further
26936 by increasing compatibility; but this ups the ante on the submission ports
26937 where the administrator might have some influence on the choice of clients
26938 used:
26939 .code
26940 # GnuTLS variant
26941 tls_require_ciphers = ${if =={$received_port}{25}\
26942                            {NORMAL:%COMPAT}\
26943                            {SECURE128}}
26944 .endd
26945
26946
26947 .section "Configuring an Exim server to use TLS" "SECID182"
26948 .cindex "TLS" "configuring an Exim server"
26949 When Exim has been built with TLS support, it advertises the availability of
26950 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26951 but not to any others. The default value of this option is unset, which means
26952 that STARTTLS is not advertised at all. This default is chosen because you
26953 need to set some other options in order to make TLS available, and also it is
26954 sensible for systems that want to use TLS only as a client.
26955
26956 If a client issues a STARTTLS command and there is some configuration
26957 problem in the server, the command is rejected with a 454 error. If the client
26958 persists in trying to issue SMTP commands, all except QUIT are rejected
26959 with the error
26960 .code
26961 554 Security failure
26962 .endd
26963 If a STARTTLS command is issued within an existing TLS session, it is
26964 rejected with a 554 error code.
26965
26966 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
26967 must be set to match some hosts. The default is * which matches all hosts.
26968
26969 .new
26970 If this is all you do, TLS encryption will be enabled but not authentication -
26971 meaning that the peer has no assurance it is actually you he is talking to.
26972 You gain protection from a passive sniffer listening on the wire but not
26973 from someone able to intercept the communication.
26974 .wen
26975
26976 Further protection requires some further configuration at the server end.
26977
26978 It is rumoured that all existing clients that support TLS/SSL use RSA
26979 encryption. To make this work you need to set, in the server,
26980 .code
26981 tls_certificate = /some/file/name
26982 tls_privatekey = /some/file/name
26983 .endd
26984 These options are, in fact, expanded strings, so you can make them depend on
26985 the identity of the client that is connected if you wish. The first file
26986 contains the server's X509 certificate, and the second contains the private key
26987 that goes with it. These files need to be
26988 PEM format and readable by the Exim user, and must
26989 always be given as full path names.
26990 The key must not be password-protected.
26991 They can be the same file if both the
26992 certificate and the key are contained within it. If &%tls_privatekey%& is not
26993 set, or if its expansion is forced to fail or results in an empty string, this
26994 is assumed to be the case. The certificate file may also contain intermediate
26995 certificates that need to be sent to the client to enable it to authenticate
26996 the server's certificate.
26997
26998 If you do not understand about certificates and keys, please try to find a
26999 source of this background information, which is not Exim-specific. (There are a
27000 few comments below in section &<<SECTcerandall>>&.)
27001
27002 &*Note*&: These options do not apply when Exim is operating as a client &--
27003 they apply only in the case of a server. If you need to use a certificate in an
27004 Exim client, you must set the options of the same names in an &(smtp)&
27005 transport.
27006
27007 With just these options, an Exim server will be able to use TLS. It does not
27008 require the client to have a certificate (but see below for how to insist on
27009 this). There is one other option that may be needed in other situations. If
27010 .code
27011 tls_dhparam = /some/file/name
27012 .endd
27013 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27014 with the parameters contained in the file.
27015 Set this to &`none`& to disable use of DH entirely, by making no prime
27016 available:
27017 .code
27018 tls_dhparam = none
27019 .endd
27020 This may also be set to a string identifying a standard prime to be used for
27021 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27022 used is &`ike23`&.  There are a few standard primes available, see the
27023 documentation for &%tls_dhparam%& for the complete list.
27024
27025 See the command
27026 .code
27027 openssl dhparam
27028 .endd
27029 for a way of generating file data.
27030
27031 The strings supplied for these three options are expanded every time a client
27032 host connects. It is therefore possible to use different certificates and keys
27033 for different hosts, if you so wish, by making use of the client's IP address
27034 in &$sender_host_address$& to control the expansion. If a string expansion is
27035 forced to fail, Exim behaves as if the option is not set.
27036
27037 .cindex "cipher" "logging"
27038 .cindex "log" "TLS cipher"
27039 .vindex "&$tls_in_cipher$&"
27040 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27041 an incoming TLS connection. It is included in the &'Received:'& header of an
27042 incoming message (by default &-- you can, of course, change this), and it is
27043 also included in the log line that records a message's arrival, keyed by
27044 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27045 condition can be used to test for specific cipher suites in ACLs.
27046
27047 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27048 can check the name of the cipher suite and vary their actions accordingly. The
27049 cipher suite names vary, depending on which TLS library is being used. For
27050 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27051 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27052 documentation for more details.
27053
27054 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27055 (again depending on the &%tls_cipher%& log selector).
27056
27057
27058 .section "Requesting and verifying client certificates" "SECID183"
27059 .cindex "certificate" "verification of client"
27060 .cindex "TLS" "client certificate verification"
27061 If you want an Exim server to request a certificate when negotiating a TLS
27062 session with a client, you must set either &%tls_verify_hosts%& or
27063 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27064 apply to all TLS connections. For any host that matches one of these options,
27065 Exim requests a certificate as part of the setup of the TLS session. The
27066 contents of the certificate are verified by comparing it with a list of
27067 expected certificates.
27068 These may be the system default set (depending on library version),
27069 an explicit file or,
27070 depending on library version, a directory, identified by
27071 &%tls_verify_certificates%&.
27072
27073 A file can contain multiple certificates, concatenated end to end. If a
27074 directory is used
27075 (OpenSSL only),
27076 each certificate must be in a separate file, with a name (or a symbolic link)
27077 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27078 certificate. You can compute the relevant hash by running the command
27079 .code
27080 openssl x509 -hash -noout -in /cert/file
27081 .endd
27082 where &_/cert/file_& contains a single certificate.
27083
27084 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27085 what happens if the client does not supply a certificate, or if the certificate
27086 does not match any of the certificates in the collection named by
27087 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27088 attempt to set up a TLS session is aborted, and the incoming connection is
27089 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27090 session continues. ACLs that run for subsequent SMTP commands can detect the
27091 fact that no certificate was verified, and vary their actions accordingly. For
27092 example, you can insist on a certificate before accepting a message for
27093 relaying, but not when the message is destined for local delivery.
27094
27095 .vindex "&$tls_in_peerdn$&"
27096 When a client supplies a certificate (whether it verifies or not), the value of
27097 the Distinguished Name of the certificate is made available in the variable
27098 &$tls_in_peerdn$& during subsequent processing of the message.
27099
27100 .cindex "log" "distinguished name"
27101 Because it is often a long text string, it is not included in the log line or
27102 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27103 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27104 &%received_header_text%& to change the &'Received:'& header. When no
27105 certificate is supplied, &$tls_in_peerdn$& is empty.
27106
27107
27108 .section "Revoked certificates" "SECID184"
27109 .cindex "TLS" "revoked certificates"
27110 .cindex "revocation list"
27111 .cindex "certificate" "revocation list"
27112 .cindex "OCSP" "stapling"
27113 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27114 certificates are revoked. If you have such a list, you can pass it to an Exim
27115 server using the global option called &%tls_crl%& and to an Exim client using
27116 an identically named option for the &(smtp)& transport. In each case, the value
27117 of the option is expanded and must then be the name of a file that contains a
27118 CRL in PEM format.
27119 The downside is that clients have to periodically re-download a potentially huge
27120 file from every certificate authority they know of.
27121
27122 The way with most moving parts at query time is Online Certificate
27123 Status Protocol (OCSP), where the client verifies the certificate
27124 against an OCSP server run by the CA.  This lets the CA track all
27125 usage of the certs.  It requires running software with access to the
27126 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27127 is based on HTTP and can be proxied accordingly.
27128
27129 The only widespread OCSP server implementation (known to this writer)
27130 comes as part of OpenSSL and aborts on an invalid request, such as
27131 connecting to the port and then disconnecting.  This requires
27132 re-entering the passphrase each time some random client does this.
27133
27134 The third way is OCSP Stapling; in this, the server using a certificate
27135 issued by the CA periodically requests an OCSP proof of validity from
27136 the OCSP server, then serves it up inline as part of the TLS
27137 negotiation.   This approach adds no extra round trips, does not let the
27138 CA track users, scales well with number of certs issued by the CA and is
27139 resilient to temporary OCSP server failures, as long as the server
27140 starts retrying to fetch an OCSP proof some time before its current
27141 proof expires.  The downside is that it requires server support.
27142
27143 Unless Exim is built with the support disabled,
27144 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27145 support for OCSP stapling is included.
27146
27147 There is a global option called &%tls_ocsp_file%&.
27148 The file specified therein is expected to be in DER format, and contain
27149 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27150 option will be re-expanded for SNI, if the &%tls_certificate%& option
27151 contains &`tls_in_sni`&, as per other TLS options.
27152
27153 Exim does not at this time implement any support for fetching a new OCSP
27154 proof.  The burden is on the administrator to handle this, outside of
27155 Exim.  The file specified should be replaced atomically, so that the
27156 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27157 on each connection, so a new file will be handled transparently on the
27158 next connection.
27159
27160 When built with OpenSSL Exim will check for a valid next update timestamp
27161 in the OCSP proof; if not present, or if the proof has expired, it will be
27162 ignored.
27163
27164 For the client to be able to verify the stapled OCSP the server must
27165 also supply, in its stapled information, any intermediate
27166 certificates for the chain leading to the OCSP proof from the signer
27167 of the server certificate.  There may be zero or one such. These
27168 intermediate certificates should be added to the server OCSP stapling
27169 file named by &%tls_ocsp_file%&.
27170
27171 Note that the proof only covers the terminal server certificate,
27172 not any of the chain from CA to it.
27173
27174 There is no current way to staple a proof for a client certificate.
27175
27176 .code
27177   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27178   OCSP server is supplied.  The server URL may be included in the
27179   server certificate, if the CA is helpful.
27180
27181   One failure mode seen was the OCSP Signer cert expiring before the end
27182   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27183   noted this as invalid overall, but the re-fetch script did not.
27184 .endd
27185
27186
27187
27188
27189 .section "Configuring an Exim client to use TLS" "SECID185"
27190 .cindex "cipher" "logging"
27191 .cindex "log" "TLS cipher"
27192 .cindex "log" "distinguished name"
27193 .cindex "TLS" "configuring an Exim client"
27194 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27195 deliveries as well as to incoming, the latter one causing logging of the
27196 server certificate's DN. The remaining client configuration for TLS is all
27197 within the &(smtp)& transport.
27198
27199 It is not necessary to set any options to have TLS work in the &(smtp)&
27200 transport. If Exim is built with TLS support, and TLS is advertised by a
27201 server, the &(smtp)& transport always tries to start a TLS session. However,
27202 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27203 transport) to a list of server hosts for which TLS should not be used.
27204
27205 If you do not want Exim to attempt to send messages unencrypted when an attempt
27206 to set up an encrypted connection fails in any way, you can set
27207 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27208 those hosts, delivery is always deferred if an encrypted connection cannot be
27209 set up. If there are any other hosts for the address, they are tried in the
27210 usual way.
27211
27212 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27213 the message unencrypted. It always does this if the response to STARTTLS is
27214 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27215 session after a success response code, what happens is controlled by the
27216 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27217 delivery to this host is deferred, and other hosts (if available) are tried. If
27218 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27219 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27220 negotiation fails, Exim closes the current connection (because it is in an
27221 unknown state), opens a new one to the same host, and then tries the delivery
27222 unencrypted.
27223
27224 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27225 transport provide the client with a certificate, which is passed to the server
27226 if it requests it. If the server is Exim, it will request a certificate only if
27227 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27228
27229 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27230 specifies a collection of expected server certificates.
27231 These may be the system default set (depending on library version),
27232 a file or,
27233 depending on library version, a directory,
27234 must name a file or,
27235 for OpenSSL only (not GnuTLS), a directory.
27236 The client verifies the server's certificate
27237 against this collection, taking into account any revoked certificates that are
27238 in the list defined by &%tls_crl%&.
27239 Failure to verify fails the TLS connection unless either of the
27240 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27241
27242 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27243 certificate verification to the listed servers.  Verification either must
27244 or need not succeed respectively.
27245
27246 The &(smtp)& transport has two OCSP-related options:
27247 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27248 is requested and required for the connection to proceed.  The default
27249 value is empty.
27250 &%hosts_request_ocsp%&; a host-list for which (additionally)
27251 a Certificate Status is requested (but not necessarily verified).  The default
27252 value is "*" meaning that requests are made unless configured
27253 otherwise.
27254
27255 The host(s) should also be in &%hosts_require_tls%&, and
27256 &%tls_verify_certificates%& configured for the transport,
27257 for OCSP to be relevant.
27258
27259 If
27260 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27261 list of permitted cipher suites. If either of these checks fails, delivery to
27262 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27263 alternative hosts, if any.
27264
27265  &*Note*&:
27266 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27267 is operating as a client. Exim does not assume that a server certificate (set
27268 by the global options of the same name) should also be used when operating as a
27269 client.
27270
27271 .vindex "&$host$&"
27272 .vindex "&$host_address$&"
27273 All the TLS options in the &(smtp)& transport are expanded before use, with
27274 &$host$& and &$host_address$& containing the name and address of the server to
27275 which the client is connected. Forced failure of an expansion causes Exim to
27276 behave as if the relevant option were unset.
27277
27278 .vindex &$tls_out_bits$&
27279 .vindex &$tls_out_cipher$&
27280 .vindex &$tls_out_peerdn$&
27281 .vindex &$tls_out_sni$&
27282 Before an SMTP connection is established, the
27283 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27284 variables are emptied. (Until the first connection, they contain the values
27285 that were set when the message was received.) If STARTTLS is subsequently
27286 successfully obeyed, these variables are set to the relevant values for the
27287 outgoing connection.
27288
27289
27290
27291 .section "Use of TLS Server Name Indication" "SECTtlssni"
27292 .cindex "TLS" "Server Name Indication"
27293 .vindex "&$tls_in_sni$&"
27294 .oindex "&%tls_in_sni%&"
27295 With TLS1.0 or above, there is an extension mechanism by which extra
27296 information can be included at various points in the protocol.  One of these
27297 extensions, documented in RFC 6066 (and before that RFC 4366) is
27298 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27299 client in the initial handshake, so that the server can examine the servername
27300 within and possibly choose to use different certificates and keys (and more)
27301 for this session.
27302
27303 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27304 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27305 address.
27306
27307 With SMTP to MX, there are the same problems here as in choosing the identity
27308 against which to validate a certificate: you can't rely on insecure DNS to
27309 provide the identity which you then cryptographically verify.  So this will
27310 be of limited use in that environment.
27311
27312 With SMTP to Submission, there is a well-defined hostname which clients are
27313 connecting to and can validate certificates against.  Thus clients &*can*&
27314 choose to include this information in the TLS negotiation.  If this becomes
27315 wide-spread, then hosters can choose to present different certificates to
27316 different clients.  Or even negotiate different cipher suites.
27317
27318 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27319 if not empty, will be sent on a TLS session as part of the handshake.  There's
27320 nothing more to it.  Choosing a sensible value not derived insecurely is the
27321 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27322 for the lifetime of the client connection (including during authentication).
27323
27324 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27325 received from a client.
27326 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27327
27328 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27329 option (prior to expansion) then the following options will be re-expanded
27330 during TLS session handshake, to permit alternative values to be chosen:
27331
27332 .ilist
27333 .vindex "&%tls_certificate%&"
27334 &%tls_certificate%&
27335 .next
27336 .vindex "&%tls_crl%&"
27337 &%tls_crl%&
27338 .next
27339 .vindex "&%tls_privatekey%&"
27340 &%tls_privatekey%&
27341 .next
27342 .vindex "&%tls_verify_certificates%&"
27343 &%tls_verify_certificates%&
27344 .next
27345 .vindex "&%tls_ocsp_file%&"
27346 &%tls_ocsp_file%&
27347 .endlist
27348
27349 Great care should be taken to deal with matters of case, various injection
27350 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27351 can always be referenced; it is important to remember that &$tls_sni$& is
27352 arbitrary unverified data provided prior to authentication.
27353
27354 The Exim developers are proceeding cautiously and so far no other TLS options
27355 are re-expanded.
27356
27357 When Exim is built against OpenSSL, OpenSSL must have been built with support
27358 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27359 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27360 see &`-servername`& in the output, then OpenSSL has support.
27361
27362 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27363 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27364 built, then you have SNI support).
27365
27366
27367
27368 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27369          "SECTmulmessam"
27370 .cindex "multiple SMTP deliveries with TLS"
27371 .cindex "TLS" "multiple message deliveries"
27372 Exim sends multiple messages down the same TCP/IP connection by starting up
27373 an entirely new delivery process for each message, passing the socket from
27374 one process to the next. This implementation does not fit well with the use
27375 of TLS, because there is quite a lot of state information associated with a TLS
27376 connection, not just a socket identification. Passing all the state information
27377 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27378 session before passing the socket to a new process. The new process may then
27379 try to start a new TLS session, and if successful, may try to re-authenticate
27380 if AUTH is in use, before sending the next message.
27381
27382 The RFC is not clear as to whether or not an SMTP session continues in clear
27383 after TLS has been shut down, or whether TLS may be restarted again later, as
27384 just described. However, if the server is Exim, this shutdown and
27385 reinitialization works. It is not known which (if any) other servers operate
27386 successfully if the client closes a TLS session and continues with unencrypted
27387 SMTP, but there are certainly some that do not work. For such servers, Exim
27388 should not pass the socket to another process, because the failure of the
27389 subsequent attempt to use it would cause Exim to record a temporary host error,
27390 and delay other deliveries to that host.
27391
27392 To test for this case, Exim sends an EHLO command to the server after
27393 closing down the TLS session. If this fails in any way, the connection is
27394 closed instead of being passed to a new delivery process, but no retry
27395 information is recorded.
27396
27397 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27398 &(smtp)& transport to match those hosts for which Exim should not pass
27399 connections to new processes if TLS has been used.
27400
27401
27402
27403
27404 .section "Certificates and all that" "SECTcerandall"
27405 .cindex "certificate" "references to discussion"
27406 In order to understand fully how TLS works, you need to know about
27407 certificates, certificate signing, and certificate authorities. This is not the
27408 place to give a tutorial, especially as I do not know very much about it
27409 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27410 to Apache, currently at
27411 .display
27412 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27413 .endd
27414 Other parts of the &'modssl'& documentation are also helpful, and have
27415 links to further files.
27416 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27417 0-201-61598-3), contains both introductory and more in-depth descriptions.
27418 Some sample programs taken from the book are available from
27419 .display
27420 &url(http://www.rtfm.com/openssl-examples/)
27421 .endd
27422
27423
27424 .section "Certificate chains" "SECID186"
27425 The file named by &%tls_certificate%& may contain more than one
27426 certificate. This is useful in the case where the certificate that is being
27427 sent is validated by an intermediate certificate which the other end does
27428 not have. Multiple certificates must be in the correct order in the file.
27429 First the host's certificate itself, then the first intermediate
27430 certificate to validate the issuer of the host certificate, then the next
27431 intermediate certificate to validate the issuer of the first intermediate
27432 certificate, and so on, until finally (optionally) the root certificate.
27433 The root certificate must already be trusted by the recipient for
27434 validation to succeed, of course, but if it's not preinstalled, sending the
27435 root certificate along with the rest makes it available for the user to
27436 install if the receiving end is a client MUA that can interact with a user.
27437
27438 Note that certificates using MD5 are unlikely to work on today's Internet;
27439 even if your libraries allow loading them for use in Exim when acting as a
27440 server, increasingly clients will not accept such certificates.  The error
27441 diagnostics in such a case can be frustratingly vague.
27442
27443
27444
27445 .section "Self-signed certificates" "SECID187"
27446 .cindex "certificate" "self-signed"
27447 You can create a self-signed certificate using the &'req'& command provided
27448 with OpenSSL, like this:
27449 . ==== Do not shorten the duration here without reading and considering
27450 . ==== the text below.  Please leave it at 9999 days.
27451 .code
27452 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27453             -days 9999 -nodes
27454 .endd
27455 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27456 delimited and so can be identified independently. The &%-days%& option
27457 specifies a period for which the certificate is valid. The &%-nodes%& option is
27458 important: if you do not set it, the key is encrypted with a passphrase
27459 that you are prompted for, and any use that is made of the key causes more
27460 prompting for the passphrase. This is not helpful if you are going to use
27461 this certificate and key in an MTA, where prompting is not possible.
27462
27463 . ==== I expect to still be working 26 years from now.  The less technical
27464 . ==== debt I create, in terms of storing up trouble for my later years, the
27465 . ==== happier I will be then.  We really have reached the point where we
27466 . ==== should start, at the very least, provoking thought and making folks
27467 . ==== pause before proceeding, instead of leaving all the fixes until two
27468 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27469 . ==== -pdp, 2012
27470 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27471 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27472 the above command might produce a date in the past.  Think carefully about
27473 the lifetime of the systems you're deploying, and either reduce the duration
27474 of the certificate or reconsider your platform deployment.  (At time of
27475 writing, reducing the duration is the most likely choice, but the inexorable
27476 progression of time takes us steadily towards an era where this will not
27477 be a sensible resolution).
27478
27479 A self-signed certificate made in this way is sufficient for testing, and
27480 may be adequate for all your requirements if you are mainly interested in
27481 encrypting transfers, and not in secure identification.
27482
27483 However, many clients require that the certificate presented by the server be a
27484 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27485 certificate. In this situation, the self-signed certificate described above
27486 must be installed on the client host as a trusted root &'certification
27487 authority'& (CA), and the certificate used by Exim must be a user certificate
27488 signed with that self-signed certificate.
27489
27490 For information on creating self-signed CA certificates and using them to sign
27491 user certificates, see the &'General implementation overview'& chapter of the
27492 Open-source PKI book, available online at
27493 &url(http://ospkibook.sourceforge.net/).
27494 .ecindex IIDencsmtp1
27495 .ecindex IIDencsmtp2
27496
27497
27498
27499 . ////////////////////////////////////////////////////////////////////////////
27500 . ////////////////////////////////////////////////////////////////////////////
27501
27502 .chapter "Access control lists" "CHAPACL"
27503 .scindex IIDacl "&ACL;" "description"
27504 .cindex "control of incoming mail"
27505 .cindex "message" "controlling incoming"
27506 .cindex "policy control" "access control lists"
27507 Access Control Lists (ACLs) are defined in a separate section of the run time
27508 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27509 name, terminated by a colon. Here is a complete ACL section that contains just
27510 one very small ACL:
27511 .code
27512 begin acl
27513 small_acl:
27514   accept   hosts = one.host.only
27515 .endd
27516 You can have as many lists as you like in the ACL section, and the order in
27517 which they appear does not matter. The lists are self-terminating.
27518
27519 The majority of ACLs are used to control Exim's behaviour when it receives
27520 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27521 when a local process submits a message using SMTP by specifying the &%-bs%&
27522 option. The most common use is for controlling which recipients are accepted
27523 in incoming messages. In addition, you can define an ACL that is used to check
27524 local non-SMTP messages. The default configuration file contains an example of
27525 a realistic ACL for checking RCPT commands. This is discussed in chapter
27526 &<<CHAPdefconfil>>&.
27527
27528
27529 .section "Testing ACLs" "SECID188"
27530 The &%-bh%& command line option provides a way of testing your ACL
27531 configuration locally by running a fake SMTP session with which you interact.
27532
27533
27534 .section "Specifying when ACLs are used" "SECID189"
27535 .cindex "&ACL;" "options for specifying"
27536 In order to cause an ACL to be used, you have to name it in one of the relevant
27537 options in the main part of the configuration. These options are:
27538 .cindex "AUTH" "ACL for"
27539 .cindex "DATA" "ACLs for"
27540 .cindex "ETRN" "ACL for"
27541 .cindex "EXPN" "ACL for"
27542 .cindex "HELO" "ACL for"
27543 .cindex "EHLO" "ACL for"
27544 .cindex "DKIM" "ACL for"
27545 .cindex "MAIL" "ACL for"
27546 .cindex "QUIT, ACL for"
27547 .cindex "RCPT" "ACL for"
27548 .cindex "STARTTLS, ACL for"
27549 .cindex "VRFY" "ACL for"
27550 .cindex "SMTP" "connection, ACL for"
27551 .cindex "non-SMTP messages" "ACLs for"
27552 .cindex "MIME content scanning" "ACL for"
27553 .cindex "PRDR" "ACL for"
27554
27555 .table2 140pt
27556 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27557 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27558 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27559 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27560 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27561 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27562 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27563 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27564 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27565 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27566 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27567 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27568 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27569 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27570 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27571 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27572 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27573 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27574 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27575 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27576 .endtable
27577
27578 For example, if you set
27579 .code
27580 acl_smtp_rcpt = small_acl
27581 .endd
27582 the little ACL defined above is used whenever Exim receives a RCPT command
27583 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27584 done when RCPT commands arrive. A rejection of RCPT should cause the
27585 sending MTA to give up on the recipient address contained in the RCPT
27586 command, whereas rejection at other times may cause the client MTA to keep on
27587 trying to deliver the message. It is therefore recommended that you do as much
27588 testing as possible at RCPT time.
27589
27590
27591 .section "The non-SMTP ACLs" "SECID190"
27592 .cindex "non-SMTP messages" "ACLs for"
27593 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27594 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27595 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27596 the state of the SMTP connection such as encryption and authentication) are not
27597 relevant and are forbidden in these ACLs. However, the sender and recipients
27598 are known, so the &%senders%& and &%sender_domains%& conditions and the
27599 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27600 &$authenticated_sender$& are also available. You can specify added header lines
27601 in any of these ACLs.
27602
27603 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27604 non-SMTP message, before any of the message has been read. (This is the
27605 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27606 batched SMTP input, it runs after the DATA command has been reached. The
27607 result of this ACL is ignored; it cannot be used to reject a message. If you
27608 really need to, you could set a value in an ACL variable here and reject based
27609 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27610 controls, and in particular, it can be used to set
27611 .code
27612 control = suppress_local_fixups
27613 .endd
27614 This cannot be used in the other non-SMTP ACLs because by the time they are
27615 run, it is too late.
27616
27617 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27618 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27619
27620 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27621 kind of rejection is treated as permanent, because there is no way of sending a
27622 temporary error for these kinds of message.
27623
27624
27625 .section "The SMTP connect ACL" "SECID191"
27626 .cindex "SMTP" "connection, ACL for"
27627 .oindex &%smtp_banner%&
27628 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27629 session, after the test specified by &%host_reject_connection%& (which is now
27630 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27631 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27632 the message override the banner message that is otherwise specified by the
27633 &%smtp_banner%& option.
27634
27635
27636 .section "The EHLO/HELO ACL" "SECID192"
27637 .cindex "EHLO" "ACL for"
27638 .cindex "HELO" "ACL for"
27639 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27640 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27641 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27642 Note that a client may issue more than one EHLO or HELO command in an SMTP
27643 session, and indeed is required to issue a new EHLO or HELO after successfully
27644 setting up encryption following a STARTTLS command.
27645
27646 Note also that a deny neither forces the client to go away nor means that
27647 mail will be refused on the connection.  Consider checking for
27648 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
27649
27650 If the command is accepted by an &%accept%& verb that has a &%message%&
27651 modifier, the message may not contain more than one line (it will be truncated
27652 at the first newline and a panic logged if it does). Such a message cannot
27653 affect the EHLO options that are listed on the second and subsequent lines of
27654 an EHLO response.
27655
27656
27657 .section "The DATA ACLs" "SECID193"
27658 .cindex "DATA" "ACLs for"
27659 Two ACLs are associated with the DATA command, because it is two-stage
27660 command, with two responses being sent to the client.
27661 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27662 is obeyed. This gives you control after all the RCPT commands, but before
27663 the message itself is received. It offers the opportunity to give a negative
27664 response to the DATA command before the data is transmitted. Header lines
27665 added by MAIL or RCPT ACLs are not visible at this time, but any that
27666 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27667
27668 You cannot test the contents of the message, for example, to verify addresses
27669 in the headers, at RCPT time or when the DATA command is received. Such
27670 tests have to appear in the ACL that is run after the message itself has been
27671 received, before the final response to the DATA command is sent. This is
27672 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27673 associated with the DATA command.
27674
27675 For both of these ACLs, it is not possible to reject individual recipients. An
27676 error response rejects the entire message. Unfortunately, it is known that some
27677 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27678 before or after the data) correctly &-- they keep the message on their queues
27679 and try again later, but that is their problem, though it does waste some of
27680 your resources.
27681
27682 The &%acl_smtp_data%& ACL is run after
27683 the &%acl_smtp_data_prdr%&,
27684 the &%acl_smtp_dkim%&
27685 and the &%acl_smtp_mime%& ACLs.
27686
27687 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27688 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27689 enabled (which is the default).
27690
27691 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27692 received, and is executed for each DKIM signature found in a message.  If not
27693 otherwise specified, the default action is to accept.
27694
27695 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27696
27697 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27698
27699
27700 .section "The SMTP MIME ACL" "SECID194"
27701 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27702 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27703
27704 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27705
27706
27707 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27708 .cindex "PRDR" "ACL for"
27709 .oindex "&%prdr_enable%&"
27710 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27711 with PRDR support enabled (which is the default).
27712 It becomes active only when the PRDR feature is negotiated between
27713 client and server for a message, and more than one recipient
27714 has been accepted.
27715
27716 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27717 has been received, and is executed once for each recipient of the message
27718 with &$local_part$& and &$domain$& valid.
27719 The test may accept, defer or deny for individual recipients.
27720 The &%acl_smtp_data%& will still be called after this ACL and
27721 can reject the message overall, even if this ACL has accepted it
27722 for some or all recipients.
27723
27724 PRDR may be used to support per-user content filtering.  Without it
27725 one must defer any recipient after the first that has a different
27726 content-filter configuration.  With PRDR, the RCPT-time check
27727 .cindex "PRDR" "variable for"
27728 for this can be disabled when the variable &$prdr_requested$&
27729 is &"yes"&.
27730 Any required difference in behaviour of the main DATA-time
27731 ACL should however depend on the PRDR-time ACL having run, as Exim
27732 will avoid doing so in some situations (e.g.  single-recipient mails).
27733
27734 See also the &%prdr_enable%& global option
27735 and the &%hosts_try_prdr%& smtp transport option.
27736
27737 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27738 If the ACL is not defined, processing completes as if
27739 the feature was not requested by the client.
27740
27741 .section "The QUIT ACL" "SECTQUITACL"
27742 .cindex "QUIT, ACL for"
27743 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27744 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27745 does not in fact control any access.
27746 For this reason, it may only accept
27747 or warn as its final result.
27748
27749 This ACL can be used for tasks such as custom logging at the end of an SMTP
27750 session. For example, you can use ACL variables in other ACLs to count
27751 messages, recipients, etc., and log the totals at QUIT time using one or
27752 more &%logwrite%& modifiers on a &%warn%& verb.
27753
27754 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27755 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27756
27757 You do not need to have a final &%accept%&, but if you do, you can use a
27758 &%message%& modifier to specify custom text that is sent as part of the 221
27759 response to QUIT.
27760
27761 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27762 failure (for example, failure to open a log file, or when Exim is bombing out
27763 because it has detected an unrecoverable error), all SMTP commands from the
27764 client are given temporary error responses until QUIT is received or the
27765 connection is closed. In these special cases, the QUIT ACL does not run.
27766
27767
27768 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27769 .vindex &$acl_smtp_notquit$&
27770 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27771 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27772 trouble, such as being unable to write to its log files, this ACL is not run,
27773 because it might try to do things (such as write to log files) that make the
27774 situation even worse.
27775
27776 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27777 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27778 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27779 and &%warn%&.
27780
27781 .vindex &$smtp_notquit_reason$&
27782 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27783 to a string that indicates the reason for the termination of the SMTP
27784 connection. The possible values are:
27785 .table2
27786 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27787 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27788 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27789 .irow &`connection-lost`&          "The SMTP connection has been lost"
27790 .irow &`data-timeout`&             "Timeout while reading message data"
27791 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27792 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27793 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27794 .irow &`synchronization-error`&    "SMTP synchronization error"
27795 .irow &`tls-failed`&               "TLS failed to start"
27796 .endtable
27797 In most cases when an SMTP connection is closed without having received QUIT,
27798 Exim sends an SMTP response message before actually closing the connection.
27799 With the exception of the &`acl-drop`& case, the default message can be
27800 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27801 &%drop%& verb in another ACL, it is the message from the other ACL that is
27802 used.
27803
27804
27805 .section "Finding an ACL to use" "SECID195"
27806 .cindex "&ACL;" "finding which to use"
27807 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27808 you can use different ACLs in different circumstances. For example,
27809 .code
27810 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27811                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27812 .endd
27813 In the default configuration file there are some example settings for
27814 providing an RFC 4409 message submission service on port 587 and a
27815 non-standard &"smtps"& service on port 465. You can use a string
27816 expansion like this to choose an ACL for MUAs on these ports which is
27817 more appropriate for this purpose than the default ACL on port 25.
27818
27819 The expanded string does not have to be the name of an ACL in the
27820 configuration file; there are other possibilities. Having expanded the
27821 string, Exim searches for an ACL as follows:
27822
27823 .ilist
27824 If the string begins with a slash, Exim uses it as a file name, and reads its
27825 contents as an ACL. The lines are processed in the same way as lines in the
27826 Exim configuration file. In particular, continuation lines are supported, blank
27827 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27828 If the file does not exist or cannot be read, an error occurs (typically
27829 causing a temporary failure of whatever caused the ACL to be run). For example:
27830 .code
27831 acl_smtp_data = /etc/acls/\
27832   ${lookup{$sender_host_address}lsearch\
27833   {/etc/acllist}{$value}{default}}
27834 .endd
27835 This looks up an ACL file to use on the basis of the host's IP address, falling
27836 back to a default if the lookup fails. If an ACL is successfully read from a
27837 file, it is retained in memory for the duration of the Exim process, so that it
27838 can be re-used without having to re-read the file.
27839 .next
27840 If the string does not start with a slash, and does not contain any spaces,
27841 Exim searches the ACL section of the configuration for an ACL whose name
27842 matches the string.
27843 .next
27844 If no named ACL is found, or if the string contains spaces, Exim parses
27845 the string as an inline ACL. This can save typing in cases where you just
27846 want to have something like
27847 .code
27848 acl_smtp_vrfy = accept
27849 .endd
27850 in order to allow free use of the VRFY command. Such a string may contain
27851 newlines; it is processed in the same way as an ACL that is read from a file.
27852 .endlist
27853
27854
27855
27856
27857 .section "ACL return codes" "SECID196"
27858 .cindex "&ACL;" "return codes"
27859 Except for the QUIT ACL, which does not affect the SMTP return code (see
27860 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27861 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27862 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27863 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27864 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27865 This also causes a 4&'xx'& return code.
27866
27867 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27868 &"deny"&, because there is no mechanism for passing temporary errors to the
27869 submitters of non-SMTP messages.
27870
27871
27872 ACLs that are relevant to message reception may also return &"discard"&. This
27873 has the effect of &"accept"&, but causes either the entire message or an
27874 individual recipient address to be discarded. In other words, it is a
27875 blackholing facility. Use it with care.
27876
27877 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27878 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27879 RCPT ACL is to discard just the one recipient address. If there are no
27880 recipients left when the message's data is received, the DATA ACL is not
27881 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27882 remaining recipients. The &"discard"& return is not permitted for the
27883 &%acl_smtp_predata%& ACL.
27884
27885
27886 .cindex "&[local_scan()]& function" "when all recipients discarded"
27887 The &[local_scan()]& function is always run, even if there are no remaining
27888 recipients; it may create new recipients.
27889
27890
27891
27892 .section "Unset ACL options" "SECID197"
27893 .cindex "&ACL;" "unset options"
27894 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27895 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27896 not defined at all. For any defined ACL, the default action when control
27897 reaches the end of the ACL statements is &"deny"&.
27898
27899 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27900 these two are ACLs that are used only for their side effects. They cannot be
27901 used to accept or reject anything.
27902
27903 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27904 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27905 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27906 when the ACL is not defined is &"accept"&.
27907
27908 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27909 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27910 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27911 messages over an SMTP connection. For an example, see the ACL in the default
27912 configuration file.
27913
27914
27915
27916
27917 .section "Data for message ACLs" "SECID198"
27918 .cindex "&ACL;" "data for message ACL"
27919 .vindex &$domain$&
27920 .vindex &$local_part$&
27921 .vindex &$sender_address$&
27922 .vindex &$sender_host_address$&
27923 .vindex &$smtp_command$&
27924 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27925 that contain information about the host and the message's sender (for example,
27926 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27927 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27928 &$local_part$& are set from the argument address. The entire SMTP command
27929 is available in &$smtp_command$&.
27930
27931 When an ACL for the AUTH parameter of MAIL is running, the variables that
27932 contain information about the host are set, but &$sender_address$& is not yet
27933 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27934 how it is used.
27935
27936 .vindex "&$message_size$&"
27937 The &$message_size$& variable is set to the value of the SIZE parameter on
27938 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27939 that parameter is not given. The value is updated to the true message size by
27940 the time the final DATA ACL is run (after the message data has been
27941 received).
27942
27943 .vindex "&$rcpt_count$&"
27944 .vindex "&$recipients_count$&"
27945 The &$rcpt_count$& variable increases by one for each RCPT command received.
27946 The &$recipients_count$& variable increases by one each time a RCPT command is
27947 accepted, so while an ACL for RCPT is being processed, it contains the number
27948 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27949 &$rcpt_count$& contains the total number of RCPT commands, and
27950 &$recipients_count$& contains the total number of accepted recipients.
27951
27952
27953
27954
27955
27956 .section "Data for non-message ACLs" "SECTdatfornon"
27957 .cindex "&ACL;" "data for non-message ACL"
27958 .vindex &$smtp_command_argument$&
27959 .vindex &$smtp_command$&
27960 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27961 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27962 and the entire SMTP command is available in &$smtp_command$&.
27963 These variables can be tested using a &%condition%& condition. For example,
27964 here is an ACL for use with AUTH, which insists that either the session is
27965 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27966 does not permit authentication methods that use cleartext passwords on
27967 unencrypted connections.
27968 .code
27969 acl_check_auth:
27970   accept encrypted = *
27971   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27972                      {CRAM-MD5}}
27973   deny   message   = TLS encryption or CRAM-MD5 required
27974 .endd
27975 (Another way of applying this restriction is to arrange for the authenticators
27976 that use cleartext passwords not to be advertised when the connection is not
27977 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27978 option to do this.)
27979
27980
27981
27982 .section "Format of an ACL" "SECID199"
27983 .cindex "&ACL;" "format of"
27984 .cindex "&ACL;" "verbs, definition of"
27985 An individual ACL consists of a number of statements. Each statement starts
27986 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27987 Modifiers can change the way the verb operates, define error and log messages,
27988 set variables, insert delays, and vary the processing of accepted messages.
27989
27990 If all the conditions are met, the verb is obeyed. The same condition may be
27991 used (with different arguments) more than once in the same statement. This
27992 provides a means of specifying an &"and"& conjunction between conditions. For
27993 example:
27994 .code
27995 deny  dnslists = list1.example
27996 dnslists = list2.example
27997 .endd
27998 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27999 the conditions and modifiers when it reaches a condition that fails. What
28000 happens then depends on the verb (and in one case, on a special modifier). Not
28001 all the conditions make sense at every testing point. For example, you cannot
28002 test a sender address in the ACL that is run for a VRFY command.
28003
28004
28005 .section "ACL verbs" "SECID200"
28006 The ACL verbs are as follows:
28007
28008 .ilist
28009 .cindex "&%accept%& ACL verb"
28010 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28011 of the conditions are not met, what happens depends on whether &%endpass%&
28012 appears among the conditions (for syntax see below). If the failing condition
28013 is before &%endpass%&, control is passed to the next ACL statement; if it is
28014 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28015 check a RCPT command:
28016 .code
28017 accept domains = +local_domains
28018 endpass
28019 verify = recipient
28020 .endd
28021 If the recipient domain does not match the &%domains%& condition, control
28022 passes to the next statement. If it does match, the recipient is verified, and
28023 the command is accepted if verification succeeds. However, if verification
28024 fails, the ACL yields &"deny"&, because the failing condition is after
28025 &%endpass%&.
28026
28027 The &%endpass%& feature has turned out to be confusing to many people, so its
28028 use is not recommended nowadays. It is always possible to rewrite an ACL so
28029 that &%endpass%& is not needed, and it is no longer used in the default
28030 configuration.
28031
28032 .cindex "&%message%& ACL modifier" "with &%accept%&"
28033 If a &%message%& modifier appears on an &%accept%& statement, its action
28034 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28035 (when an &%accept%& verb either accepts or passes control to the next
28036 statement), &%message%& can be used to vary the message that is sent when an
28037 SMTP command is accepted. For example, in a RCPT ACL you could have:
28038 .display
28039 &`accept  `&<&'some conditions'&>
28040 &`        message = OK, I will allow you through today`&
28041 .endd
28042 You can specify an SMTP response code, optionally followed by an &"extended
28043 response code"& at the start of the message, but the first digit must be the
28044 same as would be sent by default, which is 2 for an &%accept%& verb.
28045
28046 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28047 an error message that is used when access is denied. This behaviour is retained
28048 for backward compatibility, but current &"best practice"& is to avoid the use
28049 of &%endpass%&.
28050
28051
28052 .next
28053 .cindex "&%defer%& ACL verb"
28054 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28055 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28056 &%defer%& is the same as &%deny%&, because there is no way of sending a
28057 temporary error. For a RCPT command, &%defer%& is much the same as using a
28058 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28059 be used in any ACL, and even for a recipient it might be a simpler approach.
28060
28061
28062 .next
28063 .cindex "&%deny%& ACL verb"
28064 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28065 the conditions are not met, control is passed to the next ACL statement. For
28066 example,
28067 .code
28068 deny dnslists = blackholes.mail-abuse.org
28069 .endd
28070 rejects commands from hosts that are on a DNS black list.
28071
28072
28073 .next
28074 .cindex "&%discard%& ACL verb"
28075 &%discard%&: This verb behaves like &%accept%&, except that it returns
28076 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28077 that are concerned with receiving messages. When all the conditions are true,
28078 the sending entity receives a &"success"& response. However, &%discard%& causes
28079 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28080 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28081 message's recipients are discarded. Recipients that are discarded before DATA
28082 do not appear in the log line when the &%received_recipients%& log selector is set.
28083
28084 If the &%log_message%& modifier is set when &%discard%& operates,
28085 its contents are added to the line that is automatically written to the log.
28086 The &%message%& modifier operates exactly as it does for &%accept%&.
28087
28088
28089 .next
28090 .cindex "&%drop%& ACL verb"
28091 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28092 forcibly closed after the 5&'xx'& error message has been sent. For example:
28093 .code
28094 drop   message   = I don't take more than 20 RCPTs
28095        condition = ${if > {$rcpt_count}{20}}
28096 .endd
28097 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28098 The connection is always dropped after sending a 550 response.
28099
28100 .next
28101 .cindex "&%require%& ACL verb"
28102 &%require%&: If all the conditions are met, control is passed to the next ACL
28103 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28104 example, when checking a RCPT command,
28105 .code
28106 require message = Sender did not verify
28107         verify  = sender
28108 .endd
28109 passes control to subsequent statements only if the message's sender can be
28110 verified. Otherwise, it rejects the command. Note the positioning of the
28111 &%message%& modifier, before the &%verify%& condition. The reason for this is
28112 discussed in section &<<SECTcondmodproc>>&.
28113
28114 .next
28115 .cindex "&%warn%& ACL verb"
28116 &%warn%&: If all the conditions are true, a line specified by the
28117 &%log_message%& modifier is written to Exim's main log. Control always passes
28118 to the next ACL statement. If any condition is false, the log line is not
28119 written. If an identical log line is requested several times in the same
28120 message, only one copy is actually written to the log. If you want to force
28121 duplicates to be written, use the &%logwrite%& modifier instead.
28122
28123 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28124 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28125 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28126 first failing condition. There is more about adding header lines in section
28127 &<<SECTaddheadacl>>&.
28128
28129 If any condition on a &%warn%& statement cannot be completed (that is, there is
28130 some sort of defer), the log line specified by &%log_message%& is not written.
28131 This does not include the case of a forced failure from a lookup, which
28132 is considered to be a successful completion. After a defer, no further
28133 conditions or modifiers in the &%warn%& statement are processed. The incident
28134 is logged, and the ACL continues to be processed, from the next statement
28135 onwards.
28136
28137
28138 .vindex "&$acl_verify_message$&"
28139 When one of the &%warn%& conditions is an address verification that fails, the
28140 text of the verification failure message is in &$acl_verify_message$&. If you
28141 want this logged, you must set it up explicitly. For example:
28142 .code
28143 warn   !verify = sender
28144        log_message = sender verify failed: $acl_verify_message
28145 .endd
28146 .endlist
28147
28148 At the end of each ACL there is an implicit unconditional &%deny%&.
28149
28150 As you can see from the examples above, the conditions and modifiers are
28151 written one to a line, with the first one on the same line as the verb, and
28152 subsequent ones on following lines. If you have a very long condition, you can
28153 continue it onto several physical lines by the usual backslash continuation
28154 mechanism. It is conventional to align the conditions vertically.
28155
28156
28157
28158 .section "ACL variables" "SECTaclvariables"
28159 .cindex "&ACL;" "variables"
28160 There are some special variables that can be set during ACL processing. They
28161 can be used to pass information between different ACLs, different invocations
28162 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28163 transports, and filters that are used to deliver a message. The names of these
28164 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28165 an underscore, but the remainder of the name can be any sequence of
28166 alphanumeric characters and underscores that you choose. There is no limit on
28167 the number of ACL variables. The two sets act as follows:
28168 .ilist
28169 The values of those variables whose names begin with &$acl_c$& persist
28170 throughout an SMTP connection. They are never reset. Thus, a value that is set
28171 while receiving one message is still available when receiving the next message
28172 on the same SMTP connection.
28173 .next
28174 The values of those variables whose names begin with &$acl_m$& persist only
28175 while a message is being received. They are reset afterwards. They are also
28176 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28177 .endlist
28178
28179 When a message is accepted, the current values of all the ACL variables are
28180 preserved with the message and are subsequently made available at delivery
28181 time. The ACL variables are set by a modifier called &%set%&. For example:
28182 .code
28183 accept hosts = whatever
28184        set acl_m4 = some value
28185 accept authenticated = *
28186        set acl_c_auth = yes
28187 .endd
28188 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28189 be set. If you want to set a variable without taking any action, you can use a
28190 &%warn%& verb without any other modifiers or conditions.
28191
28192 .oindex &%strict_acl_vars%&
28193 What happens if a syntactically valid but undefined ACL variable is
28194 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28195 false (the default), an empty string is substituted; if it is true, an
28196 error is generated.
28197
28198 Versions of Exim before 4.64 have a limited set of numbered variables, but
28199 their names are compatible, so there is no problem with upgrading.
28200
28201
28202 .section "Condition and modifier processing" "SECTcondmodproc"
28203 .cindex "&ACL;" "conditions; processing"
28204 .cindex "&ACL;" "modifiers; processing"
28205 An exclamation mark preceding a condition negates its result. For example:
28206 .code
28207 deny   domains = *.dom.example
28208       !verify  = recipient
28209 .endd
28210 causes the ACL to return &"deny"& if the recipient domain ends in
28211 &'dom.example'& and the recipient address cannot be verified. Sometimes
28212 negation can be used on the right-hand side of a condition. For example, these
28213 two statements are equivalent:
28214 .code
28215 deny  hosts = !192.168.3.4
28216 deny !hosts =  192.168.3.4
28217 .endd
28218 However, for many conditions (&%verify%& being a good example), only left-hand
28219 side negation of the whole condition is possible.
28220
28221 The arguments of conditions and modifiers are expanded. A forced failure
28222 of an expansion causes a condition to be ignored, that is, it behaves as if the
28223 condition is true. Consider these two statements:
28224 .code
28225 accept  senders = ${lookup{$host_name}lsearch\
28226                   {/some/file}{$value}fail}
28227 accept  senders = ${lookup{$host_name}lsearch\
28228                   {/some/file}{$value}{}}
28229 .endd
28230 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28231 the returned list is searched, but if the lookup fails the behaviour is
28232 different in the two cases. The &%fail%& in the first statement causes the
28233 condition to be ignored, leaving no further conditions. The &%accept%& verb
28234 therefore succeeds. The second statement, however, generates an empty list when
28235 the lookup fails. No sender can match an empty list, so the condition fails,
28236 and therefore the &%accept%& also fails.
28237
28238 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28239 specify actions that are taken as the conditions for a statement are checked;
28240 others specify text for messages that are used when access is denied or a
28241 warning is generated. The &%control%& modifier affects the way an incoming
28242 message is handled.
28243
28244 The positioning of the modifiers in an ACL statement is important, because the
28245 processing of a verb ceases as soon as its outcome is known. Only those
28246 modifiers that have already been encountered will take effect. For example,
28247 consider this use of the &%message%& modifier:
28248 .code
28249 require message = Can't verify sender
28250         verify  = sender
28251         message = Can't verify recipient
28252         verify  = recipient
28253         message = This message cannot be used
28254 .endd
28255 If sender verification fails, Exim knows that the result of the statement is
28256 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28257 so its text is used as the error message. If sender verification succeeds, but
28258 recipient verification fails, the second message is used. If recipient
28259 verification succeeds, the third message becomes &"current"&, but is never used
28260 because there are no more conditions to cause failure.
28261
28262 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28263 modifier that is used, because all the conditions must be true for rejection to
28264 happen. Specifying more than one &%message%& modifier does not make sense, and
28265 the message can even be specified after all the conditions. For example:
28266 .code
28267 deny   hosts = ...
28268       !senders = *@my.domain.example
28269        message = Invalid sender from client host
28270 .endd
28271 The &"deny"& result does not happen until the end of the statement is reached,
28272 by which time Exim has set up the message.
28273
28274
28275
28276 .section "ACL modifiers" "SECTACLmodi"
28277 .cindex "&ACL;" "modifiers; list of"
28278 The ACL modifiers are as follows:
28279
28280 .vlist
28281 .vitem &*add_header*&&~=&~<&'text'&>
28282 This modifier specifies one or more header lines that are to be added to an
28283 incoming message, assuming, of course, that the message is ultimately
28284 accepted. For details, see section &<<SECTaddheadacl>>&.
28285
28286 .vitem &*continue*&&~=&~<&'text'&>
28287 .cindex "&%continue%& ACL modifier"
28288 .cindex "database" "updating in ACL"
28289 This modifier does nothing of itself, and processing of the ACL always
28290 continues with the next condition or modifier. The value of &%continue%& is in
28291 the side effects of expanding its argument. Typically this could be used to
28292 update a database. It is really just a syntactic tidiness, to avoid having to
28293 write rather ugly lines like this:
28294 .display
28295 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28296 .endd
28297 Instead, all you need is
28298 .display
28299 &`continue = `&<&'some expansion'&>
28300 .endd
28301
28302 .vitem &*control*&&~=&~<&'text'&>
28303 .cindex "&%control%& ACL modifier"
28304 This modifier affects the subsequent processing of the SMTP connection or of an
28305 incoming message that is accepted. The effect of the first type of control
28306 lasts for the duration of the connection, whereas the effect of the second type
28307 lasts only until the current message has been received. The message-specific
28308 controls always apply to the whole message, not to individual recipients,
28309 even if the &%control%& modifier appears in a RCPT ACL.
28310
28311 As there are now quite a few controls that can be applied, they are described
28312 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28313 in several different ways. For example:
28314
28315 . ==== As this is a nested list, any displays it contains must be indented
28316 . ==== as otherwise they are too far to the left. That comment applies only
28317 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28318 . ==== way.
28319
28320 .ilist
28321 It can be at the end of an &%accept%& statement:
28322 .code
28323     accept  ...some conditions
28324             control = queue_only
28325 .endd
28326 In this case, the control is applied when this statement yields &"accept"&, in
28327 other words, when the conditions are all true.
28328
28329 .next
28330 It can be in the middle of an &%accept%& statement:
28331 .code
28332     accept  ...some conditions...
28333             control = queue_only
28334             ...some more conditions...
28335 .endd
28336 If the first set of conditions are true, the control is applied, even if the
28337 statement does not accept because one of the second set of conditions is false.
28338 In this case, some subsequent statement must yield &"accept"& for the control
28339 to be relevant.
28340
28341 .next
28342 It can be used with &%warn%& to apply the control, leaving the
28343 decision about accepting or denying to a subsequent verb. For
28344 example:
28345 .code
28346     warn    ...some conditions...
28347             control = freeze
28348     accept  ...
28349 .endd
28350 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28351 &%logwrite%&, so it does not add anything to the message and does not write a
28352 log entry.
28353
28354 .next
28355 If you want to apply a control unconditionally, you can use it with a
28356 &%require%& verb. For example:
28357 .code
28358     require  control = no_multiline_responses
28359 .endd
28360 .endlist
28361
28362 .vitem &*delay*&&~=&~<&'time'&>
28363 .cindex "&%delay%& ACL modifier"
28364 .oindex "&%-bh%&"
28365 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28366 the time interval before proceeding. However, when testing Exim using the
28367 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28368 output instead). The time is given in the usual Exim notation, and the delay
28369 happens as soon as the modifier is processed. In an SMTP session, pending
28370 output is flushed before the delay is imposed.
28371
28372 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28373 example:
28374 .code
28375 deny    ...some conditions...
28376         delay = 30s
28377 .endd
28378 The delay happens if all the conditions are true, before the statement returns
28379 &"deny"&. Compare this with:
28380 .code
28381 deny    delay = 30s
28382         ...some conditions...
28383 .endd
28384 which waits for 30s before processing the conditions. The &%delay%& modifier
28385 can also be used with &%warn%& and together with &%control%&:
28386 .code
28387 warn    ...some conditions...
28388         delay = 2m
28389         control = freeze
28390 accept  ...
28391 .endd
28392
28393 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28394 responses to several commands are no longer buffered and sent in one packet (as
28395 they would normally be) because all output is flushed before imposing the
28396 delay. This optimization is disabled so that a number of small delays do not
28397 appear to the client as one large aggregated delay that might provoke an
28398 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28399 using a &%control%& modifier to set &%no_delay_flush%&.
28400
28401
28402 .vitem &*endpass*&
28403 .cindex "&%endpass%& ACL modifier"
28404 This modifier, which has no argument, is recognized only in &%accept%& and
28405 &%discard%& statements. It marks the boundary between the conditions whose
28406 failure causes control to pass to the next statement, and the conditions whose
28407 failure causes the ACL to return &"deny"&. This concept has proved to be
28408 confusing to some people, so the use of &%endpass%& is no longer recommended as
28409 &"best practice"&. See the description of &%accept%& above for more details.
28410
28411
28412 .vitem &*log_message*&&~=&~<&'text'&>
28413 .cindex "&%log_message%& ACL modifier"
28414 This modifier sets up a message that is used as part of the log message if the
28415 ACL denies access or a &%warn%& statement's conditions are true. For example:
28416 .code
28417 require log_message = wrong cipher suite $tls_in_cipher
28418         encrypted   = DES-CBC3-SHA
28419 .endd
28420 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28421 example:
28422 .display
28423 &`discard `&<&'some conditions'&>
28424 &`        log_message = Discarded $local_part@$domain because...`&
28425 .endd
28426 When access is denied, &%log_message%& adds to any underlying error message
28427 that may exist because of a condition failure. For example, while verifying a
28428 recipient address, a &':fail:'& redirection might have already set up a
28429 message.
28430
28431 The message may be defined before the conditions to which it applies, because
28432 the string expansion does not happen until Exim decides that access is to be
28433 denied. This means that any variables that are set by the condition are
28434 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28435 variables are set after a DNS black list lookup succeeds. If the expansion of
28436 &%log_message%& fails, or if the result is an empty string, the modifier is
28437 ignored.
28438
28439 .vindex "&$acl_verify_message$&"
28440 If you want to use a &%warn%& statement to log the result of an address
28441 verification, you can use &$acl_verify_message$& to include the verification
28442 error message.
28443
28444 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28445 the start of the logged message. If the same warning log message is requested
28446 more than once while receiving  a single email message, only one copy is
28447 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28448 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28449 is logged for a successful &%warn%& statement.
28450
28451 If &%log_message%& is not present and there is no underlying error message (for
28452 example, from the failure of address verification), but &%message%& is present,
28453 the &%message%& text is used for logging rejections. However, if any text for
28454 logging contains newlines, only the first line is logged. In the absence of
28455 both &%log_message%& and &%message%&, a default built-in message is used for
28456 logging rejections.
28457
28458
28459 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28460 .cindex "&%log_reject_target%& ACL modifier"
28461 .cindex "logging in ACL" "specifying which log"
28462 This modifier makes it possible to specify which logs are used for messages
28463 about ACL rejections. Its argument is a colon-separated list of words that can
28464 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28465 may be empty, in which case a rejection is not logged at all. For example, this
28466 ACL fragment writes no logging information when access is denied:
28467 .display
28468 &`deny `&<&'some conditions'&>
28469 &`     log_reject_target =`&
28470 .endd
28471 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28472 permanent and temporary rejections. Its effect lasts for the rest of the
28473 current ACL.
28474
28475
28476 .vitem &*logwrite*&&~=&~<&'text'&>
28477 .cindex "&%logwrite%& ACL modifier"
28478 .cindex "logging in ACL" "immediate"
28479 This modifier writes a message to a log file as soon as it is encountered when
28480 processing an ACL. (Compare &%log_message%&, which, except in the case of
28481 &%warn%& and &%discard%&, is used only if the ACL statement denies
28482 access.) The &%logwrite%& modifier can be used to log special incidents in
28483 ACLs. For example:
28484 .display
28485 &`accept `&<&'some special conditions'&>
28486 &`       control  = freeze`&
28487 &`       logwrite = froze message because ...`&
28488 .endd
28489 By default, the message is written to the main log. However, it may begin
28490 with a colon, followed by a comma-separated list of log names, and then
28491 another colon, to specify exactly which logs are to be written. For
28492 example:
28493 .code
28494 logwrite = :main,reject: text for main and reject logs
28495 logwrite = :panic: text for panic log only
28496 .endd
28497
28498
28499 .vitem &*message*&&~=&~<&'text'&>
28500 .cindex "&%message%& ACL modifier"
28501 This modifier sets up a text string that is expanded and used as a response
28502 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28503 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28504 there is some complication if &%endpass%& is involved; see the description of
28505 &%accept%& for details.)
28506
28507 The expansion of the message happens at the time Exim decides that the ACL is
28508 to end, not at the time it processes &%message%&. If the expansion fails, or
28509 generates an empty string, the modifier is ignored. Here is an example where
28510 &%message%& must be specified first, because the ACL ends with a rejection if
28511 the &%hosts%& condition fails:
28512 .code
28513 require  message = Host not recognized
28514          hosts = 10.0.0.0/8
28515 .endd
28516 (Once a condition has failed, no further conditions or modifiers are
28517 processed.)
28518
28519 .cindex "SMTP" "error codes"
28520 .oindex "&%smtp_banner%&
28521 For ACLs that are triggered by SMTP commands, the message is returned as part
28522 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28523 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28524 is accepted. In the case of the connect ACL, accepting with a message modifier
28525 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28526 accept message may not contain more than one line (otherwise it will be
28527 truncated at the first newline and a panic logged), and it cannot affect the
28528 EHLO options.
28529
28530 When SMTP is involved, the message may begin with an overriding response code,
28531 consisting of three digits optionally followed by an &"extended response code"&
28532 of the form &'n.n.n'&, each code being followed by a space. For example:
28533 .code
28534 deny  message = 599 1.2.3 Host not welcome
28535       hosts = 192.168.34.0/24
28536 .endd
28537 The first digit of the supplied response code must be the same as would be sent
28538 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28539 access, but for the predata ACL, note that the default success code is 354, not
28540 2&'xx'&.
28541
28542 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28543 the message modifier cannot override the 221 response code.
28544
28545 The text in a &%message%& modifier is literal; any quotes are taken as
28546 literals, but because the string is expanded, backslash escapes are processed
28547 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28548 response.
28549
28550 .vindex "&$acl_verify_message$&"
28551 For ACLs that are called by an &%acl =%& ACL condition, the message is
28552 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28553
28554 If &%message%& is used on a statement that verifies an address, the message
28555 specified overrides any message that is generated by the verification process.
28556 However, the original message is available in the variable
28557 &$acl_verify_message$&, so you can incorporate it into your message if you
28558 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28559 routers to be passed back as part of the SMTP response, you should either not
28560 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28561
28562 For compatibility with previous releases of Exim, a &%message%& modifier that
28563 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28564 modifier, but this usage is now deprecated. However, &%message%& acts only when
28565 all the conditions are true, wherever it appears in an ACL command, whereas
28566 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28567 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28568 effect.
28569
28570
28571 .vitem &*remove_header*&&~=&~<&'text'&>
28572 This modifier specifies one or more header names in a colon-separated list
28573  that are to be removed from an incoming message, assuming, of course, that
28574 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28575
28576
28577 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28578 .cindex "&%set%& ACL modifier"
28579 This modifier puts a value into one of the ACL variables (see section
28580 &<<SECTaclvariables>>&).
28581
28582
28583 .vitem &*udpsend*&&~=&~<&'parameters'&>
28584 This modifier sends a UDP packet, for purposes such as statistics
28585 collection or behaviour monitoring. The parameters are expanded, and
28586 the result of the expansion must be a colon-separated list consisting
28587 of a destination server, port number, and the packet contents. The
28588 server can be specified as a host name or IPv4 or IPv6 address. The
28589 separator can be changed with the usual angle bracket syntax. For
28590 example, you might want to collect information on which hosts connect
28591 when:
28592 .code
28593 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28594              $tod_zulu $sender_host_address
28595 .endd
28596 .endlist
28597
28598
28599
28600
28601 .section "Use of the control modifier" "SECTcontrols"
28602 .cindex "&%control%& ACL modifier"
28603 The &%control%& modifier supports the following settings:
28604
28605 .vlist
28606 .vitem &*control&~=&~allow_auth_unadvertised*&
28607 This modifier allows a client host to use the SMTP AUTH command even when it
28608 has not been advertised in response to EHLO. Furthermore, because there are
28609 apparently some really broken clients that do this, Exim will accept AUTH after
28610 HELO (rather than EHLO) when this control is set. It should be used only if you
28611 really need it, and you should limit its use to those broken clients that do
28612 not work without it. For example:
28613 .code
28614 warn hosts   = 192.168.34.25
28615      control = allow_auth_unadvertised
28616 .endd
28617 Normally, when an Exim server receives an AUTH command, it checks the name of
28618 the authentication mechanism that is given in the command to ensure that it
28619 matches an advertised mechanism. When this control is set, the check that a
28620 mechanism has been advertised is bypassed. Any configured mechanism can be used
28621 by the client. This control is permitted only in the connection and HELO ACLs.
28622
28623
28624 .vitem &*control&~=&~caseful_local_part*& &&&
28625        &*control&~=&~caselower_local_part*&
28626 .cindex "&ACL;" "case of local part in"
28627 .cindex "case of local parts"
28628 .vindex "&$local_part$&"
28629 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28630 (that is, during RCPT processing). By default, the contents of &$local_part$&
28631 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28632 any uppercase letters in the original local part are restored in &$local_part$&
28633 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28634 is encountered.
28635
28636 These controls affect only the current recipient. Moreover, they apply only to
28637 local part handling that takes place directly in the ACL (for example, as a key
28638 in lookups). If a test to verify the recipient is obeyed, the case-related
28639 handling of the local part during the verification is controlled by the router
28640 configuration (see the &%caseful_local_part%& generic router option).
28641
28642 This facility could be used, for example, to add a spam score to local parts
28643 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28644 spam score:
28645 .code
28646 warn  control = caseful_local_part
28647       set acl_m4 = ${eval:\
28648                      $acl_m4 + \
28649                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28650                     }
28651       control = caselower_local_part
28652 .endd
28653 Notice that we put back the lower cased version afterwards, assuming that
28654 is what is wanted for subsequent tests.
28655
28656
28657 .vitem &*control&~=&~cutthrough_delivery*&
28658 .cindex "&ACL;" "cutthrough routing"
28659 .cindex "cutthrough" "requesting"
28660 This option requests delivery be attempted while the item is being received.
28661
28662 The option is usable in the RCPT ACL.
28663 If enabled for a message received via smtp and routed to an smtp transport,
28664 and only one transport, interface, destination host and port combination
28665 is used for all recipients of the message,
28666 then the delivery connection is made while the receiving connection is open
28667 and data is copied from one to the other.
28668
28669 An attempt to set this option for any recipient but the first
28670 for a mail will be quietly ignored.
28671 If a recipient-verify callout
28672 (with use_sender)
28673 connection is subsequently
28674 requested in the same ACL it is held open and used for
28675 any subsequent recipients and the data,
28676 otherwise one is made after the initial RCPT ACL completes.
28677
28678 Note that routers are used in verify mode,
28679 and cannot depend on content of received headers.
28680 Note also that headers cannot be
28681 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28682 Headers may be modified by routers (subject to the above) and transports.
28683
28684 All the usual ACLs are called; if one results in the message being
28685 rejected, all effort spent in delivery (including the costs on
28686 the ultimate destination) will be wasted.
28687 Note that in the case of data-time ACLs this includes the entire
28688 message body.
28689
28690 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28691 of outgoing messages is done, because it sends data to the ultimate destination
28692 before the entire message has been received from the source.
28693 It is not supported for messages received with the SMTP PRDR option in use.
28694
28695 Should the ultimate destination system positively accept or reject the mail,
28696 a corresponding indication is given to the source system and nothing is queued.
28697 If there is a temporary error the item is queued for later delivery in the
28698 usual fashion. If the item is successfully delivered in cutthrough mode
28699 the delivery log lines are tagged with ">>" rather than "=>" and appear
28700 before the acceptance "<=" line.
28701
28702 Delivery in this mode avoids the generation of a bounce mail to a
28703 (possibly faked)
28704 sender when the destination system is doing content-scan based rejection.
28705
28706
28707 .vitem &*control&~=&~debug/*&<&'options'&>
28708 .cindex "&ACL;" "enabling debug logging"
28709 .cindex "debugging" "enabling from an ACL"
28710 This control turns on debug logging, almost as though Exim had been invoked
28711 with &`-d`&, with the output going to a new logfile, by default called
28712 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28713 may access any variables already defined.  The logging may be adjusted with
28714 the &'opts'& option, which takes the same values as the &`-d`& command-line
28715 option.
28716 .new
28717 Logging may be stopped, and the file removed, with the &'kill'& option.
28718 .wen
28719 Some examples (which depend on variables that don't exist in all
28720 contexts):
28721 .code
28722       control = debug
28723       control = debug/tag=.$sender_host_address
28724       control = debug/opts=+expand+acl
28725       control = debug/tag=.$message_exim_id/opts=+expand
28726       control = debug/kill
28727 .endd
28728
28729
28730 .vitem &*control&~=&~dkim_disable_verify*&
28731 .cindex "disable DKIM verify"
28732 .cindex "DKIM" "disable verify"
28733 This control turns off DKIM verification processing entirely.  For details on
28734 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28735
28736
28737 .vitem &*control&~=&~dscp/*&<&'value'&>
28738 .cindex "&ACL;" "setting DSCP value"
28739 .cindex "DSCP" "inbound"
28740 This option causes the DSCP value associated with the socket for the inbound
28741 connection to be adjusted to a given value, given as one of a number of fixed
28742 strings or to numeric value.
28743 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28744 Common values include &`throughput`&, &`mincost`&, and on newer systems
28745 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28746
28747 The outbound packets from Exim will be marked with this value in the header
28748 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28749 that these values will have any effect, not be stripped by networking
28750 equipment, or do much of anything without cooperation with your Network
28751 Engineer and those of all network operators between the source and destination.
28752
28753
28754 .vitem &*control&~=&~enforce_sync*& &&&
28755        &*control&~=&~no_enforce_sync*&
28756 .cindex "SMTP" "synchronization checking"
28757 .cindex "synchronization checking in SMTP"
28758 These controls make it possible to be selective about when SMTP synchronization
28759 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28760 state of the switch (it is true by default). See the description of this option
28761 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28762
28763 The effect of these two controls lasts for the remainder of the SMTP
28764 connection. They can appear in any ACL except the one for the non-SMTP
28765 messages. The most straightforward place to put them is in the ACL defined by
28766 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28767 before the first synchronization check. The expected use is to turn off the
28768 synchronization checks for badly-behaved hosts that you nevertheless need to
28769 work with.
28770
28771
28772 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28773 .cindex "fake defer"
28774 .cindex "defer, fake"
28775 This control works in exactly the same way as &%fakereject%& (described below)
28776 except that it causes an SMTP 450 response after the message data instead of a
28777 550 response. You must take care when using &%fakedefer%& because it causes the
28778 messages to be duplicated when the sender retries. Therefore, you should not
28779 use &%fakedefer%& if the message is to be delivered normally.
28780
28781 .vitem &*control&~=&~fakereject/*&<&'message'&>
28782 .cindex "fake rejection"
28783 .cindex "rejection, fake"
28784 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28785 words, only when an SMTP message is being received. If Exim accepts the
28786 message, instead the final 250 response, a 550 rejection message is sent.
28787 However, Exim proceeds to deliver the message as normal. The control applies
28788 only to the current message, not to any subsequent ones that may be received in
28789 the same SMTP connection.
28790
28791 The text for the 550 response is taken from the &%control%& modifier. If no
28792 message is supplied, the following is used:
28793 .code
28794 550-Your message has been rejected but is being
28795 550-kept for evaluation.
28796 550-If it was a legitimate message, it may still be
28797 550 delivered to the target recipient(s).
28798 .endd
28799 This facility should be used with extreme caution.
28800
28801 .vitem &*control&~=&~freeze*&
28802 .cindex "frozen messages" "forcing in ACL"
28803 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28804 other words, only when a message is being received. If the message is accepted,
28805 it is placed on Exim's queue and frozen. The control applies only to the
28806 current message, not to any subsequent ones that may be received in the same
28807 SMTP connection.
28808
28809 This modifier can optionally be followed by &`/no_tell`&. If the global option
28810 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28811 is told about the freezing), provided all the &*control=freeze*& modifiers that
28812 are obeyed for the current message have the &`/no_tell`& option.
28813
28814 .vitem &*control&~=&~no_delay_flush*&
28815 .cindex "SMTP" "output flushing, disabling for delay"
28816 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28817 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28818 use. This control, as long as it is encountered before the &%delay%& modifier,
28819 disables such output flushing.
28820
28821 .vitem &*control&~=&~no_callout_flush*&
28822 .cindex "SMTP" "output flushing, disabling for callout"
28823 Exim normally flushes SMTP output before performing a callout in an ACL, to
28824 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28825 use. This control, as long as it is encountered before the &%verify%& condition
28826 that causes the callout, disables such output flushing.
28827
28828 .vitem &*control&~=&~no_mbox_unspool*&
28829 This control is available when Exim is compiled with the content scanning
28830 extension. Content scanning may require a copy of the current message, or parts
28831 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28832 or spam scanner. Normally, such copies are deleted when they are no longer
28833 needed. If this control is set, the copies are not deleted. The control applies
28834 only to the current message, not to any subsequent ones that may be received in
28835 the same SMTP connection. It is provided for debugging purposes and is unlikely
28836 to be useful in production.
28837
28838 .vitem &*control&~=&~no_multiline_responses*&
28839 .cindex "multiline responses, suppressing"
28840 This control is permitted for any ACL except the one for non-SMTP messages.
28841 It seems that there are broken clients in use that cannot handle multiline
28842 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28843
28844 If this control is set, multiline SMTP responses from ACL rejections are
28845 suppressed. One way of doing this would have been to put out these responses as
28846 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28847 (&"use multiline responses for more"& it says &-- ha!), and some of the
28848 responses might get close to that. So this facility, which is after all only a
28849 sop to broken clients, is implemented by doing two very easy things:
28850
28851 .ilist
28852 Extra information that is normally output as part of a rejection caused by
28853 sender verification failure is omitted. Only the final line (typically &"sender
28854 verification failed"&) is sent.
28855 .next
28856 If a &%message%& modifier supplies a multiline response, only the first
28857 line is output.
28858 .endlist
28859
28860 The setting of the switch can, of course, be made conditional on the
28861 calling host. Its effect lasts until the end of the SMTP connection.
28862
28863 .vitem &*control&~=&~no_pipelining*&
28864 .cindex "PIPELINING" "suppressing advertising"
28865 This control turns off the advertising of the PIPELINING extension to SMTP in
28866 the current session. To be useful, it must be obeyed before Exim sends its
28867 response to an EHLO command. Therefore, it should normally appear in an ACL
28868 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28869 &%pipelining_advertise_hosts%&.
28870
28871 .vitem &*control&~=&~queue_only*&
28872 .oindex "&%queue_only%&"
28873 .cindex "queueing incoming messages"
28874 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28875 other words, only when a message is being received. If the message is accepted,
28876 it is placed on Exim's queue and left there for delivery by a subsequent queue
28877 runner. No immediate delivery process is started. In other words, it has the
28878 effect as the &%queue_only%& global option. However, the control applies only
28879 to the current message, not to any subsequent ones that may be received in the
28880 same SMTP connection.
28881
28882 .vitem &*control&~=&~submission/*&<&'options'&>
28883 .cindex "message" "submission"
28884 .cindex "submission mode"
28885 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28886 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28887 the current message is a submission from a local MUA. In this case, Exim
28888 operates in &"submission mode"&, and applies certain fixups to the message if
28889 necessary. For example, it adds a &'Date:'& header line if one is not present.
28890 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28891 late (the message has already been created).
28892
28893 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28894 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28895 submission mode; the available options for this control are described there.
28896 The control applies only to the current message, not to any subsequent ones
28897 that may be received in the same SMTP connection.
28898
28899 .vitem &*control&~=&~suppress_local_fixups*&
28900 .cindex "submission fixups, suppressing"
28901 This control applies to locally submitted (non TCP/IP) messages, and is the
28902 complement of &`control = submission`&. It disables the fixups that are
28903 normally applied to locally-submitted messages. Specifically:
28904
28905 .ilist
28906 Any &'Sender:'& header line is left alone (in this respect, it is a
28907 dynamic version of &%local_sender_retain%&).
28908 .next
28909 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28910 .next
28911 There is no check that &'From:'& corresponds to the actual sender.
28912 .endlist ilist
28913
28914 This control may be useful when a remotely-originated message is accepted,
28915 passed to some scanning program, and then re-submitted for delivery. It can be
28916 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28917 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28918 data is read.
28919
28920 &*Note:*& This control applies only to the current message, not to any others
28921 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28922
28923 .vitem &*control&~=&~utf8_downconvert*&
28924 This control enables conversion of UTF-8 in message addresses
28925 to a-label form.
28926 For details see &<<SECTi18nMTA>>&.
28927 .endlist vlist
28928
28929
28930 .section "Summary of message fixup control" "SECTsummesfix"
28931 All four possibilities for message fixups can be specified:
28932
28933 .ilist
28934 Locally submitted, fixups applied: the default.
28935 .next
28936 Locally submitted, no fixups applied: use
28937 &`control = suppress_local_fixups`&.
28938 .next
28939 Remotely submitted, no fixups applied: the default.
28940 .next
28941 Remotely submitted, fixups applied: use &`control = submission`&.
28942 .endlist
28943
28944
28945
28946 .section "Adding header lines in ACLs" "SECTaddheadacl"
28947 .cindex "header lines" "adding in an ACL"
28948 .cindex "header lines" "position of added lines"
28949 .cindex "&%add_header%& ACL modifier"
28950 The &%add_header%& modifier can be used to add one or more extra header lines
28951 to an incoming message, as in this example:
28952 .code
28953 warn dnslists = sbl.spamhaus.org : \
28954                 dialup.mail-abuse.org
28955      add_header = X-blacklisted-at: $dnslist_domain
28956 .endd
28957 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28958 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28959 receiving a message). The message must ultimately be accepted for
28960 &%add_header%& to have any significant effect. You can use &%add_header%& with
28961 any ACL verb, including &%deny%& (though this is potentially useful only in a
28962 RCPT ACL).
28963
28964 Headers will not be added to the message if the modifier is used in
28965 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28966
28967 Leading and trailing newlines are removed from
28968 the data for the &%add_header%& modifier; if it then
28969 contains one or more newlines that
28970 are not followed by a space or a tab, it is assumed to contain multiple header
28971 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28972 front of any line that is not a valid header line.
28973
28974 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28975 They are added to the message before processing the DATA and MIME ACLs.
28976 However, if an identical header line is requested more than once, only one copy
28977 is actually added to the message. Further header lines may be accumulated
28978 during the DATA and MIME ACLs, after which they are added to the message, again
28979 with duplicates suppressed. Thus, it is possible to add two identical header
28980 lines to an SMTP message, but only if one is added before DATA and one after.
28981 In the case of non-SMTP messages, new headers are accumulated during the
28982 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28983 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28984 are included in the entry that is written to the reject log.
28985
28986 .cindex "header lines" "added; visibility of"
28987 Header lines are not visible in string expansions
28988 of message headers
28989 until they are added to the
28990 message. It follows that header lines defined in the MAIL, RCPT, and predata
28991 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28992 header lines that are added by the DATA or MIME ACLs are not visible in those
28993 ACLs. Because of this restriction, you cannot use header lines as a way of
28994 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28995 this, you can use ACL variables, as described in section
28996 &<<SECTaclvariables>>&.
28997
28998 The list of headers yet to be added is given by the &%$headers_added%& variable.
28999
29000 The &%add_header%& modifier acts immediately as it is encountered during the
29001 processing of an ACL. Notice the difference between these two cases:
29002 .display
29003 &`accept add_header = ADDED: some text`&
29004 &`       `&<&'some condition'&>
29005
29006 &`accept `&<&'some condition'&>
29007 &`       add_header = ADDED: some text`&
29008 .endd
29009 In the first case, the header line is always added, whether or not the
29010 condition is true. In the second case, the header line is added only if the
29011 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29012 ACL statement. All those that are encountered before a condition fails are
29013 honoured.
29014
29015 .cindex "&%warn%& ACL verb"
29016 For compatibility with previous versions of Exim, a &%message%& modifier for a
29017 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29018 effect only if all the conditions are true, even if it appears before some of
29019 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29020 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29021 are present on a &%warn%& verb, both are processed according to their
29022 specifications.
29023
29024 By default, new header lines are added to a message at the end of the existing
29025 header lines. However, you can specify that any particular header line should
29026 be added right at the start (before all the &'Received:'& lines), immediately
29027 after the first block of &'Received:'& lines, or immediately before any line
29028 that is not a &'Received:'& or &'Resent-something:'& header.
29029
29030 This is done by specifying &":at_start:"&, &":after_received:"&, or
29031 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29032 header line, respectively. (Header text cannot start with a colon, as there has
29033 to be a header name first.) For example:
29034 .code
29035 warn add_header = \
29036        :after_received:X-My-Header: something or other...
29037 .endd
29038 If more than one header line is supplied in a single &%add_header%& modifier,
29039 each one is treated independently and can therefore be placed differently. If
29040 you add more than one line at the start, or after the Received: block, they end
29041 up in reverse order.
29042
29043 &*Warning*&: This facility currently applies only to header lines that are
29044 added in an ACL. It does NOT work for header lines that are added in a
29045 system filter or in a router or transport.
29046
29047
29048
29049 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29050 .cindex "header lines" "removing in an ACL"
29051 .cindex "header lines" "position of removed lines"
29052 .cindex "&%remove_header%& ACL modifier"
29053 The &%remove_header%& modifier can be used to remove one or more header lines
29054 from an incoming message, as in this example:
29055 .code
29056 warn   message        = Remove internal headers
29057        remove_header  = x-route-mail1 : x-route-mail2
29058 .endd
29059 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29060 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29061 receiving a message). The message must ultimately be accepted for
29062 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29063 with any ACL verb, including &%deny%&, though this is really not useful for
29064 any verb that doesn't result in a delivered message.
29065
29066 Headers will not be removed to the message if the modifier is used in
29067 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
29068
29069 More than one header can be removed at the same time by using a colon separated
29070 list of header names. The header matching is case insensitive. Wildcards are
29071 not permitted, nor is list expansion performed, so you cannot use hostlists to
29072 create a list of headers, however both connection and message variable expansion
29073 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29074 .code
29075 warn   hosts           = +internal_hosts
29076        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29077 warn   message         = Remove internal headers
29078        remove_header   = $acl_c_ihdrs
29079 .endd
29080 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29081 They are removed from the message before processing the DATA and MIME ACLs.
29082 There is no harm in attempting to remove the same header twice nor is removing
29083 a non-existent header. Further header lines to be removed may be accumulated
29084 during the DATA and MIME ACLs, after which they are removed from the message,
29085 if present. In the case of non-SMTP messages, headers to be removed are
29086 accumulated during the non-SMTP ACLs, and are removed from the message after
29087 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29088 ACL, there really is no effect because there is no logging of what headers
29089 would have been removed.
29090
29091 .cindex "header lines" "removed; visibility of"
29092 Header lines are not visible in string expansions until the DATA phase when it
29093 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29094 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29095 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29096 this restriction, you cannot use header lines as a way of controlling data
29097 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29098 you should instead use ACL variables, as described in section
29099 &<<SECTaclvariables>>&.
29100
29101 The &%remove_header%& modifier acts immediately as it is encountered during the
29102 processing of an ACL. Notice the difference between these two cases:
29103 .display
29104 &`accept remove_header = X-Internal`&
29105 &`       `&<&'some condition'&>
29106
29107 &`accept `&<&'some condition'&>
29108 &`       remove_header = X-Internal`&
29109 .endd
29110 In the first case, the header line is always removed, whether or not the
29111 condition is true. In the second case, the header line is removed only if the
29112 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29113 same ACL statement. All those that are encountered before a condition fails
29114 are honoured.
29115
29116 &*Warning*&: This facility currently applies only to header lines that are
29117 present during ACL processing. It does NOT remove header lines that are added
29118 in a system filter or in a router or transport.
29119
29120
29121
29122
29123 .section "ACL conditions" "SECTaclconditions"
29124 .cindex "&ACL;" "conditions; list of"
29125 Some of the conditions listed in this section are available only when Exim is
29126 compiled with the content-scanning extension. They are included here briefly
29127 for completeness. More detailed descriptions can be found in the discussion on
29128 content scanning in chapter &<<CHAPexiscan>>&.
29129
29130 Not all conditions are relevant in all circumstances. For example, testing
29131 senders and recipients does not make sense in an ACL that is being run as the
29132 result of the arrival of an ETRN command, and checks on message headers can be
29133 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29134 can use the same condition (with different parameters) more than once in the
29135 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29136 The conditions are as follows:
29137
29138
29139 .vlist
29140 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29141 .cindex "&ACL;" "nested"
29142 .cindex "&ACL;" "indirect"
29143 .cindex "&ACL;" "arguments"
29144 .cindex "&%acl%& ACL condition"
29145 The possible values of the argument are the same as for the
29146 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29147 &"accept"& the condition is true; if it returns &"deny"& the condition is
29148 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29149 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29150 condition false. This means that further processing of the &%warn%& verb
29151 ceases, but processing of the ACL continues.
29152
29153 If the argument is a named ACL, up to nine space-separated optional values
29154 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29155 and $acl_narg is set to the count of values.
29156 Previous values of these variables are restored after the call returns.
29157 The name and values are expanded separately.
29158 Note that spaces in complex expansions which are used as arguments
29159 will act as argument separators.
29160
29161 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29162 the connection is dropped. If it returns &"discard"&, the verb must be
29163 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29164 conditions are tested.
29165
29166 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29167 loops. This condition allows you to use different ACLs in different
29168 circumstances. For example, different ACLs can be used to handle RCPT commands
29169 for different local users or different local domains.
29170
29171 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29172 .cindex "&%authenticated%& ACL condition"
29173 .cindex "authentication" "ACL checking"
29174 .cindex "&ACL;" "testing for authentication"
29175 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29176 the name of the authenticator is tested against the list. To test for
29177 authentication by any authenticator, you can set
29178 .code
29179 authenticated = *
29180 .endd
29181
29182 .vitem &*condition&~=&~*&<&'string'&>
29183 .cindex "&%condition%& ACL condition"
29184 .cindex "customizing" "ACL condition"
29185 .cindex "&ACL;" "customized test"
29186 .cindex "&ACL;" "testing, customized"
29187 This feature allows you to make up custom conditions. If the result of
29188 expanding the string is an empty string, the number zero, or one of the strings
29189 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29190 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29191 any other value, some error is assumed to have occurred, and the ACL returns
29192 &"defer"&. However, if the expansion is forced to fail, the condition is
29193 ignored. The effect is to treat it as true, whether it is positive or
29194 negative.
29195
29196 .vitem &*decode&~=&~*&<&'location'&>
29197 .cindex "&%decode%& ACL condition"
29198 This condition is available only when Exim is compiled with the
29199 content-scanning extension, and it is allowed only in the ACL defined by
29200 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29201 If all goes well, the condition is true. It is false only if there are
29202 problems such as a syntax error or a memory shortage. For more details, see
29203 chapter &<<CHAPexiscan>>&.
29204
29205 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29206 .cindex "&%dnslists%& ACL condition"
29207 .cindex "DNS list" "in ACL"
29208 .cindex "black list (DNS)"
29209 .cindex "&ACL;" "testing a DNS list"
29210 This condition checks for entries in DNS black lists. These are also known as
29211 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29212 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29213 different variants of this condition to describe briefly here. See sections
29214 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29215
29216 .vitem &*domains&~=&~*&<&'domain&~list'&>
29217 .cindex "&%domains%& ACL condition"
29218 .cindex "domain" "ACL checking"
29219 .cindex "&ACL;" "testing a recipient domain"
29220 .vindex "&$domain_data$&"
29221 This condition is relevant only after a RCPT command. It checks that the domain
29222 of the recipient address is in the domain list. If percent-hack processing is
29223 enabled, it is done before this test is done. If the check succeeds with a
29224 lookup, the result of the lookup is placed in &$domain_data$& until the next
29225 &%domains%& test.
29226
29227 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29228 use &%domains%& in a DATA ACL.
29229
29230
29231 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29232 .cindex "&%encrypted%& ACL condition"
29233 .cindex "encryption" "checking in an ACL"
29234 .cindex "&ACL;" "testing for encryption"
29235 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29236 name of the cipher suite in use is tested against the list. To test for
29237 encryption without testing for any specific cipher suite(s), set
29238 .code
29239 encrypted = *
29240 .endd
29241
29242
29243 .vitem &*hosts&~=&~*&<&'host&~list'&>
29244 .cindex "&%hosts%& ACL condition"
29245 .cindex "host" "ACL checking"
29246 .cindex "&ACL;" "testing the client host"
29247 This condition tests that the calling host matches the host list. If you have
29248 name lookups or wildcarded host names and IP addresses in the same host list,
29249 you should normally put the IP addresses first. For example, you could have:
29250 .code
29251 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29252 .endd
29253 The lookup in this example uses the host name for its key. This is implied by
29254 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29255 and it wouldn't matter which way round you had these two items.)
29256
29257 The reason for the problem with host names lies in the left-to-right way that
29258 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29259 but when it reaches an item that requires a host name, it fails if it cannot
29260 find a host name to compare with the pattern. If the above list is given in the
29261 opposite order, the &%accept%& statement fails for a host whose name cannot be
29262 found, even if its IP address is 10.9.8.7.
29263
29264 If you really do want to do the name check first, and still recognize the IP
29265 address even if the name lookup fails, you can rewrite the ACL like this:
29266 .code
29267 accept hosts = dbm;/etc/friendly/hosts
29268 accept hosts = 10.9.8.7
29269 .endd
29270 The default action on failing to find the host name is to assume that the host
29271 is not in the list, so the first &%accept%& statement fails. The second
29272 statement can then check the IP address.
29273
29274 .vindex "&$host_data$&"
29275 If a &%hosts%& condition is satisfied by means of a lookup, the result
29276 of the lookup is made available in the &$host_data$& variable. This
29277 allows you, for example, to set up a statement like this:
29278 .code
29279 deny  hosts = net-lsearch;/some/file
29280 message = $host_data
29281 .endd
29282 which gives a custom error message for each denied host.
29283
29284 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29285 .cindex "&%local_parts%& ACL condition"
29286 .cindex "local part" "ACL checking"
29287 .cindex "&ACL;" "testing a local part"
29288 .vindex "&$local_part_data$&"
29289 This condition is relevant only after a RCPT command. It checks that the local
29290 part of the recipient address is in the list. If percent-hack processing is
29291 enabled, it is done before this test. If the check succeeds with a lookup, the
29292 result of the lookup is placed in &$local_part_data$&, which remains set until
29293 the next &%local_parts%& test.
29294
29295 .vitem &*malware&~=&~*&<&'option'&>
29296 .cindex "&%malware%& ACL condition"
29297 .cindex "&ACL;" "virus scanning"
29298 .cindex "&ACL;" "scanning for viruses"
29299 This condition is available only when Exim is compiled with the
29300 content-scanning extension. It causes the incoming message to be scanned for
29301 viruses. For details, see chapter &<<CHAPexiscan>>&.
29302
29303 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29304 .cindex "&%mime_regex%& ACL condition"
29305 .cindex "&ACL;" "testing by regex matching"
29306 This condition is available only when Exim is compiled with the
29307 content-scanning extension, and it is allowed only in the ACL defined by
29308 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29309 with any of the regular expressions. For details, see chapter
29310 &<<CHAPexiscan>>&.
29311
29312 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29313 .cindex "rate limiting"
29314 This condition can be used to limit the rate at which a user or host submits
29315 messages. Details are given in section &<<SECTratelimiting>>&.
29316
29317 .vitem &*recipients&~=&~*&<&'address&~list'&>
29318 .cindex "&%recipients%& ACL condition"
29319 .cindex "recipient" "ACL checking"
29320 .cindex "&ACL;" "testing a recipient"
29321 This condition is relevant only after a RCPT command. It checks the entire
29322 recipient address against a list of recipients.
29323
29324 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29325 .cindex "&%regex%& ACL condition"
29326 .cindex "&ACL;" "testing by regex matching"
29327 This condition is available only when Exim is compiled with the
29328 content-scanning extension, and is available only in the DATA, MIME, and
29329 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29330 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29331
29332 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29333 .cindex "&%sender_domains%& ACL condition"
29334 .cindex "sender" "ACL checking"
29335 .cindex "&ACL;" "testing a sender domain"
29336 .vindex "&$domain$&"
29337 .vindex "&$sender_address_domain$&"
29338 This condition tests the domain of the sender of the message against the given
29339 domain list. &*Note*&: The domain of the sender address is in
29340 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29341 of this condition. This is an exception to the general rule for testing domain
29342 lists. It is done this way so that, if this condition is used in an ACL for a
29343 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29344 influence the sender checking.
29345
29346 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29347 relaying, because sender addresses are easily, and commonly, forged.
29348
29349 .vitem &*senders&~=&~*&<&'address&~list'&>
29350 .cindex "&%senders%& ACL condition"
29351 .cindex "sender" "ACL checking"
29352 .cindex "&ACL;" "testing a sender"
29353 This condition tests the sender of the message against the given list. To test
29354 for a bounce message, which has an empty sender, set
29355 .code
29356 senders = :
29357 .endd
29358 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29359 relaying, because sender addresses are easily, and commonly, forged.
29360
29361 .vitem &*spam&~=&~*&<&'username'&>
29362 .cindex "&%spam%& ACL condition"
29363 .cindex "&ACL;" "scanning for spam"
29364 This condition is available only when Exim is compiled with the
29365 content-scanning extension. It causes the incoming message to be scanned by
29366 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29367
29368 .vitem &*verify&~=&~certificate*&
29369 .cindex "&%verify%& ACL condition"
29370 .cindex "TLS" "client certificate verification"
29371 .cindex "certificate" "verification of client"
29372 .cindex "&ACL;" "certificate verification"
29373 .cindex "&ACL;" "testing a TLS certificate"
29374 This condition is true in an SMTP session if the session is encrypted, and a
29375 certificate was received from the client, and the certificate was verified. The
29376 server requests a certificate only if the client matches &%tls_verify_hosts%&
29377 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29378
29379 .vitem &*verify&~=&~csa*&
29380 .cindex "CSA verification"
29381 This condition checks whether the sending host (the client) is authorized to
29382 send email. Details of how this works are given in section
29383 &<<SECTverifyCSA>>&.
29384
29385 .vitem &*verify&~=&~header_names_ascii*&
29386 .cindex "&%verify%& ACL condition"
29387 .cindex "&ACL;" "verifying header names only ASCII"
29388 .cindex "header lines" "verifying header names only ASCII"
29389 .cindex "verifying" "header names only ASCII"
29390 This condition is relevant only in an ACL that is run after a message has been
29391 received, that is, in an ACL specified by &%acl_smtp_data%& or
29392 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29393 there are no non-ASCII characters, also excluding control characters.  The
29394 allowable characters are decimal ASCII values 33 through 126.
29395
29396 Exim itself will handle headers with non-ASCII characters, but it can cause
29397 problems for downstream applications, so this option will allow their
29398 detection and rejection in the DATA ACL's.
29399
29400 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29401 .cindex "&%verify%& ACL condition"
29402 .cindex "&ACL;" "verifying sender in the header"
29403 .cindex "header lines" "verifying the sender in"
29404 .cindex "sender" "verifying in header"
29405 .cindex "verifying" "sender in header"
29406 This condition is relevant only in an ACL that is run after a message has been
29407 received, that is, in an ACL specified by &%acl_smtp_data%& or
29408 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29409 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29410 is loosely thought of as a &"sender"& address (hence the name of the test).
29411 However, an address that appears in one of these headers need not be an address
29412 that accepts bounce messages; only sender addresses in envelopes are required
29413 to accept bounces. Therefore, if you use the callout option on this check, you
29414 might want to arrange for a non-empty address in the MAIL command.
29415
29416 Details of address verification and the options are given later, starting at
29417 section &<<SECTaddressverification>>& (callouts are described in section
29418 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29419 condition to restrict it to bounce messages only:
29420 .code
29421 deny    senders = :
29422         message = A valid sender header is required for bounces
29423        !verify  = header_sender
29424 .endd
29425
29426 .vitem &*verify&~=&~header_syntax*&
29427 .cindex "&%verify%& ACL condition"
29428 .cindex "&ACL;" "verifying header syntax"
29429 .cindex "header lines" "verifying syntax"
29430 .cindex "verifying" "header syntax"
29431 This condition is relevant only in an ACL that is run after a message has been
29432 received, that is, in an ACL specified by &%acl_smtp_data%& or
29433 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29434 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29435 and &'Bcc:'&), returning true if there are no problems.
29436 Unqualified addresses (local parts without domains) are
29437 permitted only in locally generated messages and from hosts that match
29438 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29439 appropriate.
29440
29441 Note that this condition is a syntax check only. However, a common spamming
29442 ploy used to be to send syntactically invalid headers such as
29443 .code
29444 To: @
29445 .endd
29446 and this condition can be used to reject such messages, though they are not as
29447 common as they used to be.
29448
29449 .vitem &*verify&~=&~helo*&
29450 .cindex "&%verify%& ACL condition"
29451 .cindex "&ACL;" "verifying HELO/EHLO"
29452 .cindex "HELO" "verifying"
29453 .cindex "EHLO" "verifying"
29454 .cindex "verifying" "EHLO"
29455 .cindex "verifying" "HELO"
29456 This condition is true if a HELO or EHLO command has been received from the
29457 client host, and its contents have been verified. If there has been no previous
29458 attempt to verify the HELO/EHLO contents, it is carried out when this
29459 condition is encountered. See the description of the &%helo_verify_hosts%& and
29460 &%helo_try_verify_hosts%& options for details of how to request verification
29461 independently of this condition.
29462
29463 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29464 option), this condition is always true.
29465
29466
29467 .vitem &*verify&~=&~not_blind*&
29468 .cindex "verifying" "not blind"
29469 .cindex "bcc recipients, verifying none"
29470 This condition checks that there are no blind (bcc) recipients in the message.
29471 Every envelope recipient must appear either in a &'To:'& header line or in a
29472 &'Cc:'& header line for this condition to be true. Local parts are checked
29473 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29474 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29475 used only in a DATA or non-SMTP ACL.
29476
29477 There are, of course, many legitimate messages that make use of blind (bcc)
29478 recipients. This check should not be used on its own for blocking messages.
29479
29480
29481 .vitem &*verify&~=&~recipient/*&<&'options'&>
29482 .cindex "&%verify%& ACL condition"
29483 .cindex "&ACL;" "verifying recipient"
29484 .cindex "recipient" "verifying"
29485 .cindex "verifying" "recipient"
29486 .vindex "&$address_data$&"
29487 This condition is relevant only after a RCPT command. It verifies the current
29488 recipient. Details of address verification are given later, starting at section
29489 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29490 of &$address_data$& is the last value that was set while routing the address.
29491 This applies even if the verification fails. When an address that is being
29492 verified is redirected to a single address, verification continues with the new
29493 address, and in that case, the subsequent value of &$address_data$& is the
29494 value for the child address.
29495
29496 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29497 .cindex "&%verify%& ACL condition"
29498 .cindex "&ACL;" "verifying host reverse lookup"
29499 .cindex "host" "verifying reverse lookup"
29500 This condition ensures that a verified host name has been looked up from the IP
29501 address of the client host. (This may have happened already if the host name
29502 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29503 Verification ensures that the host name obtained from a reverse DNS lookup, or
29504 one of its aliases, does, when it is itself looked up in the DNS, yield the
29505 original IP address.
29506
29507 There is one possible option, &`defer_ok`&.  If this is present and a
29508 DNS operation returns a temporary error, the verify condition succeeds.
29509
29510 If this condition is used for a locally generated message (that is, when there
29511 is no client host involved), it always succeeds.
29512
29513 .vitem &*verify&~=&~sender/*&<&'options'&>
29514 .cindex "&%verify%& ACL condition"
29515 .cindex "&ACL;" "verifying sender"
29516 .cindex "sender" "verifying"
29517 .cindex "verifying" "sender"
29518 This condition is relevant only after a MAIL or RCPT command, or after a
29519 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29520 the message's sender is empty (that is, this is a bounce message), the
29521 condition is true. Otherwise, the sender address is verified.
29522
29523 .vindex "&$address_data$&"
29524 .vindex "&$sender_address_data$&"
29525 If there is data in the &$address_data$& variable at the end of routing, its
29526 value is placed in &$sender_address_data$& at the end of verification. This
29527 value can be used in subsequent conditions and modifiers in the same ACL
29528 statement. It does not persist after the end of the current statement. If you
29529 want to preserve the value for longer, you can save it in an ACL variable.
29530
29531 Details of verification are given later, starting at section
29532 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29533 to avoid doing it more than once per message.
29534
29535 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29536 .cindex "&%verify%& ACL condition"
29537 This is a variation of the previous option, in which a modified address is
29538 verified as a sender.
29539 .endlist
29540
29541
29542
29543 .section "Using DNS lists" "SECTmorednslists"
29544 .cindex "DNS list" "in ACL"
29545 .cindex "black list (DNS)"
29546 .cindex "&ACL;" "testing a DNS list"
29547 In its simplest form, the &%dnslists%& condition tests whether the calling host
29548 is on at least one of a number of DNS lists by looking up the inverted IP
29549 address in one or more DNS domains. (Note that DNS list domains are not mail
29550 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29551 special options instead.) For example, if the calling host's IP
29552 address is 192.168.62.43, and the ACL statement is
29553 .code
29554 deny dnslists = blackholes.mail-abuse.org : \
29555                 dialups.mail-abuse.org
29556 .endd
29557 the following records are looked up:
29558 .code
29559 43.62.168.192.blackholes.mail-abuse.org
29560 43.62.168.192.dialups.mail-abuse.org
29561 .endd
29562 As soon as Exim finds an existing DNS record, processing of the list stops.
29563 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29564 to test that a host is on more than one list (an &"and"& conjunction), you can
29565 use two separate conditions:
29566 .code
29567 deny dnslists = blackholes.mail-abuse.org
29568      dnslists = dialups.mail-abuse.org
29569 .endd
29570 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29571 behaves as if the host does not match the list item, that is, as if the DNS
29572 record does not exist. If there are further items in the DNS list, they are
29573 processed.
29574
29575 This is usually the required action when &%dnslists%& is used with &%deny%&
29576 (which is the most common usage), because it prevents a DNS failure from
29577 blocking mail. However, you can change this behaviour by putting one of the
29578 following special items in the list:
29579 .display
29580 &`+include_unknown `&   behave as if the item is on the list
29581 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29582 &`+defer_unknown   `&   give a temporary error
29583 .endd
29584 .cindex "&`+include_unknown`&"
29585 .cindex "&`+exclude_unknown`&"
29586 .cindex "&`+defer_unknown`&"
29587 Each of these applies to any subsequent items on the list. For example:
29588 .code
29589 deny dnslists = +defer_unknown : foo.bar.example
29590 .endd
29591 Testing the list of domains stops as soon as a match is found. If you want to
29592 warn for one list and block for another, you can use two different statements:
29593 .code
29594 deny  dnslists = blackholes.mail-abuse.org
29595 warn  message  = X-Warn: sending host is on dialups list
29596       dnslists = dialups.mail-abuse.org
29597 .endd
29598 .cindex cacheing "of dns lookup"
29599 .cindex DNS TTL
29600 DNS list lookups are cached by Exim for the duration of the SMTP session
29601 (but limited by the DNS return TTL value),
29602 so a lookup based on the IP address is done at most once for any incoming
29603 connection (assuming long-enough TTL).
29604 Exim does not share information between multiple incoming
29605 connections (but your local name server cache should be active).
29606
29607
29608
29609 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29610 .cindex "DNS list" "keyed by explicit IP address"
29611 By default, the IP address that is used in a DNS list lookup is the IP address
29612 of the calling host. However, you can specify another IP address by listing it
29613 after the domain name, introduced by a slash. For example:
29614 .code
29615 deny dnslists = black.list.tld/192.168.1.2
29616 .endd
29617 This feature is not very helpful with explicit IP addresses; it is intended for
29618 use with IP addresses that are looked up, for example, the IP addresses of the
29619 MX hosts or nameservers of an email sender address. For an example, see section
29620 &<<SECTmulkeyfor>>& below.
29621
29622
29623
29624
29625 .section "DNS lists keyed on domain names" "SECID202"
29626 .cindex "DNS list" "keyed by domain name"
29627 There are some lists that are keyed on domain names rather than inverted IP
29628 addresses (see for example the &'domain based zones'& link at
29629 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29630 with these lists. You can change the name that is looked up in a DNS list by
29631 listing it after the domain name, introduced by a slash. For example,
29632 .code
29633 deny  message  = Sender's domain is listed at $dnslist_domain
29634       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29635 .endd
29636 This particular example is useful only in ACLs that are obeyed after the
29637 RCPT or DATA commands, when a sender address is available. If (for
29638 example) the message's sender is &'user@tld.example'& the name that is looked
29639 up by this example is
29640 .code
29641 tld.example.dsn.rfc-ignorant.org
29642 .endd
29643 A single &%dnslists%& condition can contain entries for both names and IP
29644 addresses. For example:
29645 .code
29646 deny dnslists = sbl.spamhaus.org : \
29647                 dsn.rfc-ignorant.org/$sender_address_domain
29648 .endd
29649 The first item checks the sending host's IP address; the second checks a domain
29650 name. The whole condition is true if either of the DNS lookups succeeds.
29651
29652
29653
29654
29655 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29656 .cindex "DNS list" "multiple keys for"
29657 The syntax described above for looking up explicitly-defined values (either
29658 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29659 name for the DNS list, what follows the slash can in fact be a list of items.
29660 As with all lists in Exim, the default separator is a colon. However, because
29661 this is a sublist within the list of DNS blacklist domains, it is necessary
29662 either to double the separators like this:
29663 .code
29664 dnslists = black.list.tld/name.1::name.2
29665 .endd
29666 or to change the separator character, like this:
29667 .code
29668 dnslists = black.list.tld/<;name.1;name.2
29669 .endd
29670 If an item in the list is an IP address, it is inverted before the DNS
29671 blacklist domain is appended. If it is not an IP address, no inversion
29672 occurs. Consider this condition:
29673 .code
29674 dnslists = black.list.tld/<;192.168.1.2;a.domain
29675 .endd
29676 The DNS lookups that occur are:
29677 .code
29678 2.1.168.192.black.list.tld
29679 a.domain.black.list.tld
29680 .endd
29681 Once a DNS record has been found (that matches a specific IP return
29682 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29683 are done. If there is a temporary DNS error, the rest of the sublist of domains
29684 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29685 only if no other DNS lookup in this sublist succeeds. In other words, a
29686 successful lookup for any of the items in the sublist overrides a temporary
29687 error for a previous item.
29688
29689 The ability to supply a list of items after the slash is in some sense just a
29690 syntactic convenience. These two examples have the same effect:
29691 .code
29692 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29693 dnslists = black.list.tld/a.domain::b.domain
29694 .endd
29695 However, when the data for the list is obtained from a lookup, the second form
29696 is usually much more convenient. Consider this example:
29697 .code
29698 deny message  = The mail servers for the domain \
29699                 $sender_address_domain \
29700                 are listed at $dnslist_domain ($dnslist_value); \
29701                 see $dnslist_text.
29702      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29703                                    ${lookup dnsdb {>|mxh=\
29704                                    $sender_address_domain} }} }
29705 .endd
29706 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29707 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29708 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29709 of expanding the condition might be something like this:
29710 .code
29711 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29712 .endd
29713 Thus, this example checks whether or not the IP addresses of the sender
29714 domain's mail servers are on the Spamhaus black list.
29715
29716 The key that was used for a successful DNS list lookup is put into the variable
29717 &$dnslist_matched$& (see section &<<SECID204>>&).
29718
29719
29720
29721
29722 .section "Data returned by DNS lists" "SECID203"
29723 .cindex "DNS list" "data returned from"
29724 DNS lists are constructed using address records in the DNS. The original RBL
29725 just used the address 127.0.0.1 on the right hand side of each record, but the
29726 RBL+ list and some other lists use a number of values with different meanings.
29727 The values used on the RBL+ list are:
29728 .display
29729 127.1.0.1  RBL
29730 127.1.0.2  DUL
29731 127.1.0.3  DUL and RBL
29732 127.1.0.4  RSS
29733 127.1.0.5  RSS and RBL
29734 127.1.0.6  RSS and DUL
29735 127.1.0.7  RSS and DUL and RBL
29736 .endd
29737 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29738 different values. Some DNS lists may return more than one address record;
29739 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29740
29741
29742 .section "Variables set from DNS lists" "SECID204"
29743 .cindex "expansion" "variables, set from DNS list"
29744 .cindex "DNS list" "variables set from"
29745 .vindex "&$dnslist_domain$&"
29746 .vindex "&$dnslist_matched$&"
29747 .vindex "&$dnslist_text$&"
29748 .vindex "&$dnslist_value$&"
29749 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29750 the name of the overall domain that matched (for example,
29751 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29752 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29753 the DNS record. When the key is an IP address, it is not reversed in
29754 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29755 cases, for example:
29756 .code
29757 deny dnslists = spamhaus.example
29758 .endd
29759 the key is also available in another variable (in this case,
29760 &$sender_host_address$&). In more complicated cases, however, this is not true.
29761 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29762 might generate a dnslists lookup like this:
29763 .code
29764 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29765 .endd
29766 If this condition succeeds, the value in &$dnslist_matched$& might be
29767 &`192.168.6.7`& (for example).
29768
29769 If more than one address record is returned by the DNS lookup, all the IP
29770 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29771 The variable &$dnslist_text$& contains the contents of any associated TXT
29772 record. For lists such as RBL+ the TXT record for a merged entry is often not
29773 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29774 information.
29775
29776 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29777 &-- although these appear before the condition in the ACL, they are not
29778 expanded until after it has failed. For example:
29779 .code
29780 deny    hosts = !+local_networks
29781         message = $sender_host_address is listed \
29782                   at $dnslist_domain
29783         dnslists = rbl-plus.mail-abuse.example
29784 .endd
29785
29786
29787
29788 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29789 .cindex "DNS list" "matching specific returned data"
29790 You can add an equals sign and an IP address after a &%dnslists%& domain name
29791 in order to restrict its action to DNS records with a matching right hand side.
29792 For example,
29793 .code
29794 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29795 .endd
29796 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29797 any address record is considered to be a match. For the moment, we assume
29798 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29799 describes how multiple records are handled.
29800
29801 More than one IP address may be given for checking, using a comma as a
29802 separator. These are alternatives &-- if any one of them matches, the
29803 &%dnslists%& condition is true. For example:
29804 .code
29805 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29806 .endd
29807 If you want to specify a constraining address list and also specify names or IP
29808 addresses to be looked up, the constraining address list must be specified
29809 first. For example:
29810 .code
29811 deny dnslists = dsn.rfc-ignorant.org\
29812                 =127.0.0.2/$sender_address_domain
29813 .endd
29814
29815 If the character &`&&`& is used instead of &`=`&, the comparison for each
29816 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29817 In other words, the listed addresses are used as bit masks. The comparison is
29818 true if all the bits in the mask are present in the address that is being
29819 tested. For example:
29820 .code
29821 dnslists = a.b.c&0.0.0.3
29822 .endd
29823 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29824 want to test whether one bit or another bit is present (as opposed to both
29825 being present), you must use multiple values. For example:
29826 .code
29827 dnslists = a.b.c&0.0.0.1,0.0.0.2
29828 .endd
29829 matches if the final component of the address is an odd number or two times
29830 an odd number.
29831
29832
29833
29834 .section "Negated DNS matching conditions" "SECID205"
29835 You can supply a negative list of IP addresses as part of a &%dnslists%&
29836 condition. Whereas
29837 .code
29838 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29839 .endd
29840 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29841 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29842 .code
29843 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29844 .endd
29845 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29846 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29847 words, the result of the test is inverted if an exclamation mark appears before
29848 the &`=`& (or the &`&&`&) sign.
29849
29850 &*Note*&: This kind of negation is not the same as negation in a domain,
29851 host, or address list (which is why the syntax is different).
29852
29853 If you are using just one list, the negation syntax does not gain you much. The
29854 previous example is precisely equivalent to
29855 .code
29856 deny  dnslists = a.b.c
29857      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29858 .endd
29859 However, if you are using multiple lists, the negation syntax is clearer.
29860 Consider this example:
29861 .code
29862 deny  dnslists = sbl.spamhaus.org : \
29863                  list.dsbl.org : \
29864                  dnsbl.njabl.org!=127.0.0.3 : \
29865                  relays.ordb.org
29866 .endd
29867 Using only positive lists, this would have to be:
29868 .code
29869 deny  dnslists = sbl.spamhaus.org : \
29870                  list.dsbl.org
29871 deny  dnslists = dnsbl.njabl.org
29872      !dnslists = dnsbl.njabl.org=127.0.0.3
29873 deny  dnslists = relays.ordb.org
29874 .endd
29875 which is less clear, and harder to maintain.
29876
29877
29878
29879
29880 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29881 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29882 thereby providing more than one IP address. When an item in a &%dnslists%& list
29883 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29884 the match to specific results from the DNS lookup, there are two ways in which
29885 the checking can be handled. For example, consider the condition:
29886 .code
29887 dnslists = a.b.c=127.0.0.1
29888 .endd
29889 What happens if the DNS lookup for the incoming IP address yields both
29890 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29891 condition true because at least one given value was found, or is it false
29892 because at least one of the found values was not listed? And how does this
29893 affect negated conditions? Both possibilities are provided for with the help of
29894 additional separators &`==`& and &`=&&`&.
29895
29896 .ilist
29897 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29898 IP addresses matches one of the listed addresses. For the example above, the
29899 condition is true because 127.0.0.1 matches.
29900 .next
29901 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29902 looked up IP addresses matches one of the listed addresses. If the condition is
29903 changed to:
29904 .code
29905 dnslists = a.b.c==127.0.0.1
29906 .endd
29907 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29908 false because 127.0.0.2 is not listed. You would need to have:
29909 .code
29910 dnslists = a.b.c==127.0.0.1,127.0.0.2
29911 .endd
29912 for the condition to be true.
29913 .endlist
29914
29915 When &`!`& is used to negate IP address matching, it inverts the result, giving
29916 the precise opposite of the behaviour above. Thus:
29917 .ilist
29918 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29919 addresses matches one of the listed addresses. Consider:
29920 .code
29921 dnslists = a.b.c!&0.0.0.1
29922 .endd
29923 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29924 false because 127.0.0.1 matches.
29925 .next
29926 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29927 looked up IP address that does not match. Consider:
29928 .code
29929 dnslists = a.b.c!=&0.0.0.1
29930 .endd
29931 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29932 true, because 127.0.0.2 does not match. You would need to have:
29933 .code
29934 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29935 .endd
29936 for the condition to be false.
29937 .endlist
29938 When the DNS lookup yields only a single IP address, there is no difference
29939 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29940
29941
29942
29943
29944 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29945 .cindex "DNS list" "information from merged"
29946 When the facility for restricting the matching IP values in a DNS list is used,
29947 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29948 the true reason for rejection. This happens when lists are merged and the IP
29949 address in the A record is used to distinguish them; unfortunately there is
29950 only one TXT record. One way round this is not to use merged lists, but that
29951 can be inefficient because it requires multiple DNS lookups where one would do
29952 in the vast majority of cases when the host of interest is not on any of the
29953 lists.
29954
29955 A less inefficient way of solving this problem is available. If
29956 two domain names, comma-separated, are given, the second is used first to
29957 do an initial check, making use of any IP value restrictions that are set.
29958 If there is a match, the first domain is used, without any IP value
29959 restrictions, to get the TXT record. As a byproduct of this, there is also
29960 a check that the IP being tested is indeed on the first list. The first
29961 domain is the one that is put in &$dnslist_domain$&. For example:
29962 .code
29963 reject message  = \
29964          rejected because $sender_host_address is blacklisted \
29965          at $dnslist_domain\n$dnslist_text
29966        dnslists = \
29967          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29968          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29969 .endd
29970 For the first blacklist item, this starts by doing a lookup in
29971 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29972 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29973 value, and as long as something is found, it looks for the corresponding TXT
29974 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29975 The second blacklist item is processed similarly.
29976
29977 If you are interested in more than one merged list, the same list must be
29978 given several times, but because the results of the DNS lookups are cached,
29979 the DNS calls themselves are not repeated. For example:
29980 .code
29981 reject dnslists = \
29982          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29983          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29984          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29985          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29986 .endd
29987 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29988 values matches (or if no record is found), this is the only lookup that is
29989 done. Only if there is a match is one of the more specific lists consulted.
29990
29991
29992
29993 .section "DNS lists and IPv6" "SECTmorednslistslast"
29994 .cindex "IPv6" "DNS black lists"
29995 .cindex "DNS list" "IPv6 usage"
29996 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29997 nibble by nibble. For example, if the calling host's IP address is
29998 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29999 .code
30000 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30001   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30002 .endd
30003 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30004 lists contain wildcard records, intended for IPv4, that interact badly with
30005 IPv6. For example, the DNS entry
30006 .code
30007 *.3.some.list.example.    A    127.0.0.1
30008 .endd
30009 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30010 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30011
30012 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30013 &%condition%& condition, as in this example:
30014 .code
30015 deny   condition = ${if isip4{$sender_host_address}}
30016        dnslists  = some.list.example
30017 .endd
30018
30019 If an explicit key is being used for a DNS lookup and it may be an IPv6
30020 address you should specify alternate list separators for both the outer
30021 (DNS list name) list and inner (lookup keys) list:
30022 .code
30023        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30024 .endd
30025
30026 .section "Rate limiting incoming messages" "SECTratelimiting"
30027 .cindex "rate limiting" "client sending"
30028 .cindex "limiting client sending rates"
30029 .oindex "&%smtp_ratelimit_*%&"
30030 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30031 which clients can send email. This is more powerful than the
30032 &%smtp_ratelimit_*%& options, because those options control the rate of
30033 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30034 works across all connections (concurrent and sequential) from the same client
30035 host. The syntax of the &%ratelimit%& condition is:
30036 .display
30037 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30038 .endd
30039 If the average client sending rate is less than &'m'& messages per time
30040 period &'p'& then the condition is false; otherwise it is true.
30041
30042 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30043 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30044 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30045 of &'p'&.
30046
30047 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30048 time interval, for example, &`8h`& for eight hours. A larger time constant
30049 means that it takes Exim longer to forget a client's past behaviour. The
30050 parameter &'m'& is the maximum number of messages that a client is permitted to
30051 send in each time interval. It also specifies the number of messages permitted
30052 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30053 constant, you can allow a client to send more messages in a burst without
30054 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30055 both small, messages must be sent at an even rate.
30056
30057 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30058 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30059 when deploying the &%ratelimit%& ACL condition. The script prints usage
30060 instructions when it is run with no arguments.
30061
30062 The key is used to look up the data for calculating the client's average
30063 sending rate. This data is stored in Exim's spool directory, alongside the
30064 retry and other hints databases. The default key is &$sender_host_address$&,
30065 which means Exim computes the sending rate of each client host IP address.
30066 By changing the key you can change how Exim identifies clients for the purpose
30067 of ratelimiting. For example, to limit the sending rate of each authenticated
30068 user, independent of the computer they are sending from, set the key to
30069 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30070 example, &$authenticated_id$& is only meaningful if the client has
30071 authenticated (which you can check with the &%authenticated%& ACL condition).
30072
30073 The lookup key does not have to identify clients: If you want to limit the
30074 rate at which a recipient receives messages, you can use the key
30075 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30076 ACL.
30077
30078 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30079 specifies what Exim measures the rate of, for example messages or recipients
30080 or bytes. You can adjust the measurement using the &%unique=%& and/or
30081 &%count=%& options. You can also control when Exim updates the recorded rate
30082 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30083 separated by a slash, like the other parameters. They may appear in any order.
30084
30085 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30086 any options that alter the meaning of the stored data. The limit &'m'& is not
30087 stored, so you can alter the configured maximum rate and Exim will still
30088 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30089 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30090 behaviour. The lookup key is not affected by changes to the update mode and
30091 the &%count=%& option.
30092
30093
30094 .section "Ratelimit options for what is being measured" "ratoptmea"
30095 .cindex "rate limiting" "per_* options"
30096 The &%per_conn%& option limits the client's connection rate. It is not
30097 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30098 &%acl_not_smtp_start%& ACLs.
30099
30100 The &%per_mail%& option limits the client's rate of sending messages. This is
30101 the default if none of the &%per_*%& options is specified. It can be used in
30102 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30103 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30104
30105 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30106 the same ACLs as the &%per_mail%& option, though it is best to use this option
30107 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30108 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30109 in its MAIL command, which may be inaccurate or completely missing. You can
30110 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30111 in kilobytes, megabytes, or gigabytes, respectively.
30112
30113 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30114 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30115 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30116 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30117 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30118 in either case the rate limiting engine will see a message with many
30119 recipients as a large high-speed burst.
30120
30121 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30122 number of different recipients that the client has sent messages to in the
30123 last time period. That is, if the client repeatedly sends messages to the same
30124 recipient, its measured rate is not increased. This option can only be used in
30125 &%acl_smtp_rcpt%&.
30126
30127 The &%per_cmd%& option causes Exim to recompute the rate every time the
30128 condition is processed. This can be used to limit the rate of any SMTP
30129 command. If it is used in multiple ACLs it can limit the aggregate rate of
30130 multiple different commands.
30131
30132 The &%count=%& option can be used to alter how much Exim adds to the client's
30133 measured rate. For example, the &%per_byte%& option is equivalent to
30134 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30135 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30136 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30137
30138 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30139
30140
30141 .section "Ratelimit update modes" "ratoptupd"
30142 .cindex "rate limiting" "reading data without updating"
30143 You can specify one of three options with the &%ratelimit%& condition to
30144 control when its database is updated. This section describes the &%readonly%&
30145 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30146
30147 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30148 previously-computed rate to check against the limit.
30149
30150 For example, you can test the client's sending rate and deny it access (when
30151 it is too fast) in the connect ACL. If the client passes this check then it
30152 can go on to send a message, in which case its recorded rate will be updated
30153 in the MAIL ACL. Subsequent connections from the same client will check this
30154 new rate.
30155 .code
30156 acl_check_connect:
30157  deny ratelimit = 100 / 5m / readonly
30158     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30159                   (max $sender_rate_limit)
30160 # ...
30161 acl_check_mail:
30162  warn ratelimit = 100 / 5m / strict
30163     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30164                   (max $sender_rate_limit)
30165 .endd
30166
30167 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30168 processing a message then it may increase the client's measured rate more than
30169 it should. For example, this will happen if you check the &%per_rcpt%& option
30170 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30171 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30172 multiple update problems by using the &%readonly%& option on later ratelimit
30173 checks.
30174
30175 The &%per_*%& options described above do not make sense in some ACLs. If you
30176 use a &%per_*%& option in an ACL where it is not normally permitted then the
30177 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30178 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30179 next section) so you must specify the &%readonly%& option explicitly.
30180
30181
30182 .section "Ratelimit options for handling fast clients" "ratoptfast"
30183 .cindex "rate limiting" "strict and leaky modes"
30184 If a client's average rate is greater than the maximum, the rate limiting
30185 engine can react in two possible ways, depending on the presence of the
30186 &%strict%& or &%leaky%& update modes. This is independent of the other
30187 counter-measures (such as rejecting the message) that may be specified by the
30188 rest of the ACL.
30189
30190 The &%leaky%& (default) option means that the client's recorded rate is not
30191 updated if it is above the limit. The effect of this is that Exim measures the
30192 client's average rate of successfully sent email, which cannot be greater than
30193 the maximum allowed. If the client is over the limit it may suffer some
30194 counter-measures (as specified in the ACL), but it will still be able to send
30195 email at the configured maximum rate, whatever the rate of its attempts. This
30196 is generally the better choice if you have clients that retry automatically.
30197 For example, it does not prevent a sender with an over-aggressive retry rate
30198 from getting any email through.
30199
30200 The &%strict%& option means that the client's recorded rate is always
30201 updated. The effect of this is that Exim measures the client's average rate
30202 of attempts to send email, which can be much higher than the maximum it is
30203 actually allowed. If the client is over the limit it may be subjected to
30204 counter-measures by the ACL. It must slow down and allow sufficient time to
30205 pass that its computed rate falls below the maximum before it can send email
30206 again. The time (the number of smoothing periods) it must wait and not
30207 attempt to send mail can be calculated with this formula:
30208 .code
30209         ln(peakrate/maxrate)
30210 .endd
30211
30212
30213 .section "Limiting the rate of different events" "ratoptuniq"
30214 .cindex "rate limiting" "counting unique events"
30215 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30216 rate of different events. For example, the &%per_addr%& option uses this
30217 mechanism to count the number of different recipients that the client has
30218 sent messages to in the last time period; it is equivalent to
30219 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30220 measure the rate that a client uses different sender addresses with the
30221 options &`per_mail/unique=$sender_address`&.
30222
30223 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30224 has seen for that key. The whole set is thrown away when it is older than the
30225 rate smoothing period &'p'&, so each different event is counted at most once
30226 per period. In the &%leaky%& update mode, an event that causes the client to
30227 go over the limit is not added to the set, in the same way that the client's
30228 recorded rate is not updated in the same situation.
30229
30230 When you combine the &%unique=%& and &%readonly%& options, the specific
30231 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30232 rate.
30233
30234 The &%unique=%& mechanism needs more space in the ratelimit database than the
30235 other &%ratelimit%& options in order to store the event set. The number of
30236 unique values is potentially as large as the rate limit, so the extra space
30237 required increases with larger limits.
30238
30239 The uniqueification is not perfect: there is a small probability that Exim
30240 will think a new event has happened before. If the sender's rate is less than
30241 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30242 the measured rate can go above the limit, in which case Exim may under-count
30243 events by a significant margin. Fortunately, if the rate is high enough (2.7
30244 times the limit) that the false positive rate goes above 9%, then Exim will
30245 throw away the over-full event set before the measured rate falls below the
30246 limit. Therefore the only harm should be that exceptionally high sending rates
30247 are logged incorrectly; any countermeasures you configure will be as effective
30248 as intended.
30249
30250
30251 .section "Using rate limiting" "useratlim"
30252 Exim's other ACL facilities are used to define what counter-measures are taken
30253 when the rate limit is exceeded. This might be anything from logging a warning
30254 (for example, while measuring existing sending rates in order to define
30255 policy), through time delays to slow down fast senders, up to rejecting the
30256 message. For example:
30257 .code
30258 # Log all senders' rates
30259 warn ratelimit = 0 / 1h / strict
30260      log_message = Sender rate $sender_rate / $sender_rate_period
30261
30262 # Slow down fast senders; note the need to truncate $sender_rate
30263 # at the decimal point.
30264 warn ratelimit = 100 / 1h / per_rcpt / strict
30265      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30266                    $sender_rate_limit }s
30267
30268 # Keep authenticated users under control
30269 deny authenticated = *
30270      ratelimit = 100 / 1d / strict / $authenticated_id
30271
30272 # System-wide rate limit
30273 defer message = Sorry, too busy. Try again later.
30274      ratelimit = 10 / 1s / $primary_hostname
30275
30276 # Restrict incoming rate from each host, with a default
30277 # set using a macro and special cases looked up in a table.
30278 defer message = Sender rate exceeds $sender_rate_limit \
30279                messages per $sender_rate_period
30280      ratelimit = ${lookup {$sender_host_address} \
30281                    cdb {DB/ratelimits.cdb} \
30282                    {$value} {RATELIMIT} }
30283 .endd
30284 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30285 especially with the &%per_rcpt%& option, you may suffer from a performance
30286 bottleneck caused by locking on the ratelimit hints database. Apart from
30287 making your ACLs less complicated, you can reduce the problem by using a
30288 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30289 this means that Exim will lose its hints data after a reboot (including retry
30290 hints, the callout cache, and ratelimit data).
30291
30292
30293
30294 .section "Address verification" "SECTaddressverification"
30295 .cindex "verifying address" "options for"
30296 .cindex "policy control" "address verification"
30297 Several of the &%verify%& conditions described in section
30298 &<<SECTaclconditions>>& cause addresses to be verified. Section
30299 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30300 The verification conditions can be followed by options that modify the
30301 verification process. The options are separated from the keyword and from each
30302 other by slashes, and some of them contain parameters. For example:
30303 .code
30304 verify = sender/callout
30305 verify = recipient/defer_ok/callout=10s,defer_ok
30306 .endd
30307 The first stage of address verification, which always happens, is to run the
30308 address through the routers, in &"verify mode"&. Routers can detect the
30309 difference between verification and routing for delivery, and their actions can
30310 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30311 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30312 The available options are as follows:
30313
30314 .ilist
30315 If the &%callout%& option is specified, successful routing to one or more
30316 remote hosts is followed by a &"callout"& to those hosts as an additional
30317 check. Callouts and their sub-options are discussed in the next section.
30318 .next
30319 If there is a defer error while doing verification routing, the ACL
30320 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30321 options, the condition is forced to be true instead. Note that this is a main
30322 verification option as well as a suboption for callouts.
30323 .next
30324 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30325 discusses the reporting of sender address verification failures.
30326 .next
30327 The &%success_on_redirect%& option causes verification always to succeed
30328 immediately after a successful redirection. By default, if a redirection
30329 generates just one address, that address is also verified. See further
30330 discussion in section &<<SECTredirwhilveri>>&.
30331 .endlist
30332
30333 .cindex "verifying address" "differentiating failures"
30334 .vindex "&$recipient_verify_failure$&"
30335 .vindex "&$sender_verify_failure$&"
30336 .vindex "&$acl_verify_message$&"
30337 After an address verification failure, &$acl_verify_message$& contains the
30338 error message that is associated with the failure. It can be preserved by
30339 coding like this:
30340 .code
30341 warn  !verify = sender
30342        set acl_m0 = $acl_verify_message
30343 .endd
30344 If you are writing your own custom rejection message or log message when
30345 denying access, you can use this variable to include information about the
30346 verification failure.
30347
30348 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30349 appropriate) contains one of the following words:
30350
30351 .ilist
30352 &%qualify%&: The address was unqualified (no domain), and the message
30353 was neither local nor came from an exempted host.
30354 .next
30355 &%route%&: Routing failed.
30356 .next
30357 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30358 occurred at or before the MAIL command (that is, on initial
30359 connection, HELO, or MAIL).
30360 .next
30361 &%recipient%&: The RCPT command in a callout was rejected.
30362 .next
30363 &%postmaster%&: The postmaster check in a callout was rejected.
30364 .endlist
30365
30366 The main use of these variables is expected to be to distinguish between
30367 rejections of MAIL and rejections of RCPT in callouts.
30368
30369
30370
30371
30372 .section "Callout verification" "SECTcallver"
30373 .cindex "verifying address" "by callout"
30374 .cindex "callout" "verification"
30375 .cindex "SMTP" "callout verification"
30376 For non-local addresses, routing verifies the domain, but is unable to do any
30377 checking of the local part. There are situations where some means of verifying
30378 the local part is desirable. One way this can be done is to make an SMTP
30379 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30380 a subsequent host for a recipient address, to see if the host accepts the
30381 address. We use the term &'callout'& to cover both cases. Note that for a
30382 sender address, the callback is not to the client host that is trying to
30383 deliver the message, but to one of the hosts that accepts incoming mail for the
30384 sender's domain.
30385
30386 Exim does not do callouts by default. If you want them to happen, you must
30387 request them by setting appropriate options on the &%verify%& condition, as
30388 described below. This facility should be used with care, because it can add a
30389 lot of resource usage to the cost of verifying an address. However, Exim does
30390 cache the results of callouts, which helps to reduce the cost. Details of
30391 caching are in section &<<SECTcallvercache>>&.
30392
30393 Recipient callouts are usually used only between hosts that are controlled by
30394 the same administration. For example, a corporate gateway host could use
30395 callouts to check for valid recipients on an internal mailserver. A successful
30396 callout does not guarantee that a real delivery to the address would succeed;
30397 on the other hand, a failing callout does guarantee that a delivery would fail.
30398
30399 If the &%callout%& option is present on a condition that verifies an address, a
30400 second stage of verification occurs if the address is successfully routed to
30401 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30402 &(manualroute)& router, where the router specifies the hosts. However, if a
30403 router that does not set up hosts routes to an &(smtp)& transport with a
30404 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30405 &%hosts_override%& set, its hosts are always used, whether or not the router
30406 supplies a host list.
30407 Callouts are only supported on &(smtp)& transports.
30408
30409 The port that is used is taken from the transport, if it is specified and is a
30410 remote transport. (For routers that do verification only, no transport need be
30411 specified.) Otherwise, the default SMTP port is used. If a remote transport
30412 specifies an outgoing interface, this is used; otherwise the interface is not
30413 specified. Likewise, the text that is used for the HELO command is taken from
30414 the transport's &%helo_data%& option; if there is no transport, the value of
30415 &$smtp_active_hostname$& is used.
30416
30417 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30418 test whether a bounce message could be delivered to the sender address. The
30419 following SMTP commands are sent:
30420 .display
30421 &`HELO `&<&'local host name'&>
30422 &`MAIL FROM:<>`&
30423 &`RCPT TO:`&<&'the address to be tested'&>
30424 &`QUIT`&
30425 .endd
30426 LHLO is used instead of HELO if the transport's &%protocol%& option is
30427 set to &"lmtp"&.
30428
30429 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30430 settings.
30431
30432 A recipient callout check is similar. By default, it also uses an empty address
30433 for the sender. This default is chosen because most hosts do not make use of
30434 the sender address when verifying a recipient. Using the same address means
30435 that a single cache entry can be used for each recipient. Some sites, however,
30436 do make use of the sender address when verifying. These are catered for by the
30437 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30438
30439 If the response to the RCPT command is a 2&'xx'& code, the verification
30440 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30441 Exim tries the next host, if any. If there is a problem with all the remote
30442 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30443 &%callout%& option is given, in which case the condition is forced to succeed.
30444
30445 .cindex "SMTP" "output flushing, disabling for callout"
30446 A callout may take a little time. For this reason, Exim normally flushes SMTP
30447 output before performing a callout in an ACL, to avoid unexpected timeouts in
30448 clients when the SMTP PIPELINING extension is in use. The flushing can be
30449 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30450
30451
30452
30453
30454 .section "Additional parameters for callouts" "CALLaddparcall"
30455 .cindex "callout" "additional parameters for"
30456 The &%callout%& option can be followed by an equals sign and a number of
30457 optional parameters, separated by commas. For example:
30458 .code
30459 verify = recipient/callout=10s,defer_ok
30460 .endd
30461 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30462 separate verify options, is retained for backwards compatibility, but is now
30463 deprecated. The additional parameters for &%callout%& are as follows:
30464
30465
30466 .vlist
30467 .vitem <&'a&~time&~interval'&>
30468 .cindex "callout" "timeout, specifying"
30469 This specifies the timeout that applies for the callout attempt to each host.
30470 For example:
30471 .code
30472 verify = sender/callout=5s
30473 .endd
30474 The default is 30 seconds. The timeout is used for each response from the
30475 remote host. It is also used for the initial connection, unless overridden by
30476 the &%connect%& parameter.
30477
30478
30479 .vitem &*connect&~=&~*&<&'time&~interval'&>
30480 .cindex "callout" "connection timeout, specifying"
30481 This parameter makes it possible to set a different (usually smaller) timeout
30482 for making the SMTP connection. For example:
30483 .code
30484 verify = sender/callout=5s,connect=1s
30485 .endd
30486 If not specified, this timeout defaults to the general timeout value.
30487
30488 .vitem &*defer_ok*&
30489 .cindex "callout" "defer, action on"
30490 When this parameter is present, failure to contact any host, or any other kind
30491 of temporary error, is treated as success by the ACL. However, the cache is not
30492 updated in this circumstance.
30493
30494 .vitem &*fullpostmaster*&
30495 .cindex "callout" "full postmaster check"
30496 This operates like the &%postmaster%& option (see below), but if the check for
30497 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30498 accordance with the specification in RFC 2821. The RFC states that the
30499 unqualified address &'postmaster'& should be accepted.
30500
30501
30502 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30503 .cindex "callout" "sender when verifying header"
30504 When verifying addresses in header lines using the &%header_sender%&
30505 verification option, Exim behaves by default as if the addresses are envelope
30506 sender addresses from a message. Callout verification therefore tests to see
30507 whether a bounce message could be delivered, by using an empty address in the
30508 MAIL command. However, it is arguable that these addresses might never be used
30509 as envelope senders, and could therefore justifiably reject bounce messages
30510 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30511 address to use in the MAIL command. For example:
30512 .code
30513 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30514 .endd
30515 This parameter is available only for the &%header_sender%& verification option.
30516
30517
30518 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30519 .cindex "callout" "overall timeout, specifying"
30520 This parameter sets an overall timeout for performing a callout verification.
30521 For example:
30522 .code
30523 verify = sender/callout=5s,maxwait=30s
30524 .endd
30525 This timeout defaults to four times the callout timeout for individual SMTP
30526 commands. The overall timeout applies when there is more than one host that can
30527 be tried. The timeout is checked before trying the next host. This prevents
30528 very long delays if there are a large number of hosts and all are timing out
30529 (for example, when network connections are timing out).
30530
30531
30532 .vitem &*no_cache*&
30533 .cindex "callout" "cache, suppressing"
30534 .cindex "caching callout, suppressing"
30535 When this parameter is given, the callout cache is neither read nor updated.
30536
30537 .vitem &*postmaster*&
30538 .cindex "callout" "postmaster; checking"
30539 When this parameter is set, a successful callout check is followed by a similar
30540 check for the local part &'postmaster'& at the same domain. If this address is
30541 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30542 the postmaster check is recorded in a cache record; if it is a failure, this is
30543 used to fail subsequent callouts for the domain without a connection being
30544 made, until the cache record expires.
30545
30546 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30547 The postmaster check uses an empty sender in the MAIL command by default.
30548 You can use this parameter to do a postmaster check using a different address.
30549 For example:
30550 .code
30551 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30552 .endd
30553 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30554 one overrides. The &%postmaster%& parameter is equivalent to this example:
30555 .code
30556 require  verify = sender/callout=postmaster_mailfrom=
30557 .endd
30558 &*Warning*&: The caching arrangements for postmaster checking do not take
30559 account of the sender address. It is assumed that either the empty address or
30560 a fixed non-empty address will be used. All that Exim remembers is that the
30561 postmaster check for the domain succeeded or failed.
30562
30563
30564 .vitem &*random*&
30565 .cindex "callout" "&""random""& check"
30566 When this parameter is set, before doing the normal callout check, Exim does a
30567 check for a &"random"& local part at the same domain. The local part is not
30568 really random &-- it is defined by the expansion of the option
30569 &%callout_random_local_part%&, which defaults to
30570 .code
30571 $primary_hostname-$tod_epoch-testing
30572 .endd
30573 The idea here is to try to determine whether the remote host accepts all local
30574 parts without checking. If it does, there is no point in doing callouts for
30575 specific local parts. If the &"random"& check succeeds, the result is saved in
30576 a cache record, and used to force the current and subsequent callout checks to
30577 succeed without a connection being made, until the cache record expires.
30578
30579 .vitem &*use_postmaster*&
30580 .cindex "callout" "sender for recipient check"
30581 This parameter applies to recipient callouts only. For example:
30582 .code
30583 deny  !verify = recipient/callout=use_postmaster
30584 .endd
30585 .vindex "&$qualify_domain$&"
30586 It causes a non-empty postmaster address to be used in the MAIL command when
30587 performing the callout for the recipient, and also for a &"random"& check if
30588 that is configured. The local part of the address is &`postmaster`& and the
30589 domain is the contents of &$qualify_domain$&.
30590
30591 .vitem &*use_sender*&
30592 This option applies to recipient callouts only. For example:
30593 .code
30594 require  verify = recipient/callout=use_sender
30595 .endd
30596 It causes the message's actual sender address to be used in the MAIL
30597 command when performing the callout, instead of an empty address. There is no
30598 need to use this option unless you know that the called hosts make use of the
30599 sender when checking recipients. If used indiscriminately, it reduces the
30600 usefulness of callout caching.
30601 .endlist
30602
30603 If you use any of the parameters that set a non-empty sender for the MAIL
30604 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30605 &%use_sender%&), you should think about possible loops. Recipient checking is
30606 usually done between two hosts that are under the same management, and the host
30607 that receives the callouts is not normally configured to do callouts itself.
30608 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30609 these circumstances.
30610
30611 However, if you use a non-empty sender address for a callout to an arbitrary
30612 host, there is the likelihood that the remote host will itself initiate a
30613 callout check back to your host. As it is checking what appears to be a message
30614 sender, it is likely to use an empty address in MAIL, thus avoiding a
30615 callout loop. However, to be on the safe side it would be best to set up your
30616 own ACLs so that they do not do sender verification checks when the recipient
30617 is the address you use for header sender or postmaster callout checking.
30618
30619 Another issue to think about when using non-empty senders for callouts is
30620 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30621 by the sender/recipient combination; thus, for any given recipient, many more
30622 actual callouts are performed than when an empty sender or postmaster is used.
30623
30624
30625
30626
30627 .section "Callout caching" "SECTcallvercache"
30628 .cindex "hints database" "callout cache"
30629 .cindex "callout" "cache, description of"
30630 .cindex "caching" "callout"
30631 Exim caches the results of callouts in order to reduce the amount of resources
30632 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30633 option. A hints database called &"callout"& is used for the cache. Two
30634 different record types are used: one records the result of a callout check for
30635 a specific address, and the other records information that applies to the
30636 entire domain (for example, that it accepts the local part &'postmaster'&).
30637
30638 When an original callout fails, a detailed SMTP error message is given about
30639 the failure. However, for subsequent failures use the cache data, this message
30640 is not available.
30641
30642 The expiry times for negative and positive address cache records are
30643 independent, and can be set by the global options &%callout_negative_expire%&
30644 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30645
30646 If a host gives a negative response to an SMTP connection, or rejects any
30647 commands up to and including
30648 .code
30649 MAIL FROM:<>
30650 .endd
30651 (but not including the MAIL command with a non-empty address),
30652 any callout attempt is bound to fail. Exim remembers such failures in a
30653 domain cache record, which it uses to fail callouts for the domain without
30654 making new connections, until the domain record times out. There are two
30655 separate expiry times for domain cache records:
30656 &%callout_domain_negative_expire%& (default 3h) and
30657 &%callout_domain_positive_expire%& (default 7d).
30658
30659 Domain records expire when the negative expiry time is reached if callouts
30660 cannot be made for the domain, or if the postmaster check failed.
30661 Otherwise, they expire when the positive expiry time is reached. This
30662 ensures that, for example, a host that stops accepting &"random"& local parts
30663 will eventually be noticed.
30664
30665 The callout caching mechanism is based on the domain of the address that is
30666 being tested. If the domain routes to several hosts, it is assumed that their
30667 behaviour will be the same.
30668
30669
30670
30671 .section "Sender address verification reporting" "SECTsenaddver"
30672 .cindex "verifying" "suppressing error details"
30673 See section &<<SECTaddressverification>>& for a general discussion of
30674 verification. When sender verification fails in an ACL, the details of the
30675 failure are given as additional output lines before the 550 response to the
30676 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30677 you might see:
30678 .code
30679 MAIL FROM:<xyz@abc.example>
30680 250 OK
30681 RCPT TO:<pqr@def.example>
30682 550-Verification failed for <xyz@abc.example>
30683 550-Called:   192.168.34.43
30684 550-Sent:     RCPT TO:<xyz@abc.example>
30685 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30686 550 Sender verification failed
30687 .endd
30688 If more than one RCPT command fails in the same way, the details are given
30689 only for the first of them. However, some administrators do not want to send
30690 out this much information. You can suppress the details by adding
30691 &`/no_details`& to the ACL statement that requests sender verification. For
30692 example:
30693 .code
30694 verify = sender/no_details
30695 .endd
30696
30697 .section "Redirection while verifying" "SECTredirwhilveri"
30698 .cindex "verifying" "redirection while"
30699 .cindex "address redirection" "while verifying"
30700 A dilemma arises when a local address is redirected by aliasing or forwarding
30701 during verification: should the generated addresses themselves be verified,
30702 or should the successful expansion of the original address be enough to verify
30703 it? By default, Exim takes the following pragmatic approach:
30704
30705 .ilist
30706 When an incoming address is redirected to just one child address, verification
30707 continues with the child address, and if that fails to verify, the original
30708 verification also fails.
30709 .next
30710 When an incoming address is redirected to more than one child address,
30711 verification does not continue. A success result is returned.
30712 .endlist
30713
30714 This seems the most reasonable behaviour for the common use of aliasing as a
30715 way of redirecting different local parts to the same mailbox. It means, for
30716 example, that a pair of alias entries of the form
30717 .code
30718 A.Wol:   aw123
30719 aw123:   :fail: Gone away, no forwarding address
30720 .endd
30721 work as expected, with both local parts causing verification failure. When a
30722 redirection generates more than one address, the behaviour is more like a
30723 mailing list, where the existence of the alias itself is sufficient for
30724 verification to succeed.
30725
30726 It is possible, however, to change the default behaviour so that all successful
30727 redirections count as successful verifications, however many new addresses are
30728 generated. This is specified by the &%success_on_redirect%& verification
30729 option. For example:
30730 .code
30731 require verify = recipient/success_on_redirect/callout=10s
30732 .endd
30733 In this example, verification succeeds if a router generates a new address, and
30734 the callout does not occur, because no address was routed to a remote host.
30735
30736 When verification is being tested via the &%-bv%& option, the treatment of
30737 redirections is as just described, unless the &%-v%& or any debugging option is
30738 also specified. In that case, full verification is done for every generated
30739 address and a report is output for each of them.
30740
30741
30742
30743 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30744 .cindex "CSA" "verifying"
30745 Client SMTP Authorization is a system that allows a site to advertise
30746 which machines are and are not permitted to send email. This is done by placing
30747 special SRV records in the DNS; these are looked up using the client's HELO
30748 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30749 Authorization checks in Exim are performed by the ACL condition:
30750 .code
30751 verify = csa
30752 .endd
30753 This fails if the client is not authorized. If there is a DNS problem, or if no
30754 valid CSA SRV record is found, or if the client is authorized, the condition
30755 succeeds. These three cases can be distinguished using the expansion variable
30756 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30757 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30758 be likely to cause problems for legitimate email.
30759
30760 The error messages produced by the CSA code include slightly more
30761 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30762 looking up the CSA SRV record, or problems looking up the CSA target
30763 address record. There are four reasons for &$csa_status$& being &"fail"&:
30764
30765 .ilist
30766 The client's host name is explicitly not authorized.
30767 .next
30768 The client's IP address does not match any of the CSA target IP addresses.
30769 .next
30770 The client's host name is authorized but it has no valid target IP addresses
30771 (for example, the target's addresses are IPv6 and the client is using IPv4).
30772 .next
30773 The client's host name has no CSA SRV record but a parent domain has asserted
30774 that all subdomains must be explicitly authorized.
30775 .endlist
30776
30777 The &%csa%& verification condition can take an argument which is the domain to
30778 use for the DNS query. The default is:
30779 .code
30780 verify = csa/$sender_helo_name
30781 .endd
30782 This implementation includes an extension to CSA. If the query domain
30783 is an address literal such as [192.0.2.95], or if it is a bare IP
30784 address, Exim searches for CSA SRV records in the reverse DNS as if
30785 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30786 meaningful to say:
30787 .code
30788 verify = csa/$sender_host_address
30789 .endd
30790 In fact, this is the check that Exim performs if the client does not say HELO.
30791 This extension can be turned off by setting the main configuration option
30792 &%dns_csa_use_reverse%& to be false.
30793
30794 If a CSA SRV record is not found for the domain itself, a search
30795 is performed through its parent domains for a record which might be
30796 making assertions about subdomains. The maximum depth of this search is limited
30797 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30798 default. Exim does not look for CSA SRV records in a top level domain, so the
30799 default settings handle HELO domains as long as seven
30800 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30801 of legitimate HELO domains.
30802
30803 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30804 direct SRV lookups, this is not sufficient because of the extra parent domain
30805 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30806 addresses into lookups in the reverse DNS space. The result of a successful
30807 lookup such as:
30808 .code
30809 ${lookup dnsdb {csa=$sender_helo_name}}
30810 .endd
30811 has two space-separated fields: an authorization code and a target host name.
30812 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30813 authorization required but absent, or &"?"& for unknown.
30814
30815
30816
30817
30818 .section "Bounce address tag validation" "SECTverifyPRVS"
30819 .cindex "BATV, verifying"
30820 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30821 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30822 Genuine incoming bounce messages should therefore always be addressed to
30823 recipients that have a valid tag. This scheme is a way of detecting unwanted
30824 bounce messages caused by sender address forgeries (often called &"collateral
30825 spam"&), because the recipients of such messages do not include valid tags.
30826
30827 There are two expansion items to help with the implementation of the BATV
30828 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30829 the original envelope sender address by using a simple key to add a hash of the
30830 address and some time-based randomizing information. The &%prvs%& expansion
30831 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30832 The syntax of these expansion items is described in section
30833 &<<SECTexpansionitems>>&.
30834
30835 As an example, suppose the secret per-address keys are stored in an MySQL
30836 database. A query to look up the key for an address could be defined as a macro
30837 like this:
30838 .code
30839 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30840                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30841                 }{$value}}
30842 .endd
30843 Suppose also that the senders who make use of BATV are defined by an address
30844 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30845 use this:
30846 .code
30847 # Bounces: drop unsigned addresses for BATV senders
30848 deny message = This address does not send an unsigned reverse path
30849      senders = :
30850      recipients = +batv_senders
30851
30852 # Bounces: In case of prvs-signed address, check signature.
30853 deny message = Invalid reverse path signature.
30854      senders = :
30855      condition  = ${prvscheck {$local_part@$domain}\
30856                   {PRVSCHECK_SQL}{1}}
30857      !condition = $prvscheck_result
30858 .endd
30859 The first statement rejects recipients for bounce messages that are addressed
30860 to plain BATV sender addresses, because it is known that BATV senders do not
30861 send out messages with plain sender addresses. The second statement rejects
30862 recipients that are prvs-signed, but with invalid signatures (either because
30863 the key is wrong, or the signature has timed out).
30864
30865 A non-prvs-signed address is not rejected by the second statement, because the
30866 &%prvscheck%& expansion yields an empty string if its first argument is not a
30867 prvs-signed address, thus causing the &%condition%& condition to be false. If
30868 the first argument is a syntactically valid prvs-signed address, the yield is
30869 the third string (in this case &"1"&), whether or not the cryptographic and
30870 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30871 of the checks (empty for failure, &"1"& for success).
30872
30873 There is one more issue you must consider when implementing prvs-signing:
30874 you have to ensure that the routers accept prvs-signed addresses and
30875 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30876 router to remove the signature with a configuration along these lines:
30877 .code
30878 batv_redirect:
30879   driver = redirect
30880   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30881 .endd
30882 This works because, if the third argument of &%prvscheck%& is empty, the result
30883 of the expansion of a prvs-signed address is the decoded value of the original
30884 address. This router should probably be the first of your routers that handles
30885 local addresses.
30886
30887 To create BATV-signed addresses in the first place, a transport of this form
30888 can be used:
30889 .code
30890 external_smtp_batv:
30891   driver = smtp
30892   return_path = ${prvs {$return_path} \
30893                        {${lookup mysql{SELECT \
30894                        secret FROM batv_prvs WHERE \
30895                        sender='${quote_mysql:$sender_address}'} \
30896                        {$value}fail}}}
30897 .endd
30898 If no key can be found for the existing return path, no signing takes place.
30899
30900
30901
30902 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30903 .cindex "&ACL;" "relay control"
30904 .cindex "relaying" "control by ACL"
30905 .cindex "policy control" "relay control"
30906 An MTA is said to &'relay'& a message if it receives it from some host and
30907 delivers it directly to another host as a result of a remote address contained
30908 within it. Redirecting a local address via an alias or forward file and then
30909 passing the message on to another host is not relaying,
30910 .cindex "&""percent hack""&"
30911 but a redirection as a result of the &"percent hack"& is.
30912
30913 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30914 A host which is acting as a gateway or an MX backup is concerned with incoming
30915 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30916 a host which is acting as a smart host for a number of clients is concerned
30917 with outgoing relaying from those clients to the Internet at large. Often the
30918 same host is fulfilling both functions,
30919 . ///
30920 . as illustrated in the diagram below,
30921 . ///
30922 but in principle these two kinds of relaying are entirely independent. What is
30923 not wanted is the transmission of mail from arbitrary remote hosts through your
30924 system to arbitrary domains.
30925
30926
30927 You can implement relay control by means of suitable statements in the ACL that
30928 runs for each RCPT command. For convenience, it is often easiest to use
30929 Exim's named list facility to define the domains and hosts involved. For
30930 example, suppose you want to do the following:
30931
30932 .ilist
30933 Deliver a number of domains to mailboxes on the local host (or process them
30934 locally in some other way). Let's say these are &'my.dom1.example'& and
30935 &'my.dom2.example'&.
30936 .next
30937 Relay mail for a number of other domains for which you are the secondary MX.
30938 These might be &'friend1.example'& and &'friend2.example'&.
30939 .next
30940 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30941 Suppose your LAN is 192.168.45.0/24.
30942 .endlist
30943
30944
30945 In the main part of the configuration, you put the following definitions:
30946 .code
30947 domainlist local_domains    = my.dom1.example : my.dom2.example
30948 domainlist relay_to_domains = friend1.example : friend2.example
30949 hostlist   relay_from_hosts = 192.168.45.0/24
30950 .endd
30951 Now you can use these definitions in the ACL that is run for every RCPT
30952 command:
30953 .code
30954 acl_check_rcpt:
30955   accept domains = +local_domains : +relay_to_domains
30956   accept hosts   = +relay_from_hosts
30957 .endd
30958 The first statement accepts any RCPT command that contains an address in
30959 the local or relay domains. For any other domain, control passes to the second
30960 statement, which accepts the command only if it comes from one of the relay
30961 hosts. In practice, you will probably want to make your ACL more sophisticated
30962 than this, for example, by including sender and recipient verification. The
30963 default configuration includes a more comprehensive example, which is described
30964 in chapter &<<CHAPdefconfil>>&.
30965
30966
30967
30968 .section "Checking a relay configuration" "SECTcheralcon"
30969 .cindex "relaying" "checking control of"
30970 You can check the relay characteristics of your configuration in the same way
30971 that you can test any ACL behaviour for an incoming SMTP connection, by using
30972 the &%-bh%& option to run a fake SMTP session with which you interact.
30973 .ecindex IIDacl
30974
30975
30976
30977 . ////////////////////////////////////////////////////////////////////////////
30978 . ////////////////////////////////////////////////////////////////////////////
30979
30980 .chapter "Content scanning at ACL time" "CHAPexiscan"
30981 .scindex IIDcosca "content scanning" "at ACL time"
30982 The extension of Exim to include content scanning at ACL time, formerly known
30983 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30984 was integrated into the main source for Exim release 4.50, and Tom continues to
30985 maintain it. Most of the wording of this chapter is taken from Tom's
30986 specification.
30987
30988 It is also possible to scan the content of messages at other times. The
30989 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30990 scanning after all the ACLs have run. A transport filter can be used to scan
30991 messages at delivery time (see the &%transport_filter%& option, described in
30992 chapter &<<CHAPtransportgeneric>>&).
30993
30994 If you want to include the ACL-time content-scanning features when you compile
30995 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30996 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30997
30998 .ilist
30999 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31000 for all MIME parts for SMTP and non-SMTP messages, respectively.
31001 .next
31002 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31003 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31004 run at the end of message reception (the &%acl_smtp_data%& ACL).
31005 .next
31006 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31007 of messages, or parts of messages, for debugging purposes.
31008 .next
31009 Additional expansion variables that are set in the new ACL and by the new
31010 conditions.
31011 .next
31012 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31013 .endlist
31014
31015 Content-scanning is continually evolving, and new features are still being
31016 added. While such features are still unstable and liable to incompatible
31017 changes, they are made available in Exim by setting options whose names begin
31018 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31019 this manual. You can find out about them by reading the file called
31020 &_doc/experimental.txt_&.
31021
31022 All the content-scanning facilities work on a MBOX copy of the message that is
31023 temporarily created in a file called:
31024 .display
31025 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31026 .endd
31027 The &_.eml_& extension is a friendly hint to virus scanners that they can
31028 expect an MBOX-like structure inside that file. The file is created when the
31029 first content scanning facility is called. Subsequent calls to content
31030 scanning conditions open the same file again. The directory is recursively
31031 removed when the &%acl_smtp_data%& ACL has finished running, unless
31032 .code
31033 control = no_mbox_unspool
31034 .endd
31035 has been encountered. When the MIME ACL decodes files, they are put into the
31036 same directory by default.
31037
31038
31039
31040 .section "Scanning for viruses" "SECTscanvirus"
31041 .cindex "virus scanning"
31042 .cindex "content scanning" "for viruses"
31043 .cindex "content scanning" "the &%malware%& condition"
31044 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31045 It supports a &"generic"& interface to scanners called via the shell, and
31046 specialized interfaces for &"daemon"& type virus scanners, which are resident
31047 in memory and thus are much faster.
31048
31049 A timeout of 2 minutes is applied to a scanner call (by default);
31050 if it expires then a defer action is taken.
31051
31052 .oindex "&%av_scanner%&"
31053 You can set the &%av_scanner%& option in the main part of the configuration
31054 to specify which scanner to use, together with any additional options that
31055 are needed. The basic syntax is as follows:
31056 .display
31057 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31058 .endd
31059 If you do not set &%av_scanner%&, it defaults to
31060 .code
31061 av_scanner = sophie:/var/run/sophie
31062 .endd
31063 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31064 before use.
31065 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31066 The following scanner types are supported in this release:
31067
31068 .vlist
31069 .vitem &%avast%&
31070 .cindex "virus scanners" "avast"
31071 This is the scanner daemon of Avast. It has been tested with Avast Core
31072 Security (currently at version 1.1.7).
31073 You can get a trial version at &url(http://www.avast.com) or for Linux
31074 at &url(http://www.avast.com/linux-server-antivirus).
31075 This scanner type takes one option,
31076 which can be either a full path to a UNIX socket,
31077 or host and port specifiers separated by white space.
31078 The host may be a name or an IP address; the port is either a
31079 single number or a pair of numbers with a dash between.
31080 Any further options are given, on separate lines,
31081 to the daemon as options before the main scan command.
31082 For example:
31083 .code
31084 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31085 av_scanner = avast:192.168.2.22 5036
31086 .endd
31087 If you omit the argument, the default path
31088 &_/var/run/avast/scan.sock_&
31089 is used.
31090 If you use a remote host,
31091 you need to make Exim's spool directory available to it,
31092 as the scanner is passed a file path, not file contents.
31093 For information about available commands and their options you may use
31094 .code
31095 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31096     FLAGS
31097     SENSITIVITY
31098     PACK
31099 .endd
31100
31101
31102 .vitem &%aveserver%&
31103 .cindex "virus scanners" "Kaspersky"
31104 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31105 at &url(http://www.kaspersky.com). This scanner type takes one option,
31106 which is the path to the daemon's UNIX socket. The default is shown in this
31107 example:
31108 .code
31109 av_scanner = aveserver:/var/run/aveserver
31110 .endd
31111
31112
31113 .vitem &%clamd%&
31114 .cindex "virus scanners" "clamd"
31115 This daemon-type scanner is GPL and free. You can get it at
31116 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31117 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31118 in the MIME ACL. This is no longer believed to be necessary.
31119
31120 The options are a list of server specifiers, which may be
31121 a UNIX socket specification,
31122 a TCP socket specification,
31123 or a (global) option.
31124
31125 A socket specification consists of a space-separated list.
31126 For a Unix socket the first element is a full path for the socket,
31127 for a TCP socket the first element is the IP address
31128 and the second a port number,
31129 Any further elements are per-server (non-global) options.
31130 These per-server options are supported:
31131 .code
31132 retry=<timespec>        Retry on connect fail
31133 .endd
31134
31135 The &`retry`& option specifies a time after which a single retry for
31136 a failed connect is made.  The default is to not retry.
31137
31138 If a Unix socket file is specified, only one server is supported.
31139
31140 Examples:
31141 .code
31142 av_scanner = clamd:/opt/clamd/socket
31143 av_scanner = clamd:192.0.2.3 1234
31144 av_scanner = clamd:192.0.2.3 1234:local
31145 av_scanner = clamd:192.0.2.3 1234 retry=10s
31146 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31147 .endd
31148 If the value of av_scanner points to a UNIX socket file or contains the
31149 &`local`&
31150 option, then the ClamAV interface will pass a filename containing the data
31151 to be scanned, which will should normally result in less I/O happening and be
31152 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31153 Exim does not assume that there is a common filesystem with the remote host.
31154 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31155 you be running a version of ClamAV prior to 0.95.
31156
31157 The final example shows that multiple TCP targets can be specified.  Exim will
31158 randomly use one for each incoming email (i.e. it load balances them).  Note
31159 that only TCP targets may be used if specifying a list of scanners; a UNIX
31160 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31161 unavailable, Exim will try the remaining one(s) until it finds one that works.
31162 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31163 not keep track of scanner state between multiple messages, and the scanner
31164 selection is random, so the message will get logged in the mainlog for each
31165 email that the down scanner gets chosen first (message wrapped to be readable):
31166 .code
31167 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31168    clamd: connection to localhost, port 3310 failed
31169    (Connection refused)
31170 .endd
31171
31172 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31173 contributing the code for this scanner.
31174
31175 .vitem &%cmdline%&
31176 .cindex "virus scanners" "command line interface"
31177 This is the keyword for the generic command line scanner interface. It can be
31178 used to attach virus scanners that are invoked from the shell. This scanner
31179 type takes 3 mandatory options:
31180
31181 .olist
31182 The full path and name of the scanner binary, with all command line options,
31183 and a placeholder (&`%s`&) for the directory to scan.
31184
31185 .next
31186 A regular expression to match against the STDOUT and STDERR output of the
31187 virus scanner. If the expression matches, a virus was found. You must make
31188 absolutely sure that this expression matches on &"virus found"&. This is called
31189 the &"trigger"& expression.
31190
31191 .next
31192 Another regular expression, containing exactly one pair of parentheses, to
31193 match the name of the virus found in the scanners output. This is called the
31194 &"name"& expression.
31195 .endlist olist
31196
31197 For example, Sophos Sweep reports a virus on a line like this:
31198 .code
31199 Virus 'W32/Magistr-B' found in file ./those.bat
31200 .endd
31201 For the trigger expression, we can match the phrase &"found in file"&. For the
31202 name expression, we want to extract the W32/Magistr-B string, so we can match
31203 for the single quotes left and right of it. Altogether, this makes the
31204 configuration setting:
31205 .code
31206 av_scanner = cmdline:\
31207              /path/to/sweep -ss -all -rec -archive %s:\
31208              found in file:'(.+)'
31209 .endd
31210 .vitem &%drweb%&
31211 .cindex "virus scanners" "DrWeb"
31212 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31213 takes one option,
31214 either a full path to a UNIX socket,
31215 or host and port specifiers separated by white space.
31216 The host may be a name or an IP address; the port is either a
31217 single number or a pair of numbers with a dash between.
31218 For example:
31219 .code
31220 av_scanner = drweb:/var/run/drwebd.sock
31221 av_scanner = drweb:192.168.2.20 31337
31222 .endd
31223 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31224 is used. Thanks to Alex Miller for contributing the code for this scanner.
31225
31226 .vitem &%f-protd%&
31227 .cindex "virus scanners" "f-protd"
31228 The f-protd scanner is accessed via HTTP over TCP.
31229 One argument is taken, being a space-separated hostname and port number
31230 (or port-range).
31231 For example:
31232 .code
31233 av_scanner = f-protd:localhost 10200-10204
31234 .endd
31235 If you omit the argument, the default values show above are used.
31236
31237 .vitem &%fsecure%&
31238 .cindex "virus scanners" "F-Secure"
31239 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31240 argument which is the path to a UNIX socket. For example:
31241 .code
31242 av_scanner = fsecure:/path/to/.fsav
31243 .endd
31244 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31245 Thelmen for contributing the code for this scanner.
31246
31247 .vitem &%kavdaemon%&
31248 .cindex "virus scanners" "Kaspersky"
31249 This is the scanner daemon of Kaspersky Version 4. This version of the
31250 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31251 scanner type takes one option, which is the path to the daemon's UNIX socket.
31252 For example:
31253 .code
31254 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31255 .endd
31256 The default path is &_/var/run/AvpCtl_&.
31257
31258 .vitem &%mksd%&
31259 .cindex "virus scanners" "mksd"
31260 This is a daemon type scanner that is aimed mainly at Polish users, though some
31261 parts of documentation are now available in English. You can get it at
31262 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31263 the maximum number of processes used simultaneously to scan the attachments,
31264 provided that mksd has
31265 been run with at least the same number of child processes. For example:
31266 .code
31267 av_scanner = mksd:2
31268 .endd
31269 You can safely omit this option (the default value is 1).
31270
31271 .vitem &%sock%&
31272 .cindex "virus scanners" "simple socket-connected"
31273 This is a general-purpose way of talking to simple scanner daemons
31274 running on the local machine.
31275 There are four options:
31276 an address (which may be an IP address and port, or the path of a Unix socket),
31277 a commandline to send (may include a single %s which will be replaced with
31278 the path to the mail file to be scanned),
31279 an RE to trigger on from the returned data,
31280 an RE to extract malware_name from the returned data.
31281 For example:
31282 .code
31283 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
31284 .endd
31285 Default for the socket specifier is &_/tmp/malware.sock_&.
31286 Default for the commandline is &_%s\n_&.
31287 Both regular-expressions are required.
31288
31289 .vitem &%sophie%&
31290 .cindex "virus scanners" "Sophos and Sophie"
31291 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31292 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31293 for this scanner type is the path to the UNIX socket that Sophie uses for
31294 client communication. For example:
31295 .code
31296 av_scanner = sophie:/tmp/sophie
31297 .endd
31298 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31299 the option.
31300 .endlist
31301
31302 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31303 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31304 ACL.
31305
31306 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31307 makes it possible to use different scanners. See further below for an example.
31308 The &%malware%& condition caches its results, so when you use it multiple times
31309 for the same message, the actual scanning process is only carried out once.
31310 However, using expandable items in &%av_scanner%& disables this caching, in
31311 which case each use of the &%malware%& condition causes a new scan of the
31312 message.
31313
31314 The &%malware%& condition takes a right-hand argument that is expanded before
31315 use and taken as a list, slash-separated by default.
31316 The first element can then be one of
31317
31318 .ilist
31319 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31320 The condition succeeds if a virus was found, and fail otherwise. This is the
31321 recommended usage.
31322 .next
31323 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31324 the condition fails immediately.
31325 .next
31326 A regular expression, in which case the message is scanned for viruses. The
31327 condition succeeds if a virus is found and its name matches the regular
31328 expression. This allows you to take special actions on certain types of virus.
31329 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31330 unless the separator is changed (in the usual way).
31331 .endlist
31332
31333 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31334 messages even if there is a problem with the virus scanner.
31335 Otherwise, such a problem causes the ACL to defer.
31336
31337 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31338 specify a non-default timeout.  The default is two minutes.
31339 For example:
31340 .code
31341 malware = * / defer_ok / tmo=10s
31342 .endd
31343 A timeout causes the ACL to defer.
31344
31345 .vindex "&$callout_address$&"
31346 When a connection is made to the scanner the expansion variable &$callout_address$&
31347 is set to record the actual address used.
31348
31349 .vindex "&$malware_name$&"
31350 When a virus is found, the condition sets up an expansion variable called
31351 &$malware_name$& that contains the name of the virus. You can use it in a
31352 &%message%& modifier that specifies the error returned to the sender, and/or in
31353 logging data.
31354
31355 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31356 imposed by your anti-virus scanner.
31357
31358 Here is a very simple scanning example:
31359 .code
31360 deny message = This message contains malware ($malware_name)
31361      malware = *
31362 .endd
31363 The next example accepts messages when there is a problem with the scanner:
31364 .code
31365 deny message = This message contains malware ($malware_name)
31366      malware = */defer_ok
31367 .endd
31368 The next example shows how to use an ACL variable to scan with both sophie and
31369 aveserver. It assumes you have set:
31370 .code
31371 av_scanner = $acl_m0
31372 .endd
31373 in the main Exim configuration.
31374 .code
31375 deny message = This message contains malware ($malware_name)
31376      set acl_m0 = sophie
31377      malware = *
31378
31379 deny message = This message contains malware ($malware_name)
31380      set acl_m0 = aveserver
31381      malware = *
31382 .endd
31383
31384
31385 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31386 .cindex "content scanning" "for spam"
31387 .cindex "spam scanning"
31388 .cindex "SpamAssassin"
31389 .cindex "Rspamd"
31390 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31391 score and a report for the message.
31392 Support is also provided for Rspamd.
31393
31394 For more information about installation and configuration of SpamAssassin or
31395 Rspamd refer to their respective websites at
31396 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31397
31398 SpamAssassin can be installed with CPAN by running:
31399 .code
31400 perl -MCPAN -e 'install Mail::SpamAssassin'
31401 .endd
31402 SpamAssassin has its own set of configuration files. Please review its
31403 documentation to see how you can tweak it. The default installation should work
31404 nicely, however.
31405
31406 .oindex "&%spamd_address%&"
31407 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31408 intend to use an instance running on the local host you do not need to set
31409 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31410 you must set the &%spamd_address%& option in the global part of the Exim
31411 configuration as follows (example):
31412 .code
31413 spamd_address = 192.168.99.45 387
31414 .endd
31415
31416 To use Rspamd (which by default listens on all local addresses
31417 on TCP port 11333)
31418 you should add &%variant=rspamd%& after the address/port pair, for example:
31419 .code
31420 spamd_address = 127.0.0.1 11333 variant=rspamd
31421 .endd
31422
31423 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31424 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31425 file name instead of an address/port pair:
31426 .code
31427 spamd_address = /var/run/spamd_socket
31428 .endd
31429 You can have multiple &%spamd%& servers to improve scalability. These can
31430 reside on other hardware reachable over the network. To specify multiple
31431 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31432 option, separated with colons (the separator can be changed in the usual way):
31433 .code
31434 spamd_address = 192.168.2.10 783 : \
31435                 192.168.2.11 783 : \
31436                 192.168.2.12 783
31437 .endd
31438 Up to 32 &%spamd%& servers are supported.
31439 When a server fails to respond to the connection attempt, all other
31440 servers are tried until one succeeds. If no server responds, the &%spam%&
31441 condition defers.
31442
31443 Unix and TCP socket specifications may be mixed in any order.
31444 Each element of the list is a list itself, space-separated by default
31445 and changeable in the usual way.
31446
31447 For TCP socket specifications a host name or IP (v4 or v6, but
31448 subject to list-separator quoting rules) address can be used,
31449 and the port can be one or a dash-separated pair.
31450 In the latter case, the range is tried in strict order.
31451
31452 Elements after the first for Unix sockets, or second for TCP socket,
31453 are options.
31454 The supported options are:
31455 .code
31456 pri=<priority>      Selection priority
31457 weight=<value>      Selection bias
31458 time=<start>-<end>  Use only between these times of day
31459 retry=<timespec>    Retry on connect fail
31460 tmo=<timespec>      Connection time limit
31461 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31462 .endd
31463
31464 The &`pri`& option specifies a priority for the server within the list,
31465 higher values being tried first.
31466 The default priority is 1.
31467
31468 The &`weight`& option specifies a selection bias.
31469 Within a priority set
31470 servers are queried in a random fashion, weighted by this value.
31471 The default value for selection bias is 1.
31472
31473 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31474 in the local time zone; each element being one or more digits.
31475 Either the seconds or both minutes and seconds, plus the leading &`.`&
31476 characters, may be omitted and will be taken as zero.
31477
31478 Timeout specifications for the &`retry`& and &`tmo`& options
31479 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31480
31481 The &`tmo`& option specifies an overall timeout for communication.
31482 The default value is two minutes.
31483
31484 The &`retry`& option specifies a time after which a single retry for
31485 a failed connect is made.
31486 The default is to not retry.
31487
31488 The &%spamd_address%& variable is expanded before use if it starts with
31489 a dollar sign. In this case, the expansion may return a string that is
31490 used as the list so that multiple spamd servers can be the result of an
31491 expansion.
31492
31493 .vindex "&$callout_address$&"
31494 When a connection is made to the server the expansion variable &$callout_address$&
31495 is set to record the actual address used.
31496
31497 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31498 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31499 .code
31500 deny message = This message was classified as SPAM
31501      spam = joe
31502 .endd
31503 The right-hand side of the &%spam%& condition specifies a name. This is
31504 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31505 to scan using a specific profile, but rather use the SpamAssassin system-wide
31506 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31507 Rspamd does not use this setting. However, you must put something on the
31508 right-hand side.
31509
31510 The name allows you to use per-domain or per-user antispam profiles in
31511 principle, but this is not straightforward in practice, because a message may
31512 have multiple recipients, not necessarily all in the same domain. Because the
31513 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31514 read the contents of the message, the variables &$local_part$& and &$domain$&
31515 are not set.
31516 Careful enforcement of single-recipient messages
31517 (e.g. by responding with defer in the recipient ACL for all recipients
31518 after the first),
31519 or the use of PRDR,
31520 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31521 are needed to use this feature.
31522
31523 The right-hand side of the &%spam%& condition is expanded before being used, so
31524 you can put lookups or conditions there. When the right-hand side evaluates to
31525 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31526
31527
31528 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31529 large ones may cause significant performance degradation. As most spam messages
31530 are quite small, it is recommended that you do not scan the big ones. For
31531 example:
31532 .code
31533 deny message = This message was classified as SPAM
31534      condition = ${if < {$message_size}{10K}}
31535      spam = nobody
31536 .endd
31537
31538 The &%spam%& condition returns true if the threshold specified in the user's
31539 SpamAssassin profile has been matched or exceeded. If you want to use the
31540 &%spam%& condition for its side effects (see the variables below), you can make
31541 it always return &"true"& by appending &`:true`& to the username.
31542
31543 .cindex "spam scanning" "returned variables"
31544 When the &%spam%& condition is run, it sets up a number of expansion
31545 variables.
31546 Except for &$spam_report$&,
31547 these variables are saved with the received message so are
31548 available for use at delivery time.
31549
31550 .vlist
31551 .vitem &$spam_score$&
31552 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31553 for inclusion in log or reject messages.
31554
31555 .vitem &$spam_score_int$&
31556 The spam score of the message, multiplied by ten, as an integer value. For
31557 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31558 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31559 The integer value is useful for numeric comparisons in conditions.
31560
31561 .vitem &$spam_bar$&
31562 A string consisting of a number of &"+"& or &"-"& characters, representing the
31563 integer part of the spam score value. A spam score of 4.4 would have a
31564 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31565 headers, since MUAs can match on such strings. The maximum length of the
31566 spam bar is 50 characters.
31567
31568 .vitem &$spam_report$&
31569 A multiline text table, containing the full SpamAssassin report for the
31570 message. Useful for inclusion in headers or reject messages.
31571 This variable is only usable in a DATA-time ACL.
31572
31573 .vitem &$spam_action$&
31574 For SpamAssassin either 'reject' or 'no action' depending on the
31575 spam score versus threshold.
31576 For Rspamd, the recommended action.
31577
31578 .endlist
31579
31580 The &%spam%& condition caches its results unless expansion in
31581 spamd_address was used. If you call it again with the same user name, it
31582 does not scan again, but rather returns the same values as before.
31583
31584 The &%spam%& condition returns DEFER if there is any error while running
31585 the message through SpamAssassin or if the expansion of spamd_address
31586 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31587 statement block), append &`/defer_ok`& to the right-hand side of the
31588 spam condition, like this:
31589 .code
31590 deny message = This message was classified as SPAM
31591      spam    = joe/defer_ok
31592 .endd
31593 This causes messages to be accepted even if there is a problem with &%spamd%&.
31594
31595 Here is a longer, commented example of the use of the &%spam%&
31596 condition:
31597 .code
31598 # put headers in all messages (no matter if spam or not)
31599 warn  spam = nobody:true
31600       add_header = X-Spam-Score: $spam_score ($spam_bar)
31601       add_header = X-Spam-Report: $spam_report
31602
31603 # add second subject line with *SPAM* marker when message
31604 # is over threshold
31605 warn  spam = nobody
31606       add_header = Subject: *SPAM* $h_Subject:
31607
31608 # reject spam at high scores (> 12)
31609 deny  message = This message scored $spam_score spam points.
31610       spam = nobody:true
31611       condition = ${if >{$spam_score_int}{120}{1}{0}}
31612 .endd
31613
31614
31615
31616 .section "Scanning MIME parts" "SECTscanmimepart"
31617 .cindex "content scanning" "MIME parts"
31618 .cindex "MIME content scanning"
31619 .oindex "&%acl_smtp_mime%&"
31620 .oindex "&%acl_not_smtp_mime%&"
31621 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31622 each MIME part of an SMTP message, including multipart types, in the sequence
31623 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31624 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31625 options may both refer to the same ACL if you want the same processing in both
31626 cases.
31627
31628 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31629 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31630 the case of a non-SMTP message. However, a MIME ACL is called only if the
31631 message contains a &'Content-Type:'& header line. When a call to a MIME
31632 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31633 result code is sent to the client. In the case of an SMTP message, the
31634 &%acl_smtp_data%& ACL is not called when this happens.
31635
31636 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31637 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31638 condition to match against the raw MIME part. You can also use the
31639 &%mime_regex%& condition to match against the decoded MIME part (see section
31640 &<<SECTscanregex>>&).
31641
31642 At the start of a MIME ACL, a number of variables are set from the header
31643 information for the relevant MIME part. These are described below. The contents
31644 of the MIME part are not by default decoded into a disk file except for MIME
31645 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31646 part into a disk file, you can use the &%decode%& condition. The general
31647 syntax is:
31648 .display
31649 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31650 .endd
31651 The right hand side is expanded before use. After expansion,
31652 the value can be:
31653
31654 .olist
31655 &"0"& or &"false"&, in which case no decoding is done.
31656 .next
31657 The string &"default"&. In that case, the file is put in the temporary
31658 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31659 a sequential file name consisting of the message id and a sequence number. The
31660 full path and name is available in &$mime_decoded_filename$& after decoding.
31661 .next
31662 A full path name starting with a slash. If the full name is an existing
31663 directory, it is used as a replacement for the default directory. The filename
31664 is then sequentially assigned. If the path does not exist, it is used as
31665 the full path and file name.
31666 .next
31667 If the string does not start with a slash, it is used as the
31668 filename, and the default path is then used.
31669 .endlist
31670 The &%decode%& condition normally succeeds. It is only false for syntax
31671 errors or unusual circumstances such as memory shortages. You can easily decode
31672 a file with its original, proposed filename using
31673 .code
31674 decode = $mime_filename
31675 .endd
31676 However, you should keep in mind that &$mime_filename$& might contain
31677 anything. If you place files outside of the default path, they are not
31678 automatically unlinked.
31679
31680 For RFC822 attachments (these are messages attached to messages, with a
31681 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31682 as for the primary message, only that the &$mime_is_rfc822$& expansion
31683 variable is set (see below). Attached messages are always decoded to disk
31684 before being checked, and the files are unlinked once the check is done.
31685
31686 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31687 used to match regular expressions against raw and decoded MIME parts,
31688 respectively. They are described in section &<<SECTscanregex>>&.
31689
31690 .cindex "MIME content scanning" "returned variables"
31691 The following list describes all expansion variables that are
31692 available in the MIME ACL:
31693
31694 .vlist
31695 .vitem &$mime_boundary$&
31696 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31697 have a boundary string, which is stored in this variable. If the current part
31698 has no boundary parameter in the &'Content-Type:'& header, this variable
31699 contains the empty string.
31700
31701 .vitem &$mime_charset$&
31702 This variable contains the character set identifier, if one was found in the
31703 &'Content-Type:'& header. Examples for charset identifiers are:
31704 .code
31705 us-ascii
31706 gb2312 (Chinese)
31707 iso-8859-1
31708 .endd
31709 Please note that this value is not normalized, so you should do matches
31710 case-insensitively.
31711
31712 .vitem &$mime_content_description$&
31713 This variable contains the normalized content of the &'Content-Description:'&
31714 header. It can contain a human-readable description of the parts content. Some
31715 implementations repeat the filename for attachments here, but they are usually
31716 only used for display purposes.
31717
31718 .vitem &$mime_content_disposition$&
31719 This variable contains the normalized content of the &'Content-Disposition:'&
31720 header. You can expect strings like &"attachment"& or &"inline"& here.
31721
31722 .vitem &$mime_content_id$&
31723 This variable contains the normalized content of the &'Content-ID:'& header.
31724 This is a unique ID that can be used to reference a part from another part.
31725
31726 .vitem &$mime_content_size$&
31727 This variable is set only after the &%decode%& modifier (see above) has been
31728 successfully run. It contains the size of the decoded part in kilobytes. The
31729 size is always rounded up to full kilobytes, so only a completely empty part
31730 has a &$mime_content_size$& of zero.
31731
31732 .vitem &$mime_content_transfer_encoding$&
31733 This variable contains the normalized content of the
31734 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31735 type. Typical values are &"base64"& and &"quoted-printable"&.
31736
31737 .vitem &$mime_content_type$&
31738 If the MIME part has a &'Content-Type:'& header, this variable contains its
31739 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31740 are some examples of popular MIME types, as they may appear in this variable:
31741 .code
31742 text/plain
31743 text/html
31744 application/octet-stream
31745 image/jpeg
31746 audio/midi
31747 .endd
31748 If the MIME part has no &'Content-Type:'& header, this variable contains the
31749 empty string.
31750
31751 .vitem &$mime_decoded_filename$&
31752 This variable is set only after the &%decode%& modifier (see above) has been
31753 successfully run. It contains the full path and file name of the file
31754 containing the decoded data.
31755 .endlist
31756
31757 .cindex "RFC 2047"
31758 .vlist
31759 .vitem &$mime_filename$&
31760 This is perhaps the most important of the MIME variables. It contains a
31761 proposed filename for an attachment, if one was found in either the
31762 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31763 RFC2047
31764 or RFC2231
31765 decoded, but no additional sanity checks are done.
31766  If no filename was
31767 found, this variable contains the empty string.
31768
31769 .vitem &$mime_is_coverletter$&
31770 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31771 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31772 content in the cover letter, while not restricting attachments at all.
31773
31774 The variable contains 1 (true) for a MIME part believed to be part of the
31775 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31776 follows:
31777
31778 .olist
31779 The outermost MIME part of a message is always a cover letter.
31780
31781 .next
31782 If a multipart/alternative or multipart/related MIME part is a cover letter,
31783 so are all MIME subparts within that multipart.
31784
31785 .next
31786 If any other multipart is a cover letter, the first subpart is a cover letter,
31787 and the rest are attachments.
31788
31789 .next
31790 All parts contained within an attachment multipart are attachments.
31791 .endlist olist
31792
31793 As an example, the following will ban &"HTML mail"& (including that sent with
31794 alternative plain text), while allowing HTML files to be attached. HTML
31795 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31796 .code
31797 deny message = HTML mail is not accepted here
31798 !condition = $mime_is_rfc822
31799 condition = $mime_is_coverletter
31800 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31801 .endd
31802 .vitem &$mime_is_multipart$&
31803 This variable has the value 1 (true) when the current part has the main type
31804 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31805 Since multipart entities only serve as containers for other parts, you may not
31806 want to carry out specific actions on them.
31807
31808 .vitem &$mime_is_rfc822$&
31809 This variable has the value 1 (true) if the current part is not a part of the
31810 checked message itself, but part of an attached message. Attached message
31811 decoding is fully recursive.
31812
31813 .vitem &$mime_part_count$&
31814 This variable is a counter that is raised for each processed MIME part. It
31815 starts at zero for the very first part (which is usually a multipart). The
31816 counter is per-message, so it is reset when processing RFC822 attachments (see
31817 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31818 complete, so you can use it in the DATA ACL to determine the number of MIME
31819 parts of a message. For non-MIME messages, this variable contains the value -1.
31820 .endlist
31821
31822
31823
31824 .section "Scanning with regular expressions" "SECTscanregex"
31825 .cindex "content scanning" "with regular expressions"
31826 .cindex "regular expressions" "content scanning with"
31827 You can specify your own custom regular expression matches on the full body of
31828 the message, or on individual MIME parts.
31829
31830 The &%regex%& condition takes one or more regular expressions as arguments and
31831 matches them against the full message (when called in the DATA ACL) or a raw
31832 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31833 linewise, with a maximum line length of 32K characters. That means you cannot
31834 have multiline matches with the &%regex%& condition.
31835
31836 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31837 to 32K of decoded content (the whole content at once, not linewise). If the
31838 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31839 is decoded automatically when &%mime_regex%& is executed (using default path
31840 and filename values). If the decoded data is larger than  32K, only the first
31841 32K characters are checked.
31842
31843 The regular expressions are passed as a colon-separated list. To include a
31844 literal colon, you must double it. Since the whole right-hand side string is
31845 expanded before being used, you must also escape dollar signs and backslashes
31846 with more backslashes, or use the &`\N`& facility to disable expansion.
31847 Here is a simple example that contains two regular expressions:
31848 .code
31849 deny message = contains blacklisted regex ($regex_match_string)
31850      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31851 .endd
31852 The conditions returns true if any one of the regular expressions matches. The
31853 &$regex_match_string$& expansion variable is then set up and contains the
31854 matching regular expression.
31855 The expansion variables &$regex1$& &$regex2$& etc
31856 are set to any substrings captured by the regular expression.
31857
31858 &*Warning*&: With large messages, these conditions can be fairly
31859 CPU-intensive.
31860
31861 .ecindex IIDcosca
31862
31863
31864
31865
31866 . ////////////////////////////////////////////////////////////////////////////
31867 . ////////////////////////////////////////////////////////////////////////////
31868
31869 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31870          "Local scan function"
31871 .scindex IIDlosca "&[local_scan()]& function" "description of"
31872 .cindex "customizing" "input scan using C function"
31873 .cindex "policy control" "by local scan function"
31874 In these days of email worms, viruses, and ever-increasing spam, some sites
31875 want to apply a lot of checking to messages before accepting them.
31876
31877 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31878 passing messages to external virus and spam scanning software. You can also do
31879 a certain amount in Exim itself through string expansions and the &%condition%&
31880 condition in the ACL that runs after the SMTP DATA command or the ACL for
31881 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31882
31883 To allow for further customization to a site's own requirements, there is the
31884 possibility of linking Exim with a private message scanning function, written
31885 in C. If you want to run code that is written in something other than C, you
31886 can of course use a little C stub to call it.
31887
31888 The local scan function is run once for every incoming message, at the point
31889 when Exim is just about to accept the message.
31890 It can therefore be used to control non-SMTP messages from local processes as
31891 well as messages arriving via SMTP.
31892
31893 Exim applies a timeout to calls of the local scan function, and there is an
31894 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31895 Zero means &"no timeout"&.
31896 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31897 before calling the local scan function, so that the most common types of crash
31898 are caught. If the timeout is exceeded or one of those signals is caught, the
31899 incoming message is rejected with a temporary error if it is an SMTP message.
31900 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31901 code. The incident is logged on the main and reject logs.
31902
31903
31904
31905 .section "Building Exim to use a local scan function" "SECID207"
31906 .cindex "&[local_scan()]& function" "building Exim to use"
31907 To make use of the local scan function feature, you must tell Exim where your
31908 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31909 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31910 directory, so you might set
31911 .code
31912 LOCAL_SCAN_SOURCE=Local/local_scan.c
31913 .endd
31914 for example. The function must be called &[local_scan()]&. It is called by
31915 Exim after it has received a message, when the success return code is about to
31916 be sent. This is after all the ACLs have been run. The return code from your
31917 function controls whether the message is actually accepted or not. There is a
31918 commented template function (that just accepts the message) in the file
31919 _src/local_scan.c_.
31920
31921 If you want to make use of Exim's run time configuration file to set options
31922 for your &[local_scan()]& function, you must also set
31923 .code
31924 LOCAL_SCAN_HAS_OPTIONS=yes
31925 .endd
31926 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31927
31928
31929
31930
31931 .section "API for local_scan()" "SECTapiforloc"
31932 .cindex "&[local_scan()]& function" "API description"
31933 You must include this line near the start of your code:
31934 .code
31935 #include "local_scan.h"
31936 .endd
31937 This header file defines a number of variables and other values, and the
31938 prototype for the function itself. Exim is coded to use unsigned char values
31939 almost exclusively, and one of the things this header defines is a shorthand
31940 for &`unsigned char`& called &`uschar`&.
31941 It also contains the following macro definitions, to simplify casting character
31942 strings and pointers to character strings:
31943 .code
31944 #define CS   (char *)
31945 #define CCS  (const char *)
31946 #define CSS  (char **)
31947 #define US   (unsigned char *)
31948 #define CUS  (const unsigned char *)
31949 #define USS  (unsigned char **)
31950 .endd
31951 The function prototype for &[local_scan()]& is:
31952 .code
31953 extern int local_scan(int fd, uschar **return_text);
31954 .endd
31955 The arguments are as follows:
31956
31957 .ilist
31958 &%fd%& is a file descriptor for the file that contains the body of the message
31959 (the -D file). The file is open for reading and writing, but updating it is not
31960 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31961
31962 The descriptor is positioned at character 19 of the file, which is the first
31963 character of the body itself, because the first 19 characters are the message
31964 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31965 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31966 case this changes in some future version.
31967 .next
31968 &%return_text%& is an address which you can use to return a pointer to a text
31969 string at the end of the function. The value it points to on entry is NULL.
31970 .endlist
31971
31972 The function must return an &%int%& value which is one of the following macros:
31973
31974 .vlist
31975 .vitem &`LOCAL_SCAN_ACCEPT`&
31976 .vindex "&$local_scan_data$&"
31977 The message is accepted. If you pass back a string of text, it is saved with
31978 the message, and made available in the variable &$local_scan_data$&. No
31979 newlines are permitted (if there are any, they are turned into spaces) and the
31980 maximum length of text is 1000 characters.
31981
31982 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31983 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31984 queued without immediate delivery, and is frozen.
31985
31986 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31987 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31988 queued without immediate delivery.
31989
31990 .vitem &`LOCAL_SCAN_REJECT`&
31991 The message is rejected; the returned text is used as an error message which is
31992 passed back to the sender and which is also logged. Newlines are permitted &--
31993 they cause a multiline response for SMTP rejections, but are converted to
31994 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31995 used.
31996
31997 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31998 The message is temporarily rejected; the returned text is used as an error
31999 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32000 problem"& is used.
32001
32002 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32003 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32004 message is not written to the reject log. It has the effect of unsetting the
32005 &%rejected_header%& log selector for just this rejection. If
32006 &%rejected_header%& is already unset (see the discussion of the
32007 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32008 same as LOCAL_SCAN_REJECT.
32009
32010 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32011 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32012 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32013 .endlist
32014
32015 If the message is not being received by interactive SMTP, rejections are
32016 reported by writing to &%stderr%& or by sending an email, as configured by the
32017 &%-oe%& command line options.
32018
32019
32020
32021 .section "Configuration options for local_scan()" "SECTconoptloc"
32022 .cindex "&[local_scan()]& function" "configuration options"
32023 It is possible to have option settings in the main configuration file
32024 that set values in static variables in the &[local_scan()]& module. If you
32025 want to do this, you must have the line
32026 .code
32027 LOCAL_SCAN_HAS_OPTIONS=yes
32028 .endd
32029 in your &_Local/Makefile_& when you build Exim. (This line is in
32030 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32031 file, you must define static variables to hold the option values, and a table
32032 to define them.
32033
32034 The table must be a vector called &%local_scan_options%&, of type
32035 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32036 and a pointer to the variable that holds the value. The entries must appear in
32037 alphabetical order. Following &%local_scan_options%& you must also define a
32038 variable called &%local_scan_options_count%& that contains the number of
32039 entries in the table. Here is a short example, showing two kinds of option:
32040 .code
32041 static int my_integer_option = 42;
32042 static uschar *my_string_option = US"a default string";
32043
32044 optionlist local_scan_options[] = {
32045   { "my_integer", opt_int,       &my_integer_option },
32046   { "my_string",  opt_stringptr, &my_string_option }
32047 };
32048
32049 int local_scan_options_count =
32050   sizeof(local_scan_options)/sizeof(optionlist);
32051 .endd
32052 The values of the variables can now be changed from Exim's runtime
32053 configuration file by including a local scan section as in this example:
32054 .code
32055 begin local_scan
32056 my_integer = 99
32057 my_string = some string of text...
32058 .endd
32059 The available types of option data are as follows:
32060
32061 .vlist
32062 .vitem &*opt_bool*&
32063 This specifies a boolean (true/false) option. The address should point to a
32064 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32065 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32066 whether such a variable has been set at all, you can initialize it to
32067 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32068 values.)
32069
32070 .vitem &*opt_fixed*&
32071 This specifies a fixed point number, such as is used for load averages.
32072 The address should point to a variable of type &`int`&. The value is stored
32073 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32074
32075 .vitem &*opt_int*&
32076 This specifies an integer; the address should point to a variable of type
32077 &`int`&. The value may be specified in any of the integer formats accepted by
32078 Exim.
32079
32080 .vitem &*opt_mkint*&
32081 This is the same as &%opt_int%&, except that when such a value is output in a
32082 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32083 printed with the suffix K or M.
32084
32085 .vitem &*opt_octint*&
32086 This also specifies an integer, but the value is always interpreted as an
32087 octal integer, whether or not it starts with the digit zero, and it is
32088 always output in octal.
32089
32090 .vitem &*opt_stringptr*&
32091 This specifies a string value; the address must be a pointer to a
32092 variable that points to a string (for example, of type &`uschar *`&).
32093
32094 .vitem &*opt_time*&
32095 This specifies a time interval value. The address must point to a variable of
32096 type &`int`&. The value that is placed there is a number of seconds.
32097 .endlist
32098
32099 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32100 out the values of all the &[local_scan()]& options.
32101
32102
32103
32104 .section "Available Exim variables" "SECID208"
32105 .cindex "&[local_scan()]& function" "available Exim variables"
32106 The header &_local_scan.h_& gives you access to a number of C variables. These
32107 are the only ones that are guaranteed to be maintained from release to release.
32108 Note, however, that you can obtain the value of any Exim expansion variable,
32109 including &$recipients$&, by calling &'expand_string()'&. The exported
32110 C variables are as follows:
32111
32112 .vlist
32113 .vitem &*int&~body_linecount*&
32114 This variable contains the number of lines in the message's body.
32115
32116 .vitem &*int&~body_zerocount*&
32117 This variable contains the number of binary zero bytes in the message's body.
32118
32119 .vitem &*unsigned&~int&~debug_selector*&
32120 This variable is set to zero when no debugging is taking place. Otherwise, it
32121 is a bitmap of debugging selectors. Two bits are identified for use in
32122 &[local_scan()]&; they are defined as macros:
32123
32124 .ilist
32125 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32126 testing option that is not privileged &-- any caller may set it. All the
32127 other selector bits can be set only by admin users.
32128
32129 .next
32130 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32131 by the &`+local_scan`& debug selector. It is not included in the default set
32132 of debugging bits.
32133 .endlist ilist
32134
32135 Thus, to write to the debugging output only when &`+local_scan`& has been
32136 selected, you should use code like this:
32137 .code
32138 if ((debug_selector & D_local_scan) != 0)
32139   debug_printf("xxx", ...);
32140 .endd
32141 .vitem &*uschar&~*expand_string_message*&
32142 After a failing call to &'expand_string()'& (returned value NULL), the
32143 variable &%expand_string_message%& contains the error message, zero-terminated.
32144
32145 .vitem &*header_line&~*header_list*&
32146 A pointer to a chain of header lines. The &%header_line%& structure is
32147 discussed below.
32148
32149 .vitem &*header_line&~*header_last*&
32150 A pointer to the last of the header lines.
32151
32152 .vitem &*uschar&~*headers_charset*&
32153 The value of the &%headers_charset%& configuration option.
32154
32155 .vitem &*BOOL&~host_checking*&
32156 This variable is TRUE during a host checking session that is initiated by the
32157 &%-bh%& command line option.
32158
32159 .vitem &*uschar&~*interface_address*&
32160 The IP address of the interface that received the message, as a string. This
32161 is NULL for locally submitted messages.
32162
32163 .vitem &*int&~interface_port*&
32164 The port on which this message was received. When testing with the &%-bh%&
32165 command line option, the value of this variable is -1 unless a port has been
32166 specified via the &%-oMi%& option.
32167
32168 .vitem &*uschar&~*message_id*&
32169 This variable contains Exim's message id for the incoming message (the value of
32170 &$message_exim_id$&) as a zero-terminated string.
32171
32172 .vitem &*uschar&~*received_protocol*&
32173 The name of the protocol by which the message was received.
32174
32175 .vitem &*int&~recipients_count*&
32176 The number of accepted recipients.
32177
32178 .vitem &*recipient_item&~*recipients_list*&
32179 .cindex "recipient" "adding in local scan"
32180 .cindex "recipient" "removing in local scan"
32181 The list of accepted recipients, held in a vector of length
32182 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32183 can add additional recipients by calling &'receive_add_recipient()'& (see
32184 below). You can delete recipients by removing them from the vector and
32185 adjusting the value in &%recipients_count%&. In particular, by setting
32186 &%recipients_count%& to zero you remove all recipients. If you then return the
32187 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32188 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32189 and then call &'receive_add_recipient()'& as often as needed.
32190
32191 .vitem &*uschar&~*sender_address*&
32192 The envelope sender address. For bounce messages this is the empty string.
32193
32194 .vitem &*uschar&~*sender_host_address*&
32195 The IP address of the sending host, as a string. This is NULL for
32196 locally-submitted messages.
32197
32198 .vitem &*uschar&~*sender_host_authenticated*&
32199 The name of the authentication mechanism that was used, or NULL if the message
32200 was not received over an authenticated SMTP connection.
32201
32202 .vitem &*uschar&~*sender_host_name*&
32203 The name of the sending host, if known.
32204
32205 .vitem &*int&~sender_host_port*&
32206 The port on the sending host.
32207
32208 .vitem &*BOOL&~smtp_input*&
32209 This variable is TRUE for all SMTP input, including BSMTP.
32210
32211 .vitem &*BOOL&~smtp_batched_input*&
32212 This variable is TRUE for BSMTP input.
32213
32214 .vitem &*int&~store_pool*&
32215 The contents of this variable control which pool of memory is used for new
32216 requests. See section &<<SECTmemhanloc>>& for details.
32217 .endlist
32218
32219
32220 .section "Structure of header lines" "SECID209"
32221 The &%header_line%& structure contains the members listed below.
32222 You can add additional header lines by calling the &'header_add()'& function
32223 (see below). You can cause header lines to be ignored (deleted) by setting
32224 their type to *.
32225
32226
32227 .vlist
32228 .vitem &*struct&~header_line&~*next*&
32229 A pointer to the next header line, or NULL for the last line.
32230
32231 .vitem &*int&~type*&
32232 A code identifying certain headers that Exim recognizes. The codes are printing
32233 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32234 Notice in particular that any header line whose type is * is not transmitted
32235 with the message. This flagging is used for header lines that have been
32236 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32237 lines.) Effectively, * means &"deleted"&.
32238
32239 .vitem &*int&~slen*&
32240 The number of characters in the header line, including the terminating and any
32241 internal newlines.
32242
32243 .vitem &*uschar&~*text*&
32244 A pointer to the text of the header. It always ends with a newline, followed by
32245 a zero byte. Internal newlines are preserved.
32246 .endlist
32247
32248
32249
32250 .section "Structure of recipient items" "SECID210"
32251 The &%recipient_item%& structure contains these members:
32252
32253 .vlist
32254 .vitem &*uschar&~*address*&
32255 This is a pointer to the recipient address as it was received.
32256
32257 .vitem &*int&~pno*&
32258 This is used in later Exim processing when top level addresses are created by
32259 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32260 and must always contain -1 at this stage.
32261
32262 .vitem &*uschar&~*errors_to*&
32263 If this value is not NULL, bounce messages caused by failing to deliver to the
32264 recipient are sent to the address it contains. In other words, it overrides the
32265 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32266 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32267 an unqualified address, Exim qualifies it using the domain from
32268 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32269 is NULL for all recipients.
32270 .endlist
32271
32272
32273
32274 .section "Available Exim functions" "SECID211"
32275 .cindex "&[local_scan()]& function" "available Exim functions"
32276 The header &_local_scan.h_& gives you access to a number of Exim functions.
32277 These are the only ones that are guaranteed to be maintained from release to
32278 release:
32279
32280 .vlist
32281 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32282        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32283
32284 This function creates a child process that runs the command specified by
32285 &%argv%&. The environment for the process is specified by &%envp%&, which can
32286 be NULL if no environment variables are to be passed. A new umask is supplied
32287 for the process in &%newumask%&.
32288
32289 Pipes to the standard input and output of the new process are set up
32290 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32291 standard error is cloned to the standard output. If there are any file
32292 descriptors &"in the way"& in the new process, they are closed. If the final
32293 argument is TRUE, the new process is made into a process group leader.
32294
32295 The function returns the pid of the new process, or -1 if things go wrong.
32296
32297 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32298 This function waits for a child process to terminate, or for a timeout (in
32299 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32300 return value is as follows:
32301
32302 .ilist
32303 >= 0
32304
32305 The process terminated by a normal exit and the value is the process
32306 ending status.
32307
32308 .next
32309 < 0 and > &--256
32310
32311 The process was terminated by a signal and the value is the negation of the
32312 signal number.
32313
32314 .next
32315 &--256
32316
32317 The process timed out.
32318 .next
32319 &--257
32320
32321 The was some other error in wait(); &%errno%& is still set.
32322 .endlist
32323
32324 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32325 This function provide you with a means of submitting a new message to
32326 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32327 want, but this packages it all up for you.) The function creates a pipe,
32328 forks a subprocess that is running
32329 .code
32330 exim -t -oem -oi -f <>
32331 .endd
32332 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32333 that is connected to the standard input. The yield of the function is the PID
32334 of the subprocess. You can then write a message to the file descriptor, with
32335 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32336
32337 When you have finished, call &'child_close()'& to wait for the process to
32338 finish and to collect its ending status. A timeout value of zero is usually
32339 fine in this circumstance. Unless you have made a mistake with the recipient
32340 addresses, you should get a return code of zero.
32341
32342
32343 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32344        *sender_authentication)*&
32345 This function is a more sophisticated version of &'child_open()'&. The command
32346 that it runs is:
32347 .display
32348 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32349 .endd
32350 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32351
32352
32353 .vitem &*void&~debug_printf(char&~*,&~...)*&
32354 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32355 output is written to the standard error stream. If no debugging is selected,
32356 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32357 conditional on the &`local_scan`& debug selector by coding like this:
32358 .code
32359 if ((debug_selector & D_local_scan) != 0)
32360   debug_printf("xxx", ...);
32361 .endd
32362
32363 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32364 This is an interface to Exim's string expansion code. The return value is the
32365 expanded string, or NULL if there was an expansion failure.
32366 The C variable &%expand_string_message%& contains an error message after an
32367 expansion failure. If expansion does not change the string, the return value is
32368 the pointer to the input string. Otherwise, the return value points to a new
32369 block of memory that was obtained by a call to &'store_get()'&. See section
32370 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32371
32372 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32373 This function allows you to an add additional header line at the end of the
32374 existing ones. The first argument is the type, and should normally be a space
32375 character. The second argument is a format string and any number of
32376 substitution arguments as for &[sprintf()]&. You may include internal newlines
32377 if you want, and you must ensure that the string ends with a newline.
32378
32379 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32380         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32381 This function adds a new header line at a specified point in the header
32382 chain. The header itself is specified as for &'header_add()'&.
32383
32384 If &%name%& is NULL, the new header is added at the end of the chain if
32385 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32386 NULL, the header lines are searched for the first non-deleted header that
32387 matches the name. If one is found, the new header is added before it if
32388 &%after%& is false. If &%after%& is true, the new header is added after the
32389 found header and any adjacent subsequent ones with the same name (even if
32390 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32391 option controls where the header is added. If it is true, addition is at the
32392 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32393 headers, or at the top if there are no &'Received:'& headers, you could use
32394 .code
32395 header_add_at_position(TRUE, US"Received", TRUE,
32396   ' ', "X-xxx: ...");
32397 .endd
32398 Normally, there is always at least one non-deleted &'Received:'& header, but
32399 there may not be if &%received_header_text%& expands to an empty string.
32400
32401
32402 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32403 This function removes header lines. If &%occurrence%& is zero or negative, all
32404 occurrences of the header are removed. If occurrence is greater than zero, that
32405 particular instance of the header is removed. If no header(s) can be found that
32406 match the specification, the function does nothing.
32407
32408
32409 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32410         int&~length,&~BOOL&~notdel)*&"
32411 This function tests whether the given header has the given name. It is not just
32412 a string comparison, because white space is permitted between the name and the
32413 colon. If the &%notdel%& argument is true, a false return is forced for all
32414 &"deleted"& headers; otherwise they are not treated specially. For example:
32415 .code
32416 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32417 .endd
32418 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32419 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32420 This function base64-encodes a string, which is passed by address and length.
32421 The text may contain bytes of any value, including zero. The result is passed
32422 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32423 zero-terminated.
32424
32425 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32426 This function decodes a base64-encoded string. Its arguments are a
32427 zero-terminated base64-encoded string and the address of a variable that is set
32428 to point to the result, which is in dynamic memory. The length of the decoded
32429 string is the yield of the function. If the input is invalid base64 data, the
32430 yield is -1. A zero byte is added to the end of the output string to make it
32431 easy to interpret as a C string (assuming it contains no zeros of its own). The
32432 added zero byte is not included in the returned count.
32433
32434 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32435 This function checks for a match in a domain list. Domains are always
32436 matched caselessly. The return value is one of the following:
32437 .display
32438 &`OK     `& match succeeded
32439 &`FAIL   `& match failed
32440 &`DEFER  `& match deferred
32441 .endd
32442 DEFER is usually caused by some kind of lookup defer, such as the
32443 inability to contact a database.
32444
32445 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32446         BOOL&~caseless)*&"
32447 This function checks for a match in a local part list. The third argument
32448 controls case-sensitivity. The return values are as for
32449 &'lss_match_domain()'&.
32450
32451 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32452         BOOL&~caseless)*&"
32453 This function checks for a match in an address list. The third argument
32454 controls the case-sensitivity of the local part match. The domain is always
32455 matched caselessly. The return values are as for &'lss_match_domain()'&.
32456
32457 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32458         uschar&~*list)*&"
32459 This function checks for a match in a host list. The most common usage is
32460 expected to be
32461 .code
32462 lss_match_host(sender_host_name, sender_host_address, ...)
32463 .endd
32464 .vindex "&$sender_host_address$&"
32465 An empty address field matches an empty item in the host list. If the host name
32466 is NULL, the name corresponding to &$sender_host_address$& is automatically
32467 looked up if a host name is required to match an item in the list. The return
32468 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32469 returns ERROR in the case when it had to look up a host name, but the lookup
32470 failed.
32471
32472 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32473         *format,&~...)*&"
32474 This function writes to Exim's log files. The first argument should be zero (it
32475 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32476 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32477 them. It specifies to which log or logs the message is written. The remaining
32478 arguments are a format and relevant insertion arguments. The string should not
32479 contain any newlines, not even at the end.
32480
32481
32482 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32483 This function adds an additional recipient to the message. The first argument
32484 is the recipient address. If it is unqualified (has no domain), it is qualified
32485 with the &%qualify_recipient%& domain. The second argument must always be -1.
32486
32487 This function does not allow you to specify a private &%errors_to%& address (as
32488 described with the structure of &%recipient_item%& above), because it pre-dates
32489 the addition of that field to the structure. However, it is easy to add such a
32490 value afterwards. For example:
32491 .code
32492  receive_add_recipient(US"monitor@mydom.example", -1);
32493  recipients_list[recipients_count-1].errors_to =
32494    US"postmaster@mydom.example";
32495 .endd
32496
32497 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32498 This is a convenience function to remove a named recipient from the list of
32499 recipients. It returns true if a recipient was removed, and false if no
32500 matching recipient could be found. The argument must be a complete email
32501 address.
32502 .endlist
32503
32504
32505 .cindex "RFC 2047"
32506 .vlist
32507 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32508   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32509 This function decodes strings that are encoded according to RFC 2047. Typically
32510 these are the contents of header lines. First, each &"encoded word"& is decoded
32511 from the Q or B encoding into a byte-string. Then, if provided with the name of
32512 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32513 made  to translate the result to the named character set. If this fails, the
32514 binary string is returned with an error message.
32515
32516 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32517 maximum MIME word length is enforced. The third argument is the target
32518 encoding, or NULL if no translation is wanted.
32519
32520 .cindex "binary zero" "in RFC 2047 decoding"
32521 .cindex "RFC 2047" "binary zero in"
32522 If a binary zero is encountered in the decoded string, it is replaced by the
32523 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32524 not be 0 because header lines are handled as zero-terminated strings.
32525
32526 The function returns the result of processing the string, zero-terminated; if
32527 &%lenptr%& is not NULL, the length of the result is set in the variable to
32528 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32529
32530 If an error is encountered, the function returns NULL and uses the &%error%&
32531 argument to return an error message. The variable pointed to by &%error%& is
32532 set to NULL if there is no error; it may be set non-NULL even when the function
32533 returns a non-NULL value if decoding was successful, but there was a problem
32534 with translation.
32535
32536
32537 .vitem &*int&~smtp_fflush(void)*&
32538 This function is used in conjunction with &'smtp_printf()'&, as described
32539 below.
32540
32541 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32542 The arguments of this function are like &[printf()]&; it writes to the SMTP
32543 output stream. You should use this function only when there is an SMTP output
32544 stream, that is, when the incoming message is being received via interactive
32545 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32546 is FALSE. If you want to test for an incoming message from another host (as
32547 opposed to a local process that used the &%-bs%& command line option), you can
32548 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32549 is involved.
32550
32551 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32552 output function, so it can be used for all forms of SMTP connection.
32553
32554 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32555 must start with an appropriate response code: 550 if you are going to return
32556 LOCAL_SCAN_REJECT, 451 if you are going to return
32557 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32558 initial lines of a multi-line response, the code must be followed by a hyphen
32559 to indicate that the line is not the final response line. You must also ensure
32560 that the lines you write terminate with CRLF. For example:
32561 .code
32562 smtp_printf("550-this is some extra info\r\n");
32563 return LOCAL_SCAN_REJECT;
32564 .endd
32565 Note that you can also create multi-line responses by including newlines in
32566 the data returned via the &%return_text%& argument. The added value of using
32567 &'smtp_printf()'& is that, for instance, you could introduce delays between
32568 multiple output lines.
32569
32570 The &'smtp_printf()'& function does not return any error indication, because it
32571 does not automatically flush pending output, and therefore does not test
32572 the state of the stream. (In the main code of Exim, flushing and error
32573 detection is done when Exim is ready for the next SMTP input command.) If
32574 you want to flush the output and check for an error (for example, the
32575 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32576 arguments. It flushes the output stream, and returns a non-zero value if there
32577 is an error.
32578
32579 .vitem &*void&~*store_get(int)*&
32580 This function accesses Exim's internal store (memory) manager. It gets a new
32581 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32582 runs out of memory. See the next section for a discussion of memory handling.
32583
32584 .vitem &*void&~*store_get_perm(int)*&
32585 This function is like &'store_get()'&, but it always gets memory from the
32586 permanent pool. See the next section for a discussion of memory handling.
32587
32588 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32589 See below.
32590
32591 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32592 See below.
32593
32594 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32595 These three functions create strings using Exim's dynamic memory facilities.
32596 The first makes a copy of an entire string. The second copies up to a maximum
32597 number of characters, indicated by the second argument. The third uses a format
32598 and insertion arguments to create a new string. In each case, the result is a
32599 pointer to a new string in the current memory pool. See the next section for
32600 more discussion.
32601 .endlist
32602
32603
32604
32605 .section "More about Exim's memory handling" "SECTmemhanloc"
32606 .cindex "&[local_scan()]& function" "memory handling"
32607 No function is provided for freeing memory, because that is never needed.
32608 The dynamic memory that Exim uses when receiving a message is automatically
32609 recycled if another message is received by the same process (this applies only
32610 to incoming SMTP connections &-- other input methods can supply only one
32611 message at a time). After receiving the last message, a reception process
32612 terminates.
32613
32614 Because it is recycled, the normal dynamic memory cannot be used for holding
32615 data that must be preserved over a number of incoming messages on the same SMTP
32616 connection. However, Exim in fact uses two pools of dynamic memory; the second
32617 one is not recycled, and can be used for this purpose.
32618
32619 If you want to allocate memory that remains available for subsequent messages
32620 in the same SMTP connection, you should set
32621 .code
32622 store_pool = POOL_PERM
32623 .endd
32624 before calling the function that does the allocation. There is no need to
32625 restore the value if you do not need to; however, if you do want to revert to
32626 the normal pool, you can either restore the previous value of &%store_pool%& or
32627 set it explicitly to POOL_MAIN.
32628
32629 The pool setting applies to all functions that get dynamic memory, including
32630 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32631 There is also a convenience function called &'store_get_perm()'& that gets a
32632 block of memory from the permanent pool while preserving the value of
32633 &%store_pool%&.
32634 .ecindex IIDlosca
32635
32636
32637
32638
32639 . ////////////////////////////////////////////////////////////////////////////
32640 . ////////////////////////////////////////////////////////////////////////////
32641
32642 .chapter "System-wide message filtering" "CHAPsystemfilter"
32643 .scindex IIDsysfil1 "filter" "system filter"
32644 .scindex IIDsysfil2 "filtering all mail"
32645 .scindex IIDsysfil3 "system filter"
32646 The previous chapters (on ACLs and the local scan function) describe checks
32647 that can be applied to messages before they are accepted by a host. There is
32648 also a mechanism for checking messages once they have been received, but before
32649 they are delivered. This is called the &'system filter'&.
32650
32651 The system filter operates in a similar manner to users' filter files, but it
32652 is run just once per message (however many recipients the message has).
32653 It should not normally be used as a substitute for routing, because &%deliver%&
32654 commands in a system router provide new envelope recipient addresses.
32655 The system filter must be an Exim filter. It cannot be a Sieve filter.
32656
32657 The system filter is run at the start of a delivery attempt, before any routing
32658 is done. If a message fails to be completely delivered at the first attempt,
32659 the system filter is run again at the start of every retry.
32660 If you want your filter to do something only once per message, you can make use
32661 of the &%first_delivery%& condition in an &%if%& command in the filter to
32662 prevent it happening on retries.
32663
32664 .vindex "&$domain$&"
32665 .vindex "&$local_part$&"
32666 &*Warning*&: Because the system filter runs just once, variables that are
32667 specific to individual recipient addresses, such as &$local_part$& and
32668 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32669 you want to run a centrally-specified filter for each recipient address
32670 independently, you can do so by setting up a suitable &(redirect)& router, as
32671 described in section &<<SECTperaddfil>>& below.
32672
32673
32674 .section "Specifying a system filter" "SECID212"
32675 .cindex "uid (user id)" "system filter"
32676 .cindex "gid (group id)" "system filter"
32677 The name of the file that contains the system filter must be specified by
32678 setting &%system_filter%&. If you want the filter to run under a uid and gid
32679 other than root, you must also set &%system_filter_user%& and
32680 &%system_filter_group%& as appropriate. For example:
32681 .code
32682 system_filter = /etc/mail/exim.filter
32683 system_filter_user = exim
32684 .endd
32685 If a system filter generates any deliveries directly to files or pipes (via the
32686 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32687 specified by setting &%system_filter_file_transport%& and
32688 &%system_filter_pipe_transport%&, respectively. Similarly,
32689 &%system_filter_reply_transport%& must be set to handle any messages generated
32690 by the &%reply%& command.
32691
32692
32693 .section "Testing a system filter" "SECID213"
32694 You can run simple tests of a system filter in the same way as for a user
32695 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32696 are permitted only in system filters are recognized.
32697
32698 If you want to test the combined effect of a system filter and a user filter,
32699 you can use both &%-bF%& and &%-bf%& on the same command line.
32700
32701
32702
32703 .section "Contents of a system filter" "SECID214"
32704 The language used to specify system filters is the same as for users' filter
32705 files. It is described in the separate end-user document &'Exim's interface to
32706 mail filtering'&. However, there are some additional features that are
32707 available only in system filters; these are described in subsequent sections.
32708 If they are encountered in a user's filter file or when testing with &%-bf%&,
32709 they cause errors.
32710
32711 .cindex "frozen messages" "manual thaw; testing in filter"
32712 There are two special conditions which, though available in users' filter
32713 files, are designed for use in system filters. The condition &%first_delivery%&
32714 is true only for the first attempt at delivering a message, and
32715 &%manually_thawed%& is true only if the message has been frozen, and
32716 subsequently thawed by an admin user. An explicit forced delivery counts as a
32717 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32718
32719 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32720 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32721 succeed, it will not be tried again.
32722 If you want Exim to retry an unseen delivery until it succeeds, you should
32723 arrange to set it up every time the filter runs.
32724
32725 When a system filter finishes running, the values of the variables &$n0$& &--
32726 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32727 users' filter files. Thus a system filter can, for example, set up &"scores"&
32728 to which users' filter files can refer.
32729
32730
32731
32732 .section "Additional variable for system filters" "SECID215"
32733 .vindex "&$recipients$&"
32734 The expansion variable &$recipients$&, containing a list of all the recipients
32735 of the message (separated by commas and white space), is available in system
32736 filters. It is not available in users' filters for privacy reasons.
32737
32738
32739
32740 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32741 .cindex "freezing messages"
32742 .cindex "message" "freezing"
32743 .cindex "message" "forced failure"
32744 .cindex "&%fail%&" "in system filter"
32745 .cindex "&%freeze%& in system filter"
32746 .cindex "&%defer%& in system filter"
32747 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32748 always available in system filters, but are not normally enabled in users'
32749 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32750 for the &(redirect)& router.) These commands can optionally be followed by the
32751 word &%text%& and a string containing an error message, for example:
32752 .code
32753 fail text "this message looks like spam to me"
32754 .endd
32755 The keyword &%text%& is optional if the next character is a double quote.
32756
32757 The &%defer%& command defers delivery of the original recipients of the
32758 message. The &%fail%& command causes all the original recipients to be failed,
32759 and a bounce message to be created. The &%freeze%& command suspends all
32760 delivery attempts for the original recipients. In all cases, any new deliveries
32761 that are specified by the filter are attempted as normal after the filter has
32762 run.
32763
32764 The &%freeze%& command is ignored if the message has been manually unfrozen and
32765 not manually frozen since. This means that automatic freezing by a system
32766 filter can be used as a way of checking out suspicious messages. If a message
32767 is found to be all right, manually unfreezing it allows it to be delivered.
32768
32769 .cindex "log" "&%fail%& command log line"
32770 .cindex "&%fail%&" "log line; reducing"
32771 The text given with a fail command is used as part of the bounce message as
32772 well as being written to the log. If the message is quite long, this can fill
32773 up a lot of log space when such failures are common. To reduce the size of the
32774 log message, Exim interprets the text in a special way if it starts with the
32775 two characters &`<<`& and contains &`>>`& later. The text between these two
32776 strings is written to the log, and the rest of the text is used in the bounce
32777 message. For example:
32778 .code
32779 fail "<<filter test 1>>Your message is rejected \
32780      because it contains attachments that we are \
32781      not prepared to receive."
32782 .endd
32783
32784 .cindex "loop" "caused by &%fail%&"
32785 Take great care with the &%fail%& command when basing the decision to fail on
32786 the contents of the message, because the bounce message will of course include
32787 the contents of the original message and will therefore trigger the &%fail%&
32788 command again (causing a mail loop) unless steps are taken to prevent this.
32789 Testing the &%error_message%& condition is one way to prevent this. You could
32790 use, for example
32791 .code
32792 if $message_body contains "this is spam" and not error_message
32793 then fail text "spam is not wanted here" endif
32794 .endd
32795 though of course that might let through unwanted bounce messages. The
32796 alternative is clever checking of the body and/or headers to detect bounces
32797 generated by the filter.
32798
32799 The interpretation of a system filter file ceases after a
32800 &%defer%&,
32801 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32802 set up earlier in the filter file are honoured, so you can use a sequence such
32803 as
32804 .code
32805 mail ...
32806 freeze
32807 .endd
32808 to send a specified message when the system filter is freezing (or deferring or
32809 failing) a message. The normal deliveries for the message do not, of course,
32810 take place.
32811
32812
32813
32814 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32815 .cindex "header lines" "adding; in system filter"
32816 .cindex "header lines" "removing; in system filter"
32817 .cindex "filter" "header lines; adding/removing"
32818 Two filter commands that are available only in system filters are:
32819 .code
32820 headers add <string>
32821 headers remove <string>
32822 .endd
32823 The argument for the &%headers add%& is a string that is expanded and then
32824 added to the end of the message's headers. It is the responsibility of the
32825 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32826 space is ignored, and if the string is otherwise empty, or if the expansion is
32827 forced to fail, the command has no effect.
32828
32829 You can use &"\n"& within the string, followed by white space, to specify
32830 continued header lines. More than one header may be added in one command by
32831 including &"\n"& within the string without any following white space. For
32832 example:
32833 .code
32834 headers add "X-header-1: ....\n  \
32835              continuation of X-header-1 ...\n\
32836              X-header-2: ...."
32837 .endd
32838 Note that the header line continuation white space after the first newline must
32839 be placed before the backslash that continues the input string, because white
32840 space after input continuations is ignored.
32841
32842 The argument for &%headers remove%& is a colon-separated list of header names.
32843 This command applies only to those headers that are stored with the message;
32844 those that are added at delivery time (such as &'Envelope-To:'& and
32845 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32846 header with the same name, they are all removed.
32847
32848 The &%headers%& command in a system filter makes an immediate change to the set
32849 of header lines that was received with the message (with possible additions
32850 from ACL processing). Subsequent commands in the system filter operate on the
32851 modified set, which also forms the basis for subsequent message delivery.
32852 Unless further modified during routing or transporting, this set of headers is
32853 used for all recipients of the message.
32854
32855 During routing and transporting, the variables that refer to the contents of
32856 header lines refer only to those lines that are in this set. Thus, header lines
32857 that are added by a system filter are visible to users' filter files and to all
32858 routers and transports. This contrasts with the manipulation of header lines by
32859 routers and transports, which is not immediate, but which instead is saved up
32860 until the message is actually being written (see section
32861 &<<SECTheadersaddrem>>&).
32862
32863 If the message is not delivered at the first attempt, header lines that were
32864 added by the system filter are stored with the message, and so are still
32865 present at the next delivery attempt. Header lines that were removed are still
32866 present, but marked &"deleted"& so that they are not transported with the
32867 message. For this reason, it is usual to make the &%headers%& command
32868 conditional on &%first_delivery%& so that the set of header lines is not
32869 modified more than once.
32870
32871 Because header modification in a system filter acts immediately, you have to
32872 use an indirect approach if you want to modify the contents of a header line.
32873 For example:
32874 .code
32875 headers add "Old-Subject: $h_subject:"
32876 headers remove "Subject"
32877 headers add "Subject: new subject (was: $h_old-subject:)"
32878 headers remove "Old-Subject"
32879 .endd
32880
32881
32882
32883 .section "Setting an errors address in a system filter" "SECID217"
32884 .cindex "envelope sender"
32885 In a system filter, if a &%deliver%& command is followed by
32886 .code
32887 errors_to <some address>
32888 .endd
32889 in order to change the envelope sender (and hence the error reporting) for that
32890 delivery, any address may be specified. (In a user filter, only the current
32891 user's address can be set.) For example, if some mail is being monitored, you
32892 might use
32893 .code
32894 unseen deliver monitor@spying.example errors_to root@local.example
32895 .endd
32896 to take a copy which would not be sent back to the normal error reporting
32897 address if its delivery failed.
32898
32899
32900
32901 .section "Per-address filtering" "SECTperaddfil"
32902 .vindex "&$domain$&"
32903 .vindex "&$local_part$&"
32904 In contrast to the system filter, which is run just once per message for each
32905 delivery attempt, it is also possible to set up a system-wide filtering
32906 operation that runs once for each recipient address. In this case, variables
32907 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32908 filter file could be made dependent on them. This is an example of a router
32909 which implements such a filter:
32910 .code
32911 central_filter:
32912   check_local_user
32913   driver = redirect
32914   domains = +local_domains
32915   file = /central/filters/$local_part
32916   no_verify
32917   allow_filter
32918   allow_freeze
32919 .endd
32920 The filter is run in a separate process under its own uid. Therefore, either
32921 &%check_local_user%& must be set (as above), in which case the filter is run as
32922 the local user, or the &%user%& option must be used to specify which user to
32923 use. If both are set, &%user%& overrides.
32924
32925 Care should be taken to ensure that none of the commands in the filter file
32926 specify a significant delivery if the message is to go on to be delivered to
32927 its intended recipient. The router will not then claim to have dealt with the
32928 address, so it will be passed on to subsequent routers to be delivered in the
32929 normal way.
32930 .ecindex IIDsysfil1
32931 .ecindex IIDsysfil2
32932 .ecindex IIDsysfil3
32933
32934
32935
32936
32937
32938
32939 . ////////////////////////////////////////////////////////////////////////////
32940 . ////////////////////////////////////////////////////////////////////////////
32941
32942 .chapter "Message processing" "CHAPmsgproc"
32943 .scindex IIDmesproc "message" "general processing"
32944 Exim performs various transformations on the sender and recipient addresses of
32945 all messages that it handles, and also on the messages' header lines. Some of
32946 these are optional and configurable, while others always take place. All of
32947 this processing, except rewriting as a result of routing, and the addition or
32948 removal of header lines while delivering, happens when a message is received,
32949 before it is placed on Exim's queue.
32950
32951 Some of the automatic processing takes place by default only for
32952 &"locally-originated"& messages. This adjective is used to describe messages
32953 that are not received over TCP/IP, but instead are passed to an Exim process on
32954 its standard input. This includes the interactive &"local SMTP"& case that is
32955 set up by the &%-bs%& command line option.
32956
32957 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32958 or ::1) are not considered to be locally-originated. Exim does not treat the
32959 loopback interface specially in any way.
32960
32961 If you want the loopback interface to be treated specially, you must ensure
32962 that there are appropriate entries in your ACLs.
32963
32964
32965
32966
32967 .section "Submission mode for non-local messages" "SECTsubmodnon"
32968 .cindex "message" "submission"
32969 .cindex "submission mode"
32970 Processing that happens automatically for locally-originated messages (unless
32971 &%suppress_local_fixups%& is set) can also be requested for messages that are
32972 received over TCP/IP. The term &"submission mode"& is used to describe this
32973 state. Submission mode is set by the modifier
32974 .code
32975 control = submission
32976 .endd
32977 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32978 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32979 a local submission, and is normally used when the source of the message is
32980 known to be an MUA running on a client host (as opposed to an MTA). For
32981 example, to set submission mode for messages originating on the IPv4 loopback
32982 interface, you could include the following in the MAIL ACL:
32983 .code
32984 warn  hosts = 127.0.0.1
32985       control = submission
32986 .endd
32987 .cindex "&%sender_retain%& submission option"
32988 There are some options that can be used when setting submission mode. A slash
32989 is used to separate options. For example:
32990 .code
32991 control = submission/sender_retain
32992 .endd
32993 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32994 true and &%local_from_check%& false for the current incoming message. The first
32995 of these allows an existing &'Sender:'& header in the message to remain, and
32996 the second suppresses the check to ensure that &'From:'& matches the
32997 authenticated sender. With this setting, Exim still fixes up messages by adding
32998 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32999 attempt to check sender authenticity in header lines.
33000
33001 When &%sender_retain%& is not set, a submission mode setting may specify a
33002 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33003 example:
33004 .code
33005 control = submission/domain=some.domain
33006 .endd
33007 The domain may be empty. How this value is used is described in sections
33008 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33009 that allows you to specify the user's full name for inclusion in a created
33010 &'Sender:'& or &'From:'& header line. For example:
33011 .code
33012 accept authenticated = *
33013        control = submission/domain=wonderland.example/\
33014                             name=${lookup {$authenticated_id} \
33015                                    lsearch {/etc/exim/namelist}}
33016 .endd
33017 Because the name may contain any characters, including slashes, the &%name%&
33018 option must be given last. The remainder of the string is used as the name. For
33019 the example above, if &_/etc/exim/namelist_& contains:
33020 .code
33021 bigegg:  Humpty Dumpty
33022 .endd
33023 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33024 line would be:
33025 .code
33026 Sender: Humpty Dumpty <bigegg@wonderland.example>
33027 .endd
33028 .cindex "return path" "in submission mode"
33029 By default, submission mode forces the return path to the same address as is
33030 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33031 specified, the return path is also left unchanged.
33032
33033 &*Note*&: The changes caused by submission mode take effect after the predata
33034 ACL. This means that any sender checks performed before the fix-ups use the
33035 untrusted sender address specified by the user, not the trusted sender address
33036 specified by submission mode. Although this might be slightly unexpected, it
33037 does mean that you can configure ACL checks to spot that a user is trying to
33038 spoof another's address.
33039
33040 .section "Line endings" "SECTlineendings"
33041 .cindex "line endings"
33042 .cindex "carriage return"
33043 .cindex "linefeed"
33044 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33045 linefeed) is the line ending for messages transmitted over the Internet using
33046 SMTP over TCP/IP. However, within individual operating systems, different
33047 conventions are used. For example, Unix-like systems use just LF, but others
33048 use CRLF or just CR.
33049
33050 Exim was designed for Unix-like systems, and internally, it stores messages
33051 using the system's convention of a single LF as a line terminator. When
33052 receiving a message, all line endings are translated to this standard format.
33053 Originally, it was thought that programs that passed messages directly to an
33054 MTA within an operating system would use that system's convention. Experience
33055 has shown that this is not the case; for example, there are Unix applications
33056 that use CRLF in this circumstance. For this reason, and for compatibility with
33057 other MTAs, the way Exim handles line endings for all messages is now as
33058 follows:
33059
33060 .ilist
33061 LF not preceded by CR is treated as a line ending.
33062 .next
33063 CR is treated as a line ending; if it is immediately followed by LF, the LF
33064 is ignored.
33065 .next
33066 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33067 nor a local message in the state where a line containing only a dot is a
33068 terminator.
33069 .next
33070 If a bare CR is encountered within a header line, an extra space is added after
33071 the line terminator so as not to end the header line. The reasoning behind this
33072 is that bare CRs in header lines are most likely either to be mistakes, or
33073 people trying to play silly games.
33074 .next
33075 If the first header line received in a message ends with CRLF, a subsequent
33076 bare LF in a header line is treated in the same way as a bare CR in a header
33077 line.
33078 .endlist
33079
33080
33081
33082
33083
33084 .section "Unqualified addresses" "SECID218"
33085 .cindex "unqualified addresses"
33086 .cindex "address" "qualification"
33087 By default, Exim expects every envelope address it receives from an external
33088 host to be fully qualified. Unqualified addresses cause negative responses to
33089 SMTP commands. However, because SMTP is used as a means of transporting
33090 messages from MUAs running on personal workstations, there is sometimes a
33091 requirement to accept unqualified addresses from specific hosts or IP networks.
33092
33093 Exim has two options that separately control which hosts may send unqualified
33094 sender or recipient addresses in SMTP commands, namely
33095 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33096 cases, if an unqualified address is accepted, it is qualified by adding the
33097 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33098
33099 .oindex "&%qualify_domain%&"
33100 .oindex "&%qualify_recipient%&"
33101 Unqualified addresses in header lines are automatically qualified for messages
33102 that are locally originated, unless the &%-bnq%& option is given on the command
33103 line. For messages received over SMTP, unqualified addresses in header lines
33104 are qualified only if unqualified addresses are permitted in SMTP commands. In
33105 other words, such qualification is also controlled by
33106 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33107
33108
33109
33110
33111 .section "The UUCP From line" "SECID219"
33112 .cindex "&""From""& line"
33113 .cindex "UUCP" "&""From""& line"
33114 .cindex "sender" "address"
33115 .oindex "&%uucp_from_pattern%&"
33116 .oindex "&%uucp_from_sender%&"
33117 .cindex "envelope sender"
33118 .cindex "Sendmail compatibility" "&""From""& line"
33119 Messages that have come from UUCP (and some other applications) often begin
33120 with a line containing the envelope sender and a timestamp, following the word
33121 &"From"&. Examples of two common formats are:
33122 .code
33123 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33124 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33125 .endd
33126 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33127 Exim recognizes such lines at the start of messages that are submitted to it
33128 via the command line (that is, on the standard input). It does not recognize
33129 such lines in incoming SMTP messages, unless the sending host matches
33130 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33131 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33132 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33133 default value matches the two common cases shown above and puts the address
33134 that follows &"From"& into &$1$&.
33135
33136 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33137 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33138 a trusted user, the message's sender address is constructed by expanding the
33139 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33140 then parsed as an RFC 2822 address. If there is no domain, the local part is
33141 qualified with &%qualify_domain%& unless it is the empty string. However, if
33142 the command line &%-f%& option is used, it overrides the &"From"& line.
33143
33144 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33145 sender address is not changed. This is also the case for incoming SMTP messages
33146 that are permitted to contain &"From"& lines.
33147
33148 Only one &"From"& line is recognized. If there is more than one, the second is
33149 treated as a data line that starts the body of the message, as it is not valid
33150 as a header line. This also happens if a &"From"& line is present in an
33151 incoming SMTP message from a source that is not permitted to send them.
33152
33153
33154
33155 .section "Resent- header lines" "SECID220"
33156 .cindex "&%Resent-%& header lines"
33157 RFC 2822 makes provision for sets of header lines starting with the string
33158 &`Resent-`& to be added to a message when it is resent by the original
33159 recipient to somebody else. These headers are &'Resent-Date:'&,
33160 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33161 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33162
33163 .blockquote
33164 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33165 processing of replies or other such automatic actions on messages.'&
33166 .endblockquote
33167
33168 This leaves things a bit vague as far as other processing actions such as
33169 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33170 follows:
33171
33172 .ilist
33173 A &'Resent-From:'& line that just contains the login id of the submitting user
33174 is automatically rewritten in the same way as &'From:'& (see below).
33175 .next
33176 If there's a rewriting rule for a particular header line, it is also applied to
33177 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33178 &'From:'& also rewrites &'Resent-From:'&.
33179 .next
33180 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33181 also removed.
33182 .next
33183 For a locally-submitted message,
33184 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33185 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33186 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33187 included in log lines in this case.
33188 .next
33189 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33190 &%Resent-%& header lines are present.
33191 .endlist
33192
33193
33194
33195
33196 .section "The Auto-Submitted: header line" "SECID221"
33197 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33198 includes the header line:
33199 .code
33200 Auto-Submitted: auto-replied
33201 .endd
33202
33203 .section "The Bcc: header line" "SECID222"
33204 .cindex "&'Bcc:'& header line"
33205 If Exim is called with the &%-t%& option, to take recipient addresses from a
33206 message's header, it removes any &'Bcc:'& header line that may exist (after
33207 extracting its addresses). If &%-t%& is not present on the command line, any
33208 existing &'Bcc:'& is not removed.
33209
33210
33211 .section "The Date: header line" "SECID223"
33212 .cindex "&'Date:'& header line"
33213 If a locally-generated or submission-mode message has no &'Date:'& header line,
33214 Exim adds one, using the current date and time, unless the
33215 &%suppress_local_fixups%& control has been specified.
33216
33217 .section "The Delivery-date: header line" "SECID224"
33218 .cindex "&'Delivery-date:'& header line"
33219 .oindex "&%delivery_date_remove%&"
33220 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33221 set. Exim can be configured to add them to the final delivery of messages. (See
33222 the generic &%delivery_date_add%& transport option.) They should not be present
33223 in messages in transit. If the &%delivery_date_remove%& configuration option is
33224 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33225 messages.
33226
33227
33228 .section "The Envelope-to: header line" "SECID225"
33229 .cindex "&'Envelope-to:'& header line"
33230 .oindex "&%envelope_to_remove%&"
33231 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33232 Exim can be configured to add them to the final delivery of messages. (See the
33233 generic &%envelope_to_add%& transport option.) They should not be present in
33234 messages in transit. If the &%envelope_to_remove%& configuration option is set
33235 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33236 messages.
33237
33238
33239 .section "The From: header line" "SECTthefrohea"
33240 .cindex "&'From:'& header line"
33241 .cindex "Sendmail compatibility" "&""From""& line"
33242 .cindex "message" "submission"
33243 .cindex "submission mode"
33244 If a submission-mode message does not contain a &'From:'& header line, Exim
33245 adds one if either of the following conditions is true:
33246
33247 .ilist
33248 The envelope sender address is not empty (that is, this is not a bounce
33249 message). The added header line copies the envelope sender address.
33250 .next
33251 .vindex "&$authenticated_id$&"
33252 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33253 .olist
33254 .vindex "&$qualify_domain$&"
33255 If no domain is specified by the submission control, the local part is
33256 &$authenticated_id$& and the domain is &$qualify_domain$&.
33257 .next
33258 If a non-empty domain is specified by the submission control, the local
33259 part is &$authenticated_id$&, and the domain is the specified domain.
33260 .next
33261 If an empty domain is specified by the submission control,
33262 &$authenticated_id$& is assumed to be the complete address.
33263 .endlist
33264 .endlist
33265
33266 A non-empty envelope sender takes precedence.
33267
33268 If a locally-generated incoming message does not contain a &'From:'& header
33269 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33270 containing the sender's address. The calling user's login name and full name
33271 are used to construct the address, as described in section &<<SECTconstr>>&.
33272 They are obtained from the password data by calling &[getpwuid()]& (but see the
33273 &%unknown_login%& configuration option). The address is qualified with
33274 &%qualify_domain%&.
33275
33276 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33277 &'From:'& header line containing just the unqualified login name of the calling
33278 user, this is replaced by an address containing the user's login name and full
33279 name as described in section &<<SECTconstr>>&.
33280
33281
33282 .section "The Message-ID: header line" "SECID226"
33283 .cindex "&'Message-ID:'& header line"
33284 .cindex "message" "submission"
33285 .oindex "&%message_id_header_text%&"
33286 If a locally-generated or submission-mode incoming message does not contain a
33287 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33288 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33289 to the message. If there are any &'Resent-:'& headers in the message, it
33290 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33291 message id, preceded by the letter E to ensure it starts with a letter, and
33292 followed by @ and the primary host name. Additional information can be included
33293 in this header line by setting the &%message_id_header_text%& and/or
33294 &%message_id_header_domain%& options.
33295
33296
33297 .section "The Received: header line" "SECID227"
33298 .cindex "&'Received:'& header line"
33299 A &'Received:'& header line is added at the start of every message. The
33300 contents are defined by the &%received_header_text%& configuration option, and
33301 Exim automatically adds a semicolon and a timestamp to the configured string.
33302
33303 The &'Received:'& header is generated as soon as the message's header lines
33304 have been received. At this stage, the timestamp in the &'Received:'& header
33305 line is the time that the message started to be received. This is the value
33306 that is seen by the DATA ACL and by the &[local_scan()]& function.
33307
33308 Once a message is accepted, the timestamp in the &'Received:'& header line is
33309 changed to the time of acceptance, which is (apart from a small delay while the
33310 -H spool file is written) the earliest time at which delivery could start.
33311
33312
33313 .section "The References: header line" "SECID228"
33314 .cindex "&'References:'& header line"
33315 Messages created by the &(autoreply)& transport include a &'References:'&
33316 header line. This is constructed according to the rules that are described in
33317 section 3.64 of RFC 2822 (which states that replies should contain such a
33318 header line), and section 3.14 of RFC 3834 (which states that automatic
33319 responses are not different in this respect). However, because some mail
33320 processing software does not cope well with very long header lines, no more
33321 than 12 message IDs are copied from the &'References:'& header line in the
33322 incoming message. If there are more than 12, the first one and then the final
33323 11 are copied, before adding the message ID of the incoming message.
33324
33325
33326
33327 .section "The Return-path: header line" "SECID229"
33328 .cindex "&'Return-path:'& header line"
33329 .oindex "&%return_path_remove%&"
33330 &'Return-path:'& header lines are defined as something an MTA may insert when
33331 it does the final delivery of messages. (See the generic &%return_path_add%&
33332 transport option.) Therefore, they should not be present in messages in
33333 transit. If the &%return_path_remove%& configuration option is set (the
33334 default), Exim removes &'Return-path:'& header lines from incoming messages.
33335
33336
33337
33338 .section "The Sender: header line" "SECTthesenhea"
33339 .cindex "&'Sender:'& header line"
33340 .cindex "message" "submission"
33341 For a locally-originated message from an untrusted user, Exim may remove an
33342 existing &'Sender:'& header line, and it may add a new one. You can modify
33343 these actions by setting the &%local_sender_retain%& option true, the
33344 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33345 control setting.
33346
33347 When a local message is received from an untrusted user and
33348 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33349 control has not been set, a check is made to see if the address given in the
33350 &'From:'& header line is the correct (local) sender of the message. The address
33351 that is expected has the login name as the local part and the value of
33352 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33353 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33354 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33355 line is added to the message.
33356
33357 If you set &%local_from_check%& false, this checking does not occur. However,
33358 the removal of an existing &'Sender:'& line still happens, unless you also set
33359 &%local_sender_retain%& to be true. It is not possible to set both of these
33360 options true at the same time.
33361
33362 .cindex "submission mode"
33363 By default, no processing of &'Sender:'& header lines is done for messages
33364 received over TCP/IP or for messages submitted by trusted users. However, when
33365 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33366 not specified on the submission control, the following processing takes place:
33367
33368 .vindex "&$authenticated_id$&"
33369 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33370 authenticated, and &$authenticated_id$& is not empty, a sender address is
33371 created as follows:
33372
33373 .ilist
33374 .vindex "&$qualify_domain$&"
33375 If no domain is specified by the submission control, the local part is
33376 &$authenticated_id$& and the domain is &$qualify_domain$&.
33377 .next
33378 If a non-empty domain is specified by the submission control, the local part
33379 is &$authenticated_id$&, and the domain is the specified domain.
33380 .next
33381 If an empty domain is specified by the submission control,
33382 &$authenticated_id$& is assumed to be the complete address.
33383 .endlist
33384
33385 This address is compared with the address in the &'From:'& header line. If they
33386 are different, a &'Sender:'& header line containing the created address is
33387 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33388 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33389
33390 .cindex "return path" "created from &'Sender:'&"
33391 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33392 the message (the envelope sender address) is changed to be the same address,
33393 except in the case of submission mode when &%sender_retain%& is specified.
33394
33395
33396
33397 .section "Adding and removing header lines in routers and transports" &&&
33398          "SECTheadersaddrem"
33399 .cindex "header lines" "adding; in router or transport"
33400 .cindex "header lines" "removing; in router or transport"
33401 When a message is delivered, the addition and removal of header lines can be
33402 specified in a system filter, or on any of the routers and transports that
33403 process the message. Section &<<SECTaddremheasys>>& contains details about
33404 modifying headers in a system filter. Header lines can also be added in an ACL
33405 as a message is received (see section &<<SECTaddheadacl>>&).
33406
33407 In contrast to what happens in a system filter, header modifications that are
33408 specified on routers and transports apply only to the particular recipient
33409 addresses that are being processed by those routers and transports. These
33410 changes do not actually take place until a copy of the message is being
33411 transported. Therefore, they do not affect the basic set of header lines, and
33412 they do not affect the values of the variables that refer to header lines.
33413
33414 &*Note*&: In particular, this means that any expansions in the configuration of
33415 the transport cannot refer to the modified header lines, because such
33416 expansions all occur before the message is actually transported.
33417
33418 For both routers and transports, the argument of a &%headers_add%&
33419 option must be in the form of one or more RFC 2822 header lines, separated by
33420 newlines (coded as &"\n"&). For example:
33421 .code
33422 headers_add = X-added-header: added by $primary_hostname\n\
33423               X-added-second: another added header line
33424 .endd
33425 Exim does not check the syntax of these added header lines.
33426
33427 Multiple &%headers_add%& options for a single router or transport can be
33428 specified; the values will append to a single list of header lines.
33429 Each header-line is separately expanded.
33430
33431 The argument of a &%headers_remove%& option must consist of a colon-separated
33432 list of header names. This is confusing, because header names themselves are
33433 often terminated by colons. In this case, the colons are the list separators,
33434 not part of the names. For example:
33435 .code
33436 headers_remove = return-receipt-to:acknowledge-to
33437 .endd
33438
33439 Multiple &%headers_remove%& options for a single router or transport can be
33440 specified; the arguments will append to a single header-names list.
33441 Each item is separately expanded.
33442 Note that colons in complex expansions which are used to
33443 form all or part of a &%headers_remove%& list
33444 will act as list separators.
33445
33446 When &%headers_add%& or &%headers_remove%& is specified on a router,
33447 items are expanded at routing time,
33448 and then associated with all addresses that are
33449 accepted by that router, and also with any new addresses that it generates. If
33450 an address passes through several routers as a result of aliasing or
33451 forwarding, the changes are cumulative.
33452
33453 .oindex "&%unseen%&"
33454 However, this does not apply to multiple routers that result from the use of
33455 the &%unseen%& option. Any header modifications that were specified by the
33456 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33457
33458 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33459 settings cannot be delivered together in a batch, so a transport is always
33460 dealing with a set of addresses that have the same header-processing
33461 requirements.
33462
33463 The transport starts by writing the original set of header lines that arrived
33464 with the message, possibly modified by the system filter. As it writes out
33465 these lines, it consults the list of header names that were attached to the
33466 recipient address(es) by &%headers_remove%& options in routers, and it also
33467 consults the transport's own &%headers_remove%& option. Header lines whose
33468 names are on either of these lists are not written out. If there are multiple
33469 instances of any listed header, they are all skipped.
33470
33471 After the remaining original header lines have been written, new header
33472 lines that were specified by routers' &%headers_add%& options are written, in
33473 the order in which they were attached to the address. These are followed by any
33474 header lines specified by the transport's &%headers_add%& option.
33475
33476 This way of handling header line modifications in routers and transports has
33477 the following consequences:
33478
33479 .ilist
33480 The original set of header lines, possibly modified by the system filter,
33481 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33482 to it, at all times.
33483 .next
33484 Header lines that are added by a router's
33485 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33486 expansion syntax in subsequent routers or the transport.
33487 .next
33488 Conversely, header lines that are specified for removal by &%headers_remove%&
33489 in a router remain visible to subsequent routers and the transport.
33490 .next
33491 Headers added to an address by &%headers_add%& in a router cannot be removed by
33492 a later router or by a transport.
33493 .next
33494 An added header can refer to the contents of an original header that is to be
33495 removed, even it has the same name as the added header. For example:
33496 .code
33497 headers_remove = subject
33498 headers_add = Subject: new subject (was: $h_subject:)
33499 .endd
33500 .endlist
33501
33502 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33503 for a &(redirect)& router that has the &%one_time%& option set.
33504
33505
33506
33507
33508
33509 .section "Constructed addresses" "SECTconstr"
33510 .cindex "address" "constructed"
33511 .cindex "constructed address"
33512 When Exim constructs a sender address for a locally-generated message, it uses
33513 the form
33514 .display
33515 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33516 .endd
33517 For example:
33518 .code
33519 Zaphod Beeblebrox <zaphod@end.univ.example>
33520 .endd
33521 The user name is obtained from the &%-F%& command line option if set, or
33522 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33523 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33524 ampersand character, this is replaced by the login name with the first letter
33525 upper cased, as is conventional in a number of operating systems. See the
33526 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33527 The &%unknown_username%& option can be used to specify user names in cases when
33528 there is no password file entry.
33529
33530 .cindex "RFC 2047"
33531 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33532 parts of it if necessary. In addition, if it contains any non-printing
33533 characters, it is encoded as described in RFC 2047, which defines a way of
33534 including non-ASCII characters in header lines. The value of the
33535 &%headers_charset%& option specifies the name of the encoding that is used (the
33536 characters are assumed to be in this encoding). The setting of
33537 &%print_topbitchars%& controls whether characters with the top bit set (that
33538 is, with codes greater than 127) count as printing characters or not.
33539
33540
33541
33542 .section "Case of local parts" "SECID230"
33543 .cindex "case of local parts"
33544 .cindex "local part" "case of"
33545 RFC 2822 states that the case of letters in the local parts of addresses cannot
33546 be assumed to be non-significant. Exim preserves the case of local parts of
33547 addresses, but by default it uses a lower-cased form when it is routing,
33548 because on most Unix systems, usernames are in lower case and case-insensitive
33549 routing is required. However, any particular router can be made to use the
33550 original case for local parts by setting the &%caseful_local_part%& generic
33551 router option.
33552
33553 .cindex "mixed-case login names"
33554 If you must have mixed-case user names on your system, the best way to proceed,
33555 assuming you want case-independent handling of incoming email, is to set up
33556 your first router to convert incoming local parts in your domains to the
33557 correct case by means of a file lookup. For example:
33558 .code
33559 correct_case:
33560   driver = redirect
33561   domains = +local_domains
33562   data = ${lookup{$local_part}cdb\
33563               {/etc/usercased.cdb}{$value}fail}\
33564               @$domain
33565 .endd
33566 For this router, the local part is forced to lower case by the default action
33567 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33568 up a new local part in the correct case. If you then set &%caseful_local_part%&
33569 on any subsequent routers which process your domains, they will operate on
33570 local parts with the correct case in a case-sensitive manner.
33571
33572
33573
33574 .section "Dots in local parts" "SECID231"
33575 .cindex "dot" "in local part"
33576 .cindex "local part" "dots in"
33577 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33578 part may not begin or end with a dot, nor have two consecutive dots in the
33579 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33580 empty components for compatibility.
33581
33582
33583
33584 .section "Rewriting addresses" "SECID232"
33585 .cindex "rewriting" "addresses"
33586 Rewriting of sender and recipient addresses, and addresses in headers, can
33587 happen automatically, or as the result of configuration options, as described
33588 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33589 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33590
33591 Automatic rewriting includes qualification, as mentioned above. The other case
33592 in which it can happen is when an incomplete non-local domain is given. The
33593 routing process may cause this to be expanded into the full domain name. For
33594 example, a header such as
33595 .code
33596 To: hare@teaparty
33597 .endd
33598 might get rewritten as
33599 .code
33600 To: hare@teaparty.wonderland.fict.example
33601 .endd
33602 Rewriting as a result of routing is the one kind of message processing that
33603 does not happen at input time, as it cannot be done until the address has
33604 been routed.
33605
33606 Strictly, one should not do &'any'& deliveries of a message until all its
33607 addresses have been routed, in case any of the headers get changed as a
33608 result of routing. However, doing this in practice would hold up many
33609 deliveries for unreasonable amounts of time, just because one address could not
33610 immediately be routed. Exim therefore does not delay other deliveries when
33611 routing of one or more addresses is deferred.
33612 .ecindex IIDmesproc
33613
33614
33615
33616 . ////////////////////////////////////////////////////////////////////////////
33617 . ////////////////////////////////////////////////////////////////////////////
33618
33619 .chapter "SMTP processing" "CHAPSMTP"
33620 .scindex IIDsmtpproc1 "SMTP" "processing details"
33621 .scindex IIDsmtpproc2 "LMTP" "processing details"
33622 Exim supports a number of different ways of using the SMTP protocol, and its
33623 LMTP variant, which is an interactive protocol for transferring messages into a
33624 closed mail store application. This chapter contains details of how SMTP is
33625 processed. For incoming mail, the following are available:
33626
33627 .ilist
33628 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33629 .next
33630 SMTP over the standard input and output (the &%-bs%& option);
33631 .next
33632 Batched SMTP on the standard input (the &%-bS%& option).
33633 .endlist
33634
33635 For mail delivery, the following are available:
33636
33637 .ilist
33638 SMTP over TCP/IP (the &(smtp)& transport);
33639 .next
33640 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33641 &"lmtp"&);
33642 .next
33643 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33644 transport);
33645 .next
33646 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33647 the &%use_bsmtp%& option set).
33648 .endlist
33649
33650 &'Batched SMTP'& is the name for a process in which batches of messages are
33651 stored in or read from files (or pipes), in a format in which SMTP commands are
33652 used to contain the envelope information.
33653
33654
33655
33656 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33657 .cindex "SMTP" "outgoing over TCP/IP"
33658 .cindex "outgoing SMTP over TCP/IP"
33659 .cindex "LMTP" "over TCP/IP"
33660 .cindex "outgoing LMTP over TCP/IP"
33661 .cindex "EHLO"
33662 .cindex "HELO"
33663 .cindex "SIZE option on MAIL command"
33664 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33665 The &%protocol%& option selects which protocol is to be used, but the actual
33666 processing is the same in both cases.
33667
33668 If, in response to its EHLO command, Exim is told that the SIZE
33669 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33670 command. The value of <&'n'&> is the message size plus the value of the
33671 &%size_addition%& option (default 1024) to allow for additions to the message
33672 such as per-transport header lines, or changes made in a
33673 .cindex "transport" "filter"
33674 .cindex "filter" "transport filter"
33675 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33676 suppressed.
33677
33678 If the remote server advertises support for PIPELINING, Exim uses the
33679 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33680 required for the transaction.
33681
33682 If the remote server advertises support for the STARTTLS command, and Exim
33683 was built to support TLS encryption, it tries to start a TLS session unless the
33684 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33685 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33686 is called for verification.
33687
33688 If the remote server advertises support for the AUTH command, Exim scans
33689 the authenticators configuration for any suitable client settings, as described
33690 in chapter &<<CHAPSMTPAUTH>>&.
33691
33692 .cindex "carriage return"
33693 .cindex "linefeed"
33694 Responses from the remote host are supposed to be terminated by CR followed by
33695 LF. However, there are known to be hosts that do not send CR characters, so in
33696 order to be able to interwork with such hosts, Exim treats LF on its own as a
33697 line terminator.
33698
33699 If a message contains a number of different addresses, all those with the same
33700 characteristics (for example, the same envelope sender) that resolve to the
33701 same set of hosts, in the same order, are sent in a single SMTP transaction,
33702 even if they are for different domains, unless there are more than the setting
33703 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33704 they are split into groups containing no more than &%max_rcpt%&s addresses
33705 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33706 in parallel sessions. The order of hosts with identical MX values is not
33707 significant when checking whether addresses can be batched in this way.
33708
33709 When the &(smtp)& transport suffers a temporary failure that is not
33710 message-related, Exim updates its transport-specific database, which contains
33711 records indexed by host name that remember which messages are waiting for each
33712 particular host. It also updates the retry database with new retry times.
33713
33714 .cindex "hints database" "retry keys"
33715 Exim's retry hints are based on host name plus IP address, so if one address of
33716 a multi-homed host is broken, it will soon be skipped most of the time.
33717 See the next section for more detail about error handling.
33718
33719 .cindex "SMTP" "passed connection"
33720 .cindex "SMTP" "batching over TCP/IP"
33721 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33722 looks in the hints database for the transport to see if there are any queued
33723 messages waiting for the host to which it is connected. If it finds one, it
33724 creates a new Exim process using the &%-MC%& option (which can only be used by
33725 a process running as root or the Exim user) and passes the TCP/IP socket to it
33726 so that it can deliver another message using the same socket. The new process
33727 does only those deliveries that are routed to the connected host, and may in
33728 turn pass the socket on to a third process, and so on.
33729
33730 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33731 limit the number of messages sent down a single TCP/IP connection.
33732
33733 .cindex "asterisk" "after IP address"
33734 The second and subsequent messages delivered down an existing connection are
33735 identified in the main log by the addition of an asterisk after the closing
33736 square bracket of the IP address.
33737
33738
33739
33740
33741 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33742 .cindex "error" "in outgoing SMTP"
33743 .cindex "SMTP" "errors in outgoing"
33744 .cindex "host" "error"
33745 Three different kinds of error are recognized for outgoing SMTP: host errors,
33746 message errors, and recipient errors.
33747
33748 .vlist
33749 .vitem "&*Host errors*&"
33750 A host error is not associated with a particular message or with a
33751 particular recipient of a message. The host errors are:
33752
33753 .ilist
33754 Connection refused or timed out,
33755 .next
33756 Any error response code on connection,
33757 .next
33758 Any error response code to EHLO or HELO,
33759 .next
33760 Loss of connection at any time, except after &"."&,
33761 .next
33762 I/O errors at any time,
33763 .next
33764 Timeouts during the session, other than in response to MAIL, RCPT or
33765 the &"."& at the end of the data.
33766 .endlist ilist
33767
33768 For a host error, a permanent error response on connection, or in response to
33769 EHLO, causes all addresses routed to the host to be failed. Any other host
33770 error causes all addresses to be deferred, and retry data to be created for the
33771 host. It is not tried again, for any message, until its retry time arrives. If
33772 the current set of addresses are not all delivered in this run (to some
33773 alternative host), the message is added to the list of those waiting for this
33774 host, so if it is still undelivered when a subsequent successful delivery is
33775 made to the host, it will be sent down the same SMTP connection.
33776
33777 .vitem "&*Message errors*&"
33778 .cindex "message" "error"
33779 A message error is associated with a particular message when sent to a
33780 particular host, but not with a particular recipient of the message. The
33781 message errors are:
33782
33783 .ilist
33784 Any error response code to MAIL, DATA, or the &"."& that terminates
33785 the data,
33786 .next
33787 Timeout after MAIL,
33788 .next
33789 Timeout or loss of connection after the &"."& that terminates the data. A
33790 timeout after the DATA command itself is treated as a host error, as is loss of
33791 connection at any other time.
33792 .endlist ilist
33793
33794 For a message error, a permanent error response (5&'xx'&) causes all addresses
33795 to be failed, and a delivery error report to be returned to the sender. A
33796 temporary error response (4&'xx'&), or one of the timeouts, causes all
33797 addresses to be deferred. Retry data is not created for the host, but instead,
33798 a retry record for the combination of host plus message id is created. The
33799 message is not added to the list of those waiting for this host. This ensures
33800 that the failing message will not be sent to this host again until the retry
33801 time arrives. However, other messages that are routed to the host are not
33802 affected, so if it is some property of the message that is causing the error,
33803 it will not stop the delivery of other mail.
33804
33805 If the remote host specified support for the SIZE parameter in its response
33806 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33807 over-large message will cause a message error because the error arrives as a
33808 response to MAIL.
33809
33810 .vitem "&*Recipient errors*&"
33811 .cindex "recipient" "error"
33812 A recipient error is associated with a particular recipient of a message. The
33813 recipient errors are:
33814
33815 .ilist
33816 Any error response to RCPT,
33817 .next
33818 Timeout after RCPT.
33819 .endlist
33820
33821 For a recipient error, a permanent error response (5&'xx'&) causes the
33822 recipient address to be failed, and a bounce message to be returned to the
33823 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33824 address to be deferred, and routing retry data to be created for it. This is
33825 used to delay processing of the address in subsequent queue runs, until its
33826 routing retry time arrives. This applies to all messages, but because it
33827 operates only in queue runs, one attempt will be made to deliver a new message
33828 to the failing address before the delay starts to operate. This ensures that,
33829 if the failure is really related to the message rather than the recipient
33830 (&"message too big for this recipient"& is a possible example), other messages
33831 have a chance of getting delivered. If a delivery to the address does succeed,
33832 the retry information gets cleared, so all stuck messages get tried again, and
33833 the retry clock is reset.
33834
33835 The message is not added to the list of those waiting for this host. Use of the
33836 host for other messages is unaffected, and except in the case of a timeout,
33837 other recipients are processed independently, and may be successfully delivered
33838 in the current SMTP session. After a timeout it is of course impossible to
33839 proceed with the session, so all addresses get deferred. However, those other
33840 than the one that failed do not suffer any subsequent retry delays. Therefore,
33841 if one recipient is causing trouble, the others have a chance of getting
33842 through when a subsequent delivery attempt occurs before the failing
33843 recipient's retry time.
33844 .endlist
33845
33846 In all cases, if there are other hosts (or IP addresses) available for the
33847 current set of addresses (for example, from multiple MX records), they are
33848 tried in this run for any undelivered addresses, subject of course to their
33849 own retry data. In other words, recipient error retry data does not take effect
33850 until the next delivery attempt.
33851
33852 Some hosts have been observed to give temporary error responses to every
33853 MAIL command at certain times (&"insufficient space"& has been seen). It
33854 would be nice if such circumstances could be recognized, and defer data for the
33855 host itself created, but this is not possible within the current Exim design.
33856 What actually happens is that retry data for every (host, message) combination
33857 is created.
33858
33859 The reason that timeouts after MAIL and RCPT are treated specially is that
33860 these can sometimes arise as a result of the remote host's verification
33861 procedures. Exim makes this assumption, and treats them as if a temporary error
33862 response had been received. A timeout after &"."& is treated specially because
33863 it is known that some broken implementations fail to recognize the end of the
33864 message if the last character of the last line is a binary zero. Thus, it is
33865 helpful to treat this case as a message error.
33866
33867 Timeouts at other times are treated as host errors, assuming a problem with the
33868 host, or the connection to it. If a timeout after MAIL, RCPT,
33869 or &"."& is really a connection problem, the assumption is that at the next try
33870 the timeout is likely to occur at some other point in the dialogue, causing it
33871 then to be treated as a host error.
33872
33873 There is experimental evidence that some MTAs drop the connection after the
33874 terminating &"."& if they do not like the contents of the message for some
33875 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33876 should be given. That is why Exim treats this case as a message rather than a
33877 host error, in order not to delay other messages to the same host.
33878
33879
33880
33881
33882 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33883 .cindex "SMTP" "incoming over TCP/IP"
33884 .cindex "incoming SMTP over TCP/IP"
33885 .cindex "inetd"
33886 .cindex "daemon"
33887 Incoming SMTP messages can be accepted in one of two ways: by running a
33888 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33889 &_/etc/inetd.conf_& should be like this:
33890 .code
33891 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33892 .endd
33893 Exim distinguishes between this case and the case of a locally running user
33894 agent using the &%-bs%& option by checking whether or not the standard input is
33895 a socket. When it is, either the port must be privileged (less than 1024), or
33896 the caller must be root or the Exim user. If any other user passes a socket
33897 with an unprivileged port number, Exim prints a message on the standard error
33898 stream and exits with an error code.
33899
33900 By default, Exim does not make a log entry when a remote host connects or
33901 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33902 unexpected. It can be made to write such log entries by setting the
33903 &%smtp_connection%& log selector.
33904
33905 .cindex "carriage return"
33906 .cindex "linefeed"
33907 Commands from the remote host are supposed to be terminated by CR followed by
33908 LF. However, there are known to be hosts that do not send CR characters. In
33909 order to be able to interwork with such hosts, Exim treats LF on its own as a
33910 line terminator.
33911 Furthermore, because common code is used for receiving messages from all
33912 sources, a CR on its own is also interpreted as a line terminator. However, the
33913 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33914
33915 .cindex "EHLO" "invalid data"
33916 .cindex "HELO" "invalid data"
33917 One area that sometimes gives rise to problems concerns the EHLO or
33918 HELO commands. Some clients send syntactically invalid versions of these
33919 commands, which Exim rejects by default. (This is nothing to do with verifying
33920 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33921 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33922 match the broken hosts that send invalid commands.
33923
33924 .cindex "SIZE option on MAIL command"
33925 .cindex "MAIL" "SIZE option"
33926 The amount of disk space available is checked whenever SIZE is received on
33927 a MAIL command, independently of whether &%message_size_limit%& or
33928 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33929 false. A temporary error is given if there is not enough space. If
33930 &%check_spool_space%& is set, the check is for that amount of space plus the
33931 value given with SIZE, that is, it checks that the addition of the incoming
33932 message will not reduce the space below the threshold.
33933
33934 When a message is successfully received, Exim includes the local message id in
33935 its response to the final &"."& that terminates the data. If the remote host
33936 logs this text it can help with tracing what has happened to a message.
33937
33938 The Exim daemon can limit the number of simultaneous incoming connections it is
33939 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33940 number of simultaneous incoming connections from a single remote host (see the
33941 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33942 rejected using the SMTP temporary error code 421.
33943
33944 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33945 subprocess has finished, as this can get lost at busy times. Instead, it looks
33946 for completed subprocesses every time it wakes up. Provided there are other
33947 things happening (new incoming calls, starts of queue runs), completed
33948 processes will be noticed and tidied away. On very quiet systems you may
33949 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33950 it will be noticed when the daemon next wakes up.
33951
33952 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33953 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33954 high system load &-- for details see the &%smtp_accept_reserve%&,
33955 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33956 applies in both the daemon and &'inetd'& cases.
33957
33958 Exim normally starts a delivery process for each message received, though this
33959 can be varied by means of the &%-odq%& command line option and the
33960 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33961 number of simultaneously running delivery processes started in this way from
33962 SMTP input can be limited by the &%smtp_accept_queue%& and
33963 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33964 subsequently received messages are just put on the input queue without starting
33965 a delivery process.
33966
33967 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33968 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33969 started up from the &'inetd'& daemon, because in that case each connection is
33970 handled by an entirely independent Exim process. Control by load average is,
33971 however, available with &'inetd'&.
33972
33973 Exim can be configured to verify addresses in incoming SMTP commands as they
33974 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33975 to rewrite addresses at this time &-- before any syntax checking is done. See
33976 section &<<SECTrewriteS>>&.
33977
33978 Exim can also be configured to limit the rate at which a client host submits
33979 MAIL and RCPT commands in a single SMTP session. See the
33980 &%smtp_ratelimit_hosts%& option.
33981
33982
33983
33984 .section "Unrecognized SMTP commands" "SECID234"
33985 .cindex "SMTP" "unrecognized commands"
33986 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33987 commands during a single SMTP connection, it drops the connection after sending
33988 the error response to the last command. The default value for
33989 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33990 abuse that subvert web servers into making connections to SMTP ports; in these
33991 circumstances, a number of non-SMTP lines are sent first.
33992
33993
33994 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33995 .cindex "SMTP" "syntax errors"
33996 .cindex "SMTP" "protocol errors"
33997 A syntax error is detected if an SMTP command is recognized, but there is
33998 something syntactically wrong with its data, for example, a malformed email
33999 address in a RCPT command. Protocol errors include invalid command
34000 sequencing such as RCPT before MAIL. If Exim receives more than
34001 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34002 drops the connection after sending the error response to the last command. The
34003 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34004 broken clients that loop sending bad commands (yes, it has been seen).
34005
34006
34007
34008 .section "Use of non-mail SMTP commands" "SECID236"
34009 .cindex "SMTP" "non-mail commands"
34010 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34011 DATA. Exim counts such commands, and drops the connection if there are too
34012 many of them in a single SMTP session. This action catches some
34013 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34014 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34015 defines what &"too many"& means. Its default value is 10.
34016
34017 When a new message is expected, one occurrence of RSET is not counted. This
34018 allows a client to send one RSET between messages (this is not necessary,
34019 but some clients do it). Exim also allows one uncounted occurrence of HELO
34020 or EHLO, and one occurrence of STARTTLS between messages. After
34021 starting up a TLS session, another EHLO is expected, and so it too is not
34022 counted.
34023
34024 The first occurrence of AUTH in a connection, or immediately following
34025 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34026 RCPT, DATA, and QUIT are counted.
34027
34028 You can control which hosts are subject to the limit set by
34029 &%smtp_accept_max_nonmail%& by setting
34030 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34031 the limit apply to all hosts. This option means that you can exclude any
34032 specific badly-behaved hosts that you have to live with.
34033
34034
34035
34036
34037 .section "The VRFY and EXPN commands" "SECID237"
34038 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34039 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34040 appropriate) in order to decide whether the command should be accepted or not.
34041
34042 .cindex "VRFY" "processing"
34043 When no ACL is defined for VRFY, or if it rejects without
34044 setting an explicit response code, the command is accepted
34045 (with a 252 SMTP response code)
34046 in order to support awkward clients that do a VRFY before every RCPT.
34047 When VRFY is accepted, it runs exactly the same code as when Exim is
34048 called with the &%-bv%& option, and returns 250/451/550
34049 SMTP response codes.
34050
34051 .cindex "EXPN" "processing"
34052 If no ACL for EXPN is defined, the command is rejected.
34053 When EXPN is accepted, a single-level expansion of the address is done.
34054 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34055 than a verification (the &%-bv%& option). If an unqualified local part is given
34056 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34057 of VRFY and EXPN commands are logged on the main and reject logs, and
34058 VRFY verification failures are logged on the main log for consistency with
34059 RCPT failures.
34060
34061
34062
34063 .section "The ETRN command" "SECTETRN"
34064 .cindex "ETRN" "processing"
34065 RFC 1985 describes an SMTP command called ETRN that is designed to
34066 overcome the security problems of the TURN command (which has fallen into
34067 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34068 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34069 should be accepted or not. If no ACL is defined, the command is rejected.
34070
34071 The ETRN command is concerned with &"releasing"& messages that are awaiting
34072 delivery to certain hosts. As Exim does not organize its message queue by host,
34073 the only form of ETRN that is supported by default is the one where the
34074 text starts with the &"#"& prefix, in which case the remainder of the text is
34075 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34076 the &%-R%& option to happen, with the remainder of the ETRN text as its
34077 argument. For example,
34078 .code
34079 ETRN #brigadoon
34080 .endd
34081 runs the command
34082 .code
34083 exim -R brigadoon
34084 .endd
34085 which causes a delivery attempt on all messages with undelivered addresses
34086 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34087 default), Exim prevents the simultaneous execution of more than one queue run
34088 for the same argument string as a result of an ETRN command. This stops
34089 a misbehaving client from starting more than one queue runner at once.
34090
34091 .cindex "hints database" "ETRN serialization"
34092 Exim implements the serialization by means of a hints database in which a
34093 record is written whenever a process is started by ETRN, and deleted when
34094 the process completes. However, Exim does not keep the SMTP session waiting for
34095 the ETRN process to complete. Once ETRN is accepted, the client is sent
34096 a &"success"& return code. Obviously there is scope for hints records to get
34097 left lying around if there is a system or program crash. To guard against this,
34098 Exim ignores any records that are more than six hours old.
34099
34100 .oindex "&%smtp_etrn_command%&"
34101 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34102 used. This specifies a command that is run whenever ETRN is received,
34103 whatever the form of its argument. For
34104 example:
34105 .code
34106 smtp_etrn_command = /etc/etrn_command $domain \
34107                     $sender_host_address
34108 .endd
34109 .vindex "&$domain$&"
34110 The string is split up into arguments which are independently expanded. The
34111 expansion variable &$domain$& is set to the argument of the ETRN command,
34112 and no syntax checking is done on the contents of this argument. Exim does not
34113 wait for the command to complete, so its status code is not checked. Exim runs
34114 under its own uid and gid when receiving incoming SMTP, so it is not possible
34115 for it to change them before running the command.
34116
34117
34118
34119 .section "Incoming local SMTP" "SECID238"
34120 .cindex "SMTP" "local incoming"
34121 Some user agents use SMTP to pass messages to their local MTA using the
34122 standard input and output, as opposed to passing the envelope on the command
34123 line and writing the message to the standard input. This is supported by the
34124 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34125 messages over TCP/IP (including the use of ACLs), except that the envelope
34126 sender given in a MAIL command is ignored unless the caller is trusted. In
34127 an ACL you can detect this form of SMTP input by testing for an empty host
34128 identification. It is common to have this as the first line in the ACL that
34129 runs for RCPT commands:
34130 .code
34131 accept hosts = :
34132 .endd
34133 This accepts SMTP messages from local processes without doing any other tests.
34134
34135
34136
34137 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34138 .cindex "SMTP" "batched outgoing"
34139 .cindex "batched SMTP output"
34140 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34141 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34142 be output in BSMTP format. No SMTP responses are possible for this form of
34143 delivery. All it is doing is using SMTP commands as a way of transmitting the
34144 envelope along with the message.
34145
34146 The message is written to the file or pipe preceded by the SMTP commands
34147 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34148 the message that start with a dot have an extra dot added. The SMTP command
34149 HELO is not normally used. If it is required, the &%message_prefix%& option
34150 can be used to specify it.
34151
34152 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34153 one recipient address at a time by default. However, you can arrange for them
34154 to handle several addresses at once by setting the &%batch_max%& option. When
34155 this is done for BSMTP, messages may contain multiple RCPT commands. See
34156 chapter &<<CHAPbatching>>& for more details.
34157
34158 .vindex "&$host$&"
34159 When one or more addresses are routed to a BSMTP transport by a router that
34160 sets up a host list, the name of the first host on the list is available to the
34161 transport in the variable &$host$&. Here is an example of such a transport and
34162 router:
34163 .code
34164 begin routers
34165 route_append:
34166   driver = manualroute
34167   transport = smtp_appendfile
34168   route_list = domain.example  batch.host.example
34169
34170 begin transports
34171 smtp_appendfile:
34172   driver = appendfile
34173   directory = /var/bsmtp/$host
34174   batch_max = 1000
34175   use_bsmtp
34176   user = exim
34177 .endd
34178 This causes messages addressed to &'domain.example'& to be written in BSMTP
34179 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34180 message (unless there are more than 1000 recipients).
34181
34182
34183
34184 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34185 .cindex "SMTP" "batched incoming"
34186 .cindex "batched SMTP input"
34187 The &%-bS%& command line option causes Exim to accept one or more messages by
34188 reading SMTP on the standard input, but to generate no responses. If the caller
34189 is trusted, the senders in the MAIL commands are believed; otherwise the
34190 sender is always the caller of Exim. Unqualified senders and receivers are not
34191 rejected (there seems little point) but instead just get qualified. HELO
34192 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34193 as NOOP; QUIT quits.
34194
34195 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34196 ACL is run in the same way as for non-SMTP local input.
34197
34198 If an error is detected while reading a message, including a missing &"."& at
34199 the end, Exim gives up immediately. It writes details of the error to the
34200 standard output in a stylized way that the calling program should be able to
34201 make some use of automatically, for example:
34202 .code
34203 554 Unexpected end of file
34204 Transaction started in line 10
34205 Error detected in line 14
34206 .endd
34207 It writes a more verbose version, for human consumption, to the standard error
34208 file, for example:
34209 .code
34210 An error was detected while processing a file of BSMTP input.
34211 The error message was:
34212
34213 501 '>' missing at end of address
34214
34215 The SMTP transaction started in line 10.
34216 The error was detected in line 12.
34217 The SMTP command at fault was:
34218
34219 rcpt to:<malformed@in.com.plete
34220
34221 1 previous message was successfully processed.
34222 The rest of the batch was abandoned.
34223 .endd
34224 The return code from Exim is zero only if there were no errors. It is 1 if some
34225 messages were accepted before an error was detected, and 2 if no messages were
34226 accepted.
34227 .ecindex IIDsmtpproc1
34228 .ecindex IIDsmtpproc2
34229
34230
34231
34232 . ////////////////////////////////////////////////////////////////////////////
34233 . ////////////////////////////////////////////////////////////////////////////
34234
34235 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34236          "Customizing messages"
34237 When a message fails to be delivered, or remains on the queue for more than a
34238 configured amount of time, Exim sends a message to the original sender, or
34239 to an alternative configured address. The text of these messages is built into
34240 the code of Exim, but it is possible to change it, either by adding a single
34241 string, or by replacing each of the paragraphs by text supplied in a file.
34242
34243 The &'From:'& and &'To:'& header lines are automatically generated; you can
34244 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34245 option. Exim also adds the line
34246 .code
34247 Auto-Submitted: auto-generated
34248 .endd
34249 to all warning and bounce messages,
34250
34251
34252 .section "Customizing bounce messages" "SECID239"
34253 .cindex "customizing" "bounce message"
34254 .cindex "bounce message" "customizing"
34255 If &%bounce_message_text%& is set, its contents are included in the default
34256 message immediately after &"This message was created automatically by mail
34257 delivery software."& The string is not expanded. It is not used if
34258 &%bounce_message_file%& is set.
34259
34260 When &%bounce_message_file%& is set, it must point to a template file for
34261 constructing error messages. The file consists of a series of text items,
34262 separated by lines consisting of exactly four asterisks. If the file cannot be
34263 opened, default text is used and a message is written to the main and panic
34264 logs. If any text item in the file is empty, default text is used for that
34265 item.
34266
34267 .vindex "&$bounce_recipient$&"
34268 .vindex "&$bounce_return_size_limit$&"
34269 Each item of text that is read from the file is expanded, and there are two
34270 expansion variables which can be of use here: &$bounce_recipient$& is set to
34271 the recipient of an error message while it is being created, and
34272 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34273 option, rounded to a whole number.
34274
34275 The items must appear in the file in the following order:
34276
34277 .ilist
34278 The first item is included in the headers, and should include at least a
34279 &'Subject:'& header. Exim does not check the syntax of these headers.
34280 .next
34281 The second item forms the start of the error message. After it, Exim lists the
34282 failing addresses with their error messages.
34283 .next
34284 The third item is used to introduce any text from pipe transports that is to be
34285 returned to the sender. It is omitted if there is no such text.
34286 .next
34287 The fourth, fifth and sixth items will be ignored and may be empty.
34288 The fields exist for back-compatibility
34289 .endlist
34290
34291 The default state (&%bounce_message_file%& unset) is equivalent to the
34292 following file, in which the sixth item is empty. The &'Subject:'& and some
34293 other lines have been split in order to fit them on the page:
34294 .code
34295 Subject: Mail delivery failed
34296   ${if eq{$sender_address}{$bounce_recipient}
34297   {: returning message to sender}}
34298 ****
34299 This message was created automatically by mail delivery software.
34300
34301 A message ${if eq{$sender_address}{$bounce_recipient}
34302   {that you sent }{sent by
34303
34304 <$sender_address>
34305
34306 }}could not be delivered to all of its recipients.
34307 This is a permanent error. The following address(es) failed:
34308 ****
34309 The following text was generated during the delivery attempt(s):
34310 ****
34311 ------ This is a copy of the message, including all the headers.
34312   ------
34313 ****
34314 ------ The body of the message is $message_size characters long;
34315   only the first
34316 ------ $bounce_return_size_limit or so are included here.
34317 ****
34318 .endd
34319 .section "Customizing warning messages" "SECTcustwarn"
34320 .cindex "customizing" "warning message"
34321 .cindex "warning of delay" "customizing the message"
34322 The option &%warn_message_file%& can be pointed at a template file for use when
34323 warnings about message delays are created. In this case there are only three
34324 text sections:
34325
34326 .ilist
34327 The first item is included in the headers, and should include at least a
34328 &'Subject:'& header. Exim does not check the syntax of these headers.
34329 .next
34330 The second item forms the start of the warning message. After it, Exim lists
34331 the delayed addresses.
34332 .next
34333 The third item then ends the message.
34334 .endlist
34335
34336 The default state is equivalent to the following file, except that some lines
34337 have been split here, in order to fit them on the page:
34338 .code
34339 Subject: Warning: message $message_exim_id delayed
34340   $warn_message_delay
34341 ****
34342 This message was created automatically by mail delivery software.
34343
34344 A message ${if eq{$sender_address}{$warn_message_recipients}
34345 {that you sent }{sent by
34346
34347 <$sender_address>
34348
34349 }}has not been delivered to all of its recipients after
34350 more than $warn_message_delay on the queue on $primary_hostname.
34351
34352 The message identifier is:     $message_exim_id
34353 The subject of the message is: $h_subject
34354 The date of the message is:    $h_date
34355
34356 The following address(es) have not yet been delivered:
34357 ****
34358 No action is required on your part. Delivery attempts will
34359 continue for some time, and this warning may be repeated at
34360 intervals if the message remains undelivered. Eventually the
34361 mail delivery software will give up, and when that happens,
34362 the message will be returned to you.
34363 .endd
34364 .vindex "&$warn_message_delay$&"
34365 .vindex "&$warn_message_recipients$&"
34366 However, in the default state the subject and date lines are omitted if no
34367 appropriate headers exist. During the expansion of this file,
34368 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34369 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34370 of recipients for the warning message. There may be more than one if there are
34371 multiple addresses with different &%errors_to%& settings on the routers that
34372 handled them.
34373
34374
34375
34376
34377 . ////////////////////////////////////////////////////////////////////////////
34378 . ////////////////////////////////////////////////////////////////////////////
34379
34380 .chapter "Some common configuration settings" "CHAPcomconreq"
34381 This chapter discusses some configuration settings that seem to be fairly
34382 common. More examples and discussion can be found in the Exim book.
34383
34384
34385
34386 .section "Sending mail to a smart host" "SECID240"
34387 .cindex "smart host" "example router"
34388 If you want to send all mail for non-local domains to a &"smart host"&, you
34389 should replace the default &(dnslookup)& router with a router which does the
34390 routing explicitly:
34391 .code
34392 send_to_smart_host:
34393   driver = manualroute
34394   route_list = !+local_domains smart.host.name
34395   transport = remote_smtp
34396 .endd
34397 You can use the smart host's IP address instead of the name if you wish.
34398 If you are using Exim only to submit messages to a smart host, and not for
34399 receiving incoming messages, you can arrange for it to do the submission
34400 synchronously by setting the &%mua_wrapper%& option (see chapter
34401 &<<CHAPnonqueueing>>&).
34402
34403
34404
34405
34406 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34407 .cindex "mailing lists"
34408 Exim can be used to run simple mailing lists, but for large and/or complicated
34409 requirements, the use of additional specialized mailing list software such as
34410 Majordomo or Mailman is recommended.
34411
34412 The &(redirect)& router can be used to handle mailing lists where each list
34413 is maintained in a separate file, which can therefore be managed by an
34414 independent manager. The &%domains%& router option can be used to run these
34415 lists in a separate domain from normal mail. For example:
34416 .code
34417 lists:
34418   driver = redirect
34419   domains = lists.example
34420   file = /usr/lists/$local_part
34421   forbid_pipe
34422   forbid_file
34423   errors_to = $local_part-request@lists.example
34424   no_more
34425 .endd
34426 This router is skipped for domains other than &'lists.example'&. For addresses
34427 in that domain, it looks for a file that matches the local part. If there is no
34428 such file, the router declines, but because &%no_more%& is set, no subsequent
34429 routers are tried, and so the whole delivery fails.
34430
34431 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34432 expanded into a file name or a pipe delivery, which is usually inappropriate in
34433 a mailing list.
34434
34435 .oindex "&%errors_to%&"
34436 The &%errors_to%& option specifies that any delivery errors caused by addresses
34437 taken from a mailing list are to be sent to the given address rather than the
34438 original sender of the message. However, before acting on this, Exim verifies
34439 the error address, and ignores it if verification fails.
34440
34441 For example, using the configuration above, mail sent to
34442 &'dicts@lists.example'& is passed on to those addresses contained in
34443 &_/usr/lists/dicts_&, with error reports directed to
34444 &'dicts-request@lists.example'&, provided that this address can be verified.
34445 There could be a file called &_/usr/lists/dicts-request_& containing
34446 the address(es) of this particular list's manager(s), but other approaches,
34447 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34448 or &%local_part_suffix%& options) to handle addresses of the form
34449 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34450
34451
34452
34453 .section "Syntax errors in mailing lists" "SECID241"
34454 .cindex "mailing lists" "syntax errors in"
34455 If an entry in redirection data contains a syntax error, Exim normally defers
34456 delivery of the original address. That means that a syntax error in a mailing
34457 list holds up all deliveries to the list. This may not be appropriate when a
34458 list is being maintained automatically from data supplied by users, and the
34459 addresses are not rigorously checked.
34460
34461 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34462 entries that fail to parse, noting the incident in the log. If in addition
34463 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34464 whenever a broken address is skipped. It is usually appropriate to set
34465 &%syntax_errors_to%& to the same address as &%errors_to%&.
34466
34467
34468
34469 .section "Re-expansion of mailing lists" "SECID242"
34470 .cindex "mailing lists" "re-expansion of"
34471 Exim remembers every individual address to which a message has been delivered,
34472 in order to avoid duplication, but it normally stores only the original
34473 recipient addresses with a message. If all the deliveries to a mailing list
34474 cannot be done at the first attempt, the mailing list is re-expanded when the
34475 delivery is next tried. This means that alterations to the list are taken into
34476 account at each delivery attempt, so addresses that have been added to
34477 the list since the message arrived will therefore receive a copy of the
34478 message, even though it pre-dates their subscription.
34479
34480 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34481 on the &(redirect)& router. If this is done, any addresses generated by the
34482 router that fail to deliver at the first attempt are added to the message as
34483 &"top level"& addresses, and the parent address that generated them is marked
34484 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34485 subsequent delivery attempts. The disadvantage of this is that if any of the
34486 failing addresses are incorrect, correcting them in the file has no effect on
34487 pre-existing messages.
34488
34489 The original top-level address is remembered with each of the generated
34490 addresses, and is output in any log messages. However, any intermediate parent
34491 addresses are not recorded. This makes a difference to the log only if the
34492 &%all_parents%& selector is set, but for mailing lists there is normally only
34493 one level of expansion anyway.
34494
34495
34496
34497 .section "Closed mailing lists" "SECID243"
34498 .cindex "mailing lists" "closed"
34499 The examples so far have assumed open mailing lists, to which anybody may
34500 send mail. It is also possible to set up closed lists, where mail is accepted
34501 from specified senders only. This is done by making use of the generic
34502 &%senders%& option to restrict the router that handles the list.
34503
34504 The following example uses the same file as a list of recipients and as a list
34505 of permitted senders. It requires three routers:
34506 .code
34507 lists_request:
34508   driver = redirect
34509   domains = lists.example
34510   local_part_suffix = -request
34511   file = /usr/lists/$local_part$local_part_suffix
34512   no_more
34513
34514 lists_post:
34515   driver = redirect
34516   domains = lists.example
34517   senders = ${if exists {/usr/lists/$local_part}\
34518              {lsearch;/usr/lists/$local_part}{*}}
34519   file = /usr/lists/$local_part
34520   forbid_pipe
34521   forbid_file
34522   errors_to = $local_part-request@lists.example
34523   no_more
34524
34525 lists_closed:
34526   driver = redirect
34527   domains = lists.example
34528   allow_fail
34529   data = :fail: $local_part@lists.example is a closed mailing list
34530 .endd
34531 All three routers have the same &%domains%& setting, so for any other domains,
34532 they are all skipped. The first router runs only if the local part ends in
34533 &%-request%&. It handles messages to the list manager(s) by means of an open
34534 mailing list.
34535
34536 The second router runs only if the &%senders%& precondition is satisfied. It
34537 checks for the existence of a list that corresponds to the local part, and then
34538 checks that the sender is on the list by means of a linear search. It is
34539 necessary to check for the existence of the file before trying to search it,
34540 because otherwise Exim thinks there is a configuration error. If the file does
34541 not exist, the expansion of &%senders%& is *, which matches all senders. This
34542 means that the router runs, but because there is no list, declines, and
34543 &%no_more%& ensures that no further routers are run. The address fails with an
34544 &"unrouteable address"& error.
34545
34546 The third router runs only if the second router is skipped, which happens when
34547 a mailing list exists, but the sender is not on it. This router forcibly fails
34548 the address, giving a suitable error message.
34549
34550
34551
34552
34553 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34554 .cindex "VERP"
34555 .cindex "Variable Envelope Return Paths"
34556 .cindex "envelope sender"
34557 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34558 are a way of helping mailing list administrators discover which subscription
34559 address is the cause of a particular delivery failure. The idea is to encode
34560 the original recipient address in the outgoing envelope sender address, so that
34561 if the message is forwarded by another host and then subsequently bounces, the
34562 original recipient can be extracted from the recipient address of the bounce.
34563
34564 .oindex &%errors_to%&
34565 .oindex &%return_path%&
34566 Envelope sender addresses can be modified by Exim using two different
34567 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34568 list examples), or the &%return_path%& option on a transport. The second of
34569 these is effective only if the message is successfully delivered to another
34570 host; it is not used for errors detected on the local host (see the description
34571 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34572 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34573 .code
34574 verp_smtp:
34575   driver = smtp
34576   max_rcpt = 1
34577   return_path = \
34578     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34579       {$1-request+$local_part=$domain@your.dom.example}fail}
34580 .endd
34581 This has the effect of rewriting the return path (envelope sender) on outgoing
34582 SMTP messages, if the local part of the original return path ends in
34583 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34584 local part and domain of the recipient into the return path. Suppose, for
34585 example, that a message whose return path has been set to
34586 &'somelist-request@your.dom.example'& is sent to
34587 &'subscriber@other.dom.example'&. In the transport, the return path is
34588 rewritten as
34589 .code
34590 somelist-request+subscriber=other.dom.example@your.dom.example
34591 .endd
34592 .vindex "&$local_part$&"
34593 For this to work, you must tell Exim to send multiple copies of messages that
34594 have more than one recipient, so that each copy has just one recipient. This is
34595 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34596 might be sent to several different recipients in the same domain, in which case
34597 &$local_part$& is not available in the transport, because it is not unique.
34598
34599 Unless your host is doing nothing but mailing list deliveries, you should
34600 probably use a separate transport for the VERP deliveries, so as not to use
34601 extra resources in making one-per-recipient copies for other deliveries. This
34602 can easily be done by expanding the &%transport%& option in the router:
34603 .code
34604 dnslookup:
34605   driver = dnslookup
34606   domains = ! +local_domains
34607   transport = \
34608     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34609       {verp_smtp}{remote_smtp}}
34610   no_more
34611 .endd
34612 If you want to change the return path using &%errors_to%& in a router instead
34613 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34614 routers that handle mailing list addresses. This will ensure that all delivery
34615 errors, including those detected on the local host, are sent to the VERP
34616 address.
34617
34618 On a host that does no local deliveries and has no manual routing, only the
34619 &(dnslookup)& router needs to be changed. A special transport is not needed for
34620 SMTP deliveries. Every mailing list recipient has its own return path value,
34621 and so Exim must hand them to the transport one at a time. Here is an example
34622 of a &(dnslookup)& router that implements VERP:
34623 .code
34624 verp_dnslookup:
34625   driver = dnslookup
34626   domains = ! +local_domains
34627   transport = remote_smtp
34628   errors_to = \
34629     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34630      {$1-request+$local_part=$domain@your.dom.example}fail}
34631   no_more
34632 .endd
34633 Before you start sending out messages with VERPed return paths, you must also
34634 configure Exim to accept the bounce messages that come back to those paths.
34635 Typically this is done by setting a &%local_part_suffix%& option for a
34636 router, and using this to route the messages to wherever you want to handle
34637 them.
34638
34639 The overhead incurred in using VERP depends very much on the size of the
34640 message, the number of recipient addresses that resolve to the same remote
34641 host, and the speed of the connection over which the message is being sent. If
34642 a lot of addresses resolve to the same host and the connection is slow, sending
34643 a separate copy of the message for each address may take substantially longer
34644 than sending a single copy with many recipients (for which VERP cannot be
34645 used).
34646
34647
34648
34649
34650
34651
34652 .section "Virtual domains" "SECTvirtualdomains"
34653 .cindex "virtual domains"
34654 .cindex "domain" "virtual"
34655 The phrase &'virtual domain'& is unfortunately used with two rather different
34656 meanings:
34657
34658 .ilist
34659 A domain for which there are no real mailboxes; all valid local parts are
34660 aliases for other email addresses. Common examples are organizational
34661 top-level domains and &"vanity"& domains.
34662 .next
34663 One of a number of independent domains that are all handled by the same host,
34664 with mailboxes on that host, but where the mailbox owners do not necessarily
34665 have login accounts on that host.
34666 .endlist
34667
34668 The first usage is probably more common, and does seem more &"virtual"& than
34669 the second. This kind of domain can be handled in Exim with a straightforward
34670 aliasing router. One approach is to create a separate alias file for each
34671 virtual domain. Exim can test for the existence of the alias file to determine
34672 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34673 to a router of this form:
34674 .code
34675 virtual:
34676   driver = redirect
34677   domains = dsearch;/etc/mail/virtual
34678   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34679   no_more
34680 .endd
34681 The &%domains%& option specifies that the router is to be skipped, unless there
34682 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34683 domain that is being processed. When the router runs, it looks up the local
34684 part in the file to find a new address (or list of addresses). The &%no_more%&
34685 setting ensures that if the lookup fails (leading to &%data%& being an empty
34686 string), Exim gives up on the address without trying any subsequent routers.
34687
34688 This one router can handle all the virtual domains because the alias file names
34689 follow a fixed pattern. Permissions can be arranged so that appropriate people
34690 can edit the different alias files. A successful aliasing operation results in
34691 a new envelope recipient address, which is then routed from scratch.
34692
34693 The other kind of &"virtual"& domain can also be handled in a straightforward
34694 way. One approach is to create a file for each domain containing a list of
34695 valid local parts, and use it in a router like this:
34696 .code
34697 my_domains:
34698   driver = accept
34699   domains = dsearch;/etc/mail/domains
34700   local_parts = lsearch;/etc/mail/domains/$domain
34701   transport = my_mailboxes
34702 .endd
34703 The address is accepted if there is a file for the domain, and the local part
34704 can be found in the file. The &%domains%& option is used to check for the
34705 file's existence because &%domains%& is tested before the &%local_parts%&
34706 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34707 because that option is tested after &%local_parts%&. The transport is as
34708 follows:
34709 .code
34710 my_mailboxes:
34711   driver = appendfile
34712   file = /var/mail/$domain/$local_part
34713   user = mail
34714 .endd
34715 This uses a directory of mailboxes for each domain. The &%user%& setting is
34716 required, to specify which uid is to be used for writing to the mailboxes.
34717
34718 The configuration shown here is just one example of how you might support this
34719 requirement. There are many other ways this kind of configuration can be set
34720 up, for example, by using a database instead of separate files to hold all the
34721 information about the domains.
34722
34723
34724
34725 .section "Multiple user mailboxes" "SECTmulbox"
34726 .cindex "multiple mailboxes"
34727 .cindex "mailbox" "multiple"
34728 .cindex "local part" "prefix"
34729 .cindex "local part" "suffix"
34730 Heavy email users often want to operate with multiple mailboxes, into which
34731 incoming mail is automatically sorted. A popular way of handling this is to
34732 allow users to use multiple sender addresses, so that replies can easily be
34733 identified. Users are permitted to add prefixes or suffixes to their local
34734 parts for this purpose. The wildcard facility of the generic router options
34735 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34736 example, consider this router:
34737 .code
34738 userforward:
34739   driver = redirect
34740   check_local_user
34741   file = $home/.forward
34742   local_part_suffix = -*
34743   local_part_suffix_optional
34744   allow_filter
34745 .endd
34746 .vindex "&$local_part_suffix$&"
34747 It runs a user's &_.forward_& file for all local parts of the form
34748 &'username-*'&. Within the filter file the user can distinguish different
34749 cases by testing the variable &$local_part_suffix$&. For example:
34750 .code
34751 if $local_part_suffix contains -special then
34752 save /home/$local_part/Mail/special
34753 endif
34754 .endd
34755 If the filter file does not exist, or does not deal with such addresses, they
34756 fall through to subsequent routers, and, assuming no subsequent use of the
34757 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34758 control over which suffixes are valid.
34759
34760 Alternatively, a suffix can be used to trigger the use of a different
34761 &_.forward_& file &-- which is the way a similar facility is implemented in
34762 another MTA:
34763 .code
34764 userforward:
34765   driver = redirect
34766   check_local_user
34767   file = $home/.forward$local_part_suffix
34768   local_part_suffix = -*
34769   local_part_suffix_optional
34770   allow_filter
34771 .endd
34772 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34773 example, &_.forward-special_& is used. Once again, if the appropriate file
34774 does not exist, or does not deal with the address, it is passed on to
34775 subsequent routers, which could, if required, look for an unqualified
34776 &_.forward_& file to use as a default.
34777
34778
34779
34780 .section "Simplified vacation processing" "SECID244"
34781 .cindex "vacation processing"
34782 The traditional way of running the &'vacation'& program is for a user to set up
34783 a pipe command in a &_.forward_& file
34784 (see section &<<SECTspecitredli>>& for syntax details).
34785 This is prone to error by inexperienced users. There are two features of Exim
34786 that can be used to make this process simpler for users:
34787
34788 .ilist
34789 A local part prefix such as &"vacation-"& can be specified on a router which
34790 can cause the message to be delivered directly to the &'vacation'& program, or
34791 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34792 &_.forward_& file are then much simpler. For example:
34793 .code
34794 spqr, vacation-spqr
34795 .endd
34796 .next
34797 The &%require_files%& generic router option can be used to trigger a
34798 vacation delivery by checking for the existence of a certain file in the
34799 user's home directory. The &%unseen%& generic option should also be used, to
34800 ensure that the original delivery also proceeds. In this case, all the user has
34801 to do is to create a file called, say, &_.vacation_&, containing a vacation
34802 message.
34803 .endlist
34804
34805 Another advantage of both these methods is that they both work even when the
34806 use of arbitrary pipes by users is locked out.
34807
34808
34809
34810 .section "Taking copies of mail" "SECID245"
34811 .cindex "message" "copying every"
34812 Some installations have policies that require archive copies of all messages to
34813 be made. A single copy of each message can easily be taken by an appropriate
34814 command in a system filter, which could, for example, use a different file for
34815 each day's messages.
34816
34817 There is also a shadow transport mechanism that can be used to take copies of
34818 messages that are successfully delivered by local transports, one copy per
34819 delivery. This could be used, &'inter alia'&, to implement automatic
34820 notification of delivery by sites that insist on doing such things.
34821
34822
34823
34824 .section "Intermittently connected hosts" "SECID246"
34825 .cindex "intermittently connected hosts"
34826 It has become quite common (because it is cheaper) for hosts to connect to the
34827 Internet periodically rather than remain connected all the time. The normal
34828 arrangement is that mail for such hosts accumulates on a system that is
34829 permanently connected.
34830
34831 Exim was designed for use on permanently connected hosts, and so it is not
34832 particularly well-suited to use in an intermittently connected environment.
34833 Nevertheless there are some features that can be used.
34834
34835
34836 .section "Exim on the upstream server host" "SECID247"
34837 It is tempting to arrange for incoming mail for the intermittently connected
34838 host to remain on Exim's queue until the client connects. However, this
34839 approach does not scale very well. Two different kinds of waiting message are
34840 being mixed up in the same queue &-- those that cannot be delivered because of
34841 some temporary problem, and those that are waiting for their destination host
34842 to connect. This makes it hard to manage the queue, as well as wasting
34843 resources, because each queue runner scans the entire queue.
34844
34845 A better approach is to separate off those messages that are waiting for an
34846 intermittently connected host. This can be done by delivering these messages
34847 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34848 format, from where they are transmitted by other software when their
34849 destination connects. This makes it easy to collect all the mail for one host
34850 in a single directory, and to apply local timeout rules on a per-message basis
34851 if required.
34852
34853 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34854 you are doing this, you should configure Exim with a long retry period for the
34855 intermittent host. For example:
34856 .code
34857 cheshire.wonderland.fict.example    *   F,5d,24h
34858 .endd
34859 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34860 which messages it has queued up for that host. Once the intermittent host comes
34861 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34862 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34863 causes all the queued up messages to be delivered, often down a single SMTP
34864 connection. While the host remains connected, any new messages get delivered
34865 immediately.
34866
34867 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34868 issued with a different IP address each time it connects, Exim's retry
34869 mechanisms on the holding host get confused, because the IP address is normally
34870 used as part of the key string for holding retry information. This can be
34871 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34872 Since this has disadvantages for permanently connected hosts, it is best to
34873 arrange a separate transport for the intermittently connected ones.
34874
34875
34876
34877 .section "Exim on the intermittently connected client host" "SECID248"
34878 The value of &%smtp_accept_queue_per_connection%& should probably be
34879 increased, or even set to zero (that is, disabled) on the intermittently
34880 connected host, so that all incoming messages down a single connection get
34881 delivered immediately.
34882
34883 .cindex "SMTP" "passed connection"
34884 .cindex "SMTP" "multiple deliveries"
34885 .cindex "multiple SMTP deliveries"
34886 Mail waiting to be sent from an intermittently connected host will probably
34887 not have been routed, because without a connection DNS lookups are not
34888 possible. This means that if a normal queue run is done at connection time,
34889 each message is likely to be sent in a separate SMTP session. This can be
34890 avoided by starting the queue run with a command line option beginning with
34891 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34892 first pass, routing is done but no deliveries take place. The second pass is a
34893 normal queue run; since all the messages have been previously routed, those
34894 destined for the same host are likely to get sent as multiple deliveries in a
34895 single SMTP connection.
34896
34897
34898
34899 . ////////////////////////////////////////////////////////////////////////////
34900 . ////////////////////////////////////////////////////////////////////////////
34901
34902 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34903          "Exim as a non-queueing client"
34904 .cindex "client, non-queueing"
34905 .cindex "smart host" "suppressing queueing"
34906 On a personal computer, it is a common requirement for all
34907 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34908 configured to operate that way, for all the popular operating systems.
34909 However, there are some MUAs for Unix-like systems that cannot be so
34910 configured: they submit messages using the command line interface of
34911 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34912 messages this way.
34913
34914 If the personal computer runs continuously, there is no problem, because it can
34915 run a conventional MTA that handles delivery to the smart host, and deal with
34916 any delays via its queueing mechanism. However, if the computer does not run
34917 continuously or runs different operating systems at different times, queueing
34918 email is not desirable.
34919
34920 There is therefore a requirement for something that can provide the
34921 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34922 any queueing or retrying facilities. Furthermore, the delivery to the smart
34923 host should be synchronous, so that if it fails, the sending MUA is immediately
34924 informed. In other words, we want something that extends an MUA that submits
34925 to a local MTA via the command line so that it behaves like one that submits
34926 to a remote smart host using TCP/SMTP.
34927
34928 There are a number of applications (for example, there is one called &'ssmtp'&)
34929 that do this job. However, people have found them to be lacking in various
34930 ways. For instance, you might want to allow aliasing and forwarding to be done
34931 before sending a message to the smart host.
34932
34933 Exim already had the necessary infrastructure for doing this job. Just a few
34934 tweaks were needed to make it behave as required, though it is somewhat of an
34935 overkill to use a fully-featured MTA for this purpose.
34936
34937 .oindex "&%mua_wrapper%&"
34938 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34939 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34940 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34941 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34942 compatible router and transport configuration. Typically there will be just one
34943 router and one transport, sending everything to a smart host.
34944
34945 When run in MUA wrapping mode, the behaviour of Exim changes in the
34946 following ways:
34947
34948 .ilist
34949 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34950 In other words, the only way to submit messages is via the command line.
34951 .next
34952 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34953 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34954 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34955 does not finish until the delivery attempt is complete. If the delivery is
34956 successful, a zero return code is given.
34957 .next
34958 Address redirection is permitted, but the final routing for all addresses must
34959 be to the same remote transport, and to the same list of hosts. Furthermore,
34960 the return address (envelope sender) must be the same for all recipients, as
34961 must any added or deleted header lines. In other words, it must be possible to
34962 deliver the message in a single SMTP transaction, however many recipients there
34963 are.
34964 .next
34965 If these conditions are not met, or if routing any address results in a
34966 failure or defer status, or if Exim is unable to deliver all the recipients
34967 successfully to one of the smart hosts, delivery of the entire message fails.
34968 .next
34969 Because no queueing is allowed, all failures are treated as permanent; there
34970 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34971 smart host. Furthermore, because only a single yes/no response can be given to
34972 the caller, it is not possible to deliver to some recipients and not others. If
34973 there is an error (temporary or permanent) for any recipient, all are failed.
34974 .next
34975 If more than one smart host is listed, Exim will try another host after a
34976 connection failure or a timeout, in the normal way. However, if this kind of
34977 failure happens for all the hosts, the delivery fails.
34978 .next
34979 When delivery fails, an error message is written to the standard error stream
34980 (as well as to Exim's log), and Exim exits to the caller with a return code
34981 value 1. The message is expunged from Exim's spool files. No bounce messages
34982 are ever generated.
34983 .next
34984 No retry data is maintained, and any retry rules are ignored.
34985 .next
34986 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34987 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34988 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34989 .endlist
34990
34991 The overall effect is that Exim makes a single synchronous attempt to deliver
34992 the message, failing if there is any kind of problem. Because no local
34993 deliveries are done and no daemon can be run, Exim does not need root
34994 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34995 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34996 the advantages and disadvantages of running without root privilege.
34997
34998
34999
35000
35001 . ////////////////////////////////////////////////////////////////////////////
35002 . ////////////////////////////////////////////////////////////////////////////
35003
35004 .chapter "Log files" "CHAPlog"
35005 .scindex IIDloggen "log" "general description"
35006 .cindex "log" "types of"
35007 Exim writes three different logs, referred to as the main log, the reject log,
35008 and the panic log:
35009
35010 .ilist
35011 .cindex "main log"
35012 The main log records the arrival of each message and each delivery in a single
35013 line in each case. The format is as compact as possible, in an attempt to keep
35014 down the size of log files. Two-character flag sequences make it easy to pick
35015 out these lines. A number of other events are recorded in the main log. Some of
35016 them are optional, in which case the &%log_selector%& option controls whether
35017 they are included or not. A Perl script called &'eximstats'&, which does simple
35018 analysis of main log files, is provided in the Exim distribution (see section
35019 &<<SECTmailstat>>&).
35020 .next
35021 .cindex "reject log"
35022 The reject log records information from messages that are rejected as a result
35023 of a configuration option (that is, for policy reasons).
35024 The first line of each rejection is a copy of the line that is also written to
35025 the main log. Then, if the message's header has been read at the time the log
35026 is written, its contents are written to this log. Only the original header
35027 lines are available; header lines added by ACLs are not logged. You can use the
35028 reject log to check that your policy controls are working correctly; on a busy
35029 host this may be easier than scanning the main log for rejection messages. You
35030 can suppress the writing of the reject log by setting &%write_rejectlog%&
35031 false.
35032 .next
35033 .cindex "panic log"
35034 .cindex "system log"
35035 When certain serious errors occur, Exim writes entries to its panic log. If the
35036 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35037 are usually written to the main log as well, but can get lost amid the mass of
35038 other entries. The panic log should be empty under normal circumstances. It is
35039 therefore a good idea to check it (or to have a &'cron'& script check it)
35040 regularly, in order to become aware of any problems. When Exim cannot open its
35041 panic log, it tries as a last resort to write to the system log (syslog). This
35042 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35043 message itself is written at priority LOG_CRIT.
35044 .endlist
35045
35046 Every log line starts with a timestamp, in the format shown in the following
35047 example. Note that many of the examples shown in this chapter are line-wrapped.
35048 In the log file, this would be all on one line:
35049 .code
35050 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35051   by QUIT
35052 .endd
35053 By default, the timestamps are in the local timezone. There are two
35054 ways of changing this:
35055
35056 .ilist
35057 You can set the &%timezone%& option to a different time zone; in particular, if
35058 you set
35059 .code
35060 timezone = UTC
35061 .endd
35062 the timestamps will be in UTC (aka GMT).
35063 .next
35064 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35065 example:
35066 .code
35067 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35068 .endd
35069 .endlist
35070
35071 .cindex "log" "process ids in"
35072 .cindex "pid (process id)" "in log lines"
35073 Exim does not include its process id in log lines by default, but you can
35074 request that it does so by specifying the &`pid`& log selector (see section
35075 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35076 brackets, immediately after the time and date.
35077
35078
35079
35080
35081 .section "Where the logs are written" "SECTwhelogwri"
35082 .cindex "log" "destination"
35083 .cindex "log" "to file"
35084 .cindex "log" "to syslog"
35085 .cindex "syslog"
35086 The logs may be written to local files, or to syslog, or both. However, it
35087 should be noted that many syslog implementations use UDP as a transport, and
35088 are therefore unreliable in the sense that messages are not guaranteed to
35089 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35090 It has also been reported that on large log files (tens of megabytes) you may
35091 need to tweak syslog to prevent it syncing the file with each write &-- on
35092 Linux this has been seen to make syslog take 90% plus of CPU time.
35093
35094 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35095 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35096 configuration. This latter string is expanded, so it can contain, for example,
35097 references to the host name:
35098 .code
35099 log_file_path = /var/log/$primary_hostname/exim_%slog
35100 .endd
35101 It is generally advisable, however, to set the string in &_Local/Makefile_&
35102 rather than at run time, because then the setting is available right from the
35103 start of Exim's execution. Otherwise, if there's something it wants to log
35104 before it has read the configuration file (for example, an error in the
35105 configuration file) it will not use the path you want, and may not be able to
35106 log at all.
35107
35108 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35109 list, currently limited to at most two items. This is one option where the
35110 facility for changing a list separator may not be used. The list must always be
35111 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35112 otherwise the item must either be an absolute path, containing &`%s`& at the
35113 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35114 implying the use of a default path.
35115
35116 When Exim encounters an empty item in the list, it searches the list defined by
35117 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35118 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35119 mean &"use the path specified at build time"&. It no such item exists, log
35120 files are written in the &_log_& subdirectory of the spool directory. This is
35121 equivalent to the setting:
35122 .code
35123 log_file_path = $spool_directory/log/%slog
35124 .endd
35125 If you do not specify anything at build time or run time,
35126 or if you unset the option at run time (i.e. &`log_file_path = `&),
35127 that is where the logs are written.
35128
35129 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35130 are in use &-- see section &<<SECTdatlogfil>>& below.
35131
35132 Here are some examples of possible settings:
35133 .display
35134 &`LOG_FILE_PATH=syslog                    `& syslog only
35135 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35136 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35137 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35138 .endd
35139 If there are more than two paths in the list, the first is used and a panic
35140 error is logged.
35141
35142
35143
35144 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35145 .cindex "log" "cycling local files"
35146 .cindex "cycling logs"
35147 .cindex "&'exicyclog'&"
35148 .cindex "log" "local files; writing to"
35149 Some operating systems provide centralized and standardized methods for cycling
35150 log files. For those that do not, a utility script called &'exicyclog'& is
35151 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35152 main and reject logs each time it is called. The maximum number of old logs to
35153 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35154
35155 An Exim delivery process opens the main log when it first needs to write to it,
35156 and it keeps the file open in case subsequent entries are required &-- for
35157 example, if a number of different deliveries are being done for the same
35158 message. However, remote SMTP deliveries can take a long time, and this means
35159 that the file may be kept open long after it is renamed if &'exicyclog'& or
35160 something similar is being used to rename log files on a regular basis. To
35161 ensure that a switch of log files is noticed as soon as possible, Exim calls
35162 &[stat()]& on the main log's name before reusing an open file, and if the file
35163 does not exist, or its inode has changed, the old file is closed and Exim
35164 tries to open the main log from scratch. Thus, an old log file may remain open
35165 for quite some time, but no Exim processes should write to it once it has been
35166 renamed.
35167
35168
35169
35170 .section "Datestamped log files" "SECTdatlogfil"
35171 .cindex "log" "datestamped files"
35172 Instead of cycling the main and reject log files by renaming them
35173 periodically, some sites like to use files whose names contain a datestamp,
35174 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35175 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35176 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35177 point where the datestamp is required. For example:
35178 .code
35179 log_file_path = /var/spool/exim/log/%slog-%D
35180 log_file_path = /var/log/exim-%s-%D.log
35181 log_file_path = /var/spool/exim/log/%D-%slog
35182 log_file_path = /var/log/exim/%s.%M
35183 .endd
35184 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35185 examples of names generated by the above examples:
35186 .code
35187 /var/spool/exim/log/mainlog-20021225
35188 /var/log/exim-reject-20021225.log
35189 /var/spool/exim/log/20021225-mainlog
35190 /var/log/exim/main.200212
35191 .endd
35192 When this form of log file is specified, Exim automatically switches to new
35193 files at midnight. It does not make any attempt to compress old logs; you
35194 will need to write your own script if you require this. You should not
35195 run &'exicyclog'& with this form of logging.
35196
35197 The location of the panic log is also determined by &%log_file_path%&, but it
35198 is not datestamped, because rotation of the panic log does not make sense.
35199 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35200 the string. In addition, if it immediately follows a slash, a following
35201 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35202 character is removed. Thus, the four examples above would give these panic
35203 log names:
35204 .code
35205 /var/spool/exim/log/paniclog
35206 /var/log/exim-panic.log
35207 /var/spool/exim/log/paniclog
35208 /var/log/exim/panic
35209 .endd
35210
35211
35212 .section "Logging to syslog" "SECID249"
35213 .cindex "log" "syslog; writing to"
35214 The use of syslog does not change what Exim logs or the format of its messages,
35215 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35216 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35217 that, the same strings are written to syslog as to log files. The syslog
35218 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35219 by default, but you can change these by setting the &%syslog_facility%& and
35220 &%syslog_processname%& options, respectively. If Exim was compiled with
35221 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35222 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35223 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35224 the time and host name to each line.
35225 The three log streams are mapped onto syslog priorities as follows:
35226
35227 .ilist
35228 &'mainlog'& is mapped to LOG_INFO
35229 .next
35230 &'rejectlog'& is mapped to LOG_NOTICE
35231 .next
35232 &'paniclog'& is mapped to LOG_ALERT
35233 .endlist
35234
35235 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35236 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35237 these are routed by syslog to the same place. You can suppress this duplication
35238 by setting &%syslog_duplication%& false.
35239
35240 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35241 entries contain multiple lines when headers are included. To cope with both
35242 these cases, entries written to syslog are split into separate &[syslog()]&
35243 calls at each internal newline, and also after a maximum of
35244 870 data characters. (This allows for a total syslog line length of 1024, when
35245 additions such as timestamps are added.) If you are running a syslog
35246 replacement that can handle lines longer than the 1024 characters allowed by
35247 RFC 3164, you should set
35248 .code
35249 SYSLOG_LONG_LINES=yes
35250 .endd
35251 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35252 lines, but it still splits at internal newlines in &'reject'& log entries.
35253
35254 To make it easy to re-assemble split lines later, each component of a split
35255 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35256 where <&'n'&> is the component number and <&'m'&> is the total number of
35257 components in the entry. The / delimiter is used when the line was split
35258 because it was too long; if it was split because of an internal newline, the \
35259 delimiter is used. For example, supposing the length limit to be 50 instead of
35260 870, the following would be the result of a typical rejection message to
35261 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35262 name, and pid as added by syslog:
35263 .code
35264 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35265 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35266 [3/5]  when scanning for sender: missing or malformed lo
35267 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35268 [5/5] mple>)
35269 .endd
35270 The same error might cause the following lines to be written to &"rejectlog"&
35271 (LOG_NOTICE):
35272 .code
35273 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35274 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35275 [3/18] er when scanning for sender: missing or malformed
35276 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35277 [5\18] .example>)
35278 [6\18] Recipients: ph10@some.domain.cam.example
35279 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35280 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35281 [9\18]        id 16RdAL-0006pc-00
35282 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35283 [11\18] 09:43 +0100
35284 [12\18] F From: <>
35285 [13\18]   Subject: this is a test header
35286 [18\18]   X-something: this is another header
35287 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35288 [16\18] le>
35289 [17\18] B Bcc:
35290 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35291 .endd
35292 Log lines that are neither too long nor contain newlines are written to syslog
35293 without modification.
35294
35295 If only syslog is being used, the Exim monitor is unable to provide a log tail
35296 display, unless syslog is routing &'mainlog'& to a file on the local host and
35297 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35298 where it is.
35299
35300
35301
35302 .section "Log line flags" "SECID250"
35303 One line is written to the main log for each message received, and for each
35304 successful, unsuccessful, and delayed delivery. These lines can readily be
35305 picked out by the distinctive two-character flags that immediately follow the
35306 timestamp. The flags are:
35307 .display
35308 &`<=`&     message arrival
35309 &`=>`&     normal message delivery
35310 &`->`&     additional address in same delivery
35311 &`>>`&     cutthrough message delivery
35312 &`*>`&     delivery suppressed by &%-N%&
35313 &`**`&     delivery failed; address bounced
35314 &`==`&     delivery deferred; temporary problem
35315 .endd
35316
35317
35318 .section "Logging message reception" "SECID251"
35319 .cindex "log" "reception line"
35320 The format of the single-line entry in the main log that is written for every
35321 message received is shown in the basic example below, which is split over
35322 several lines in order to fit it on the page:
35323 .code
35324 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35325   H=mailer.fict.example [192.168.123.123] U=exim
35326   P=smtp S=5678 id=<incoming message id>
35327 .endd
35328 The address immediately following &"<="& is the envelope sender address. A
35329 bounce message is shown with the sender address &"<>"&, and if it is locally
35330 generated, this is followed by an item of the form
35331 .code
35332 R=<message id>
35333 .endd
35334 which is a reference to the message that caused the bounce to be sent.
35335
35336 .cindex "HELO"
35337 .cindex "EHLO"
35338 For messages from other hosts, the H and U fields identify the remote host and
35339 record the RFC 1413 identity of the user that sent the message, if one was
35340 received. The number given in square brackets is the IP address of the sending
35341 host. If there is a single, unparenthesized  host name in the H field, as
35342 above, it has been verified to correspond to the IP address (see the
35343 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35344 by the remote host in the SMTP HELO or EHLO command, and has not been
35345 verified. If verification yields a different name to that given for HELO or
35346 EHLO, the verified name appears first, followed by the HELO or EHLO
35347 name in parentheses.
35348
35349 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35350 without brackets, in the HELO or EHLO command, leading to entries in
35351 the log containing text like these examples:
35352 .code
35353 H=(10.21.32.43) [192.168.8.34]
35354 H=([10.21.32.43]) [192.168.8.34]
35355 .endd
35356 This can be confusing. Only the final address in square brackets can be relied
35357 on.
35358
35359 For locally generated messages (that is, messages not received over TCP/IP),
35360 the H field is omitted, and the U field contains the login name of the caller
35361 of Exim.
35362
35363 .cindex "authentication" "logging"
35364 .cindex "AUTH" "logging"
35365 For all messages, the P field specifies the protocol used to receive the
35366 message. This is the value that is stored in &$received_protocol$&. In the case
35367 of incoming SMTP messages, the value indicates whether or not any SMTP
35368 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35369 session was encrypted, there is an additional X field that records the cipher
35370 suite that was used.
35371
35372 .cindex log protocol
35373 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35374 hosts that have authenticated themselves using the SMTP AUTH command. The first
35375 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35376 there is an additional item A= followed by the name of the authenticator that
35377 was used. If an authenticated identification was set up by the authenticator's
35378 &%server_set_id%& option, this is logged too, separated by a colon from the
35379 authenticator name.
35380
35381 .cindex "size" "of message"
35382 The id field records the existing message id, if present. The size of the
35383 received message is given by the S field. When the message is delivered,
35384 headers may be removed or added, so that the size of delivered copies of the
35385 message may not correspond with this value (and indeed may be different to each
35386 other).
35387
35388 The &%log_selector%& option can be used to request the logging of additional
35389 data when a message is received. See section &<<SECTlogselector>>& below.
35390
35391
35392
35393 .section "Logging deliveries" "SECID252"
35394 .cindex "log" "delivery line"
35395 The format of the single-line entry in the main log that is written for every
35396 delivery is shown in one of the examples below, for local and remote
35397 deliveries, respectively. Each example has been split into multiple lines in order
35398 to fit it on the page:
35399 .code
35400 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35401   <marv@hitch.fict.example> R=localuser T=local_delivery
35402 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35403   monk@holistic.fict.example R=dnslookup T=remote_smtp
35404   H=holistic.fict.example [192.168.234.234]
35405 .endd
35406 For ordinary local deliveries, the original address is given in angle brackets
35407 after the final delivery address, which might be a pipe or a file. If
35408 intermediate address(es) exist between the original and the final address, the
35409 last of these is given in parentheses after the final address. The R and T
35410 fields record the router and transport that were used to process the address.
35411
35412 If SMTP AUTH was used for the delivery there is an additional item A=
35413 followed by the name of the authenticator that was used.
35414 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35415 option, this is logged too, separated by a colon from the authenticator name.
35416
35417 If a shadow transport was run after a successful local delivery, the log line
35418 for the successful delivery has an item added on the end, of the form
35419 .display
35420 &`ST=<`&&'shadow transport name'&&`>`&
35421 .endd
35422 If the shadow transport did not succeed, the error message is put in
35423 parentheses afterwards.
35424
35425 .cindex "asterisk" "after IP address"
35426 When more than one address is included in a single delivery (for example, two
35427 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35428 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35429 down a single SMTP connection, an asterisk follows the IP address in the log
35430 lines for the second and subsequent messages.
35431
35432 .cindex "delivery" "cutthrough; logging"
35433 .cindex "cutthrough" "logging"
35434 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35435 line precedes the reception line, since cutthrough waits for a possible
35436 rejection from the destination in case it can reject the sourced item.
35437
35438 The generation of a reply message by a filter file gets logged as a
35439 &"delivery"& to the addressee, preceded by &">"&.
35440
35441 The &%log_selector%& option can be used to request the logging of additional
35442 data when a message is delivered. See section &<<SECTlogselector>>& below.
35443
35444
35445 .section "Discarded deliveries" "SECID253"
35446 .cindex "discarded messages"
35447 .cindex "message" "discarded"
35448 .cindex "delivery" "discarded; logging"
35449 When a message is discarded as a result of the command &"seen finish"& being
35450 obeyed in a filter file which generates no deliveries, a log entry of the form
35451 .code
35452 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35453   <low.club@bridge.example> R=userforward
35454 .endd
35455 is written, to record why no deliveries are logged. When a message is discarded
35456 because it is aliased to &":blackhole:"& the log line is like this:
35457 .code
35458 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35459   <hole@nowhere.example> R=blackhole_router
35460 .endd
35461
35462
35463 .section "Deferred deliveries" "SECID254"
35464 When a delivery is deferred, a line of the following form is logged:
35465 .code
35466 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35467   R=dnslookup T=smtp defer (146): Connection refused
35468 .endd
35469 In the case of remote deliveries, the error is the one that was given for the
35470 last IP address that was tried. Details of individual SMTP failures are also
35471 written to the log, so the above line would be preceded by something like
35472 .code
35473 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35474   mail1.endrest.example [192.168.239.239]: Connection refused
35475 .endd
35476 When a deferred address is skipped because its retry time has not been reached,
35477 a message is written to the log, but this can be suppressed by setting an
35478 appropriate value in &%log_selector%&.
35479
35480
35481
35482 .section "Delivery failures" "SECID255"
35483 .cindex "delivery" "failure; logging"
35484 If a delivery fails because an address cannot be routed, a line of the
35485 following form is logged:
35486 .code
35487 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35488   <jim@trek99.example>: unknown mail domain
35489 .endd
35490 If a delivery fails at transport time, the router and transport are shown, and
35491 the response from the remote host is included, as in this example:
35492 .code
35493 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35494   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35495   after pipelined RCPT TO:<ace400@pb.example>: host
35496   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35497   <ace400@pb.example>...Addressee unknown
35498 .endd
35499 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35500 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35501 disabling PIPELINING. The log lines for all forms of delivery failure are
35502 flagged with &`**`&.
35503
35504
35505
35506 .section "Fake deliveries" "SECID256"
35507 .cindex "delivery" "fake; logging"
35508 If a delivery does not actually take place because the &%-N%& option has been
35509 used to suppress it, a normal delivery line is written to the log, except that
35510 &"=>"& is replaced by &"*>"&.
35511
35512
35513
35514 .section "Completion" "SECID257"
35515 A line of the form
35516 .code
35517 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35518 .endd
35519 is written to the main log when a message is about to be removed from the spool
35520 at the end of its processing.
35521
35522
35523
35524
35525 .section "Summary of Fields in Log Lines" "SECID258"
35526 .cindex "log" "summary of fields"
35527 A summary of the field identifiers that are used in log lines is shown in
35528 the following table:
35529 .display
35530 &`A   `&        authenticator name (and optional id and sender)
35531 &`C   `&        SMTP confirmation on delivery
35532 &`    `&        command list for &"no mail in SMTP session"&
35533 &`CV  `&        certificate verification status
35534 &`D   `&        duration of &"no mail in SMTP session"&
35535 &`DN  `&        distinguished name from peer certificate
35536 &`DS  `&        DNSSEC secured lookups
35537 &`DT  `&        on &`=>`& lines: time taken for a delivery
35538 &`F   `&        sender address (on delivery lines)
35539 &`H   `&        host name and IP address
35540 &`I   `&        local interface used
35541 &`id  `&        message id for incoming message
35542 &`P   `&        on &`<=`& lines: protocol used
35543 &`    `&        on &`=>`& and &`**`& lines: return path
35544 &`PRX `&        on &'<='& and&`=>`& lines: proxy address
35545 &`QT  `&        on &`=>`& lines: time spent on queue so far
35546 &`    `&        on &"Completed"& lines: time spent on queue
35547 &`R   `&        on &`<=`& lines: reference for local bounce
35548 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
35549 &`S   `&        size of message in bytes
35550 &`SNI `&        server name indication from TLS client hello
35551 &`ST  `&        shadow transport name
35552 &`T   `&        on &`<=`& lines: message subject (topic)
35553 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35554 &`U   `&        local user or RFC 1413 identity
35555 &`X   `&        TLS cipher suite
35556 .endd
35557
35558
35559 .section "Other log entries" "SECID259"
35560 Various other types of log entry are written from time to time. Most should be
35561 self-explanatory. Among the more common are:
35562
35563 .ilist
35564 .cindex "retry" "time not reached"
35565 &'retry time not reached'&&~&~An address previously suffered a temporary error
35566 during routing or local delivery, and the time to retry has not yet arrived.
35567 This message is not written to an individual message log file unless it happens
35568 during the first delivery attempt.
35569 .next
35570 &'retry time not reached for any host'&&~&~An address previously suffered
35571 temporary errors during remote delivery, and the retry time has not yet arrived
35572 for any of the hosts to which it is routed.
35573 .next
35574 .cindex "spool directory" "file locked"
35575 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35576 some other Exim process is already working on the message. This can be quite
35577 common if queue running processes are started at frequent intervals. The
35578 &'exiwhat'& utility script can be used to find out what Exim processes are
35579 doing.
35580 .next
35581 .cindex "error" "ignored"
35582 &'error ignored'&&~&~There are several circumstances that give rise to this
35583 message:
35584 .olist
35585 Exim failed to deliver a bounce message whose age was greater than
35586 &%ignore_bounce_errors_after%&. The bounce was discarded.
35587 .next
35588 A filter file set up a delivery using the &"noerror"& option, and the delivery
35589 failed. The delivery was discarded.
35590 .next
35591 A delivery set up by a router configured with
35592 . ==== As this is a nested list, any displays it contains must be indented
35593 . ==== as otherwise they are too far to the left.
35594 .code
35595     errors_to = <>
35596 .endd
35597 failed. The delivery was discarded.
35598 .endlist olist
35599 .endlist ilist
35600
35601
35602
35603
35604
35605 .section "Reducing or increasing what is logged" "SECTlogselector"
35606 .cindex "log" "selectors"
35607 By setting the &%log_selector%& global option, you can disable some of Exim's
35608 default logging, or you can request additional logging. The value of
35609 &%log_selector%& is made up of names preceded by plus or minus characters. For
35610 example:
35611 .code
35612 log_selector = +arguments -retry_defer
35613 .endd
35614 The list of optional log items is in the following table, with the default
35615 selection marked by asterisks:
35616 .display
35617 &` 8bitmime                   `&  received 8BITMIME status
35618 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35619 &` address_rewrite            `&  address rewriting
35620 &` all_parents                `&  all parents in => lines
35621 &` arguments                  `&  command line arguments
35622 &`*connection_reject          `&  connection rejections
35623 &`*delay_delivery             `&  immediate delivery delayed
35624 &` deliver_time               `&  time taken to perform delivery
35625 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35626 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35627 &` dnssec                     `&  DNSSEC secured lookups
35628 &`*etrn                       `&  ETRN commands
35629 &`*host_lookup_failed         `&  as it says
35630 &` ident_timeout              `&  timeout for ident connection
35631 &` incoming_interface         `&  local interface on <= and => lines
35632 &` incoming_port              `&  remote port on <= lines
35633 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35634 &` outgoing_interface         `&  local interface on => lines
35635 &` outgoing_port              `&  add remote port to => lines
35636 &`*queue_run                  `&  start and end queue runs
35637 &` queue_time                 `&  time on queue for one recipient
35638 &` queue_time_overall         `&  time on queue for whole message
35639 &` pid                        `&  Exim process id
35640 &` proxy                      `&  proxy address on <= and => lines
35641 &` received_recipients        `&  recipients on <= lines
35642 &` received_sender            `&  sender on <= lines
35643 &`*rejected_header            `&  header contents on reject log
35644 &`*retry_defer                `&  &"retry time not reached"&
35645 &` return_path_on_delivery    `&  put return path on => and ** lines
35646 &` sender_on_delivery         `&  add sender to => lines
35647 &`*sender_verify_fail         `&  sender verification failures
35648 &`*size_reject                `&  rejection because too big
35649 &`*skip_delivery              `&  delivery skipped in a queue run
35650 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35651 &` smtp_connection            `&  incoming SMTP connections
35652 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35653 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35654 &` smtp_no_mail               `&  session with no MAIL commands
35655 &` smtp_protocol_error        `&  SMTP protocol errors
35656 &` smtp_syntax_error          `&  SMTP syntax errors
35657 &` subject                    `&  contents of &'Subject:'& on <= lines
35658 &`*tls_certificate_verified   `&  certificate verification status
35659 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35660 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35661 &` tls_sni                    `&  TLS SNI on <= lines
35662 &` unknown_in_list            `&  DNS lookup failed in list match
35663
35664 &` all                        `&  all of the above
35665 .endd
35666 See also the &%slow_lookup_log%& main configuration option,
35667 section &<<SECID99>>&
35668
35669 More details on each of these items follows:
35670
35671 .ilist
35672 .cindex "8BITMIME"
35673 .cindex "log" "8BITMIME"
35674 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35675 which may help in tracking down interoperability issues with ancient MTAs
35676 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35677 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35678 &`7BIT`& and &`8BITMIME`& respectively.
35679 .next
35680 .cindex "&%warn%& ACL verb" "log when skipping"
35681 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35682 its conditions cannot be evaluated, a log line to this effect is written if
35683 this log selector is set.
35684 .next
35685 .cindex "log" "rewriting"
35686 .cindex "rewriting" "logging"
35687 &%address_rewrite%&: This applies both to global rewrites and per-transport
35688 rewrites, but not to rewrites in filters run as an unprivileged user (because
35689 such users cannot access the log).
35690 .next
35691 .cindex "log" "full parentage"
35692 &%all_parents%&: Normally only the original and final addresses are logged on
35693 delivery lines; with this selector, intermediate parents are given in
35694 parentheses between them.
35695 .next
35696 .cindex "log" "Exim arguments"
35697 .cindex "Exim arguments, logging"
35698 &%arguments%&: This causes Exim to write the arguments with which it was called
35699 to the main log, preceded by the current working directory. This is a debugging
35700 feature, added to make it easier to find out how certain MUAs call
35701 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35702 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35703 that are empty or that contain white space are quoted. Non-printing characters
35704 are shown as escape sequences. This facility cannot log unrecognized arguments,
35705 because the arguments are checked before the configuration file is read. The
35706 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35707 between the caller and Exim.
35708 .next
35709 .cindex "log" "connection rejections"
35710 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35711 connection is rejected, for whatever reason.
35712 .next
35713 .cindex "log" "delayed delivery"
35714 .cindex "delayed delivery, logging"
35715 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35716 started for an incoming message because the load is too high or too many
35717 messages were received on one connection. Logging does not occur if no delivery
35718 process is started because &%queue_only%& is set or &%-odq%& was used.
35719 .next
35720 .cindex "log" "delivery duration"
35721 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35722 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35723 .next
35724 .cindex "log" "message size on delivery"
35725 .cindex "size" "of message"
35726 &%delivery_size%&: For each delivery, the size of message delivered is added to
35727 the &"=>"& line, tagged with S=.
35728 .next
35729 .cindex "log" "dnslist defer"
35730 .cindex "DNS list" "logging defer"
35731 .cindex "black list (DNS)"
35732 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35733 DNS black list suffers a temporary error.
35734 .next
35735 .cindex log dnssec
35736 .cindex dnssec logging
35737 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
35738 dns lookups gave secure results a tag of DS is added.
35739 For acceptance this covers the reverse and forward lookups for host name verification.
35740 It does not cover helo-name verification.
35741 For delivery this covers the SRV, MX, A and/or AAAA lookups.
35742 .next
35743 .cindex "log" "ETRN commands"
35744 .cindex "ETRN" "logging"
35745 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35746 is run to determine whether or not it is actually accepted. An invalid ETRN
35747 command, or one received within a message transaction is not logged by this
35748 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35749 .next
35750 .cindex "log" "host lookup failure"
35751 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35752 any addresses, or when a lookup of an IP address fails to find a host name, a
35753 log line is written. This logging does not apply to direct DNS lookups when
35754 routing email addresses, but it does apply to &"byname"& lookups.
35755 .next
35756 .cindex "log" "ident timeout"
35757 .cindex "RFC 1413" "logging timeout"
35758 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35759 client's ident port times out.
35760 .next
35761 .cindex "log" "incoming interface"
35762 .cindex "log" "local interface"
35763 .cindex "log" "local address and port"
35764 .cindex "TCP/IP" "logging local address and port"
35765 .cindex "interface" "logging"
35766 &%incoming_interface%&: The interface on which a message was received is added
35767 to the &"<="& line as an IP address in square brackets, tagged by I= and
35768 followed by a colon and the port number. The local interface and port are also
35769 added to other SMTP log lines, for example &"SMTP connection from"&, to
35770 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35771 The latter can be disabled by turning off the &%outgoing_interface%& option.
35772 .next
35773 .cindex log "incoming proxy address"
35774 .cindex proxy "logging proxy address"
35775 .cindex "TCP/IP" "logging proxy address"
35776 &%proxy%&: The internal (closest to the system running Exim) IP address
35777 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
35778 on a proxied connection
35779 or the &"=>"& line for a message delivered on a proxied connection..
35780 See &<<SECTproxyInbound>>& for more information.
35781 .next
35782 .cindex "log" "incoming remote port"
35783 .cindex "port" "logging remote"
35784 .cindex "TCP/IP" "logging incoming remote port"
35785 .vindex "&$sender_fullhost$&"
35786 .vindex "&$sender_rcvhost$&"
35787 &%incoming_port%&: The remote port number from which a message was received is
35788 added to log entries and &'Received:'& header lines, following the IP address
35789 in square brackets, and separated from it by a colon. This is implemented by
35790 changing the value that is put in the &$sender_fullhost$& and
35791 &$sender_rcvhost$& variables. Recording the remote port number has become more
35792 important with the widening use of NAT (see RFC 2505).
35793 .next
35794 .cindex "log" "dropped connection"
35795 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35796 connection is unexpectedly dropped.
35797 .next
35798 .cindex "log" "outgoing interface"
35799 .cindex "log" "local interface"
35800 .cindex "log" "local address and port"
35801 .cindex "TCP/IP" "logging local address and port"
35802 .cindex "interface" "logging"
35803 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35804 interface on which a message was sent is added to delivery lines as an I= tag
35805 followed by IP address in square brackets. You can disable this by turning
35806 off the &%outgoing_interface%& option.
35807 .next
35808 .cindex "log" "outgoing remote port"
35809 .cindex "port" "logging outgoint remote"
35810 .cindex "TCP/IP" "logging ougtoing remote port"
35811 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35812 containing => tags) following the IP address.
35813 The local port is also added if &%incoming_interface%& and
35814 &%outgoing_interface%& are both enabled.
35815 This option is not included in the default setting, because for most ordinary
35816 configurations, the remote port number is always 25 (the SMTP port), and the
35817 local port is a random ephemeral port.
35818 .next
35819 .cindex "log" "process ids in"
35820 .cindex "pid (process id)" "in log lines"
35821 &%pid%&: The current process id is added to every log line, in square brackets,
35822 immediately after the time and date.
35823 .next
35824 .cindex "log" "queue run"
35825 .cindex "queue runner" "logging"
35826 &%queue_run%&: The start and end of every queue run are logged.
35827 .next
35828 .cindex "log" "queue time"
35829 &%queue_time%&: The amount of time the message has been in the queue on the
35830 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35831 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35832 includes reception time as well as the delivery time for the current address.
35833 This means that it may be longer than the difference between the arrival and
35834 delivery log line times, because the arrival log line is not written until the
35835 message has been successfully received.
35836 .next
35837 &%queue_time_overall%&: The amount of time the message has been in the queue on
35838 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35839 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35840 message, so it includes reception time as well as the total delivery time.
35841 .next
35842 .cindex "log" "recipients"
35843 &%received_recipients%&: The recipients of a message are listed in the main log
35844 as soon as the message is received. The list appears at the end of the log line
35845 that is written when a message is received, preceded by the word &"for"&. The
35846 addresses are listed after they have been qualified, but before any rewriting
35847 has taken place.
35848 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35849 in the list.
35850 .next
35851 .cindex "log" "sender reception"
35852 &%received_sender%&: The unrewritten original sender of a message is added to
35853 the end of the log line that records the message's arrival, after the word
35854 &"from"& (before the recipients if &%received_recipients%& is also set).
35855 .next
35856 .cindex "log" "header lines for rejection"
35857 &%rejected_header%&: If a message's header has been received at the time a
35858 rejection is written to the reject log, the complete header is added to the
35859 log. Header logging can be turned off individually for messages that are
35860 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35861 .next
35862 .cindex "log" "retry defer"
35863 &%retry_defer%&: A log line is written if a delivery is deferred because a
35864 retry time has not yet been reached. However, this &"retry time not reached"&
35865 message is always omitted from individual message logs after the first delivery
35866 attempt.
35867 .next
35868 .cindex "log" "return path"
35869 &%return_path_on_delivery%&: The return path that is being transmitted with
35870 the message is included in delivery and bounce lines, using the tag P=.
35871 This is omitted if no delivery actually happens, for example, if routing fails,
35872 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35873 .next
35874 .cindex "log" "sender on delivery"
35875 &%sender_on_delivery%&: The message's sender address is added to every delivery
35876 and bounce line, tagged by F= (for &"from"&).
35877 This is the original sender that was received with the message; it is not
35878 necessarily the same as the outgoing return path.
35879 .next
35880 .cindex "log" "sender verify failure"
35881 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35882 gives details of a sender verification failure is not written. Log lines for
35883 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35884 detail is lost.
35885 .next
35886 .cindex "log" "size rejection"
35887 &%size_reject%&: A log line is written whenever a message is rejected because
35888 it is too big.
35889 .next
35890 .cindex "log" "frozen messages; skipped"
35891 .cindex "frozen messages" "logging skipping"
35892 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35893 queue run because it is frozen or because another process is already delivering
35894 it.
35895 .cindex "&""spool file is locked""&"
35896 The message that is written is &"spool file is locked"&.
35897 .next
35898 .cindex "log" "smtp confirmation"
35899 .cindex "SMTP" "logging confirmation"
35900 .cindex "LMTP" "logging confirmation"
35901 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35902 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35903 A number of MTAs (including Exim) return an identifying string in this
35904 response.
35905 .next
35906 .cindex "log" "SMTP connections"
35907 .cindex "SMTP" "logging connections"
35908 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
35909 established or closed, unless the connection is from a host that matches
35910 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35911 only when the closure is unexpected.) This applies to connections from local
35912 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35913 dropped in the middle of a message, a log line is always written, whether or
35914 not this selector is set, but otherwise nothing is written at the start and end
35915 of connections unless this selector is enabled.
35916
35917 For TCP/IP connections to an Exim daemon, the current number of connections is
35918 included in the log message for each new connection, but note that the count is
35919 reset if the daemon is restarted.
35920 Also, because connections are closed (and the closure is logged) in
35921 subprocesses, the count may not include connections that have been closed but
35922 whose termination the daemon has not yet noticed. Thus, while it is possible to
35923 match up the opening and closing of connections in the log, the value of the
35924 logged counts may not be entirely accurate.
35925 .next
35926 .cindex "log" "SMTP transaction; incomplete"
35927 .cindex "SMTP" "logging incomplete transactions"
35928 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35929 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35930 and the message sender plus any accepted recipients are included in the log
35931 line. This can provide evidence of dictionary attacks.
35932 .next
35933 .cindex "log" "non-MAIL SMTP sessions"
35934 .cindex "MAIL" "logging session without"
35935 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35936 connection terminates without having issued a MAIL command. This includes both
35937 the case when the connection is dropped, and the case when QUIT is used. It
35938 does not include cases where the connection is rejected right at the start (by
35939 an ACL, or because there are too many connections, or whatever). These cases
35940 already have their own log lines.
35941
35942 The log line that is written contains the identity of the client in the usual
35943 way, followed by D= and a time, which records the duration of the connection.
35944 If the connection was authenticated, this fact is logged exactly as it is for
35945 an incoming message, with an A= item. If the connection was encrypted, CV=,
35946 DN=, and X= items may appear as they do for an incoming message, controlled by
35947 the same logging options.
35948
35949 Finally, if any SMTP commands were issued during the connection, a C= item
35950 is added to the line, listing the commands that were used. For example,
35951 .code
35952 C=EHLO,QUIT
35953 .endd
35954 shows that the client issued QUIT straight after EHLO. If there were fewer
35955 than 20 commands, they are all listed. If there were more than 20 commands,
35956 the last 20 are listed, preceded by &"..."&. However, with the default
35957 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
35958 have been aborted before 20 non-mail commands are processed.
35959 .next
35960 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35961 colon-separated, is appended to the A= item for a message arrival or delivery
35962 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35963 was accepted or used.
35964 .next
35965 .cindex "log" "SMTP protocol error"
35966 .cindex "SMTP" "logging protocol error"
35967 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35968 encountered. Exim does not have perfect detection of all protocol errors
35969 because of transmission delays and the use of pipelining. If PIPELINING has
35970 been advertised to a client, an Exim server assumes that the client will use
35971 it, and therefore it does not count &"expected"& errors (for example, RCPT
35972 received after rejecting MAIL) as protocol errors.
35973 .next
35974 .cindex "SMTP" "logging syntax errors"
35975 .cindex "SMTP" "syntax errors; logging"
35976 .cindex "SMTP" "unknown command; logging"
35977 .cindex "log" "unknown SMTP command"
35978 .cindex "log" "SMTP syntax error"
35979 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35980 encountered. An unrecognized command is treated as a syntax error. For an
35981 external connection, the host identity is given; for an internal connection
35982 using &%-bs%& the sender identification (normally the calling user) is given.
35983 .next
35984 .cindex "log" "subject"
35985 .cindex "subject, logging"
35986 &%subject%&: The subject of the message is added to the arrival log line,
35987 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35988 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35989 specifies whether characters with values greater than 127 should be logged
35990 unchanged, or whether they should be rendered as escape sequences.
35991 .next
35992 .cindex "log" "certificate verification"
35993 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35994 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35995 verified, and &`CV=no`& if not.
35996 .next
35997 .cindex "log" "TLS cipher"
35998 .cindex "TLS" "logging cipher"
35999 &%tls_cipher%&: When a message is sent or received over an encrypted
36000 connection, the cipher suite used is added to the log line, preceded by X=.
36001 .next
36002 .cindex "log" "TLS peer DN"
36003 .cindex "TLS" "logging peer DN"
36004 &%tls_peerdn%&: When a message is sent or received over an encrypted
36005 connection, and a certificate is supplied by the remote host, the peer DN is
36006 added to the log line, preceded by DN=.
36007 .next
36008 .cindex "log" "TLS SNI"
36009 .cindex "TLS" "logging SNI"
36010 &%tls_sni%&: When a message is received over an encrypted connection, and
36011 the remote host provided the Server Name Indication extension, the SNI is
36012 added to the log line, preceded by SNI=.
36013 .next
36014 .cindex "log" "DNS failure in list"
36015 &%unknown_in_list%&: This setting causes a log entry to be written when the
36016 result of a list match is failure because a DNS lookup failed.
36017 .endlist
36018
36019
36020 .section "Message log" "SECID260"
36021 .cindex "message" "log file for"
36022 .cindex "log" "message log; description of"
36023 .cindex "&_msglog_& directory"
36024 .oindex "&%preserve_message_logs%&"
36025 In addition to the general log files, Exim writes a log file for each message
36026 that it handles. The names of these per-message logs are the message ids, and
36027 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36028 message log contains copies of the log lines that apply to the message. This
36029 makes it easier to inspect the status of an individual message without having
36030 to search the main log. A message log is deleted when processing of the message
36031 is complete, unless &%preserve_message_logs%& is set, but this should be used
36032 only with great care because they can fill up your disk very quickly.
36033
36034 On a heavily loaded system, it may be desirable to disable the use of
36035 per-message logs, in order to reduce disk I/O. This can be done by setting the
36036 &%message_logs%& option false.
36037 .ecindex IIDloggen
36038
36039
36040
36041
36042 . ////////////////////////////////////////////////////////////////////////////
36043 . ////////////////////////////////////////////////////////////////////////////
36044
36045 .chapter "Exim utilities" "CHAPutils"
36046 .scindex IIDutils "utilities"
36047 A number of utility scripts and programs are supplied with Exim and are
36048 described in this chapter. There is also the Exim Monitor, which is covered in
36049 the next chapter. The utilities described here are:
36050
36051 .itable none 0 0 3  7* left  15* left  40* left
36052 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36053   "list what Exim processes are doing"
36054 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36055 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36056 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36057 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36058                                                 various criteria"
36059 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36060 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36061   "extract statistics from the log"
36062 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36063   "check address acceptance from given IP"
36064 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36065 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36066 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36067 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36068 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36069 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36070 .endtable
36071
36072 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36073 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36074 &url(http://duncanthrax.net/exilog/) for details.
36075
36076
36077
36078
36079 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36080 .cindex "&'exiwhat'&"
36081 .cindex "process, querying"
36082 .cindex "SIGUSR1"
36083 On operating systems that can restart a system call after receiving a signal
36084 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36085 a line describing what it is doing to the file &_exim-process.info_& in the
36086 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36087 processes it can find, having first emptied the file. It then waits for one
36088 second to allow the Exim processes to react before displaying the results. In
36089 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36090 send the signal to the Exim processes, so it is normally run as root.
36091
36092 &*Warning*&: This is not an efficient process. It is intended for occasional
36093 use by system administrators. It is not sensible, for example, to set up a
36094 script that sends SIGUSR1 signals to Exim processes at short intervals.
36095
36096
36097 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36098 varies in different operating systems. Not only are different options used,
36099 but the format of the output is different. For this reason, there are some
36100 system configuration options that configure exactly how &'exiwhat'& works. If
36101 it doesn't seem to be working for you, check the following compile-time
36102 options:
36103 .display
36104 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36105 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36106 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36107 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36108 .endd
36109 An example of typical output from &'exiwhat'& is
36110 .code
36111 164 daemon: -q1h, listening on port 25
36112 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36113 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36114   [10.19.42.42] (editor@ref.example)
36115 10592 handling incoming call from [192.168.243.242]
36116 10628 accepting a local non-SMTP message
36117 .endd
36118 The first number in the output line is the process number. The third line has
36119 been split here, in order to fit it on the page.
36120
36121
36122
36123 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36124 .cindex "&'exiqgrep'&"
36125 .cindex "queue" "grepping"
36126 This utility is a Perl script contributed by Matt Hubbard. It runs
36127 .code
36128 exim -bpu
36129 .endd
36130 or (in case &*-a*& switch is specified)
36131 .code
36132 exim -bp
36133 .endd
36134 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36135 contain alternate exim configuration the queue management might be using.
36136
36137 to obtain a queue listing, and then greps the output to select messages
36138 that match given criteria. The following selection options are available:
36139
36140 .vlist
36141 .vitem &*-f*&&~<&'regex'&>
36142 Match the sender address using a case-insensitive search. The field that is
36143 tested is enclosed in angle brackets, so you can test for bounce messages with
36144 .code
36145 exiqgrep -f '^<>$'
36146 .endd
36147 .vitem &*-r*&&~<&'regex'&>
36148 Match a recipient address using a case-insensitive search. The field that is
36149 tested is not enclosed in angle brackets.
36150
36151 .vitem &*-s*&&~<&'regex'&>
36152 Match against the size field.
36153
36154 .vitem &*-y*&&~<&'seconds'&>
36155 Match messages that are younger than the given time.
36156
36157 .vitem &*-o*&&~<&'seconds'&>
36158 Match messages that are older than the given time.
36159
36160 .vitem &*-z*&
36161 Match only frozen messages.
36162
36163 .vitem &*-x*&
36164 Match only non-frozen messages.
36165 .endlist
36166
36167 The following options control the format of the output:
36168
36169 .vlist
36170 .vitem &*-c*&
36171 Display only the count of matching messages.
36172
36173 .vitem &*-l*&
36174 Long format &-- display the full message information as output by Exim. This is
36175 the default.
36176
36177 .vitem &*-i*&
36178 Display message ids only.
36179
36180 .vitem &*-b*&
36181 Brief format &-- one line per message.
36182
36183 .vitem &*-R*&
36184 Display messages in reverse order.
36185
36186 .vitem &*-a*&
36187 Include delivered recipients in queue listing.
36188 .endlist
36189
36190 There is one more option, &%-h%&, which outputs a list of options.
36191
36192
36193
36194 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36195 .cindex "&'exiqsumm'&"
36196 .cindex "queue" "summary"
36197 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36198 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36199 running a command such as
36200 .code
36201 exim -bp | exiqsumm
36202 .endd
36203 The output consists of one line for each domain that has messages waiting for
36204 it, as in the following example:
36205 .code
36206 3   2322   74m   66m  msn.com.example
36207 .endd
36208 Each line lists the number of pending deliveries for a domain, their total
36209 volume, and the length of time that the oldest and the newest messages have
36210 been waiting. Note that the number of pending deliveries is greater than the
36211 number of messages when messages have more than one recipient.
36212
36213 A summary line is output at the end. By default the output is sorted on the
36214 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36215 the output to be sorted by oldest message and by count of messages,
36216 respectively. There are also three options that split the messages for each
36217 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36218 separates frozen messages, and &%-s%& separates messages according to their
36219 sender.
36220
36221 The output of &'exim -bp'& contains the original addresses in the message, so
36222 this also applies to the output from &'exiqsumm'&. No domains from addresses
36223 generated by aliasing or forwarding are included (unless the &%one_time%&
36224 option of the &(redirect)& router has been used to convert them into &"top
36225 level"& addresses).
36226
36227
36228
36229
36230 .section "Extracting specific information from the log (exigrep)" &&&
36231          "SECTextspeinf"
36232 .cindex "&'exigrep'&"
36233 .cindex "log" "extracts; grepping for"
36234 The &'exigrep'& utility is a Perl script that searches one or more main log
36235 files for entries that match a given pattern. When it finds a match, it
36236 extracts all the log entries for the relevant message, not just those that
36237 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36238 given message, or all mail for a given user, or for a given host, for example.
36239 The input files can be in Exim log format or syslog format.
36240 If a matching log line is not associated with a specific message, it is
36241 included in &'exigrep'&'s output without any additional lines. The usage is:
36242 .display
36243 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36244 .endd
36245 If no log file names are given on the command line, the standard input is read.
36246
36247 The &%-t%& argument specifies a number of seconds. It adds an additional
36248 condition for message selection. Messages that are complete are shown only if
36249 they spent more than <&'n'&> seconds on the queue.
36250
36251 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36252 makes it case-sensitive. This may give a performance improvement when searching
36253 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36254 option; with &%-I%& they do not. In both cases it is possible to change the
36255 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36256
36257 The &%-l%& option means &"literal"&, that is, treat all characters in the
36258 pattern as standing for themselves. Otherwise the pattern must be a Perl
36259 regular expression.
36260
36261 The &%-v%& option inverts the matching condition. That is, a line is selected
36262 if it does &'not'& match the pattern.
36263
36264 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36265 that are generated as a result/response to a message that &'exigrep'& matched
36266 normally.
36267
36268 Example of &%-M%&:
36269 user_a sends a message to user_b, which generates a bounce back to user_b. If
36270 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36271 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36272 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36273 when searching for &"user_a"& will show both messages since the bounce is
36274 &"related"& to or a &"result"& of the first message that was found by the
36275 search term.
36276
36277 If the location of a &'zcat'& command is known from the definition of
36278 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36279 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36280 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36281 autodetection of some well known compression extensions.
36282
36283
36284 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36285 .cindex "&'exipick'&"
36286 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36287 lists messages from the queue according to a variety of criteria. For details
36288 of &'exipick'&'s facilities, visit the web page at
36289 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36290 the &%--help%& option.
36291
36292
36293 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36294 .cindex "log" "cycling local files"
36295 .cindex "cycling logs"
36296 .cindex "&'exicyclog'&"
36297 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36298 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36299 you are using log files with datestamps in their names (see section
36300 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36301 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36302 There are two command line options for &'exicyclog'&:
36303 .ilist
36304 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36305 default that is set when Exim is built. The default default is 10.
36306 .next
36307 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36308 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36309 overriding the script's default, which is to find the setting from Exim's
36310 configuration.
36311 .endlist
36312
36313 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36314 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36315 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36316 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36317 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36318 logs are handled similarly.
36319
36320 If the limit is greater than 99, the script uses 3-digit numbers such as
36321 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36322 to one that is greater, or &'vice versa'&, you will have to fix the names of
36323 any existing log files.
36324
36325 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36326 the end are deleted. All files with numbers greater than 01 are compressed,
36327 using a compression command which is configured by the COMPRESS_COMMAND
36328 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36329 root &%crontab%& entry of the form
36330 .code
36331 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36332 .endd
36333 assuming you have used the name &"exim"& for the Exim user. You can run
36334 &'exicyclog'& as root if you wish, but there is no need.
36335
36336
36337
36338 .section "Mail statistics (eximstats)" "SECTmailstat"
36339 .cindex "statistics"
36340 .cindex "&'eximstats'&"
36341 A Perl script called &'eximstats'& is provided for extracting statistical
36342 information from log files. The output is either plain text, or HTML.
36343 Exim log files are also supported by the &'Lire'& system produced by the
36344 LogReport Foundation &url(http://www.logreport.org).
36345
36346 The &'eximstats'& script has been hacked about quite a bit over time. The
36347 latest version is the result of some extensive revision by Steve Campbell. A
36348 lot of information is given by default, but there are options for suppressing
36349 various parts of it. Following any options, the arguments to the script are a
36350 list of files, which should be main log files. For example:
36351 .code
36352 eximstats -nr /var/spool/exim/log/mainlog.01
36353 .endd
36354 By default, &'eximstats'& extracts information about the number and volume of
36355 messages received from or delivered to various hosts. The information is sorted
36356 both by message count and by volume, and the top fifty hosts in each category
36357 are listed on the standard output. Similar information, based on email
36358 addresses or domains instead of hosts can be requested by means of various
36359 options. For messages delivered and received locally, similar statistics are
36360 also produced per user.
36361
36362 The output also includes total counts and statistics about delivery errors, and
36363 histograms showing the number of messages received and deliveries made in each
36364 hour of the day. A delivery with more than one address in its envelope (for
36365 example, an SMTP transaction with more than one RCPT command) is counted
36366 as a single delivery by &'eximstats'&.
36367
36368 Though normally more deliveries than receipts are reported (as messages may
36369 have multiple recipients), it is possible for &'eximstats'& to report more
36370 messages received than delivered, even though the queue is empty at the start
36371 and end of the period in question. If an incoming message contains no valid
36372 recipients, no deliveries are recorded for it. A bounce message is handled as
36373 an entirely separate message.
36374
36375 &'eximstats'& always outputs a grand total summary giving the volume and number
36376 of messages received and deliveries made, and the number of hosts involved in
36377 each case. It also outputs the number of messages that were delayed (that is,
36378 not completely delivered at the first attempt), and the number that had at
36379 least one address that failed.
36380
36381 The remainder of the output is in sections that can be independently disabled
36382 or modified by various options. It consists of a summary of deliveries by
36383 transport, histograms of messages received and delivered per time interval
36384 (default per hour), information about the time messages spent on the queue,
36385 a list of relayed messages, lists of the top fifty sending hosts, local
36386 senders, destination hosts, and destination local users by count and by volume,
36387 and a list of delivery errors that occurred.
36388
36389 The relay information lists messages that were actually relayed, that is, they
36390 came from a remote host and were directly delivered to some other remote host,
36391 without being processed (for example, for aliasing or forwarding) locally.
36392
36393 There are quite a few options for &'eximstats'& to control exactly what it
36394 outputs. These are documented in the Perl script itself, and can be extracted
36395 by running the command &(perldoc)& on the script. For example:
36396 .code
36397 perldoc /usr/exim/bin/eximstats
36398 .endd
36399
36400 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36401 .cindex "&'exim_checkaccess'&"
36402 .cindex "policy control" "checking access"
36403 .cindex "checking access"
36404 The &%-bh%& command line argument allows you to run a fake SMTP session with
36405 debugging output, in order to check what Exim is doing when it is applying
36406 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36407 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36408 sometimes you just want to answer the question &"Does this address have
36409 access?"& without bothering with any further details.
36410
36411 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36412 two arguments, an IP address and an email address:
36413 .code
36414 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36415 .endd
36416 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36417 given email address would be accepted in a RCPT command in a TCP/IP
36418 connection from the host with the given IP address. The output of the utility
36419 is either the word &"accepted"&, or the SMTP error response, for example:
36420 .code
36421 Rejected:
36422 550 Relay not permitted
36423 .endd
36424 When running this test, the utility uses &`<>`& as the envelope sender address
36425 for the MAIL command, but you can change this by providing additional
36426 options. These are passed directly to the Exim command. For example, to specify
36427 that the test is to be run with the sender address &'himself@there.example'&
36428 you can use:
36429 .code
36430 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36431                  -f himself@there.example
36432 .endd
36433 Note that these additional Exim command line items must be given after the two
36434 mandatory arguments.
36435
36436 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36437 while running its checks. You can run checks that include callouts by using
36438 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36439
36440
36441
36442 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36443 .cindex "DBM" "building dbm files"
36444 .cindex "building DBM files"
36445 .cindex "&'exim_dbmbuild'&"
36446 .cindex "lower casing"
36447 .cindex "binary zero" "in lookup key"
36448 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36449 the format used by the &(lsearch)& lookup (see section
36450 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36451 names as keys and the remainder of the information as data. The lower-casing
36452 can be prevented by calling the program with the &%-nolc%& option.
36453
36454 A terminating zero is included as part of the key string. This is expected by
36455 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36456 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36457 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36458 files.
36459
36460 The program requires two arguments: the name of the input file (which can be a
36461 single hyphen to indicate the standard input), and the name of the output file.
36462 It creates the output under a temporary name, and then renames it if all went
36463 well.
36464
36465 .cindex "USE_DB"
36466 If the native DB interface is in use (USE_DB is set in a compile-time
36467 configuration file &-- this is common in free versions of Unix) the two file
36468 names must be different, because in this mode the Berkeley DB functions create
36469 a single output file using exactly the name given. For example,
36470 .code
36471 exim_dbmbuild /etc/aliases /etc/aliases.db
36472 .endd
36473 reads the system alias file and creates a DBM version of it in
36474 &_/etc/aliases.db_&.
36475
36476 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36477 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36478 environment, the suffixes are added to the second argument of
36479 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36480 when the Berkeley functions are used in compatibility mode (though this is not
36481 recommended), because in that case it adds a &_.db_& suffix to the file name.
36482
36483 If a duplicate key is encountered, the program outputs a warning, and when it
36484 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36485 option is used. By default, only the first of a set of duplicates is used &--
36486 this makes it compatible with &(lsearch)& lookups. There is an option
36487 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36488 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36489 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36490 return code is 2.
36491
36492
36493
36494
36495 .section "Finding individual retry times (exinext)" "SECTfinindret"
36496 .cindex "retry" "times"
36497 .cindex "&'exinext'&"
36498 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36499 fish specific information out of the retry database. Given a mail domain (or a
36500 complete address), it looks up the hosts for that domain, and outputs any retry
36501 information for the hosts or for the domain. At present, the retry information
36502 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36503 output. For example:
36504 .code
36505 $ exinext piglet@milne.fict.example
36506 kanga.milne.example:192.168.8.1 error 146: Connection refused
36507   first failed: 21-Feb-1996 14:57:34
36508   last tried:   21-Feb-1996 14:57:34
36509   next try at:  21-Feb-1996 15:02:34
36510 roo.milne.example:192.168.8.3 error 146: Connection refused
36511   first failed: 20-Jan-1996 13:12:08
36512   last tried:   21-Feb-1996 11:42:03
36513   next try at:  21-Feb-1996 19:42:03
36514   past final cutoff time
36515 .endd
36516 You can also give &'exinext'& a local part, without a domain, and it
36517 will give any retry information for that local part in your default domain.
36518 A message id can be used to obtain retry information pertaining to a specific
36519 message. This exists only when an attempt to deliver a message to a remote host
36520 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36521 &'exinext'& is not particularly efficient, but then it is not expected to be
36522 run very often.
36523
36524 The &'exinext'& utility calls Exim to find out information such as the location
36525 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36526 passed on to the &'exim'& commands. The first specifies an alternate Exim
36527 configuration file, and the second sets macros for use within the configuration
36528 file. These features are mainly to help in testing, but might also be useful in
36529 environments where more than one configuration file is in use.
36530
36531
36532
36533 .section "Hints database maintenance" "SECThindatmai"
36534 .cindex "hints database" "maintenance"
36535 .cindex "maintaining Exim's hints database"
36536 Three utility programs are provided for maintaining the DBM files that Exim
36537 uses to contain its delivery hint information. Each program requires two
36538 arguments. The first specifies the name of Exim's spool directory, and the
36539 second is the name of the database it is to operate on. These are as follows:
36540
36541 .ilist
36542 &'retry'&: the database of retry information
36543 .next
36544 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36545 for remote hosts
36546 .next
36547 &'callout'&: the callout cache
36548 .next
36549 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36550 .next
36551 &'misc'&: other hints data
36552 .endlist
36553
36554 The &'misc'& database is used for
36555
36556 .ilist
36557 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36558 .next
36559 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36560 &(smtp)& transport)
36561 .next
36562 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36563 in a transport)
36564 .endlist
36565
36566
36567
36568 .section "exim_dumpdb" "SECID261"
36569 .cindex "&'exim_dumpdb'&"
36570 The entire contents of a database are written to the standard output by the
36571 &'exim_dumpdb'& program, which has no options or arguments other than the
36572 spool and database names. For example, to dump the retry database:
36573 .code
36574 exim_dumpdb /var/spool/exim retry
36575 .endd
36576 Two lines of output are produced for each entry:
36577 .code
36578 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36579 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36580 .endd
36581 The first item on the first line is the key of the record. It starts with one
36582 of the letters R, or T, depending on whether it refers to a routing or
36583 transport retry. For a local delivery, the next part is the local address; for
36584 a remote delivery it is the name of the remote host, followed by its failing IP
36585 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36586 transport). If the remote port is not the standard one (port 25), it is added
36587 to the IP address. Then there follows an error code, an additional error code,
36588 and a textual description of the error.
36589
36590 The three times on the second line are the time of first failure, the time of
36591 the last delivery attempt, and the computed time for the next attempt. The line
36592 ends with an asterisk if the cutoff time for the last retry rule has been
36593 exceeded.
36594
36595 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36596 consists of a host name followed by a list of ids for messages that are or were
36597 waiting to be delivered to that host. If there are a very large number for any
36598 one host, continuation records, with a sequence number added to the host name,
36599 may be seen. The data in these records is often out of date, because a message
36600 may be routed to several alternative hosts, and Exim makes no effort to keep
36601 cross-references.
36602
36603
36604
36605 .section "exim_tidydb" "SECID262"
36606 .cindex "&'exim_tidydb'&"
36607 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36608 database. If run with no options, it removes all records that are more than 30
36609 days old. The age is calculated from the date and time that the record was last
36610 updated. Note that, in the case of the retry database, it is &'not'& the time
36611 since the first delivery failure. Information about a host that has been down
36612 for more than 30 days will remain in the database, provided that the record is
36613 updated sufficiently often.
36614
36615 The cutoff date can be altered by means of the &%-t%& option, which must be
36616 followed by a time. For example, to remove all records older than a week from
36617 the retry database:
36618 .code
36619 exim_tidydb -t 7d /var/spool/exim retry
36620 .endd
36621 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36622 message ids. In the former these appear as data in records keyed by host &--
36623 they were messages that were waiting for that host &-- and in the latter they
36624 are the keys for retry information for messages that have suffered certain
36625 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36626 message ids in database records are those of messages that are still on the
36627 queue. Message ids for messages that no longer exist are removed from
36628 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36629 For the &'retry'& database, records whose keys are non-existent message ids are
36630 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36631 whenever it removes information from the database.
36632
36633 Certain records are automatically removed by Exim when they are no longer
36634 needed, but others are not. For example, if all the MX hosts for a domain are
36635 down, a retry record is created for each one. If the primary MX host comes back
36636 first, its record is removed when Exim successfully delivers to it, but the
36637 records for the others remain because Exim has not tried to use those hosts.
36638
36639 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36640 hints databases. You should do this at a quiet time of day, because it requires
36641 a database to be locked (and therefore inaccessible to Exim) while it does its
36642 work. Removing records from a DBM file does not normally make the file smaller,
36643 but all the common DBM libraries are able to re-use the space that is released.
36644 After an initial phase of increasing in size, the databases normally reach a
36645 point at which they no longer get any bigger, as long as they are regularly
36646 tidied.
36647
36648 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36649 databases is likely to keep on increasing.
36650
36651
36652
36653
36654 .section "exim_fixdb" "SECID263"
36655 .cindex "&'exim_fixdb'&"
36656 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36657 Its main use is for testing Exim, but it might also be occasionally useful for
36658 getting round problems in a live system. It has no options, and its interface
36659 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36660 key of a database record can then be entered, and the data for that record is
36661 displayed.
36662
36663 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36664 except the &'retry'& database, that is the only operation that can be carried
36665 out. For the &'retry'& database, each field is output preceded by a number, and
36666 data for individual fields can be changed by typing the field number followed
36667 by new data, for example:
36668 .code
36669 > 4 951102:1000
36670 .endd
36671 resets the time of the next delivery attempt. Time values are given as a
36672 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36673 used as optional separators.
36674
36675
36676
36677
36678 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36679 .cindex "mailbox" "maintenance"
36680 .cindex "&'exim_lock'&"
36681 .cindex "locking mailboxes"
36682 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36683 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36684 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36685 a user agent while investigating a problem. The utility requires the name of
36686 the file as its first argument. If the locking is successful, the second
36687 argument is run as a command (using C's &[system()]& function); if there is no
36688 second argument, the value of the SHELL environment variable is used; if this
36689 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36690 is unlocked and the utility ends. The following options are available:
36691
36692 .vlist
36693 .vitem &%-fcntl%&
36694 Use &[fcntl()]& locking on the open mailbox.
36695
36696 .vitem &%-flock%&
36697 Use &[flock()]& locking on the open mailbox, provided the operating system
36698 supports it.
36699
36700 .vitem &%-interval%&
36701 This must be followed by a number, which is a number of seconds; it sets the
36702 interval to sleep between retries (default 3).
36703
36704 .vitem &%-lockfile%&
36705 Create a lock file before opening the mailbox.
36706
36707 .vitem &%-mbx%&
36708 Lock the mailbox using MBX rules.
36709
36710 .vitem &%-q%&
36711 Suppress verification output.
36712
36713 .vitem &%-retries%&
36714 This must be followed by a number; it sets the number of times to try to get
36715 the lock (default 10).
36716
36717 .vitem &%-restore_time%&
36718 This option causes &%exim_lock%& to restore the modified and read times to the
36719 locked file before exiting. This allows you to access a locked mailbox (for
36720 example, to take a backup copy) without disturbing the times that the user
36721 subsequently sees.
36722
36723 .vitem &%-timeout%&
36724 This must be followed by a number, which is a number of seconds; it sets a
36725 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36726 default), a non-blocking call is used.
36727
36728 .vitem &%-v%&
36729 Generate verbose output.
36730 .endlist
36731
36732 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36733 default is to create a lock file and also to use &[fcntl()]& locking on the
36734 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36735 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36736 requires that the directory containing the file be writeable. Locking by lock
36737 file does not last for ever; Exim assumes that a lock file is expired if it is
36738 more than 30 minutes old.
36739
36740 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36741 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36742 to be taken out on the open mailbox, and an exclusive lock on the file
36743 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36744 number of the mailbox file. When the locking is released, if an exclusive lock
36745 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36746
36747 The default output contains verification of the locking that takes place. The
36748 &%-v%& option causes some additional information to be given. The &%-q%& option
36749 suppresses all output except error messages.
36750
36751 A command such as
36752 .code
36753 exim_lock /var/spool/mail/spqr
36754 .endd
36755 runs an interactive shell while the file is locked, whereas
36756 .display
36757 &`exim_lock -q /var/spool/mail/spqr <<End`&
36758 <&'some commands'&>
36759 &`End`&
36760 .endd
36761 runs a specific non-interactive sequence of commands while the file is locked,
36762 suppressing all verification output. A single command can be run by a command
36763 such as
36764 .code
36765 exim_lock -q /var/spool/mail/spqr \
36766   "cp /var/spool/mail/spqr /some/where"
36767 .endd
36768 Note that if a command is supplied, it must be entirely contained within the
36769 second argument &-- hence the quotes.
36770 .ecindex IIDutils
36771
36772
36773 . ////////////////////////////////////////////////////////////////////////////
36774 . ////////////////////////////////////////////////////////////////////////////
36775
36776 .chapter "The Exim monitor" "CHAPeximon"
36777 .scindex IIDeximon "Exim monitor" "description"
36778 .cindex "X-windows"
36779 .cindex "&'eximon'&"
36780 .cindex "Local/eximon.conf"
36781 .cindex "&_exim_monitor/EDITME_&"
36782 The Exim monitor is an application which displays in an X window information
36783 about the state of Exim's queue and what Exim is doing. An admin user can
36784 perform certain operations on messages from this GUI interface; however all
36785 such facilities are also available from the command line, and indeed, the
36786 monitor itself makes use of the command line to perform any actions requested.
36787
36788
36789
36790 .section "Running the monitor" "SECID264"
36791 The monitor is started by running the script called &'eximon'&. This is a shell
36792 script that sets up a number of environment variables, and then runs the
36793 binary called &_eximon.bin_&. The default appearance of the monitor window can
36794 be changed by editing the &_Local/eximon.conf_& file created by editing
36795 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36796 parameters are for.
36797
36798 The parameters that get built into the &'eximon'& script can be overridden for
36799 a particular invocation by setting up environment variables of the same names,
36800 preceded by &`EXIMON_`&. For example, a shell command such as
36801 .code
36802 EXIMON_LOG_DEPTH=400 eximon
36803 .endd
36804 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36805 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36806 overrides the Exim log file configuration. This makes it possible to have
36807 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36808 syslog messages are routed to a file on the local host.
36809
36810 X resources can be used to change the appearance of the window in the normal
36811 way. For example, a resource setting of the form
36812 .code
36813 Eximon*background: gray94
36814 .endd
36815 changes the colour of the background to light grey rather than white. The
36816 stripcharts are drawn with both the data lines and the reference lines in
36817 black. This means that the reference lines are not visible when on top of the
36818 data. However, their colour can be changed by setting a resource called
36819 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36820 For example, if your X server is running Unix, you could set up lighter
36821 reference lines in the stripcharts by obeying
36822 .code
36823 xrdb -merge <<End
36824 Eximon*highlight: gray
36825 End
36826 .endd
36827 .cindex "admin user"
36828 In order to see the contents of messages on the queue, and to operate on them,
36829 &'eximon'& must either be run as root or by an admin user.
36830
36831 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36832 contain X11 resource parameters interpreted by the X11 library.  In addition,
36833 if the first parameter starts with the string "gdb" then it is removed and the
36834 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36835 versioned variants of gdb can be invoked).
36836
36837 The monitor's window is divided into three parts. The first contains one or
36838 more stripcharts and two action buttons, the second contains a &"tail"& of the
36839 main log file, and the third is a display of the queue of messages awaiting
36840 delivery, with two more action buttons. The following sections describe these
36841 different parts of the display.
36842
36843
36844
36845
36846 .section "The stripcharts" "SECID265"
36847 .cindex "stripchart"
36848 The first stripchart is always a count of messages on the queue. Its name can
36849 be configured by setting QUEUE_STRIPCHART_NAME in the
36850 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36851 configuration script by regular expression matches on log file entries, making
36852 it possible to display, for example, counts of messages delivered to certain
36853 hosts or using certain transports. The supplied defaults display counts of
36854 received and delivered messages, and of local and SMTP deliveries. The default
36855 period between stripchart updates is one minute; this can be adjusted by a
36856 parameter in the &_Local/eximon.conf_& file.
36857
36858 The stripchart displays rescale themselves automatically as the value they are
36859 displaying changes. There are always 10 horizontal lines in each chart; the
36860 title string indicates the value of each division when it is greater than one.
36861 For example, &"x2"& means that each division represents a value of 2.
36862
36863 It is also possible to have a stripchart which shows the percentage fullness of
36864 a particular disk partition, which is useful when local deliveries are confined
36865 to a single partition.
36866
36867 .cindex "&%statvfs%& function"
36868 This relies on the availability of the &[statvfs()]& function or equivalent in
36869 the operating system. Most, but not all versions of Unix that support Exim have
36870 this. For this particular stripchart, the top of the chart always represents
36871 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36872 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36873 &_Local/eximon.conf_& file.
36874
36875
36876
36877
36878 .section "Main action buttons" "SECID266"
36879 .cindex "size" "of monitor window"
36880 .cindex "Exim monitor" "window size"
36881 .cindex "window size"
36882 Below the stripcharts there is an action button for quitting the monitor. Next
36883 to this is another button marked &"Size"&. They are placed here so that
36884 shrinking the window to its default minimum size leaves just the queue count
36885 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36886 the window to expand to its maximum size, unless it is already at the maximum,
36887 in which case it is reduced to its minimum.
36888
36889 When expanding to the maximum, if the window cannot be fully seen where it
36890 currently is, it is moved back to where it was the last time it was at full
36891 size. When it is expanding from its minimum size, the old position is
36892 remembered, and next time it is reduced to the minimum it is moved back there.
36893
36894 The idea is that you can keep a reduced window just showing one or two
36895 stripcharts at a convenient place on your screen, easily expand it to show
36896 the full window when required, and just as easily put it back to what it was.
36897 The idea is copied from what the &'twm'& window manager does for its
36898 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36899 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36900
36901 Normally, the monitor starts up with the window at its full size, but it can be
36902 built so that it starts up with the window at its smallest size, by setting
36903 START_SMALL=yes in &_Local/eximon.conf_&.
36904
36905
36906
36907 .section "The log display" "SECID267"
36908 .cindex "log" "tail of; in monitor"
36909 The second section of the window is an area in which a display of the tail of
36910 the main log is maintained.
36911 To save space on the screen, the timestamp on each log line is shortened by
36912 removing the date and, if &%log_timezone%& is set, the timezone.
36913 The log tail is not available when the only destination for logging data is
36914 syslog, unless the syslog lines are routed to a local file whose name is passed
36915 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36916
36917 The log sub-window has a scroll bar at its lefthand side which can be used to
36918 move back to look at earlier text, and the up and down arrow keys also have a
36919 scrolling effect. The amount of log that is kept depends on the setting of
36920 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36921 to use. When this is full, the earlier 50% of data is discarded &-- this is
36922 much more efficient than throwing it away line by line. The sub-window also has
36923 a horizontal scroll bar for accessing the ends of long log lines. This is the
36924 only means of horizontal scrolling; the right and left arrow keys are not
36925 available. Text can be cut from this part of the window using the mouse in the
36926 normal way. The size of this subwindow is controlled by parameters in the
36927 configuration file &_Local/eximon.conf_&.
36928
36929 Searches of the text in the log window can be carried out by means of the ^R
36930 and ^S keystrokes, which default to a reverse and a forward search,
36931 respectively. The search covers only the text that is displayed in the window.
36932 It cannot go further back up the log.
36933
36934 The point from which the search starts is indicated by a caret marker. This is
36935 normally at the end of the text in the window, but can be positioned explicitly
36936 by pointing and clicking with the left mouse button, and is moved automatically
36937 by a successful search. If new text arrives in the window when it is scrolled
36938 back, the caret remains where it is, but if the window is not scrolled back,
36939 the caret is moved to the end of the new text.
36940
36941 Pressing ^R or ^S pops up a window into which the search text can be typed.
36942 There are buttons for selecting forward or reverse searching, for carrying out
36943 the search, and for cancelling. If the &"Search"& button is pressed, the search
36944 happens and the window remains so that further searches can be done. If the
36945 &"Return"& key is pressed, a single search is done and the window is closed. If
36946 ^C is typed the search is cancelled.
36947
36948 The searching facility is implemented using the facilities of the Athena text
36949 widget. By default this pops up a window containing both &"search"& and
36950 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36951 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36952 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36953 provided version of &%TextPop%& when the remaining parts of the text widget
36954 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36955 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36956 on these systems, at the expense of having unwanted items in the search popup
36957 window.
36958
36959
36960
36961 .section "The queue display" "SECID268"
36962 .cindex "queue" "display in monitor"
36963 The bottom section of the monitor window contains a list of all messages that
36964 are on the queue, which includes those currently being received or delivered,
36965 as well as those awaiting delivery. The size of this subwindow is controlled by
36966 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36967 at which it is updated is controlled by another parameter in the same file &--
36968 the default is 5 minutes, since queue scans can be quite expensive. However,
36969 there is an &"Update"& action button just above the display which can be used
36970 to force an update of the queue display at any time.
36971
36972 When a host is down for some time, a lot of pending mail can build up for it,
36973 and this can make it hard to deal with other messages on the queue. To help
36974 with this situation there is a button next to &"Update"& called &"Hide"&. If
36975 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36976 type anything in here and press &"Return"&, the text is added to a chain of
36977 such texts, and if every undelivered address in a message matches at least one
36978 of the texts, the message is not displayed.
36979
36980 If there is an address that does not match any of the texts, all the addresses
36981 are displayed as normal. The matching happens on the ends of addresses so, for
36982 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36983 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36984 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36985 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36986 a hide request is automatically cancelled after one hour.
36987
36988 While the dialogue box is displayed, you can't press any buttons or do anything
36989 else to the monitor window. For this reason, if you want to cut text from the
36990 queue display to use in the dialogue box, you have to do the cutting before
36991 pressing the &"Hide"& button.
36992
36993 The queue display contains, for each unhidden queued message, the length of
36994 time it has been on the queue, the size of the message, the message id, the
36995 message sender, and the first undelivered recipient, all on one line. If it is
36996 a bounce message, the sender is shown as &"<>"&. If there is more than one
36997 recipient to which the message has not yet been delivered, subsequent ones are
36998 listed on additional lines, up to a maximum configured number, following which
36999 an ellipsis is displayed. Recipients that have already received the message are
37000 not shown.
37001
37002 .cindex "frozen messages" "display"
37003 If a message is frozen, an asterisk is displayed at the left-hand side.
37004
37005 The queue display has a vertical scroll bar, and can also be scrolled by means
37006 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37007 The text searching facilities, as described above for the log window, are also
37008 available, but the caret is always moved to the end of the text when the queue
37009 display is updated.
37010
37011
37012
37013 .section "The queue menu" "SECID269"
37014 .cindex "queue" "menu in monitor"
37015 If the &%shift%& key is held down and the left button is clicked when the mouse
37016 pointer is over the text for any message, an action menu pops up, and the first
37017 line of the queue display for the message is highlighted. This does not affect
37018 any selected text.
37019
37020 If you want to use some other event for popping up the menu, you can set the
37021 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37022 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37023 value set in this parameter is a standard X event description. For example, to
37024 run eximon using &%ctrl%& rather than &%shift%& you could use
37025 .code
37026 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37027 .endd
37028 The title of the menu is the message id, and it contains entries which act as
37029 follows:
37030
37031 .ilist
37032 &'message log'&: The contents of the message log for the message are displayed
37033 in a new text window.
37034 .next
37035 &'headers'&: Information from the spool file that contains the envelope
37036 information and headers is displayed in a new text window. See chapter
37037 &<<CHAPspool>>& for a description of the format of spool files.
37038 .next
37039 &'body'&: The contents of the spool file containing the body of the message are
37040 displayed in a new text window. There is a default limit of 20,000 bytes to the
37041 amount of data displayed. This can be changed by setting the BODY_MAX
37042 option at compile time, or the EXIMON_BODY_MAX option at run time.
37043 .next
37044 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37045 delivery of the message. This causes an automatic thaw if the message is
37046 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37047 a new text window. The delivery is run in a separate process, to avoid holding
37048 up the monitor while the delivery proceeds.
37049 .next
37050 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37051 that the message be frozen.
37052 .next
37053 .cindex "thawing messages"
37054 .cindex "unfreezing messages"
37055 .cindex "frozen messages" "thawing"
37056 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37057 that the message be thawed.
37058 .next
37059 .cindex "delivery" "forcing failure"
37060 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37061 that Exim gives up trying to deliver the message. A bounce message is generated
37062 for any remaining undelivered addresses.
37063 .next
37064 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37065 that the message be deleted from the system without generating a bounce
37066 message.
37067 .next
37068 &'add recipient'&: A dialog box is displayed into which a recipient address can
37069 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37070 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37071 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37072 causes a call to Exim to be made using the &%-Mar%& option to request that an
37073 additional recipient be added to the message, unless the entry box is empty, in
37074 which case no action is taken.
37075 .next
37076 &'mark delivered'&: A dialog box is displayed into which a recipient address
37077 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37078 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37079 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37080 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37081 recipient address as already delivered, unless the entry box is empty, in which
37082 case no action is taken.
37083 .next
37084 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37085 mark all recipient addresses as already delivered.
37086 .next
37087 &'edit sender'&: A dialog box is displayed initialized with the current
37088 sender's address. Pressing RETURN causes a call to Exim to be made using the
37089 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37090 in which case no action is taken. If you want to set an empty sender (as in
37091 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37092 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37093 the address is qualified with that domain.
37094 .endlist
37095
37096 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37097 other cases when a call to Exim is made, if there is any output from Exim (in
37098 particular, if the command fails) a window containing the command and the
37099 output is displayed. Otherwise, the results of the action are normally apparent
37100 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37101 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37102 if no output is generated.
37103
37104 The queue display is automatically updated for actions such as freezing and
37105 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37106 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37107 force an update of the display after one of these actions.
37108
37109 In any text window that is displayed as result of a menu action, the normal
37110 cut-and-paste facility is available, and searching can be carried out using ^R
37111 and ^S, as described above for the log tail window.
37112 .ecindex IIDeximon
37113
37114
37115
37116
37117
37118 . ////////////////////////////////////////////////////////////////////////////
37119 . ////////////////////////////////////////////////////////////////////////////
37120
37121 .chapter "Security considerations" "CHAPsecurity"
37122 .scindex IIDsecurcon "security" "discussion of"
37123 This chapter discusses a number of issues concerned with security, some of
37124 which are also covered in other parts of this manual.
37125
37126 For reasons that this author does not understand, some people have promoted
37127 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37128 existence of this chapter in the documentation. However, the intent of the
37129 chapter is simply to describe the way Exim works in relation to certain
37130 security concerns, not to make any specific claims about the effectiveness of
37131 its security as compared with other MTAs.
37132
37133 What follows is a description of the way Exim is supposed to be. Best efforts
37134 have been made to try to ensure that the code agrees with the theory, but an
37135 absence of bugs can never be guaranteed. Any that are reported will get fixed
37136 as soon as possible.
37137
37138
37139 .section "Building a more &""hardened""& Exim" "SECID286"
37140 .cindex "security" "build-time features"
37141 There are a number of build-time options that can be set in &_Local/Makefile_&
37142 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37143 Exim administrator who does not have the root password, or by someone who has
37144 penetrated the Exim (but not the root) account. These options are as follows:
37145
37146 .ilist
37147 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37148 start of any file names used with the &%-C%& option. When it is set, these file
37149 names are also not allowed to contain the sequence &"/../"&. (However, if the
37150 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37151 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37152 default setting for &%ALT_CONFIG_PREFIX%&.
37153
37154 If the permitted configuration files are confined to a directory to
37155 which only root has access, this guards against someone who has broken
37156 into the Exim account from running a privileged Exim with an arbitrary
37157 configuration file, and using it to break into other accounts.
37158 .next
37159
37160 If a non-trusted configuration file (i.e. not the default configuration file
37161 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37162 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37163 the next item), then root privilege is retained only if the caller of Exim is
37164 root. This locks out the possibility of testing a configuration using &%-C%&
37165 right through message reception and delivery, even if the caller is root. The
37166 reception works, but by that time, Exim is running as the Exim user, so when
37167 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37168 privilege to be lost. However, root can test reception and delivery using two
37169 separate commands.
37170
37171 .next
37172 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37173 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37174 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37175 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37176 the restrictive side.  Requiring build-time selection of safe macros is onerous
37177 but this option is intended solely as a transition mechanism to permit
37178 previously-working configurations to continue to work after release 4.73.
37179 .next
37180 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37181 is disabled.
37182 .next
37183 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37184 never to be used for any deliveries. This is like the &%never_users%& runtime
37185 option, but it cannot be overridden; the runtime option adds additional users
37186 to the list. The default setting is &"root"&; this prevents a non-root user who
37187 is permitted to modify the runtime file from using Exim as a way to get root.
37188 .endlist
37189
37190
37191
37192 .section "Root privilege" "SECID270"
37193 .cindex "setuid"
37194 .cindex "root privilege"
37195 The Exim binary is normally setuid to root, which means that it gains root
37196 privilege (runs as root) when it starts execution. In some special cases (for
37197 example, when the daemon is not in use and there are no local deliveries), it
37198 may be possible to run Exim setuid to some user other than root. This is
37199 discussed in the next section. However, in most installations, root privilege
37200 is required for two things:
37201
37202 .ilist
37203 To set up a socket connected to the standard SMTP port (25) when initialising
37204 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37205 not required.
37206 .next
37207 To be able to change uid and gid in order to read users' &_.forward_& files and
37208 perform local deliveries as the receiving user or as specified in the
37209 configuration.
37210 .endlist
37211
37212 It is not necessary to be root to do any of the other things Exim does, such as
37213 receiving messages and delivering them externally over SMTP, and it is
37214 obviously more secure if Exim does not run as root except when necessary.
37215 For this reason, a user and group for Exim to use must be defined in
37216 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37217 group"&. Their values can be changed by the run time configuration, though this
37218 is not recommended. Often a user called &'exim'& is used, but some sites use
37219 &'mail'& or another user name altogether.
37220
37221 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37222 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37223 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37224
37225 After a new Exim process has interpreted its command line options, it changes
37226 uid and gid in the following cases:
37227
37228 .ilist
37229 .oindex "&%-C%&"
37230 .oindex "&%-D%&"
37231 If the &%-C%& option is used to specify an alternate configuration file, or if
37232 the &%-D%& option is used to define macro values for the configuration, and the
37233 calling process is not running as root, the uid and gid are changed to those of
37234 the calling process.
37235 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37236 option may not be used at all.
37237 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37238 can be supplied if the calling process is running as root, the Exim run-time
37239 user or CONFIGURE_OWNER, if defined.
37240 .next
37241 .oindex "&%-be%&"
37242 .oindex "&%-bf%&"
37243 .oindex "&%-bF%&"
37244 If the expansion test option (&%-be%&) or one of the filter testing options
37245 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37246 calling process.
37247 .next
37248 If the process is not a daemon process or a queue runner process or a delivery
37249 process or a process for testing address routing (started with &%-bt%&), the
37250 uid and gid are changed to the Exim user and group. This means that Exim always
37251 runs under its own uid and gid when receiving messages. This also applies when
37252 testing address verification
37253 .oindex "&%-bv%&"
37254 .oindex "&%-bh%&"
37255 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37256 option).
37257 .next
37258 For a daemon, queue runner, delivery, or address testing process, the uid
37259 remains as root at this stage, but the gid is changed to the Exim group.
37260 .endlist
37261
37262 The processes that initially retain root privilege behave as follows:
37263
37264 .ilist
37265 A daemon process changes the gid to the Exim group and the uid to the Exim
37266 user after setting up one or more listening sockets. The &[initgroups()]&
37267 function is called, so that if the Exim user is in any additional groups, they
37268 will be used during message reception.
37269 .next
37270 A queue runner process retains root privilege throughout its execution. Its
37271 job is to fork a controlled sequence of delivery processes.
37272 .next
37273 A delivery process retains root privilege throughout most of its execution,
37274 but any actual deliveries (that is, the transports themselves) are run in
37275 subprocesses which always change to a non-root uid and gid. For local
37276 deliveries this is typically the uid and gid of the owner of the mailbox; for
37277 remote deliveries, the Exim uid and gid are used. Once all the delivery
37278 subprocesses have been run, a delivery process changes to the Exim uid and gid
37279 while doing post-delivery tidying up such as updating the retry database and
37280 generating bounce and warning messages.
37281
37282 While the recipient addresses in a message are being routed, the delivery
37283 process runs as root. However, if a user's filter file has to be processed,
37284 this is done in a subprocess that runs under the individual user's uid and
37285 gid. A system filter is run as root unless &%system_filter_user%& is set.
37286 .next
37287 A process that is testing addresses (the &%-bt%& option) runs as root so that
37288 the routing is done in the same environment as a message delivery.
37289 .endlist
37290
37291
37292
37293
37294 .section "Running Exim without privilege" "SECTrunexiwitpri"
37295 .cindex "privilege, running without"
37296 .cindex "unprivileged running"
37297 .cindex "root privilege" "running without"
37298 Some installations like to run Exim in an unprivileged state for more of its
37299 operation, for added security. Support for this mode of operation is provided
37300 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37301 gid are changed to the Exim user and group at the start of a delivery process
37302 (and also queue runner and address testing processes). This means that address
37303 routing is no longer run as root, and the deliveries themselves cannot change
37304 to any other uid.
37305
37306 .cindex SIGHUP
37307 .cindex "daemon" "restarting"
37308 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37309 that the daemon can still be started in the usual way, and it can respond
37310 correctly to SIGHUP because the re-invocation regains root privilege.
37311
37312 An alternative approach is to make Exim setuid to the Exim user and also setgid
37313 to the Exim group. If you do this, the daemon must be started from a root
37314 process. (Calling Exim from a root process makes it behave in the way it does
37315 when it is setuid root.) However, the daemon cannot restart itself after a
37316 SIGHUP signal because it cannot regain privilege.
37317
37318 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37319 stops Exim from trying to re-invoke itself to do a delivery after a message has
37320 been received. Such a re-invocation is a waste of resources because it has no
37321 effect.
37322
37323 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37324 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37325 to the Exim user seems a clean approach, but there is one complication:
37326
37327 In this style of operation, Exim is running with the real uid and gid set to
37328 those of the calling process, and the effective uid/gid set to Exim's values.
37329 Ideally, any association with the calling process' uid/gid should be dropped,
37330 that is, the real uid/gid should be reset to the effective values so as to
37331 discard any privileges that the caller may have. While some operating systems
37332 have a function that permits this action for a non-root effective uid, quite a
37333 number of them do not. Because of this lack of standardization, Exim does not
37334 address this problem at this time.
37335
37336 For this reason, the recommended approach for &"mostly unprivileged"& running
37337 is to keep the Exim binary setuid to root, and to set
37338 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37339 be used in the most straightforward way.
37340
37341 If you configure Exim not to run delivery processes as root, there are a
37342 number of restrictions on what you can do:
37343
37344 .ilist
37345 You can deliver only as the Exim user/group. You should  explicitly use the
37346 &%user%& and &%group%& options to override routers or local transports that
37347 normally deliver as the recipient. This makes sure that configurations that
37348 work in this mode function the same way in normal mode. Any implicit or
37349 explicit specification of another user causes an error.
37350 .next
37351 Use of &_.forward_& files is severely restricted, such that it is usually
37352 not worthwhile to include them in the configuration.
37353 .next
37354 Users who wish to use &_.forward_& would have to make their home directory and
37355 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37356 and their equivalents in Exim filters, cannot be used. While they could be
37357 enabled in the Exim user's name, that would be insecure and not very useful.
37358 .next
37359 Unless the local user mailboxes are all owned by the Exim user (possible in
37360 some POP3 or IMAP-only environments):
37361
37362 .olist
37363 They must be owned by the Exim group and be writeable by that group. This
37364 implies you must set &%mode%& in the appendfile configuration, as well as the
37365 mode of the mailbox files themselves.
37366 .next
37367 You must set &%no_check_owner%&, since most or all of the files will not be
37368 owned by the Exim user.
37369 .next
37370 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37371 on a newly created mailbox when unprivileged. This also implies that new
37372 mailboxes need to be created manually.
37373 .endlist olist
37374 .endlist ilist
37375
37376
37377 These restrictions severely restrict what can be done in local deliveries.
37378 However, there are no restrictions on remote deliveries. If you are running a
37379 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37380 gives more security at essentially no cost.
37381
37382 If you are using the &%mua_wrapper%& facility (see chapter
37383 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37384
37385
37386
37387
37388 .section "Delivering to local files" "SECID271"
37389 Full details of the checks applied by &(appendfile)& before it writes to a file
37390 are given in chapter &<<CHAPappendfile>>&.
37391
37392
37393
37394 .section "Running local commands" "SECTsecconslocalcmds"
37395 .cindex "security" "local commands"
37396 .cindex "security" "command injection attacks"
37397 There are a number of ways in which an administrator can configure Exim to run
37398 commands based upon received, untrustworthy, data. Further, in some
37399 configurations a user who can control a &_.forward_& file can also arrange to
37400 run commands. Configuration to check includes, but is not limited to:
37401
37402 .ilist
37403 Use of &%use_shell%& in the pipe transport: various forms of shell command
37404 injection may be possible with this option present. It is dangerous and should
37405 be used only with considerable caution. Consider constraints which whitelist
37406 allowed characters in a variable which is to be used in a pipe transport that
37407 has &%use_shell%& enabled.
37408 .next
37409 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37410 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37411 &_.forward_& files in a redirect router. If Exim is running on a central mail
37412 hub to which ordinary users do not have shell access, but home directories are
37413 NFS mounted (for instance) then administrators should review the list of these
37414 forbid options available, and should bear in mind that the options that may
37415 need forbidding can change as new features are added between releases.
37416 .next
37417 The &%${run...}%& expansion item does not use a shell by default, but
37418 administrators can configure use of &_/bin/sh_& as part of the command.
37419 Such invocations should be viewed with prejudicial suspicion.
37420 .next
37421 Administrators who use embedded Perl are advised to explore how Perl's
37422 taint checking might apply to their usage.
37423 .next
37424 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37425 administrators are well advised to view its use with suspicion, in case (for
37426 instance) it allows a local-part to contain embedded Exim directives.
37427 .next
37428 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37429 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37430 each can reference arbitrary lists and files, rather than just being a list
37431 of opaque strings.
37432 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37433 real-world security vulnerabilities caused by its use with untrustworthy data
37434 injected in, for SQL injection attacks.
37435 Consider the use of the &%inlisti%& expansion condition instead.
37436 .endlist
37437
37438
37439
37440
37441 .section "Trust in configuration data" "SECTsecconfdata"
37442 .cindex "security" "data sources"
37443 .cindex "security" "regular expressions"
37444 .cindex "regular expressions" "security"
37445 .cindex "PCRE" "security"
37446 If configuration data for Exim can come from untrustworthy sources, there
37447 are some issues to be aware of:
37448
37449 .ilist
37450 Use of &%${expand...}%& may provide a path for shell injection attacks.
37451 .next
37452 Letting untrusted data provide a regular expression is unwise.
37453 .next
37454 Using &%${match...}%& to apply a fixed regular expression against untrusted
37455 data may result in pathological behaviour within PCRE.  Be aware of what
37456 "backtracking" means and consider options for being more strict with a regular
37457 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37458 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37459 possessive quantifiers or just not using regular expressions against untrusted
37460 data.
37461 .next
37462 It can be important to correctly use &%${quote:...}%&,
37463 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37464 items to ensure that data is correctly constructed.
37465 .next
37466 Some lookups might return multiple results, even though normal usage is only
37467 expected to yield one result.
37468 .endlist
37469
37470
37471
37472
37473 .section "IPv4 source routing" "SECID272"
37474 .cindex "source routing" "in IP packets"
37475 .cindex "IP source routing"
37476 Many operating systems suppress IP source-routed packets in the kernel, but
37477 some cannot be made to do this, so Exim does its own check. It logs incoming
37478 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37479 IPv6. No special checking is currently done.
37480
37481
37482
37483 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37484 Support for these SMTP commands is disabled by default. If required, they can
37485 be enabled by defining suitable ACLs.
37486
37487
37488
37489
37490 .section "Privileged users" "SECID274"
37491 .cindex "trusted users"
37492 .cindex "admin user"
37493 .cindex "privileged user"
37494 .cindex "user" "trusted"
37495 .cindex "user" "admin"
37496 Exim recognizes two sets of users with special privileges. Trusted users are
37497 able to submit new messages to Exim locally, but supply their own sender
37498 addresses and information about a sending host. For other users submitting
37499 local messages, Exim sets up the sender address from the uid, and doesn't
37500 permit a remote host to be specified.
37501
37502 .oindex "&%-f%&"
37503 However, an untrusted user is permitted to use the &%-f%& command line option
37504 in the special form &%-f <>%& to indicate that a delivery failure for the
37505 message should not cause an error report. This affects the message's envelope,
37506 but it does not affect the &'Sender:'& header. Untrusted users may also be
37507 permitted to use specific forms of address with the &%-f%& option by setting
37508 the &%untrusted_set_sender%& option.
37509
37510 Trusted users are used to run processes that receive mail messages from some
37511 other mail domain and pass them on to Exim for delivery either locally, or over
37512 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37513 as any user listed in the &%trusted_users%& configuration option, or under any
37514 group listed in the &%trusted_groups%& option.
37515
37516 Admin users are permitted to do things to the messages on Exim's queue. They
37517 can freeze or thaw messages, cause them to be returned to their senders, remove
37518 them entirely, or modify them in various ways. In addition, admin users can run
37519 the Exim monitor and see all the information it is capable of providing, which
37520 includes the contents of files on the spool.
37521
37522 .oindex "&%-M%&"
37523 .oindex "&%-q%&"
37524 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37525 delivery of messages on its queue is restricted to admin users. This
37526 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37527 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37528 queue is also restricted to admin users. This restriction can be relaxed by
37529 setting &%no_queue_list_requires_admin%&.
37530
37531 Exim recognizes an admin user if the calling process is running as root or as
37532 the Exim user or if any of the groups associated with the calling process is
37533 the Exim group. It is not necessary actually to be running under the Exim
37534 group. However, if admin users who are not root or the Exim user are to access
37535 the contents of files on the spool via the Exim monitor (which runs
37536 unprivileged), Exim must be built to allow group read access to its spool
37537 files.
37538
37539
37540
37541 .section "Spool files" "SECID275"
37542 .cindex "spool directory" "files"
37543 Exim's spool directory and everything it contains is owned by the Exim user and
37544 set to the Exim group. The mode for spool files is defined in the
37545 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37546 any user who is a member of the Exim group can access these files.
37547
37548
37549
37550 .section "Use of argv[0]" "SECID276"
37551 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37552 of specific strings, Exim assumes certain options. For example, calling Exim
37553 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37554 to calling it with the option &%-bS%&. There are no security implications in
37555 this.
37556
37557
37558
37559 .section "Use of %f formatting" "SECID277"
37560 The only use made of &"%f"& by Exim is in formatting load average values. These
37561 are actually stored in integer variables as 1000 times the load average.
37562 Consequently, their range is limited and so therefore is the length of the
37563 converted output.
37564
37565
37566
37567 .section "Embedded Exim path" "SECID278"
37568 Exim uses its own path name, which is embedded in the code, only when it needs
37569 to re-exec in order to regain root privilege. Therefore, it is not root when it
37570 does so. If some bug allowed the path to get overwritten, it would lead to an
37571 arbitrary program's being run as exim, not as root.
37572
37573
37574
37575 .section "Dynamic module directory" "SECTdynmoddir"
37576 Any dynamically loadable modules must be installed into the directory
37577 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37578 loading it.
37579
37580
37581 .section "Use of sprintf()" "SECID279"
37582 .cindex "&[sprintf()]&"
37583 A large number of occurrences of &"sprintf"& in the code are actually calls to
37584 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37585 The intermediate formatting is done into a large fixed buffer by a function
37586 that runs through the format string itself, and checks the length of each
37587 conversion before performing it, thus preventing buffer overruns.
37588
37589 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37590 the output buffer is known to be sufficiently long to contain the converted
37591 string.
37592
37593
37594
37595 .section "Use of debug_printf() and log_write()" "SECID280"
37596 Arbitrary strings are passed to both these functions, but they do their
37597 formatting by calling the function &'string_vformat()'&, which runs through
37598 the format string itself, and checks the length of each conversion.
37599
37600
37601
37602 .section "Use of strcat() and strcpy()" "SECID281"
37603 These are used only in cases where the output buffer is known to be large
37604 enough to hold the result.
37605 .ecindex IIDsecurcon
37606
37607
37608
37609
37610 . ////////////////////////////////////////////////////////////////////////////
37611 . ////////////////////////////////////////////////////////////////////////////
37612
37613 .chapter "Format of spool files" "CHAPspool"
37614 .scindex IIDforspo1 "format" "spool files"
37615 .scindex IIDforspo2 "spool directory" "format of files"
37616 .scindex IIDforspo3 "spool files" "format of"
37617 .cindex "spool files" "editing"
37618 A message on Exim's queue consists of two files, whose names are the message id
37619 followed by -D and -H, respectively. The data portion of the message is kept in
37620 the -D file on its own. The message's envelope, status, and headers are all
37621 kept in the -H file, whose format is described in this chapter. Each of these
37622 two files contains the final component of its own name as its first line. This
37623 is insurance against disk crashes where the directory is lost but the files
37624 themselves are recoverable.
37625
37626 Some people are tempted into editing -D files in order to modify messages. You
37627 need to be extremely careful if you do this; it is not recommended and you are
37628 on your own if you do it. Here are some of the pitfalls:
37629
37630 .ilist
37631 You must ensure that Exim does not try to deliver the message while you are
37632 fiddling with it. The safest way is to take out a write lock on the -D file,
37633 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37634 place, the lock will be retained. If you write a new file and rename it, the
37635 lock will be lost at the instant of rename.
37636 .next
37637 .vindex "&$body_linecount$&"
37638 If you change the number of lines in the file, the value of
37639 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37640 present, this value is not used by Exim, but there is no guarantee that this
37641 will always be the case.
37642 .next
37643 If the message is in MIME format, you must take care not to break it.
37644 .next
37645 If the message is cryptographically signed, any change will invalidate the
37646 signature.
37647 .endlist
37648 All in all, modifying -D files is fraught with danger.
37649
37650 Files whose names end with -J may also be seen in the &_input_& directory (or
37651 its subdirectories when &%split_spool_directory%& is set). These are journal
37652 files, used to record addresses to which the message has been delivered during
37653 the course of a delivery attempt. If there are still undelivered recipients at
37654 the end, the -H file is updated, and the -J file is deleted. If, however, there
37655 is some kind of crash (for example, a power outage) before this happens, the -J
37656 file remains in existence. When Exim next processes the message, it notices the
37657 -J file and uses it to update the -H file before starting the next delivery
37658 attempt.
37659
37660 .section "Format of the -H file" "SECID282"
37661 .cindex "uid (user id)" "in spool file"
37662 .cindex "gid (group id)" "in spool file"
37663 The second line of the -H file contains the login name for the uid of the
37664 process that called Exim to read the message, followed by the numerical uid and
37665 gid. For a locally generated message, this is normally the user who sent the
37666 message. For a message received over TCP/IP via the daemon, it is
37667 normally the Exim user.
37668
37669 The third line of the file contains the address of the message's sender as
37670 transmitted in the envelope, contained in angle brackets. The sender address is
37671 empty for bounce messages. For incoming SMTP mail, the sender address is given
37672 in the MAIL command. For locally generated mail, the sender address is
37673 created by Exim from the login name of the current user and the configured
37674 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37675 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37676 &"<>"& or an address that matches &%untrusted_set_senders%&.
37677
37678 The fourth line contains two numbers. The first is the time that the message
37679 was received, in the conventional Unix form &-- the number of seconds since the
37680 start of the epoch. The second number is a count of the number of messages
37681 warning of delayed delivery that have been sent to the sender.
37682
37683 There follow a number of lines starting with a hyphen. These can appear in any
37684 order, and are omitted when not relevant:
37685
37686 .vlist
37687 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37688 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37689 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37690 recognized, to provide backward compatibility. In the old format, a line of
37691 this form is present for every ACL variable that is not empty. The number
37692 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37693 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37694 the data string for the variable. The string itself starts at the beginning of
37695 the next line, and is followed by a newline character. It may contain internal
37696 newlines.
37697
37698 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37699 A line of this form is present for every ACL connection variable that is
37700 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37701 The length is the length of the data string for the variable. The string itself
37702 starts at the beginning of the next line, and is followed by a newline
37703 character. It may contain internal newlines.
37704
37705 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37706 A line of this form is present for every ACL message variable that is defined.
37707 Note that there is a space between &%-aclm%& and the rest of the name. The
37708 length is the length of the data string for the variable. The string itself
37709 starts at the beginning of the next line, and is followed by a newline
37710 character. It may contain internal newlines.
37711
37712 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37713 This is present if, when the message was received over SMTP, the value of
37714 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37715
37716 .vitem &%-allow_unqualified_recipient%&
37717 This is present if unqualified recipient addresses are permitted in header
37718 lines (to stop such addresses from being qualified if rewriting occurs at
37719 transport time). Local messages that were input using &%-bnq%& and remote
37720 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37721
37722 .vitem &%-allow_unqualified_sender%&
37723 This is present if unqualified sender addresses are permitted in header lines
37724 (to stop such addresses from being qualified if rewriting occurs at transport
37725 time). Local messages that were input using &%-bnq%& and remote messages from
37726 hosts that match &%sender_unqualified_hosts%& set this flag.
37727
37728 .vitem "&%-auth_id%&&~<&'text'&>"
37729 The id information for a message received on an authenticated SMTP connection
37730 &-- the value of the &$authenticated_id$& variable.
37731
37732 .vitem "&%-auth_sender%&&~<&'address'&>"
37733 The address of an authenticated sender &-- the value of the
37734 &$authenticated_sender$& variable.
37735
37736 .vitem "&%-body_linecount%&&~<&'number'&>"
37737 This records the number of lines in the body of the message, and is always
37738 present.
37739
37740 .vitem "&%-body_zerocount%&&~<&'number'&>"
37741 This records the number of binary zero bytes in the body of the message, and is
37742 present if the number is greater than zero.
37743
37744 .vitem &%-deliver_firsttime%&
37745 This is written when a new message is first added to the spool. When the spool
37746 file is updated after a deferral, it is omitted.
37747
37748 .vitem "&%-frozen%&&~<&'time'&>"
37749 .cindex "frozen messages" "spool data"
37750 The message is frozen, and the freezing happened at <&'time'&>.
37751
37752 .vitem "&%-helo_name%&&~<&'text'&>"
37753 This records the host name as specified by a remote host in a HELO or EHLO
37754 command.
37755
37756 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37757 This records the IP address of the host from which the message was received and
37758 the remote port number that was used. It is omitted for locally generated
37759 messages.
37760
37761 .vitem "&%-host_auth%&&~<&'text'&>"
37762 If the message was received on an authenticated SMTP connection, this records
37763 the name of the authenticator &-- the value of the
37764 &$sender_host_authenticated$& variable.
37765
37766 .vitem &%-host_lookup_failed%&
37767 This is present if an attempt to look up the sending host's name from its IP
37768 address failed. It corresponds to the &$host_lookup_failed$& variable.
37769
37770 .vitem "&%-host_name%&&~<&'text'&>"
37771 .cindex "reverse DNS lookup"
37772 .cindex "DNS" "reverse lookup"
37773 This records the name of the remote host from which the message was received,
37774 if the host name was looked up from the IP address when the message was being
37775 received. It is not present if no reverse lookup was done.
37776
37777 .vitem "&%-ident%&&~<&'text'&>"
37778 For locally submitted messages, this records the login of the originating user,
37779 unless it was a trusted user and the &%-oMt%& option was used to specify an
37780 ident value. For messages received over TCP/IP, this records the ident string
37781 supplied by the remote host, if any.
37782
37783 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37784 This records the IP address of the local interface and the port number through
37785 which a message was received from a remote host. It is omitted for locally
37786 generated messages.
37787
37788 .vitem &%-local%&
37789 The message is from a local sender.
37790
37791 .vitem &%-localerror%&
37792 The message is a locally-generated bounce message.
37793
37794 .vitem "&%-local_scan%&&~<&'string'&>"
37795 This records the data string that was returned by the &[local_scan()]& function
37796 when the message was received &-- the value of the &$local_scan_data$&
37797 variable. It is omitted if no data was returned.
37798
37799 .vitem &%-manual_thaw%&
37800 The message was frozen but has been thawed manually, that is, by an explicit
37801 Exim command rather than via the auto-thaw process.
37802
37803 .vitem &%-N%&
37804 A testing delivery process was started using the &%-N%& option to suppress any
37805 actual deliveries, but delivery was deferred. At any further delivery attempts,
37806 &%-N%& is assumed.
37807
37808 .vitem &%-received_protocol%&
37809 This records the value of the &$received_protocol$& variable, which contains
37810 the name of the protocol by which the message was received.
37811
37812 .vitem &%-sender_set_untrusted%&
37813 The envelope sender of this message was set by an untrusted local caller (used
37814 to ensure that the caller is displayed in queue listings).
37815
37816 .vitem "&%-spam_score_int%&&~<&'number'&>"
37817 If a message was scanned by SpamAssassin, this is present. It records the value
37818 of &$spam_score_int$&.
37819
37820 .vitem &%-tls_certificate_verified%&
37821 A TLS certificate was received from the client that sent this message, and the
37822 certificate was verified by the server.
37823
37824 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37825 When the message was received over an encrypted connection, this records the
37826 name of the cipher suite that was used.
37827
37828 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37829 When the message was received over an encrypted connection, and a certificate
37830 was received from the client, this records the Distinguished Name from that
37831 certificate.
37832 .endlist
37833
37834 Following the options there is a list of those addresses to which the message
37835 is not to be delivered. This set of addresses is initialized from the command
37836 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37837 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37838 the address is added to this set. The addresses are kept internally as a
37839 balanced binary tree, and it is a representation of that tree which is written
37840 to the spool file. If an address is expanded via an alias or forward file, the
37841 original address is added to the tree when deliveries to all its child
37842 addresses are complete.
37843
37844 If the tree is empty, there is a single line in the spool file containing just
37845 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37846 Y or N, followed by an address. The address is the value for the node of the
37847 tree, and the letters indicate whether the node has a left branch and/or a
37848 right branch attached to it, respectively. If branches exist, they immediately
37849 follow. Here is an example of a three-node tree:
37850 .code
37851 YY darcy@austen.fict.example
37852 NN alice@wonderland.fict.example
37853 NN editor@thesaurus.ref.example
37854 .endd
37855 After the non-recipients tree, there is a list of the message's recipients.
37856 This is a simple list, preceded by a count. It includes all the original
37857 recipients of the message, including those to whom the message has already been
37858 delivered. In the simplest case, the list contains one address per line. For
37859 example:
37860 .code
37861 4
37862 editor@thesaurus.ref.example
37863 darcy@austen.fict.example
37864 rdo@foundation
37865 alice@wonderland.fict.example
37866 .endd
37867 However, when a child address has been added to the top-level addresses as a
37868 result of the use of the &%one_time%& option on a &(redirect)& router, each
37869 line is of the following form:
37870 .display
37871 <&'top-level address'&> <&'errors_to address'&> &&&
37872   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37873 .endd
37874 The 01 flag bit indicates the presence of the three other fields that follow
37875 the top-level address. Other bits may be used in future to support additional
37876 fields. The <&'parent number'&> is the offset in the recipients list of the
37877 original parent of the &"one time"& address. The first two fields are the
37878 envelope sender that is associated with this address and its length. If the
37879 length is zero, there is no special envelope sender (there are then two space
37880 characters in the line). A non-empty field can arise from a &(redirect)& router
37881 that has an &%errors_to%& setting.
37882
37883
37884 A blank line separates the envelope and status information from the headers
37885 which follow. A header may occupy several lines of the file, and to save effort
37886 when reading it in, each header is preceded by a number and an identifying
37887 character. The number is the number of characters in the header, including any
37888 embedded newlines and the terminating newline. The character is one of the
37889 following:
37890
37891 .table2 50pt
37892 .row <&'blank'&>         "header in which Exim has no special interest"
37893 .row &`B`&               "&'Bcc:'& header"
37894 .row &`C`&               "&'Cc:'& header"
37895 .row &`F`&               "&'From:'& header"
37896 .row &`I`&               "&'Message-id:'& header"
37897 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37898 .row &`R`&               "&'Reply-To:'& header"
37899 .row &`S`&               "&'Sender:'& header"
37900 .row &`T`&               "&'To:'& header"
37901 .row &`*`&               "replaced or deleted header"
37902 .endtable
37903
37904 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37905 purposes. They are not transmitted when the message is delivered. Here is a
37906 typical set of headers:
37907 .code
37908 111P Received: by hobbit.fict.example with local (Exim 4.00)
37909 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37910 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37911 038* X-rewrote-sender: bb@hobbit.fict.example
37912 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37913 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37914 099* To: alice@wonderland.fict.example, rdo@foundation,
37915 darcy@austen.fict.example, editor@thesaurus.ref.example
37916 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37917 darcy@austen.fict.example, editor@thesaurus.ref.example
37918 038  Date: Fri, 11 May 2001 10:28:59 +0100
37919 .endd
37920 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37921 &'To:'& header have been rewritten, the last one because routing expanded the
37922 unqualified domain &'foundation'&.
37923 .ecindex IIDforspo1
37924 .ecindex IIDforspo2
37925 .ecindex IIDforspo3
37926
37927 . ////////////////////////////////////////////////////////////////////////////
37928 . ////////////////////////////////////////////////////////////////////////////
37929
37930 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37931          "DKIM Support"
37932 .cindex "DKIM"
37933
37934 DKIM is a mechanism by which messages sent by some entity can be provably
37935 linked to a domain which that entity controls.  It permits reputation to
37936 be tracked on a per-domain basis, rather than merely upon source IP address.
37937 DKIM is documented in RFC 4871.
37938
37939 DKIM support is compiled into Exim by default if TLS support is present.
37940 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
37941
37942 Exim's DKIM implementation allows to
37943 .olist
37944 Sign outgoing messages: This function is implemented in the SMTP transport.
37945 It can co-exist with all other Exim features
37946 (including transport filters)
37947 except cutthrough delivery.
37948 .next
37949 Verify signatures in incoming messages: This is implemented by an additional
37950 ACL (acl_smtp_dkim), which can be called several times per message, with
37951 different signature contexts.
37952 .endlist
37953
37954 In typical Exim style, the verification implementation does not include any
37955 default "policy". Instead it enables you to build your own policy using
37956 Exim's standard controls.
37957
37958 Please note that verification of DKIM signatures in incoming mail is turned
37959 on by default for logging purposes. For each signature in incoming email,
37960 exim will log a line displaying the most important signature details, and the
37961 signature status. Here is an example (with line-breaks added for clarity):
37962 .code
37963 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37964     d=facebookmail.com s=q1-2009b
37965     c=relaxed/relaxed a=rsa-sha1
37966     i=@facebookmail.com t=1252484542 [verification succeeded]
37967 .endd
37968 You might want to turn off DKIM verification processing entirely for internal
37969 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37970 control modifier. This should typically be done in the RCPT ACL, at points
37971 where you accept mail from relay sources (internal hosts or authenticated
37972 senders).
37973
37974
37975 .section "Signing outgoing messages" "SECDKIMSIGN"
37976 .cindex "DKIM" "signing"
37977
37978 Signing is implemented by setting private options on the SMTP transport.
37979 These options take (expandable) strings as arguments.
37980
37981 .option dkim_domain smtp string&!! unset
37982 MANDATORY:
37983 The domain you want to sign with. The result of this expanded
37984 option is put into the &%$dkim_domain%& expansion variable.
37985
37986 .option dkim_selector smtp string&!! unset
37987 MANDATORY:
37988 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37989 variable to look up a matching selector. The result is put in the expansion
37990 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
37991 option along with &%$dkim_domain%&.
37992
37993 .option dkim_private_key smtp string&!! unset
37994 MANDATORY:
37995 This sets the private key to use. You can use the &%$dkim_domain%& and
37996 &%$dkim_selector%& expansion variables to determine the private key to use.
37997 The result can either
37998 .ilist
37999 be a valid RSA private key in ASCII armor, including line breaks.
38000 .next
38001 start with a slash, in which case it is treated as a file that contains
38002 the private key.
38003 .next
38004 be "0", "false" or the empty string, in which case the message will not
38005 be signed. This case will not result in an error, even if &%dkim_strict%&
38006 is set.
38007 .endlist
38008
38009 .option dkim_canon smtp string&!! unset
38010 OPTIONAL:
38011 This option sets the canonicalization method used when signing a message.
38012 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38013 The option defaults to "relaxed" when unset. Note: the current implementation
38014 only supports using the same canonicalization method for both headers and body.
38015
38016 .option dkim_strict smtp string&!! unset
38017 OPTIONAL:
38018 This  option  defines  how  Exim  behaves  when  signing a message that
38019 should be signed fails for some reason.  When the expansion evaluates to
38020 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38021 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38022 variables here.
38023
38024 .option dkim_sign_headers smtp string&!! unset
38025 OPTIONAL:
38026 When set, this option must expand to (or be specified as) a colon-separated
38027 list of header names. Headers with these names will be included in the message
38028 signature. When unspecified, the header names recommended in RFC4871 will be
38029 used.
38030
38031
38032 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38033 .cindex "DKIM" "verification"
38034
38035 Verification of DKIM signatures in incoming email is implemented via the
38036 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38037 syntactically(!) correct signature in the incoming message.
38038 A missing ACL definition defaults to accept.
38039 If any ACL call does not accept, the message is not accepted.
38040 If a cutthrough delivery was in progress for the message it is
38041 summarily dropped (having wasted the transmission effort).
38042
38043 To evaluate the signature in the ACL a large number of expansion variables
38044 containing the signature status and its details are set up during the
38045 runtime of the ACL.
38046
38047 Calling the ACL only for existing signatures is not sufficient to build
38048 more advanced policies. For that reason, the global option
38049 &%dkim_verify_signers%&, and a global expansion variable
38050 &%$dkim_signers%& exist.
38051
38052 The global option &%dkim_verify_signers%& can be set to a colon-separated
38053 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38054 called. It is expanded when the message has been received. At this point,
38055 the expansion variable &%$dkim_signers%& already contains a colon-separated
38056 list of signer domains and identities for the message. When
38057 &%dkim_verify_signers%& is not specified in the main configuration,
38058 it defaults as:
38059 .code
38060 dkim_verify_signers = $dkim_signers
38061 .endd
38062 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38063 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38064 call the ACL for known domains or identities. This would be achieved as follows:
38065 .code
38066 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38067 .endd
38068 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38069 and "ebay.com", plus all domains and identities that have signatures in the message.
38070 You can also be more creative in constructing your policy. For example:
38071 .code
38072 dkim_verify_signers = $sender_address_domain:$dkim_signers
38073 .endd
38074
38075 If a domain or identity is listed several times in the (expanded) value of
38076 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38077
38078
38079 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38080 available (from most to least important):
38081
38082
38083 .vlist
38084 .vitem &%$dkim_cur_signer%&
38085 The signer that is being evaluated in this ACL run. This can be a domain or
38086 an identity. This is one of the list items from the expanded main option
38087 &%dkim_verify_signers%& (see above).
38088 .vitem &%$dkim_verify_status%&
38089 A string describing the general status of the signature. One of
38090 .ilist
38091 &%none%&: There is no signature in the message for the current domain or
38092 identity (as reflected by &%$dkim_cur_signer%&).
38093 .next
38094 &%invalid%&: The signature could not be verified due to a processing error.
38095 More detail is available in &%$dkim_verify_reason%&.
38096 .next
38097 &%fail%&: Verification of the signature failed.  More detail is
38098 available in &%$dkim_verify_reason%&.
38099 .next
38100 &%pass%&: The signature passed verification. It is valid.
38101 .endlist
38102 .vitem &%$dkim_verify_reason%&
38103 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38104 "fail" or "invalid". One of
38105 .ilist
38106 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38107 key for the domain could not be retrieved. This may be a temporary problem.
38108 .next
38109 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38110 record for the domain is syntactically invalid.
38111 .next
38112 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38113 body hash does not match the one specified in the signature header. This
38114 means that the message body was modified in transit.
38115 .next
38116 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38117 could not be verified. This may mean that headers were modified,
38118 re-written or otherwise changed in a way which is incompatible with
38119 DKIM verification. It may of course also mean that the signature is forged.
38120 .endlist
38121 .vitem &%$dkim_domain%&
38122 The signing domain. IMPORTANT: This variable is only populated if there is
38123 an actual signature in the message for the current domain or identity (as
38124 reflected by &%$dkim_cur_signer%&).
38125 .vitem &%$dkim_identity%&
38126 The signing identity, if present. IMPORTANT: This variable is only populated
38127 if there is an actual signature in the message for the current domain or
38128 identity (as reflected by &%$dkim_cur_signer%&).
38129 .vitem &%$dkim_selector%&
38130 The key record selector string.
38131 .vitem &%$dkim_algo%&
38132 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38133 .vitem &%$dkim_canon_body%&
38134 The body canonicalization method. One of 'relaxed' or 'simple'.
38135 .vitem &%dkim_canon_headers%&
38136 The header canonicalization method. One of 'relaxed' or 'simple'.
38137 .vitem &%$dkim_copiedheaders%&
38138 A transcript of headers and their values which are included in the signature
38139 (copied from the 'z=' tag of the signature).
38140 .vitem &%$dkim_bodylength%&
38141 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38142 limit was set by the signer, "9999999999999" is returned. This makes sure
38143 that this variable always expands to an integer value.
38144 .vitem &%$dkim_created%&
38145 UNIX timestamp reflecting the date and time when the signature was created.
38146 When this was not specified by the signer, "0" is returned.
38147 .vitem &%$dkim_expires%&
38148 UNIX timestamp reflecting the date and time when the signer wants the
38149 signature to be treated as "expired". When this was not specified by the
38150 signer, "9999999999999" is returned. This makes it possible to do useful
38151 integer size comparisons against this value.
38152 .vitem &%$dkim_headernames%&
38153 A colon-separated list of names of headers included in the signature.
38154 .vitem &%$dkim_key_testing%&
38155 "1" if the key record has the "testing" flag set, "0" if not.
38156 .vitem &%$dkim_key_nosubdomains%&
38157 "1" if the key record forbids subdomaining, "0" otherwise.
38158 .vitem &%$dkim_key_srvtype%&
38159 Service type (tag s=) from the key record. Defaults to "*" if not specified
38160 in the key record.
38161 .vitem &%$dkim_key_granularity%&
38162 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38163 in the key record.
38164 .vitem &%$dkim_key_notes%&
38165 Notes from the key record (tag n=).
38166 .vitem &%$dkim_key_length%&
38167 Number of bits in the key.
38168 .endlist
38169
38170 In addition, two ACL conditions are provided:
38171
38172 .vlist
38173 .vitem &%dkim_signers%&
38174 ACL condition that checks a colon-separated list of domains or identities
38175 for a match against the domain or identity that the ACL is currently verifying
38176 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38177 verb to a group of domains or identities. For example:
38178
38179 .code
38180 # Warn when Mail purportedly from GMail has no signature at all
38181 warn log_message = GMail sender without DKIM signature
38182      sender_domains = gmail.com
38183      dkim_signers = gmail.com
38184      dkim_status = none
38185 .endd
38186
38187 .vitem &%dkim_status%&
38188 ACL condition that checks a colon-separated list of possible DKIM verification
38189 results against the actual result of verification. This is typically used
38190 to restrict an ACL verb to a list of verification outcomes, for example:
38191
38192 .code
38193 deny message = Mail from Paypal with invalid/missing signature
38194      sender_domains = paypal.com:paypal.de
38195      dkim_signers = paypal.com:paypal.de
38196      dkim_status = none:invalid:fail
38197 .endd
38198
38199 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38200 see the documentation of the &%$dkim_verify_status%& expansion variable above
38201 for more information of what they mean.
38202 .endlist
38203
38204 . ////////////////////////////////////////////////////////////////////////////
38205 . ////////////////////////////////////////////////////////////////////////////
38206
38207 .chapter "Proxies" "CHAPproxies" &&&
38208          "Proxy support"
38209 .cindex "proxy support"
38210 .cindex "proxy" "access via"
38211
38212 A proxy is an intermediate system through which communication is passed.
38213 Proxies may provide a security, availability or load-distribution function.
38214
38215
38216 .section "Inbound proxies" SECTproxyInbound
38217 .cindex proxy inbound
38218 .cindex proxy "server side"
38219 .cindex proxy "Proxy protocol"
38220 .cindex "Proxy protocol" proxy
38221
38222 Exim has support for receiving inbound SMTP connections via a proxy
38223 that uses &"Proxy Protocol"& to speak to it.
38224 To include this support, include &"SUPPORT_PROXY=yes"&
38225 in Local/Makefile.
38226
38227 It was built on specifications from:
38228 http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt
38229 That URL was revised in May 2014 to version 2 spec:
38230 http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e
38231
38232 The purpose of this facility is so that an application load balancer,
38233 such as HAProxy, can sit in front of several Exim servers
38234 to distribute load.
38235 Exim uses the local protocol communication with the proxy to obtain
38236 the remote SMTP system IP address and port information.
38237 There is no logging if a host passes or
38238 fails Proxy Protocol negotiation, but it can easily be determined and
38239 recorded in an ACL (example is below).
38240
38241 Use of a proxy is enabled by setting the &%hosts_proxy%&
38242 main configuration option to a hostlist; connections from these
38243 hosts will use Proxy Protocol.
38244
38245 .new
38246 The following expansion variables are usable
38247 (&"internal"& and &"external"& here refer to the interfaces
38248 of the proxy):
38249 .display
38250 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38251 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38252 &'proxy_local_address '& IP of proxy server inbound or IP of local interface of proxy
38253 &'proxy_local_port    '& Port of proxy server inbound or Port on local interface of proxy
38254 &'proxy_session        '& boolean: SMTP connection via proxy
38255 .endd
38256 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38257 there was a protocol error.
38258 .wen
38259
38260 Since the real connections are all coming from the proxy, and the
38261 per host connection tracking is done before Proxy Protocol is
38262 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38263 handle all of the parallel volume you expect per inbound proxy.
38264 With the option set so high, you lose the ability
38265 to protect your server from many connections from one IP.
38266 In order to prevent your server from overload, you
38267 need to add a per connection ratelimit to your connect ACL.
38268 A possible solution is:
38269 .display
38270   # Set max number of connections per host
38271   LIMIT   = 5
38272   # Or do some kind of IP lookup in a flat file or database
38273   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38274
38275   defer   message        = Too many connections from this IP right now
38276           ratelimit      = LIMIT / 5s / per_conn / strict
38277 .endd
38278
38279
38280
38281 .section "Outbound proxies" SECTproxySOCKS
38282 .cindex proxy outbound
38283 .cindex proxy "client side"
38284 .cindex proxy SOCKS
38285 .cindex SOCKS proxy
38286 Exim has support for sending outbound SMTP via a proxy
38287 using a protocol called SOCKS5 (defined by RFC1928).
38288 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38289 Local/Makefile.
38290
38291 Use of a proxy is enabled by setting the &%socks_proxy%& option
38292 on an smtp transport.
38293 The option value is expanded and should then be a list
38294 (colon-separated by default) of proxy specifiers.
38295 Each proxy specifier is a list
38296 (space-separated by default) where the initial element
38297 is an IP address and any subsequent elements are options.
38298
38299 Options are a string <name>=<value>.
38300 The list of options is in the following table:
38301 .display
38302 &'auth   '& authentication method
38303 &'name   '& authentication username
38304 &'pass   '& authentication password
38305 &'port   '& tcp port
38306 &'tmo    '& connection timeout
38307 &'pri    '& priority
38308 &'weight '& selection bias
38309 .endd
38310
38311 More details on each of these options follows:
38312
38313 .ilist
38314 .cindex authentication "to proxy"
38315 .cindex proxy authentication
38316 &%auth%&: Either &"none"& (default) or &"name"&.
38317 Using &"name"& selects username/password authentication per RFC 1929
38318 for access to the proxy.
38319 Default is &"none"&.
38320 .next
38321 &%name%&: sets the username for the &"name"& authentication method.
38322 Default is empty.
38323 .next
38324 &%pass%&: sets the password for the &"name"& authentication method.
38325 Default is empty.
38326 .next
38327 &%port%&: the TCP port number to use for the connection to the proxy.
38328 Default is 1080.
38329 .next
38330 &%tmo%&: sets a connection timeout in seconds for this proxy.
38331 Default is 5.
38332 .next
38333 &%pri%&: specifies a priority for the proxy within the list,
38334 higher values being tried first.
38335 The default priority is 1.
38336 .next
38337 &%weight%&: specifies a selection bias.
38338 Within a priority set servers are queried in a random fashion,
38339 weighted by this value.
38340 The default value for selection bias is 1.
38341 .endlist
38342
38343 Proxies from the list are tried according to their priority
38344 and weight settings until one responds.  The timeout for the
38345 overall connection applies to the set of proxied attempts.
38346
38347 .section Logging SECTproxyLog
38348 To log the (local) IP of a proxy in the incoming or delivery logline,
38349 add &"+proxy"& to the &%log_selector%& option.
38350 This will add a component tagged with &"PRX="& to the line.
38351
38352 . ////////////////////////////////////////////////////////////////////////////
38353 . ////////////////////////////////////////////////////////////////////////////
38354
38355 .chapter "Internationalisation" "CHAPi18n" &&&
38356          "Internationalisation""
38357 .cindex internationalisation "email address"
38358 .cindex EAI
38359 .cindex i18n
38360 .cindex UTF-8 "mail name handling"
38361
38362 Exim has support for Internationalised mail names.
38363 To include this it must be built with SUPPORT_I18N and the libidn library.
38364 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38365
38366 .section "MTA operations" SECTi18nMTA
38367 .cindex SMTPUTF8 "ESMTP option"
38368 The main configuration option &%smtputf8_advertise_hosts%& specifies
38369 a host list.  If this matches the sending host and
38370 accept_8bitmime is true (the default) then the ESMTP option
38371 SMTPUTF8 will be advertised.
38372
38373 If the sender specifies the SMTPUTF8 option on a MAIL command
38374 international handling for the message is enabled and
38375 the expansion variable &$message_smtputf8$& will have value TRUE.
38376
38377 The option &%allow_utf8_domains%& is set to true for this
38378 message. All DNS lookups are converted to a-label form
38379 whatever the setting of &%allow_utf8_domains%&
38380 when Exim is built with SUPPORT_I18N.
38381
38382 Both localparts and domain are maintained as the original
38383 UTF-8 form internally; any comparison or regular-expression use will
38384 require appropriate care.  Filenames created, eg. by
38385 the appendfile transport, will have UTF-8 names.
38386
38387 HELO names sent by the smtp transport will have any UTF-8
38388 components expanded to a-label form,
38389 and any certificate name checks will be done using the a-label
38390 form of the name.
38391
38392 .cindex log protocol
38393 .cindex SMTPUTF8 logging
38394 Log lines and Received-by: header lines will acquire a "utf8"
38395 prefix on the protocol element, eg. utf8esmtp.
38396
38397 The following expansion operator can be used:
38398 .code
38399 ${utf8_domain_to_alabel:str}
38400 ${utf8_domain_from_alabel:str}
38401 ${utf8_localpart_to_alabel:str}
38402 ${utf8_localpart_from_alabel:str}
38403 .endd
38404
38405 ACLs may use the following modifier:
38406 .display
38407 control = utf8_downconvert
38408 control = utf8_downconvert/<value>
38409 .endd
38410 This sets a flag requiring that addresses are converted to
38411 a-label form before smtp delivery, for use in a
38412 Message Submission Agent context.
38413 If a value is appended it may be:
38414 .display
38415 &`1  `& (default) mandatory downconversion
38416 &`0  `& no downconversion
38417 &`-1 `& if SMTPUTF8 not supported by destination host
38418 .endd
38419
38420 If mua_wrapper is set, the utf8_downconvert control
38421 is initially set to -1.
38422
38423
38424 There is no explicit support for VRFY and EXPN.
38425 Configurations supporting these should inspect
38426 &$smtp_command_argument$& for an SMTPUTF8 argument.
38427
38428 There is no support for LMTP on Unix sockets.
38429 Using the "lmtp" protocol option on an smtp transport,
38430 for LMTP over TCP, should work as expected.
38431
38432 There is no support for DSN unitext handling,
38433 and no provision for converting logging from or to UTF-8.
38434
38435
38436
38437 .section "MDA operations" SECTi18nMDA
38438 To aid in constructing names suitable for IMAP folders
38439 the following expansion operator can be used:
38440 .code
38441 ${imapfolder {<string>} {<sep>} {<specials>}}
38442 .endd
38443
38444 The string is converted from the charset specified by
38445 the "headers charset" command (in a filter file)
38446 or &%headers_charset%& main configuration option (otherwise),
38447 to the
38448 modified UTF-7 encoding specified by RFC 2060,
38449 with the following exception: All occurences of <sep>
38450 (which has to be a single character)
38451 are replaced with periods ("."), and all periods and slashes that are not
38452 <sep> and are not in the <specials> string are BASE64 encoded.
38453
38454 The third argument can be omitted, defaulting to an empty string.
38455 The second argument can be omitted, defaulting to "/".
38456
38457 This is the encoding used by Courier for Maildir names on disk, and followed
38458 by many other IMAP servers.
38459
38460 Examples:
38461 .display
38462 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
38463 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
38464 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
38465 .endd
38466
38467 Note that the source charset setting is vital, and also that characters
38468 must be representable in UTF-16.
38469
38470
38471 . ////////////////////////////////////////////////////////////////////////////
38472 . ////////////////////////////////////////////////////////////////////////////
38473
38474 .chapter "Events" "CHAPevents" &&&
38475          "Events"
38476 .cindex events
38477
38478 The events mechanism in Exim can be used to intercept processing at a number
38479 of points.  It was originally invented to giave a way to do customised logging
38480 actions (for example, to a database) but can also be used to modify some
38481 processing actions.
38482
38483 Most installations will never need to use Events.
38484 The support can be left out of a build by defining DISABLE_EVENT=yes
38485 in &_Local/Makefile_&.
38486
38487 There are two major classes of events: main and transport.
38488 The main configuration option &%event_action%& controls reception events;
38489 a transport option &%event_action%& controls delivery events.
38490
38491 Both options are a string which is expanded when the event fires.
38492 An example might look like:
38493 .cindex logging custom
38494 .code
38495 event_action = ${if eq {msg:delivery}{$event_name} \
38496 {${lookup pgsql {SELECT * FROM record_Delivery( \
38497     '${quote_pgsql:$sender_address_domain}',\
38498     '${quote_pgsql:${lc:$sender_address_local_part}}', \
38499     '${quote_pgsql:$domain}', \
38500     '${quote_pgsql:${lc:$local_part}}', \
38501     '${quote_pgsql:$host_address}', \
38502     '${quote_pgsql:${lc:$host}}', \
38503     '${quote_pgsql:$message_exim_id}')}} \
38504 } {}}
38505 .endd
38506
38507 Events have names which correspond to the point in process at which they fire.
38508 The name is placed in the variable &$event_name$& and the event action
38509 expansion must check this, as it will be called for every possible event type.
38510
38511 The current list of events is:
38512 .display
38513 &`msg:complete           after    main       `& per message
38514 &`msg:delivery           after    transport  `& per recipient
38515 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
38516 &`msg:rcpt:defer         after    transport  `& per recipient
38517 &`msg:host:defer         after    transport  `& per attempt
38518 &`msg:fail:delivery      after    main       `& per recipient
38519 &`msg:fail:internal      after    main       `& per recipient
38520 &`tcp:connect            before   transport  `& per connection
38521 &`tcp:close              after    transport  `& per connection
38522 &`tls:cert               before   both       `& per certificate in verification chain
38523 &`smtp:connect           after    transport  `& per connection
38524 .endd
38525 New event types may be added in future.
38526
38527 The event name is a colon-separated list, defining the type of
38528 event in a tree of possibilities.  It may be used as a list
38529 or just matched on as a whole.  There will be no spaces in the name.
38530
38531 The second column in the table above describes whether the event fires
38532 before or after the action is associates with.  Those which fire before
38533 can be used to affect that action (more on this below).
38534
38535 An additional variable, &$event_data$&, is filled with information varying
38536 with the event type:
38537 .display
38538 &`msg:delivery         `& smtp confirmation mssage
38539 &`msg:rcpt:host:defer  `& error string
38540 &`msg:rcpt:defer       `& error string
38541 &`msg:host:defer       `& error string
38542 &`tls:cert             `& verification chain depth
38543 &`smtp:connect         `& smtp banner
38544 .endd
38545
38546 The :defer events populate one extra variable: &$event_defer_errno$&.
38547
38548 For complex operations an ACL expansion can be used in &%event_action%&
38549 however due to the multiple contextx that Exim operates in during
38550 the course of its processing:
38551 .ilist
38552 variables set in transport events will not be visible outside that
38553 transport call
38554 .next
38555 acl_m variables in a server context are lost on a new connection,
38556 and after smtp helo/ehlo/mail/starttls/rset commands
38557 .endlist
38558 Using an ACL expansion with the logwrite modifier can be
38559 a useful way of writing to the main log.
38560
38561 The expansion of the event_action option should normally
38562 return an empty string.  Should it return anything else the
38563 following will be forced:
38564 .display
38565 &`msg:delivery     `&  (ignored)
38566 &`msg:host:defer   `&  (ignored)
38567 &`msg:fail:delivery`&  (ignored)
38568 &`tcp:connect      `&  do not connect
38569 &`tcp:close        `&  (ignored)
38570 &`tls:cert         `&  refuse verification
38571 &`smtp:connect     `&  close connection
38572 .endd
38573 No other use is made of the result string.
38574
38575 For a tcp:connect event, if the connection is being made to a proxy
38576 then the address and port variables will be that of the proxy and not
38577 the target system.
38578
38579 For tls:cert events, if GnuTLS is in use this will trigger only per
38580 chain element received on the connection.
38581 For OpenSSL it will trigger for every chain element including those
38582 loaded locally.
38583
38584 . ////////////////////////////////////////////////////////////////////////////
38585 . ////////////////////////////////////////////////////////////////////////////
38586
38587 .chapter "Adding new drivers or lookup types" "CHID13" &&&
38588          "Adding drivers or lookups"
38589 .cindex "adding drivers"
38590 .cindex "new drivers, adding"
38591 .cindex "drivers" "adding new"
38592 The following actions have to be taken in order to add a new router, transport,
38593 authenticator, or lookup type to Exim:
38594
38595 .olist
38596 Choose a name for the driver or lookup type that does not conflict with any
38597 existing name; I will use &"newdriver"& in what follows.
38598 .next
38599 Add to &_src/EDITME_& the line:
38600 .display
38601 <&'type'&>&`_NEWDRIVER=yes`&
38602 .endd
38603 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
38604 code is not to be included in the binary by default, comment this line out. You
38605 should also add any relevant comments about the driver or lookup type.
38606 .next
38607 Add to &_src/config.h.defaults_& the line:
38608 .code
38609 #define <type>_NEWDRIVER
38610 .endd
38611 .next
38612 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
38613 and create a table entry as is done for all the other drivers and lookup types.
38614 .next
38615 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
38616 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
38617 Add your &`NEWDRIVER`& to that list.
38618 As long as the dynamic module would be named &_newdriver.so_&, you can use the
38619 simple form that most lookups have.
38620 .next
38621 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
38622 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
38623 driver or lookup type and add it to the definition of OBJ.
38624 .next
38625 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
38626 &_src_&.
38627 .next
38628 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
38629 as for other drivers and lookups.
38630 .endlist
38631
38632 Then all you need to do is write the code! A good way to start is to make a
38633 proforma by copying an existing module of the same type, globally changing all
38634 occurrences of the name, and cutting out most of the code. Note that any
38635 options you create must be listed in alphabetical order, because the tables are
38636 searched using a binary chop procedure.
38637
38638 There is a &_README_& file in each of the sub-directories of &_src_& describing
38639 the interface that is expected.
38640
38641
38642
38643
38644 . ////////////////////////////////////////////////////////////////////////////
38645 . ////////////////////////////////////////////////////////////////////////////
38646
38647 . /////////////////////////////////////////////////////////////////////////////
38648 . These lines are processing instructions for the Simple DocBook Processor that
38649 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38650 . PDFs than using xmlto and fop. They will be ignored by all other XML
38651 . processors.
38652 . /////////////////////////////////////////////////////////////////////////////
38653
38654 .literal xml
38655 <?sdop
38656   format="newpage"
38657   foot_right_recto="&chaptertitle;"
38658   foot_right_verso="&chaptertitle;"
38659 ?>
38660 .literal off
38661
38662 .makeindex "Options index"   "option"
38663 .makeindex "Variables index" "variable"
38664 .makeindex "Concept index"   "concept"
38665
38666
38667 . /////////////////////////////////////////////////////////////////////////////
38668 . /////////////////////////////////////////////////////////////////////////////