Add cmdline option to append a log message. Bug 418
[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.85"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2014
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- the small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for Ascii
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and Unixware.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of the program,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of the document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, the manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(http://www.uit.co.uk/exim-book/)).
396
397 This book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As the program develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to the program (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .endtable
440
441 The main specification and the specification of the filtering language are also
442 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
443 &<<SECTavail>>& below tells you how to get hold of these.
444
445
446
447 .section "FTP and web sites" "SECID2"
448 .cindex "web site"
449 .cindex "FTP site"
450 The primary site for Exim source distributions is currently the University of
451 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
452 distribution'& below. In addition, there is a web site and an FTP site at
453 &%exim.org%&. These are now also hosted at the University of Cambridge. The
454 &%exim.org%& site was previously hosted for a number of years by Energis
455 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
456
457 .cindex "wiki"
458 .cindex "FAQ"
459 As well as Exim distribution tar files, the Exim web site contains a number of
460 differently formatted versions of the documentation. A recent addition to the
461 online information is the Exim wiki (&url(http://wiki.exim.org)),
462 which contains what used to be a separate FAQ, as well as various other
463 examples, tips, and know-how that have been contributed by Exim users.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(http://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on this list and not on the general Exim
493 lists.
494
495 .section "Exim training" "SECID4"
496 .cindex "training courses"
497 Training courses in Cambridge (UK) used to be run annually by the author of
498 Exim, before he retired. At the time of writing, there are no plans to run
499 further Exim courses in Cambridge. However, if that changes, relevant
500 information will be posted at &url(http://www-tus.csx.cam.ac.uk/courses/exim/).
501
502 .section "Bug reports" "SECID5"
503 .cindex "bug reports"
504 .cindex "reporting bugs"
505 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
506 via the Bugzilla (&url(http://bugs.exim.org)). However, if you are unsure
507 whether some behaviour is a bug or not, the best thing to do is to post a
508 message to the &'exim-dev'& mailing list and have it discussed.
509
510
511
512 .section "Where to find the Exim distribution" "SECTavail"
513 .cindex "FTP site"
514 .cindex "distribution" "ftp site"
515 The master ftp site for the Exim distribution is
516 .display
517 &*ftp://ftp.csx.cam.ac.uk/pub/software/email/exim*&
518 .endd
519 This is mirrored by
520 .display
521 &*ftp://ftp.exim.org/pub/exim*&
522 .endd
523 The file references that follow are relative to the &_exim_& directories at
524 these sites. There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.gz_&
533 &_exim-n.nn.tar.bz2_&
534 .endd
535 where &'n.nn'& is the highest such version number in the directory. The two
536 files contain identical data; the only difference is the type of compression.
537 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
538
539 .cindex "distribution" "signing details"
540 .cindex "distribution" "public key"
541 .cindex "public key for signed distribution"
542 The distributions will be PGP signed by an individual key of the Release
543 Coordinator.  This key will have a uid containing an email address in the
544 &'exim.org'& domain and will have signatures from other people, including
545 other Exim maintainers.  We expect that the key will be in the "strong set" of
546 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
547 PGP key, a version of which can be found in the release directory in the file
548 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
549 such as &'pool.sks-keyservers.net'&.
550
551 At time of last update, releases were being made by Phil Pennock and signed with
552 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
553 A trust path from Nigel's key to Phil's can be observed at
554 &url(https://www.security.spodhuis.org/exim-trustpath).
555
556 Releases have also been authorized to be performed by Todd Lyons who signs with
557 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
558 Pennock and Todd Lyons through a common associate.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.gz.asc_&
563 &_exim-n.nn.tar.bz2.asc_&
564 .endd
565 For each released version, the log of changes is made separately available in a
566 separate file in the directory &_ChangeLogs_& so that it is possible to
567 find out what has changed without having to download the entire distribution.
568
569 .cindex "documentation" "available formats"
570 The main distribution contains ASCII versions of this specification and other
571 documentation; other formats of the documents are available in separate files
572 inside the &_exim4_& directory of the FTP site:
573 .display
574 &_exim-html-n.nn.tar.gz_&
575 &_exim-pdf-n.nn.tar.gz_&
576 &_exim-postscript-n.nn.tar.gz_&
577 &_exim-texinfo-n.nn.tar.gz_&
578 .endd
579 These tar files contain only the &_doc_& directory, not the complete
580 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
581
582
583 .section "Limitations" "SECID6"
584 .ilist
585 .cindex "limitations of Exim"
586 .cindex "bang paths" "not handled by Exim"
587 Exim is designed for use as an Internet MTA, and therefore handles addresses in
588 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
589 simple two-component bang paths can be converted by a straightforward rewriting
590 configuration. This restriction does not prevent Exim from being interfaced to
591 UUCP as a transport mechanism, provided that domain addresses are used.
592 .next
593 .cindex "domainless addresses"
594 .cindex "address" "without domain"
595 Exim insists that every address it handles has a domain attached. For incoming
596 local messages, domainless addresses are automatically qualified with a
597 configured domain value. Configuration options specify from which remote
598 systems unqualified addresses are acceptable. These are then qualified on
599 arrival.
600 .next
601 .cindex "transport" "external"
602 .cindex "external transports"
603 The only external transport mechanisms that are currently implemented are SMTP
604 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
605 transport is available, and there are facilities for writing messages to files
606 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
607 to send messages to other transport mechanisms such as UUCP, provided they can
608 handle domain-style addresses. Batched SMTP input is also catered for.
609 .next
610 Exim is not designed for storing mail for dial-in hosts. When the volumes of
611 such mail are large, it is better to get the messages &"delivered"& into files
612 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
613 other means.
614 .next
615 Although Exim does have basic facilities for scanning incoming messages, these
616 are not comprehensive enough to do full virus or spam scanning. Such operations
617 are best carried out using additional specialized software packages. If you
618 compile Exim with the content-scanning extension, straightforward interfaces to
619 a number of common scanners are provided.
620 .endlist
621
622
623 .section "Run time configuration" "SECID7"
624 Exim's run time configuration is held in a single text file that is divided
625 into a number of sections. The entries in this file consist of keywords and
626 values, in the style of Smail 3 configuration files. A default configuration
627 file which is suitable for simple online installations is provided in the
628 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
629
630
631 .section "Calling interface" "SECID8"
632 .cindex "Sendmail compatibility" "command line interface"
633 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
634 can be a straight replacement for &_/usr/lib/sendmail_& or
635 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
636 about Sendmail in order to run Exim. For actions other than sending messages,
637 Sendmail-compatible options also exist, but those that produce output (for
638 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
639 format. There are also some additional options that are compatible with Smail
640 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
641 documents all Exim's command line options. This information is automatically
642 made into the man page that forms part of the Exim distribution.
643
644 Control of messages on the queue can be done via certain privileged command
645 line options. There is also an optional monitor program called &'eximon'&,
646 which displays current information in an X window, and which contains a menu
647 interface to Exim's command line administration options.
648
649
650
651 .section "Terminology" "SECID9"
652 .cindex "terminology definitions"
653 .cindex "body of message" "definition of"
654 The &'body'& of a message is the actual data that the sender wants to transmit.
655 It is the last part of a message, and is separated from the &'header'& (see
656 below) by a blank line.
657
658 .cindex "bounce message" "definition of"
659 When a message cannot be delivered, it is normally returned to the sender in a
660 delivery failure message or a &"non-delivery report"& (NDR). The term
661 &'bounce'& is commonly used for this action, and the error reports are often
662 called &'bounce messages'&. This is a convenient shorthand for &"delivery
663 failure error report"&. Such messages have an empty sender address in the
664 message's &'envelope'& (see below) to ensure that they cannot themselves give
665 rise to further bounce messages.
666
667 The term &'default'& appears frequently in this manual. It is used to qualify a
668 value which is used in the absence of any setting in the configuration. It may
669 also qualify an action which is taken unless a configuration setting specifies
670 otherwise.
671
672 The term &'defer'& is used when the delivery of a message to a specific
673 destination cannot immediately take place for some reason (a remote host may be
674 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
675 until a later time.
676
677 The word &'domain'& is sometimes used to mean all but the first component of a
678 host's name. It is &'not'& used in that sense here, where it normally refers to
679 the part of an email address following the @ sign.
680
681 .cindex "envelope, definition of"
682 .cindex "sender" "definition of"
683 A message in transit has an associated &'envelope'&, as well as a header and a
684 body. The envelope contains a sender address (to which bounce messages should
685 be delivered), and any number of recipient addresses. References to the
686 sender or the recipients of a message usually mean the addresses in the
687 envelope. An MTA uses these addresses for delivery, and for returning bounce
688 messages, not the addresses that appear in the header lines.
689
690 .cindex "message" "header, definition of"
691 .cindex "header section" "definition of"
692 The &'header'& of a message is the first part of a message's text, consisting
693 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
694 &'Subject:'&, etc. Long header lines can be split over several text lines by
695 indenting the continuations. The header is separated from the body by a blank
696 line.
697
698 .cindex "local part" "definition of"
699 .cindex "domain" "definition of"
700 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
701 part of an email address that precedes the @ sign. The part that follows the
702 @ sign is called the &'domain'& or &'mail domain'&.
703
704 .cindex "local delivery" "definition of"
705 .cindex "remote delivery, definition of"
706 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
707 delivery to a file or a pipe on the local host from delivery by SMTP over
708 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
709 host it is running on are &'remote'&.
710
711 .cindex "return path" "definition of"
712 &'Return path'& is another name that is used for the sender address in a
713 message's envelope.
714
715 .cindex "queue" "definition of"
716 The term &'queue'& is used to refer to the set of messages awaiting delivery,
717 because this term is in widespread use in the context of MTAs. However, in
718 Exim's case the reality is more like a pool than a queue, because there is
719 normally no ordering of waiting messages.
720
721 .cindex "queue runner" "definition of"
722 The term &'queue runner'& is used to describe a process that scans the queue
723 and attempts to deliver those messages whose retry times have come. This term
724 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
725 the waiting messages are normally processed in an unpredictable order.
726
727 .cindex "spool directory" "definition of"
728 The term &'spool directory'& is used for a directory in which Exim keeps the
729 messages on its queue &-- that is, those that it is in the process of
730 delivering. This should not be confused with the directory in which local
731 mailboxes are stored, which is called a &"spool directory"& by some people. In
732 the Exim documentation, &"spool"& is always used in the first sense.
733
734
735
736
737
738
739 . ////////////////////////////////////////////////////////////////////////////
740 . ////////////////////////////////////////////////////////////////////////////
741
742 .chapter "Incorporated code" "CHID2"
743 .cindex "incorporated code"
744 .cindex "regular expressions" "library"
745 .cindex "PCRE"
746 .cindex "OpenDMARC"
747 A number of pieces of external code are included in the Exim distribution.
748
749 .ilist
750 Regular expressions are supported in the main Exim program and in the
751 Exim monitor using the freely-distributable PCRE library, copyright
752 &copy; University of Cambridge. The source to PCRE is no longer shipped with
753 Exim, so you will need to use the version of PCRE shipped with your system,
754 or obtain and install the full version of the library from
755 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
756 .next
757 .cindex "cdb" "acknowledgment"
758 Support for the cdb (Constant DataBase) lookup method is provided by code
759 contributed by Nigel Metheringham of (at the time he contributed it) Planet
760 Online Ltd. The implementation is completely contained within the code of Exim.
761 It does not link against an external cdb library. The code contains the
762 following statements:
763
764 .blockquote
765 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
766
767 This program is free software; you can redistribute it and/or modify it under
768 the terms of the GNU General Public License as published by the Free Software
769 Foundation; either version 2 of the License, or (at your option) any later
770 version.
771 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
772 the spec and sample code for cdb can be obtained from
773 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
774 some code from Dan Bernstein's implementation (which has no license
775 restrictions applied to it).
776 .endblockquote
777 .next
778 .cindex "SPA authentication"
779 .cindex "Samba project"
780 .cindex "Microsoft Secure Password Authentication"
781 Client support for Microsoft's &'Secure Password Authentication'& is provided
782 by code contributed by Marc Prud'hommeaux. Server support was contributed by
783 Tom Kistner. This includes code taken from the Samba project, which is released
784 under the Gnu GPL.
785 .next
786 .cindex "Cyrus"
787 .cindex "&'pwcheck'& daemon"
788 .cindex "&'pwauthd'& daemon"
789 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
790 by code taken from the Cyrus-SASL library and adapted by Alexander S.
791 Sabourenkov. The permission notice appears below, in accordance with the
792 conditions expressed therein.
793
794 .blockquote
795 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
796
797 Redistribution and use in source and binary forms, with or without
798 modification, are permitted provided that the following conditions
799 are met:
800
801 .olist
802 Redistributions of source code must retain the above copyright
803 notice, this list of conditions and the following disclaimer.
804 .next
805 Redistributions in binary form must reproduce the above copyright
806 notice, this list of conditions and the following disclaimer in
807 the documentation and/or other materials provided with the
808 distribution.
809 .next
810 The name &"Carnegie Mellon University"& must not be used to
811 endorse or promote products derived from this software without
812 prior written permission. For permission or any other legal
813 details, please contact
814 .display
815               Office of Technology Transfer
816               Carnegie Mellon University
817               5000 Forbes Avenue
818               Pittsburgh, PA  15213-3890
819               (412) 268-4387, fax: (412) 268-7395
820               tech-transfer@andrew.cmu.edu
821 .endd
822 .next
823 Redistributions of any form whatsoever must retain the following
824 acknowledgment:
825
826 &"This product includes software developed by Computing Services
827 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
828
829 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
830 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
831 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
832 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
833 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
834 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
835 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
836 .endlist
837 .endblockquote
838
839 .next
840 .cindex "Exim monitor" "acknowledgment"
841 .cindex "X-windows"
842 .cindex "Athena"
843 The Exim Monitor program, which is an X-Window application, includes
844 modified versions of the Athena StripChart and TextPop widgets.
845 This code is copyright by DEC and MIT, and their permission notice appears
846 below, in accordance with the conditions expressed therein.
847
848 .blockquote
849 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
850 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
851
852 All Rights Reserved
853
854 Permission to use, copy, modify, and distribute this software and its
855 documentation for any purpose and without fee is hereby granted,
856 provided that the above copyright notice appear in all copies and that
857 both that copyright notice and this permission notice appear in
858 supporting documentation, and that the names of Digital or MIT not be
859 used in advertising or publicity pertaining to distribution of the
860 software without specific, written prior permission.
861
862 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
863 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
864 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
865 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
866 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
867 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
868 SOFTWARE.
869 .endblockquote
870
871 .next
872 .cindex "opendmarc" "acknowledgment"
873 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
874 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
875 derived code are indicated in the respective source files. The full OpenDMARC
876 license is provided in the LICENSE.opendmarc file contained in the distributed
877 source code.
878
879 .next
880 Many people have contributed code fragments, some large, some small, that were
881 not covered by any specific licence requirements. It is assumed that the
882 contributors are happy to see their code incorporated into Exim under the GPL.
883 .endlist
884
885
886
887
888
889 . ////////////////////////////////////////////////////////////////////////////
890 . ////////////////////////////////////////////////////////////////////////////
891
892 .chapter "How Exim receives and delivers mail" "CHID11" &&&
893          "Receiving and delivering mail"
894
895
896 .section "Overall philosophy" "SECID10"
897 .cindex "design philosophy"
898 Exim is designed to work efficiently on systems that are permanently connected
899 to the Internet and are handling a general mix of mail. In such circumstances,
900 most messages can be delivered immediately. Consequently, Exim does not
901 maintain independent queues of messages for specific domains or hosts, though
902 it does try to send several messages in a single SMTP connection after a host
903 has been down, and it also maintains per-host retry information.
904
905
906 .section "Policy control" "SECID11"
907 .cindex "policy control" "overview"
908 Policy controls are now an important feature of MTAs that are connected to the
909 Internet. Perhaps their most important job is to stop MTAs being abused as
910 &"open relays"& by misguided individuals who send out vast amounts of
911 unsolicited junk, and want to disguise its source. Exim provides flexible
912 facilities for specifying policy controls on incoming mail:
913
914 .ilist
915 .cindex "&ACL;" "introduction"
916 Exim 4 (unlike previous versions of Exim) implements policy controls on
917 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
918 series of statements that may either grant or deny access. ACLs can be used at
919 several places in the SMTP dialogue while receiving a message from a remote
920 host. However, the most common places are after each RCPT command, and at the
921 very end of the message. The sysadmin can specify conditions for accepting or
922 rejecting individual recipients or the entire message, respectively, at these
923 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
924 error code.
925 .next
926 An ACL is also available for locally generated, non-SMTP messages. In this
927 case, the only available actions are to accept or deny the entire message.
928 .next
929 When Exim is compiled with the content-scanning extension, facilities are
930 provided in the ACL mechanism for passing the message to external virus and/or
931 spam scanning software. The result of such a scan is passed back to the ACL,
932 which can then use it to decide what to do with the message.
933 .next
934 When a message has been received, either from a remote host or from the local
935 host, but before the final acknowledgment has been sent, a locally supplied C
936 function called &[local_scan()]& can be run to inspect the message and decide
937 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
938 is accepted, the list of recipients can be modified by the function.
939 .next
940 Using the &[local_scan()]& mechanism is another way of calling external scanner
941 software. The &%SA-Exim%& add-on package works this way. It does not require
942 Exim to be compiled with the content-scanning extension.
943 .next
944 After a message has been accepted, a further checking mechanism is available in
945 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
946 runs at the start of every delivery process.
947 .endlist
948
949
950
951 .section "User filters" "SECID12"
952 .cindex "filter" "introduction"
953 .cindex "Sieve filter"
954 In a conventional Exim configuration, users are able to run private filters by
955 setting up appropriate &_.forward_& files in their home directories. See
956 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
957 configuration needed to support this, and the separate document entitled
958 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
959 of filtering are available:
960
961 .ilist
962 Sieve filters are written in the standard filtering language that is defined
963 by RFC 3028.
964 .next
965 Exim filters are written in a syntax that is unique to Exim, but which is more
966 powerful than Sieve, which it pre-dates.
967 .endlist
968
969 User filters are run as part of the routing process, described below.
970
971
972
973 .section "Message identification" "SECTmessiden"
974 .cindex "message ids" "details of format"
975 .cindex "format" "of message id"
976 .cindex "id of message"
977 .cindex "base62"
978 .cindex "base36"
979 .cindex "Darwin"
980 .cindex "Cygwin"
981 Every message handled by Exim is given a &'message id'& which is sixteen
982 characters long. It is divided into three parts, separated by hyphens, for
983 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
984 normally encoding numbers in base 62. However, in the Darwin operating
985 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
986 (avoiding the use of lower case letters) is used instead, because the message
987 id is used to construct file names, and the names of files in those systems are
988 not always case-sensitive.
989
990 .cindex "pid (process id)" "re-use of"
991 The detail of the contents of the message id have changed as Exim has evolved.
992 Earlier versions relied on the operating system not re-using a process id (pid)
993 within one second. On modern operating systems, this assumption can no longer
994 be made, so the algorithm had to be changed. To retain backward compatibility,
995 the format of the message id was retained, which is why the following rules are
996 somewhat eccentric:
997
998 .ilist
999 The first six characters of the message id are the time at which the message
1000 started to be received, to a granularity of one second. That is, this field
1001 contains the number of seconds since the start of the epoch (the normal Unix
1002 way of representing the date and time of day).
1003 .next
1004 After the first hyphen, the next six characters are the id of the process that
1005 received the message.
1006 .next
1007 There are two different possibilities for the final two characters:
1008 .olist
1009 .oindex "&%localhost_number%&"
1010 If &%localhost_number%& is not set, this value is the fractional part of the
1011 time of reception, normally in units of 1/2000 of a second, but for systems
1012 that must use base 36 instead of base 62 (because of case-insensitive file
1013 systems), the units are 1/1000 of a second.
1014 .next
1015 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1016 the fractional part of the time, which in this case is in units of 1/200
1017 (1/100) of a second.
1018 .endlist
1019 .endlist
1020
1021 After a message has been received, Exim waits for the clock to tick at the
1022 appropriate resolution before proceeding, so that if another message is
1023 received by the same process, or by another process with the same (re-used)
1024 pid, it is guaranteed that the time will be different. In most cases, the clock
1025 will already have ticked while the message was being received.
1026
1027
1028 .section "Receiving mail" "SECID13"
1029 .cindex "receiving mail"
1030 .cindex "message" "reception"
1031 The only way Exim can receive mail from another host is using SMTP over
1032 TCP/IP, in which case the sender and recipient addresses are transferred using
1033 SMTP commands. However, from a locally running process (such as a user's MUA),
1034 there are several possibilities:
1035
1036 .ilist
1037 If the process runs Exim with the &%-bm%& option, the message is read
1038 non-interactively (usually via a pipe), with the recipients taken from the
1039 command line, or from the body of the message if &%-t%& is also used.
1040 .next
1041 If the process runs Exim with the &%-bS%& option, the message is also read
1042 non-interactively, but in this case the recipients are listed at the start of
1043 the message in a series of SMTP RCPT commands, terminated by a DATA
1044 command. This is so-called &"batch SMTP"& format,
1045 but it isn't really SMTP. The SMTP commands are just another way of passing
1046 envelope addresses in a non-interactive submission.
1047 .next
1048 If the process runs Exim with the &%-bs%& option, the message is read
1049 interactively, using the SMTP protocol. A two-way pipe is normally used for
1050 passing data between the local process and the Exim process.
1051 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1052 example, the ACLs for SMTP commands are used for this form of submission.
1053 .next
1054 A local process may also make a TCP/IP call to the host's loopback address
1055 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1056 does not treat the loopback address specially. It treats all such connections
1057 in the same way as connections from other hosts.
1058 .endlist
1059
1060
1061 .cindex "message sender, constructed by Exim"
1062 .cindex "sender" "constructed by Exim"
1063 In the three cases that do not involve TCP/IP, the sender address is
1064 constructed from the login name of the user that called Exim and a default
1065 qualification domain (which can be set by the &%qualify_domain%& configuration
1066 option). For local or batch SMTP, a sender address that is passed using the
1067 SMTP MAIL command is ignored. However, the system administrator may allow
1068 certain users (&"trusted users"&) to specify a different sender address
1069 unconditionally, or all users to specify certain forms of different sender
1070 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1071 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1072 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1073 users to change sender addresses.
1074
1075 Messages received by either of the non-interactive mechanisms are subject to
1076 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1077 (either over TCP/IP, or interacting with a local process) can be checked by a
1078 number of ACLs that operate at different times during the SMTP session. Either
1079 individual recipients, or the entire message, can be rejected if local policy
1080 requirements are not met. The &[local_scan()]& function (see chapter
1081 &<<CHAPlocalscan>>&) is run for all incoming messages.
1082
1083 Exim can be configured not to start a delivery process when a message is
1084 received; this can be unconditional, or depend on the number of incoming SMTP
1085 connections or the system load. In these situations, new messages wait on the
1086 queue until a queue runner process picks them up. However, in standard
1087 configurations under normal conditions, delivery is started as soon as a
1088 message is received.
1089
1090
1091
1092
1093
1094 .section "Handling an incoming message" "SECID14"
1095 .cindex "spool directory" "files that hold a message"
1096 .cindex "file" "how a message is held"
1097 When Exim accepts a message, it writes two files in its spool directory. The
1098 first contains the envelope information, the current status of the message, and
1099 the header lines, and the second contains the body of the message. The names of
1100 the two spool files consist of the message id, followed by &`-H`& for the
1101 file containing the envelope and header, and &`-D`& for the data file.
1102
1103 .cindex "spool directory" "&_input_& sub-directory"
1104 By default all these message files are held in a single directory called
1105 &_input_& inside the general Exim spool directory. Some operating systems do
1106 not perform very well if the number of files in a directory gets large; to
1107 improve performance in such cases, the &%split_spool_directory%& option can be
1108 used. This causes Exim to split up the input files into 62 sub-directories
1109 whose names are single letters or digits. When this is done, the queue is
1110 processed one sub-directory at a time instead of all at once, which can improve
1111 overall performance even when there are not enough files in each directory to
1112 affect file system performance.
1113
1114 The envelope information consists of the address of the message's sender and
1115 the addresses of the recipients. This information is entirely separate from
1116 any addresses contained in the header lines. The status of the message includes
1117 a list of recipients who have already received the message. The format of the
1118 first spool file is described in chapter &<<CHAPspool>>&.
1119
1120 .cindex "rewriting" "addresses"
1121 Address rewriting that is specified in the rewrite section of the configuration
1122 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1123 both in the header lines and the envelope, at the time the message is accepted.
1124 If during the course of delivery additional addresses are generated (for
1125 example, via aliasing), these new addresses are rewritten as soon as they are
1126 generated. At the time a message is actually delivered (transported) further
1127 rewriting can take place; because this is a transport option, it can be
1128 different for different forms of delivery. It is also possible to specify the
1129 addition or removal of certain header lines at the time the message is
1130 delivered (see chapters &<<CHAProutergeneric>>& and
1131 &<<CHAPtransportgeneric>>&).
1132
1133
1134
1135 .section "Life of a message" "SECID15"
1136 .cindex "message" "life of"
1137 .cindex "message" "frozen"
1138 A message remains in the spool directory until it is completely delivered to
1139 its recipients or to an error address, or until it is deleted by an
1140 administrator or by the user who originally created it. In cases when delivery
1141 cannot proceed &-- for example, when a message can neither be delivered to its
1142 recipients nor returned to its sender, the message is marked &"frozen"& on the
1143 spool, and no more deliveries are attempted.
1144
1145 .cindex "frozen messages" "thawing"
1146 .cindex "message" "thawing frozen"
1147 An administrator can &"thaw"& such messages when the problem has been
1148 corrected, and can also freeze individual messages by hand if necessary. In
1149 addition, an administrator can force a delivery error, causing a bounce message
1150 to be sent.
1151
1152 .oindex "&%timeout_frozen_after%&"
1153 .oindex "&%ignore_bounce_errors_after%&"
1154 There are options called &%ignore_bounce_errors_after%& and
1155 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1156 The first applies only to frozen bounces, the second to any frozen messages.
1157
1158 .cindex "message" "log file for"
1159 .cindex "log" "file for each message"
1160 While Exim is working on a message, it writes information about each delivery
1161 attempt to its main log file. This includes successful, unsuccessful, and
1162 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1163 lines are also written to a separate &'message log'& file for each message.
1164 These logs are solely for the benefit of the administrator, and are normally
1165 deleted along with the spool files when processing of a message is complete.
1166 The use of individual message logs can be disabled by setting
1167 &%no_message_logs%&; this might give an improvement in performance on very busy
1168 systems.
1169
1170 .cindex "journal file"
1171 .cindex "file" "journal"
1172 All the information Exim itself needs to set up a delivery is kept in the first
1173 spool file, along with the header lines. When a successful delivery occurs, the
1174 address is immediately written at the end of a journal file, whose name is the
1175 message id followed by &`-J`&. At the end of a delivery run, if there are some
1176 addresses left to be tried again later, the first spool file (the &`-H`& file)
1177 is updated to indicate which these are, and the journal file is then deleted.
1178 Updating the spool file is done by writing a new file and renaming it, to
1179 minimize the possibility of data loss.
1180
1181 Should the system or the program crash after a successful delivery but before
1182 the spool file has been updated, the journal is left lying around. The next
1183 time Exim attempts to deliver the message, it reads the journal file and
1184 updates the spool file before proceeding. This minimizes the chances of double
1185 deliveries caused by crashes.
1186
1187
1188
1189 .section "Processing an address for delivery" "SECTprocaddress"
1190 .cindex "drivers" "definition of"
1191 .cindex "router" "definition of"
1192 .cindex "transport" "definition of"
1193 The main delivery processing elements of Exim are called &'routers'& and
1194 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1195 number of them is provided in the source distribution, and compile-time options
1196 specify which ones are included in the binary. Run time options specify which
1197 ones are actually used for delivering messages.
1198
1199 .cindex "drivers" "instance definition"
1200 Each driver that is specified in the run time configuration is an &'instance'&
1201 of that particular driver type. Multiple instances are allowed; for example,
1202 you can set up several different &(smtp)& transports, each with different
1203 option values that might specify different ports or different timeouts. Each
1204 instance has its own identifying name. In what follows we will normally use the
1205 instance name when discussing one particular instance (that is, one specific
1206 configuration of the driver), and the generic driver name when discussing
1207 the driver's features in general.
1208
1209 A &'router'& is a driver that operates on an address, either determining how
1210 its delivery should happen, by assigning it to a specific transport, or
1211 converting the address into one or more new addresses (for example, via an
1212 alias file). A router may also explicitly choose to fail an address, causing it
1213 to be bounced.
1214
1215 A &'transport'& is a driver that transmits a copy of the message from Exim's
1216 spool to some destination. There are two kinds of transport: for a &'local'&
1217 transport, the destination is a file or a pipe on the local host, whereas for a
1218 &'remote'& transport the destination is some other host. A message is passed
1219 to a specific transport as a result of successful routing. If a message has
1220 several recipients, it may be passed to a number of different transports.
1221
1222 .cindex "preconditions" "definition of"
1223 An address is processed by passing it to each configured router instance in
1224 turn, subject to certain preconditions, until a router accepts the address or
1225 specifies that it should be bounced. We will describe this process in more
1226 detail shortly. First, as a simple example, we consider how each recipient
1227 address in a message is processed in a small configuration of three routers.
1228
1229 To make this a more concrete example, it is described in terms of some actual
1230 routers, but remember, this is only an example. You can configure Exim's
1231 routers in many different ways, and there may be any number of routers in a
1232 configuration.
1233
1234 The first router that is specified in a configuration is often one that handles
1235 addresses in domains that are not recognized specially by the local host. These
1236 are typically addresses for arbitrary domains on the Internet. A precondition
1237 is set up which looks for the special domains known to the host (for example,
1238 its own domain name), and the router is run for addresses that do &'not'&
1239 match. Typically, this is a router that looks up domains in the DNS in order to
1240 find the hosts to which this address routes. If it succeeds, the address is
1241 assigned to a suitable SMTP transport; if it does not succeed, the router is
1242 configured to fail the address.
1243
1244 The second router is reached only when the domain is recognized as one that
1245 &"belongs"& to the local host. This router does redirection &-- also known as
1246 aliasing and forwarding. When it generates one or more new addresses from the
1247 original, each of them is routed independently from the start. Otherwise, the
1248 router may cause an address to fail, or it may simply decline to handle the
1249 address, in which case the address is passed to the next router.
1250
1251 The final router in many configurations is one that checks to see if the
1252 address belongs to a local mailbox. The precondition may involve a check to
1253 see if the local part is the name of a login account, or it may look up the
1254 local part in a file or a database. If its preconditions are not met, or if
1255 the router declines, we have reached the end of the routers. When this happens,
1256 the address is bounced.
1257
1258
1259
1260 .section "Processing an address for verification" "SECID16"
1261 .cindex "router" "for verification"
1262 .cindex "verifying address" "overview"
1263 As well as being used to decide how to deliver to an address, Exim's routers
1264 are also used for &'address verification'&. Verification can be requested as
1265 one of the checks to be performed in an ACL for incoming messages, on both
1266 sender and recipient addresses, and it can be tested using the &%-bv%& and
1267 &%-bvs%& command line options.
1268
1269 When an address is being verified, the routers are run in &"verify mode"&. This
1270 does not affect the way the routers work, but it is a state that can be
1271 detected. By this means, a router can be skipped or made to behave differently
1272 when verifying. A common example is a configuration in which the first router
1273 sends all messages to a message-scanning program, unless they have been
1274 previously scanned. Thus, the first router accepts all addresses without any
1275 checking, making it useless for verifying. Normally, the &%no_verify%& option
1276 would be set for such a router, causing it to be skipped in verify mode.
1277
1278
1279
1280
1281 .section "Running an individual router" "SECTrunindrou"
1282 .cindex "router" "running details"
1283 .cindex "preconditions" "checking"
1284 .cindex "router" "result of running"
1285 As explained in the example above, a number of preconditions are checked before
1286 running a router. If any are not met, the router is skipped, and the address is
1287 passed to the next router. When all the preconditions on a router &'are'& met,
1288 the router is run. What happens next depends on the outcome, which is one of
1289 the following:
1290
1291 .ilist
1292 &'accept'&: The router accepts the address, and either assigns it to a
1293 transport, or generates one or more &"child"& addresses. Processing the
1294 original address ceases,
1295 .oindex "&%unseen%&"
1296 unless the &%unseen%& option is set on the router. This option
1297 can be used to set up multiple deliveries with different routing (for example,
1298 for keeping archive copies of messages). When &%unseen%& is set, the address is
1299 passed to the next router. Normally, however, an &'accept'& return marks the
1300 end of routing.
1301
1302 Any child addresses generated by the router are processed independently,
1303 starting with the first router by default. It is possible to change this by
1304 setting the &%redirect_router%& option to specify which router to start at for
1305 child addresses. Unlike &%pass_router%& (see below) the router specified by
1306 &%redirect_router%& may be anywhere in the router configuration.
1307 .next
1308 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1309 requests that the address be passed to another router. By default the address
1310 is passed to the next router, but this can be changed by setting the
1311 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1312 must be below the current router (to avoid loops).
1313 .next
1314 &'decline'&: The router declines to accept the address because it does not
1315 recognize it at all. By default, the address is passed to the next router, but
1316 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1317 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1318 &'decline'& into &'fail'&.
1319 .next
1320 &'fail'&: The router determines that the address should fail, and queues it for
1321 the generation of a bounce message. There is no further processing of the
1322 original address unless &%unseen%& is set on the router.
1323 .next
1324 &'defer'&: The router cannot handle the address at the present time. (A
1325 database may be offline, or a DNS lookup may have timed out.) No further
1326 processing of the address happens in this delivery attempt. It is tried again
1327 next time the message is considered for delivery.
1328 .next
1329 &'error'&: There is some error in the router (for example, a syntax error in
1330 its configuration). The action is as for defer.
1331 .endlist
1332
1333 If an address reaches the end of the routers without having been accepted by
1334 any of them, it is bounced as unrouteable. The default error message in this
1335 situation is &"unrouteable address"&, but you can set your own message by
1336 making use of the &%cannot_route_message%& option. This can be set for any
1337 router; the value from the last router that &"saw"& the address is used.
1338
1339 Sometimes while routing you want to fail a delivery when some conditions are
1340 met but others are not, instead of passing the address on for further routing.
1341 You can do this by having a second router that explicitly fails the delivery
1342 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1343 facility for this purpose.
1344
1345
1346 .section "Duplicate addresses" "SECID17"
1347 .cindex "case of local parts"
1348 .cindex "address duplicate, discarding"
1349 .cindex "duplicate addresses"
1350 Once routing is complete, Exim scans the addresses that are assigned to local
1351 and remote transports, and discards any duplicates that it finds. During this
1352 check, local parts are treated as case-sensitive. This happens only when
1353 actually delivering a message; when testing routers with &%-bt%&, all the
1354 routed addresses are shown.
1355
1356
1357
1358 .section "Router preconditions" "SECTrouprecon"
1359 .cindex "router" "preconditions, order of processing"
1360 .cindex "preconditions" "order of processing"
1361 The preconditions that are tested for each router are listed below, in the
1362 order in which they are tested. The individual configuration options are
1363 described in more detail in chapter &<<CHAProutergeneric>>&.
1364
1365 .ilist
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 If the &%local_parts%& option is set, the local part of the address must be in
1403 the set of local parts that it defines. If &%local_part_prefix%& or
1404 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1405 part before this check. If you want to do precondition tests on local parts
1406 that include affixes, you can do so by using a &%condition%& option (see below)
1407 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1408 &$local_part_suffix$& as necessary.
1409 .next
1410 .vindex "&$local_user_uid$&"
1411 .vindex "&$local_user_gid$&"
1412 .vindex "&$home$&"
1413 If the &%check_local_user%& option is set, the local part must be the name of
1414 an account on the local host. If this check succeeds, the uid and gid of the
1415 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1416 user's home directory is placed in &$home$&; these values can be used in the
1417 remaining preconditions.
1418 .next
1419 If the &%router_home_directory%& option is set, it is expanded at this point,
1420 because it overrides the value of &$home$&. If this expansion were left till
1421 later, the value of &$home$& as set by &%check_local_user%& would be used in
1422 subsequent tests. Having two different values of &$home$& in the same router
1423 could lead to confusion.
1424 .next
1425 If the &%senders%& option is set, the envelope sender address must be in the
1426 set of addresses that it defines.
1427 .next
1428 If the &%require_files%& option is set, the existence or non-existence of
1429 specified files is tested.
1430 .next
1431 .cindex "customizing" "precondition"
1432 If the &%condition%& option is set, it is evaluated and tested. This option
1433 uses an expanded string to allow you to set up your own custom preconditions.
1434 Expanded strings are described in chapter &<<CHAPexpand>>&.
1435 .endlist
1436
1437
1438 Note that &%require_files%& comes near the end of the list, so you cannot use
1439 it to check for the existence of a file in which to lookup up a domain, local
1440 part, or sender. However, as these options are all expanded, you can use the
1441 &%exists%& expansion condition to make such tests within each condition. The
1442 &%require_files%& option is intended for checking files that the router may be
1443 going to use internally, or which are needed by a specific transport (for
1444 example, &_.procmailrc_&).
1445
1446
1447
1448 .section "Delivery in detail" "SECID18"
1449 .cindex "delivery" "in detail"
1450 When a message is to be delivered, the sequence of events is as follows:
1451
1452 .ilist
1453 If a system-wide filter file is specified, the message is passed to it. The
1454 filter may add recipients to the message, replace the recipients, discard the
1455 message, cause a new message to be generated, or cause the message delivery to
1456 fail. The format of the system filter file is the same as for Exim user filter
1457 files, described in the separate document entitled &'Exim's interfaces to mail
1458 filtering'&.
1459 .cindex "Sieve filter" "not available for system filter"
1460 (&*Note*&: Sieve cannot be used for system filter files.)
1461
1462 Some additional features are available in system filters &-- see chapter
1463 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1464 filter only once per delivery attempt, however many recipients it has. However,
1465 if there are several delivery attempts because one or more addresses could not
1466 be immediately delivered, the system filter is run each time. The filter
1467 condition &%first_delivery%& can be used to detect the first run of the system
1468 filter.
1469 .next
1470 Each recipient address is offered to each configured router in turn, subject to
1471 its preconditions, until one is able to handle it. If no router can handle the
1472 address, that is, if they all decline, the address is failed. Because routers
1473 can be targeted at particular domains, several locally handled domains can be
1474 processed entirely independently of each other.
1475 .next
1476 .cindex "routing" "loops in"
1477 .cindex "loop" "while routing"
1478 A router that accepts an address may assign it to a local or a remote
1479 transport. However, the transport is not run at this time. Instead, the address
1480 is placed on a list for the particular transport, which will be run later.
1481 Alternatively, the router may generate one or more new addresses (typically
1482 from alias, forward, or filter files). New addresses are fed back into this
1483 process from the top, but in order to avoid loops, a router ignores any address
1484 which has an identically-named ancestor that was processed by itself.
1485 .next
1486 When all the routing has been done, addresses that have been successfully
1487 handled are passed to their assigned transports. When local transports are
1488 doing real local deliveries, they handle only one address at a time, but if a
1489 local transport is being used as a pseudo-remote transport (for example, to
1490 collect batched SMTP messages for transmission by some other means) multiple
1491 addresses can be handled. Remote transports can always handle more than one
1492 address at a time, but can be configured not to do so, or to restrict multiple
1493 addresses to the same domain.
1494 .next
1495 Each local delivery to a file or a pipe runs in a separate process under a
1496 non-privileged uid, and these deliveries are run one at a time. Remote
1497 deliveries also run in separate processes, normally under a uid that is private
1498 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1499 run in parallel. The maximum number of simultaneous remote deliveries for any
1500 one message is set by the &%remote_max_parallel%& option.
1501 The order in which deliveries are done is not defined, except that all local
1502 deliveries happen before any remote deliveries.
1503 .next
1504 .cindex "queue runner"
1505 When it encounters a local delivery during a queue run, Exim checks its retry
1506 database to see if there has been a previous temporary delivery failure for the
1507 address before running the local transport. If there was a previous failure,
1508 Exim does not attempt a new delivery until the retry time for the address is
1509 reached. However, this happens only for delivery attempts that are part of a
1510 queue run. Local deliveries are always attempted when delivery immediately
1511 follows message reception, even if retry times are set for them. This makes for
1512 better behaviour if one particular message is causing problems (for example,
1513 causing quota overflow, or provoking an error in a filter file).
1514 .next
1515 .cindex "delivery" "retry in remote transports"
1516 Remote transports do their own retry handling, since an address may be
1517 deliverable to one of a number of hosts, each of which may have a different
1518 retry time. If there have been previous temporary failures and no host has
1519 reached its retry time, no delivery is attempted, whether in a queue run or
1520 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1521 .next
1522 If there were any permanent errors, a bounce message is returned to an
1523 appropriate address (the sender in the common case), with details of the error
1524 for each failing address. Exim can be configured to send copies of bounce
1525 messages to other addresses.
1526 .next
1527 .cindex "delivery" "deferral"
1528 If one or more addresses suffered a temporary failure, the message is left on
1529 the queue, to be tried again later. Delivery of these addresses is said to be
1530 &'deferred'&.
1531 .next
1532 When all the recipient addresses have either been delivered or bounced,
1533 handling of the message is complete. The spool files and message log are
1534 deleted, though the message log can optionally be preserved if required.
1535 .endlist
1536
1537
1538
1539
1540 .section "Retry mechanism" "SECID19"
1541 .cindex "delivery" "retry mechanism"
1542 .cindex "retry" "description of mechanism"
1543 .cindex "queue runner"
1544 Exim's mechanism for retrying messages that fail to get delivered at the first
1545 attempt is the queue runner process. You must either run an Exim daemon that
1546 uses the &%-q%& option with a time interval to start queue runners at regular
1547 intervals, or use some other means (such as &'cron'&) to start them. If you do
1548 not arrange for queue runners to be run, messages that fail temporarily at the
1549 first attempt will remain on your queue for ever. A queue runner process works
1550 its way through the queue, one message at a time, trying each delivery that has
1551 passed its retry time.
1552 You can run several queue runners at once.
1553
1554 Exim uses a set of configured rules to determine when next to retry the failing
1555 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1556 should give up trying to deliver to the address, at which point it generates a
1557 bounce message. If no retry rules are set for a particular host, address, and
1558 error combination, no retries are attempted, and temporary errors are treated
1559 as permanent.
1560
1561
1562
1563 .section "Temporary delivery failure" "SECID20"
1564 .cindex "delivery" "temporary failure"
1565 There are many reasons why a message may not be immediately deliverable to a
1566 particular address. Failure to connect to a remote machine (because it, or the
1567 connection to it, is down) is one of the most common. Temporary failures may be
1568 detected during routing as well as during the transport stage of delivery.
1569 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1570 is on a file system where the user is over quota. Exim can be configured to
1571 impose its own quotas on local mailboxes; where system quotas are set they will
1572 also apply.
1573
1574 If a host is unreachable for a period of time, a number of messages may be
1575 waiting for it by the time it recovers, and sending them in a single SMTP
1576 connection is clearly beneficial. Whenever a delivery to a remote host is
1577 deferred,
1578 .cindex "hints database"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. It is not known
1989 if anyone is actually using A6 records. Exim has support for A6 records, but
1990 this is included only if you set &`SUPPORT_A6=YES`& in &_Local/Makefile_&. The
1991 support has not been tested for some time.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2036 building process fails if it is set.
2037
2038 If this is the first time &'make'& has been run, it calls a script that builds
2039 a make file inside the build directory, using the configuration files from the
2040 &_Local_& directory. The new make file is then passed to another instance of
2041 &'make'&. This does the real work, building a number of utility scripts, and
2042 then compiling and linking the binaries for the Exim monitor (if configured), a
2043 number of utility programs, and finally Exim itself. The command &`make
2044 makefile`& can be used to force a rebuild of the make file in the build
2045 directory, should this ever be necessary.
2046
2047 If you have problems building Exim, check for any comments there may be in the
2048 &_README_& file concerning your operating system, and also take a look at the
2049 FAQ, where some common problems are covered.
2050
2051
2052
2053 .section 'Output from &"make"&' "SECID283"
2054 The output produced by the &'make'& process for compile lines is often very
2055 unreadable, because these lines can be very long. For this reason, the normal
2056 output is suppressed by default, and instead output similar to that which
2057 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2058 each module that is being compiled or linked. However, it is still possible to
2059 get the full output, by calling &'make'& like this:
2060 .code
2061 FULLECHO='' make -e
2062 .endd
2063 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2064 command reflection in &'make'&. When you ask for the full output, it is
2065 given in addition to the short output.
2066
2067
2068
2069 .section "Overriding build-time options for Exim" "SECToverride"
2070 .cindex "build-time options, overriding"
2071 The main make file that is created at the beginning of the building process
2072 consists of the concatenation of a number of files which set configuration
2073 values, followed by a fixed set of &'make'& instructions. If a value is set
2074 more than once, the last setting overrides any previous ones. This provides a
2075 convenient way of overriding defaults. The files that are concatenated are, in
2076 order:
2077 .display
2078 &_OS/Makefile-Default_&
2079 &_OS/Makefile-_&<&'ostype'&>
2080 &_Local/Makefile_&
2081 &_Local/Makefile-_&<&'ostype'&>
2082 &_Local/Makefile-_&<&'archtype'&>
2083 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2084 &_OS/Makefile-Base_&
2085 .endd
2086 .cindex "&_Local/Makefile_&"
2087 .cindex "building Exim" "operating system type"
2088 .cindex "building Exim" "architecture type"
2089 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2090 architecture type. &_Local/Makefile_& is required to exist, and the building
2091 process fails if it is absent. The other three &_Local_& files are optional,
2092 and are often not needed.
2093
2094 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2095 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2096 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2097 values are used, thereby providing a means of forcing particular settings.
2098 Otherwise, the scripts try to get values from the &%uname%& command. If this
2099 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2100 of &'ad hoc'& transformations are then applied, to produce the standard names
2101 that Exim expects. You can run these scripts directly from the shell in order
2102 to find out what values are being used on your system.
2103
2104
2105 &_OS/Makefile-Default_& contains comments about the variables that are set
2106 therein. Some (but not all) are mentioned below. If there is something that
2107 needs changing, review the contents of this file and the contents of the make
2108 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2109 default values are.
2110
2111
2112 .cindex "building Exim" "overriding default settings"
2113 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2114 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2115 need to change the original files. Instead, you should make the changes by
2116 putting the new values in an appropriate &_Local_& file. For example,
2117 .cindex "Tru64-Unix build-time settings"
2118 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2119 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2120 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2121 called with the option &%-std1%&, to make it recognize some of the features of
2122 Standard C that Exim uses. (Most other compilers recognize Standard C by
2123 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2124 containing the lines
2125 .code
2126 CC=cc
2127 CFLAGS=-std1
2128 .endd
2129 If you are compiling for just one operating system, it may be easier to put
2130 these lines directly into &_Local/Makefile_&.
2131
2132 Keeping all your local configuration settings separate from the distributed
2133 files makes it easy to transfer them to new versions of Exim simply by copying
2134 the contents of the &_Local_& directory.
2135
2136
2137 .cindex "NIS lookup type" "including support for"
2138 .cindex "NIS+ lookup type" "including support for"
2139 .cindex "LDAP" "including support for"
2140 .cindex "lookup" "inclusion in binary"
2141 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2142 lookup, but not all systems have these components installed, so the default is
2143 not to include the relevant code in the binary. All the different kinds of file
2144 and database lookup that Exim supports are implemented as separate code modules
2145 which are included only if the relevant compile-time options are set. In the
2146 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2147 .code
2148 LOOKUP_LDAP=yes
2149 LOOKUP_NIS=yes
2150 LOOKUP_NISPLUS=yes
2151 .endd
2152 and similar settings apply to the other lookup types. They are all listed in
2153 &_src/EDITME_&. In many cases the relevant include files and interface
2154 libraries need to be installed before compiling Exim.
2155 .cindex "cdb" "including support for"
2156 However, there are some optional lookup types (such as cdb) for which
2157 the code is entirely contained within Exim, and no external include
2158 files or libraries are required. When a lookup type is not included in the
2159 binary, attempts to configure Exim to use it cause run time configuration
2160 errors.
2161
2162 .cindex "pkg-config" "lookups"
2163 .cindex "pkg-config" "authenticators"
2164 Many systems now use a tool called &'pkg-config'& to encapsulate information
2165 about how to compile against a library; Exim has some initial support for
2166 being able to use pkg-config for lookups and authenticators.  For any given
2167 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2168 variable with the &`_PC`& suffix in the name and assign as the value the
2169 name of the package to be queried.  The results of querying via the
2170 &'pkg-config'& command will be added to the appropriate Makefile variables
2171 with &`+=`& directives, so your version of &'make'& will need to support that
2172 syntax.  For instance:
2173 .code
2174 LOOKUP_SQLITE=yes
2175 LOOKUP_SQLITE_PC=sqlite3
2176 AUTH_GSASL=yes
2177 AUTH_GSASL_PC=libgsasl
2178 AUTH_HEIMDAL_GSSAPI=yes
2179 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2180 .endd
2181
2182 .cindex "Perl" "including support for"
2183 Exim can be linked with an embedded Perl interpreter, allowing Perl
2184 subroutines to be called during string expansion. To enable this facility,
2185 .code
2186 EXIM_PERL=perl.o
2187 .endd
2188 must be defined in &_Local/Makefile_&. Details of this facility are given in
2189 chapter &<<CHAPperl>>&.
2190
2191 .cindex "X11 libraries, location of"
2192 The location of the X11 libraries is something that varies a lot between
2193 operating systems, and there may be different versions of X11 to cope
2194 with. Exim itself makes no use of X11, but if you are compiling the Exim
2195 monitor, the X11 libraries must be available.
2196 The following three variables are set in &_OS/Makefile-Default_&:
2197 .code
2198 X11=/usr/X11R6
2199 XINCLUDE=-I$(X11)/include
2200 XLFLAGS=-L$(X11)/lib
2201 .endd
2202 These are overridden in some of the operating-system configuration files. For
2203 example, in &_OS/Makefile-SunOS5_& there is
2204 .code
2205 X11=/usr/openwin
2206 XINCLUDE=-I$(X11)/include
2207 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2208 .endd
2209 If you need to override the default setting for your operating system, place a
2210 definition of all three of these variables into your
2211 &_Local/Makefile-<ostype>_& file.
2212
2213 .cindex "EXTRALIBS"
2214 If you need to add any extra libraries to the link steps, these can be put in a
2215 variable called EXTRALIBS, which appears in all the link commands, but by
2216 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2217 command for linking the main Exim binary, and not for any associated utilities.
2218
2219 .cindex "DBM libraries" "configuration for building"
2220 There is also DBMLIB, which appears in the link commands for binaries that
2221 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2222 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2223 binary, and which can be used, for example, to include additional X11
2224 libraries.
2225
2226 .cindex "configuration file" "editing"
2227 The make file copes with rebuilding Exim correctly if any of the configuration
2228 files are edited. However, if an optional configuration file is deleted, it is
2229 necessary to touch the associated non-optional file (that is,
2230 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2231
2232
2233 .section "OS-specific header files" "SECID30"
2234 .cindex "&_os.h_&"
2235 .cindex "building Exim" "OS-specific C header files"
2236 The &_OS_& directory contains a number of files with names of the form
2237 &_os.h-<ostype>_&. These are system-specific C header files that should not
2238 normally need to be changed. There is a list of macro settings that are
2239 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2240 are porting Exim to a new operating system.
2241
2242
2243
2244 .section "Overriding build-time options for the monitor" "SECID31"
2245 .cindex "building Eximon"
2246 A similar process is used for overriding things when building the Exim monitor,
2247 where the files that are involved are
2248 .display
2249 &_OS/eximon.conf-Default_&
2250 &_OS/eximon.conf-_&<&'ostype'&>
2251 &_Local/eximon.conf_&
2252 &_Local/eximon.conf-_&<&'ostype'&>
2253 &_Local/eximon.conf-_&<&'archtype'&>
2254 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2255 .endd
2256 .cindex "&_Local/eximon.conf_&"
2257 As with Exim itself, the final three files need not exist, and in this case the
2258 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2259 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2260 variables of the same name, preceded by EXIMON_. For example, setting
2261 EXIMON_LOG_DEPTH in the environment overrides the value of
2262 LOG_DEPTH at run time.
2263 .ecindex IIDbuex
2264
2265
2266 .section "Installing Exim binaries and scripts" "SECID32"
2267 .cindex "installing Exim"
2268 .cindex "BIN_DIRECTORY"
2269 The command &`make install`& runs the &(exim_install)& script with no
2270 arguments. The script copies binaries and utility scripts into the directory
2271 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2272 .cindex "setuid" "installing Exim with"
2273 The install script copies files only if they are newer than the files they are
2274 going to replace. The Exim binary is required to be owned by root and have the
2275 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2276 install`& as root so that it can set up the Exim binary in this way. However, in
2277 some special situations (for example, if a host is doing no local deliveries)
2278 it may be possible to run Exim without making the binary setuid root (see
2279 chapter &<<CHAPsecurity>>& for details).
2280
2281 .cindex "CONFIGURE_FILE"
2282 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2283 in &_Local/Makefile_&. If this names a single file, and the file does not
2284 exist, the default configuration file &_src/configure.default_& is copied there
2285 by the installation script. If a run time configuration file already exists, it
2286 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2287 alternative files, no default is installed.
2288
2289 .cindex "system aliases file"
2290 .cindex "&_/etc/aliases_&"
2291 One change is made to the default configuration file when it is installed: the
2292 default configuration contains a router that references a system aliases file.
2293 The path to this file is set to the value specified by
2294 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2295 If the system aliases file does not exist, the installation script creates it,
2296 and outputs a comment to the user.
2297
2298 The created file contains no aliases, but it does contain comments about the
2299 aliases a site should normally have. Mail aliases have traditionally been
2300 kept in &_/etc/aliases_&. However, some operating systems are now using
2301 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2302 Exim's configuration if necessary.
2303
2304 The default configuration uses the local host's name as the only local domain,
2305 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2306 running as the local user. System aliases and &_.forward_& files in users' home
2307 directories are supported, but no NIS or NIS+ support is configured. Domains
2308 other than the name of the local host are routed using the DNS, with delivery
2309 over SMTP.
2310
2311 It is possible to install Exim for special purposes (such as building a binary
2312 distribution) in a private part of the file system. You can do this by a
2313 command such as
2314 .code
2315 make DESTDIR=/some/directory/ install
2316 .endd
2317 This has the effect of pre-pending the specified directory to all the file
2318 paths, except the name of the system aliases file that appears in the default
2319 configuration. (If a default alias file is created, its name &'is'& modified.)
2320 For backwards compatibility, ROOT is used if DESTDIR is not set,
2321 but this usage is deprecated.
2322
2323 .cindex "installing Exim" "what is not installed"
2324 Running &'make install'& does not copy the Exim 4 conversion script
2325 &'convert4r4'&. You will probably run this only once if you are
2326 upgrading from Exim 3. None of the documentation files in the &_doc_&
2327 directory are copied, except for the info files when you have set
2328 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2329
2330 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2331 to their names. The Exim binary itself, however, is handled differently. It is
2332 installed under a name that includes the version number and the compile number,
2333 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2334 called &_exim_& to point to the binary. If you are updating a previous version
2335 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2336 from the directory (as seen by other processes).
2337
2338 .cindex "installing Exim" "testing the script"
2339 If you want to see what the &'make install'& will do before running it for
2340 real, you can pass the &%-n%& option to the installation script by this
2341 command:
2342 .code
2343 make INSTALL_ARG=-n install
2344 .endd
2345 The contents of the variable INSTALL_ARG are passed to the installation
2346 script. You do not need to be root to run this test. Alternatively, you can run
2347 the installation script directly, but this must be from within the build
2348 directory. For example, from the top-level Exim directory you could use this
2349 command:
2350 .code
2351 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2352 .endd
2353 .cindex "installing Exim" "install script options"
2354 There are two other options that can be supplied to the installation script.
2355
2356 .ilist
2357 &%-no_chown%& bypasses the call to change the owner of the installed binary
2358 to root, and the call to make it a setuid binary.
2359 .next
2360 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2361 installed binary.
2362 .endlist
2363
2364 INSTALL_ARG can be used to pass these options to the script. For example:
2365 .code
2366 make INSTALL_ARG=-no_symlink install
2367 .endd
2368 The installation script can also be given arguments specifying which files are
2369 to be copied. For example, to install just the Exim binary, and nothing else,
2370 without creating the symbolic link, you could use:
2371 .code
2372 make INSTALL_ARG='-no_symlink exim' install
2373 .endd
2374
2375
2376
2377 .section "Installing info documentation" "SECTinsinfdoc"
2378 .cindex "installing Exim" "&'info'& documentation"
2379 Not all systems use the GNU &'info'& system for documentation, and for this
2380 reason, the Texinfo source of Exim's documentation is not included in the main
2381 distribution. Instead it is available separately from the ftp site (see section
2382 &<<SECTavail>>&).
2383
2384 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2385 source of the documentation is found in the source tree, running &`make
2386 install`& automatically builds the info files and installs them.
2387
2388
2389
2390 .section "Setting up the spool directory" "SECID33"
2391 .cindex "spool directory" "creating"
2392 When it starts up, Exim tries to create its spool directory if it does not
2393 exist. The Exim uid and gid are used for the owner and group of the spool
2394 directory. Sub-directories are automatically created in the spool directory as
2395 necessary.
2396
2397
2398
2399
2400 .section "Testing" "SECID34"
2401 .cindex "testing" "installation"
2402 Having installed Exim, you can check that the run time configuration file is
2403 syntactically valid by running the following command, which assumes that the
2404 Exim binary directory is within your PATH environment variable:
2405 .code
2406 exim -bV
2407 .endd
2408 If there are any errors in the configuration file, Exim outputs error messages.
2409 Otherwise it outputs the version number and build date,
2410 the DBM library that is being used, and information about which drivers and
2411 other optional code modules are included in the binary.
2412 Some simple routing tests can be done by using the address testing option. For
2413 example,
2414 .display
2415 &`exim -bt`& <&'local username'&>
2416 .endd
2417 should verify that it recognizes a local mailbox, and
2418 .display
2419 &`exim -bt`& <&'remote address'&>
2420 .endd
2421 a remote one. Then try getting it to deliver mail, both locally and remotely.
2422 This can be done by passing messages directly to Exim, without going through a
2423 user agent. For example:
2424 .code
2425 exim -v postmaster@your.domain.example
2426 From: user@your.domain.example
2427 To: postmaster@your.domain.example
2428 Subject: Testing Exim
2429
2430 This is a test message.
2431 ^D
2432 .endd
2433 The &%-v%& option causes Exim to output some verification of what it is doing.
2434 In this case you should see copies of three log lines, one for the message's
2435 arrival, one for its delivery, and one containing &"Completed"&.
2436
2437 .cindex "delivery" "problems with"
2438 If you encounter problems, look at Exim's log files (&'mainlog'& and
2439 &'paniclog'&) to see if there is any relevant information there. Another source
2440 of information is running Exim with debugging turned on, by specifying the
2441 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2442 with debugging turned on by a command of the form
2443 .display
2444 &`exim -d -M`& <&'exim-message-id'&>
2445 .endd
2446 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2447 produces rather a lot of output, but you can cut this down to specific areas.
2448 For example, if you use &%-d-all+route%& only the debugging information
2449 relevant to routing is included. (See the &%-d%& option in chapter
2450 &<<CHAPcommandline>>& for more details.)
2451
2452 .cindex '&"sticky"& bit'
2453 .cindex "lock files"
2454 One specific problem that has shown up on some sites is the inability to do
2455 local deliveries into a shared mailbox directory, because it does not have the
2456 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2457 writing to a mailbox file, and if it cannot create the lock file, the delivery
2458 is deferred. You can get round this either by setting the &"sticky bit"& on the
2459 directory, or by setting a specific group for local deliveries and allowing
2460 that group to create files in the directory (see the comments above the
2461 &(local_delivery)& transport in the default configuration file). Another
2462 approach is to configure Exim not to use lock files, but just to rely on
2463 &[fcntl()]& locking instead. However, you should do this only if all user
2464 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2465 see chapter &<<CHAPappendfile>>&.
2466
2467 One thing that cannot be tested on a system that is already running an MTA is
2468 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2469 &%-oX%& option can be used to run an Exim daemon that listens on some other
2470 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2471 &'exim_checkaccess'& utility can be used to check out policy controls on
2472 incoming SMTP mail.
2473
2474 Testing a new version on a system that is already running Exim can most easily
2475 be done by building a binary with a different CONFIGURE_FILE setting. From
2476 within the run time configuration, all other file and directory names
2477 that Exim uses can be altered, in order to keep it entirely clear of the
2478 production version.
2479
2480
2481 .section "Replacing another MTA with Exim" "SECID35"
2482 .cindex "replacing another MTA"
2483 Building and installing Exim for the first time does not of itself put it in
2484 general use. The name by which the system's MTA is called by mail user agents
2485 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2486 operating system), and it is necessary to make this name point to the &'exim'&
2487 binary in order to get the user agents to pass messages to Exim. This is
2488 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2489 or &_/usr/lib/sendmail_&
2490 .cindex "symbolic link" "to &'exim'& binary"
2491 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2492 privilege and executable status from the old MTA. It is then necessary to stop
2493 and restart the mailer daemon, if one is running.
2494
2495 .cindex "FreeBSD, MTA indirection"
2496 .cindex "&_/etc/mail/mailer.conf_&"
2497 Some operating systems have introduced alternative ways of switching MTAs. For
2498 example, if you are running FreeBSD, you need to edit the file
2499 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2500 described. A typical example of the contents of this file for running Exim is
2501 as follows:
2502 .code
2503 sendmail            /usr/exim/bin/exim
2504 send-mail           /usr/exim/bin/exim
2505 mailq               /usr/exim/bin/exim -bp
2506 newaliases          /usr/bin/true
2507 .endd
2508 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2509 your Exim installation is &"live"&. Check it by sending a message from your
2510 favourite user agent.
2511
2512 You should consider what to tell your users about the change of MTA. Exim may
2513 have different capabilities to what was previously running, and there are
2514 various operational differences such as the text of messages produced by
2515 command line options and in bounce messages. If you allow your users to make
2516 use of Exim's filtering capabilities, you should make the document entitled
2517 &'Exim's interface to mail filtering'& available to them.
2518
2519
2520
2521 .section "Upgrading Exim" "SECID36"
2522 .cindex "upgrading Exim"
2523 If you are already running Exim on your host, building and installing a new
2524 version automatically makes it available to MUAs, or any other programs that
2525 call the MTA directly. However, if you are running an Exim daemon, you do need
2526 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2527 new binary. You do not need to stop processing mail in order to install a new
2528 version of Exim. The install script does not modify an existing runtime
2529 configuration file.
2530
2531
2532
2533
2534 .section "Stopping the Exim daemon on Solaris" "SECID37"
2535 .cindex "Solaris" "stopping Exim on"
2536 The standard command for stopping the mailer daemon on Solaris is
2537 .code
2538 /etc/init.d/sendmail stop
2539 .endd
2540 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2541 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2542 for the text &"sendmail"&; this is not present because the actual program name
2543 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2544 solution is to replace the line that finds the process id with something like
2545 .code
2546 pid=`cat /var/spool/exim/exim-daemon.pid`
2547 .endd
2548 to obtain the daemon's pid directly from the file that Exim saves it in.
2549
2550 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2551 still be received from local processes, and if automatic delivery is configured
2552 (the normal case), deliveries will still occur.
2553
2554
2555
2556
2557 . ////////////////////////////////////////////////////////////////////////////
2558 . ////////////////////////////////////////////////////////////////////////////
2559
2560 .chapter "The Exim command line" "CHAPcommandline"
2561 .scindex IIDclo1 "command line" "options"
2562 .scindex IIDclo2 "options" "command line"
2563 Exim's command line takes the standard Unix form of a sequence of options,
2564 each starting with a hyphen character, followed by a number of arguments. The
2565 options are compatible with the main options of Sendmail, and there are also
2566 some additional options, some of which are compatible with Smail 3. Certain
2567 combinations of options do not make sense, and provoke an error if used.
2568 The form of the arguments depends on which options are set.
2569
2570
2571 .section "Setting options by program name" "SECID38"
2572 .cindex "&'mailq'&"
2573 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2574 were present before any other options.
2575 The &%-bp%& option requests a listing of the contents of the mail queue on the
2576 standard output.
2577 This feature is for compatibility with some systems that contain a command of
2578 that name in one of the standard libraries, symbolically linked to
2579 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2580
2581 .cindex "&'rsmtp'&"
2582 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2583 were present before any other options, for compatibility with Smail. The
2584 &%-bS%& option is used for reading in a number of messages in batched SMTP
2585 format.
2586
2587 .cindex "&'rmail'&"
2588 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2589 &%-oee%& options were present before any other options, for compatibility with
2590 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2591
2592 .cindex "&'runq'&"
2593 .cindex "queue runner"
2594 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2595 were present before any other options, for compatibility with Smail. The &%-q%&
2596 option causes a single queue runner process to be started.
2597
2598 .cindex "&'newaliases'&"
2599 .cindex "alias file" "building"
2600 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2601 If Exim is called under the name &'newaliases'& it behaves as if the option
2602 &%-bi%& were present before any other options, for compatibility with Sendmail.
2603 This option is used for rebuilding Sendmail's alias file. Exim does not have
2604 the concept of a single alias file, but can be configured to run a given
2605 command if called with the &%-bi%& option.
2606
2607
2608 .section "Trusted and admin users" "SECTtrustedadmin"
2609 Some Exim options are available only to &'trusted users'& and others are
2610 available only to &'admin users'&. In the description below, the phrases &"Exim
2611 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2612 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2613 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2614
2615 .ilist
2616 .cindex "trusted users" "definition of"
2617 .cindex "user" "trusted definition of"
2618 The trusted users are root, the Exim user, any user listed in the
2619 &%trusted_users%& configuration option, and any user whose current group or any
2620 supplementary group is one of those listed in the &%trusted_groups%&
2621 configuration option. Note that the Exim group is not automatically trusted.
2622
2623 .cindex '&"From"& line'
2624 .cindex "envelope sender"
2625 Trusted users are always permitted to use the &%-f%& option or a leading
2626 &"From&~"& line to specify the envelope sender of a message that is passed to
2627 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2628 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2629 users to set envelope senders.
2630
2631 .cindex "&'From:'& header line"
2632 .cindex "&'Sender:'& header line"
2633 For a trusted user, there is never any check on the contents of the &'From:'&
2634 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2635 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2636
2637 Trusted users may also specify a host name, host address, interface address,
2638 protocol name, ident value, and authentication data when submitting a message
2639 locally. Thus, they are able to insert messages into Exim's queue locally that
2640 have the characteristics of messages received from a remote host. Untrusted
2641 users may in some circumstances use &%-f%&, but can never set the other values
2642 that are available to trusted users.
2643 .next
2644 .cindex "user" "admin definition of"
2645 .cindex "admin user" "definition of"
2646 The admin users are root, the Exim user, and any user that is a member of the
2647 Exim group or of any group listed in the &%admin_groups%& configuration option.
2648 The current group does not have to be one of these groups.
2649
2650 Admin users are permitted to list the queue, and to carry out certain
2651 operations on messages, for example, to force delivery failures. It is also
2652 necessary to be an admin user in order to see the full information provided by
2653 the Exim monitor, and full debugging output.
2654
2655 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2656 Exim to attempt delivery of messages on its queue is restricted to admin users.
2657 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2658 option false (that is, specifying &%no_prod_requires_admin%&).
2659
2660 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2661 is restricted to admin users unless &%queue_list_requires_admin%& is set
2662 false.
2663 .endlist
2664
2665
2666 &*Warning*&: If you configure your system so that admin users are able to
2667 edit Exim's configuration file, you are giving those users an easy way of
2668 getting root. There is further discussion of this issue at the start of chapter
2669 &<<CHAPconf>>&.
2670
2671
2672
2673
2674 .section "Command line options" "SECID39"
2675 Exim's command line options are described in alphabetical order below. If none
2676 of the options that specifies a specific action (such as starting the daemon or
2677 a queue runner, or testing an address, or receiving a message in a specific
2678 format, or listing the queue) are present, and there is at least one argument
2679 on the command line, &%-bm%& (accept a local message on the standard input,
2680 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2681 outputs a brief message about itself and exits.
2682
2683 . ////////////////////////////////////////////////////////////////////////////
2684 . Insert a stylized XML comment here, to identify the start of the command line
2685 . options. This is for the benefit of the Perl script that automatically
2686 . creates a man page for the options.
2687 . ////////////////////////////////////////////////////////////////////////////
2688
2689 .literal xml
2690 <!-- === Start of command line options === -->
2691 .literal off
2692
2693
2694 .vlist
2695 .vitem &%--%&
2696 .oindex "--"
2697 .cindex "options" "command line; terminating"
2698 This is a pseudo-option whose only purpose is to terminate the options and
2699 therefore to cause subsequent command line items to be treated as arguments
2700 rather than options, even if they begin with hyphens.
2701
2702 .vitem &%--help%&
2703 .oindex "&%--help%&"
2704 This option causes Exim to output a few sentences stating what it is.
2705 The same output is generated if the Exim binary is called with no options and
2706 no arguments.
2707
2708 .vitem &%--version%&
2709 .oindex "&%--version%&"
2710 This option is an alias for &%-bV%& and causes version information to be
2711 displayed.
2712
2713 .vitem &%-Ac%& &&&
2714        &%-Am%&
2715 .oindex "&%-Ac%&"
2716 .oindex "&%-Am%&"
2717 These options are used by Sendmail for selecting configuration files and are
2718 ignored by Exim.
2719
2720 .vitem &%-B%&<&'type'&>
2721 .oindex "&%-B%&"
2722 .cindex "8-bit characters"
2723 .cindex "Sendmail compatibility" "8-bit characters"
2724 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2725 clean; it ignores this option.
2726
2727 .vitem &%-bd%&
2728 .oindex "&%-bd%&"
2729 .cindex "daemon"
2730 .cindex "SMTP" "listener"
2731 .cindex "queue runner"
2732 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2733 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2734 that the daemon should also initiate periodic queue runs.
2735
2736 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2737 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2738 disconnect from the controlling terminal. When running this way, it can be
2739 stopped by pressing ctrl-C.
2740
2741 By default, Exim listens for incoming connections to the standard SMTP port on
2742 all the host's running interfaces. However, it is possible to listen on other
2743 ports, on multiple ports, and only on specific interfaces. Chapter
2744 &<<CHAPinterfaces>>& contains a description of the options that control this.
2745
2746 When a listening daemon
2747 .cindex "daemon" "process id (pid)"
2748 .cindex "pid (process id)" "of daemon"
2749 is started without the use of &%-oX%& (that is, without overriding the normal
2750 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2751 in Exim's spool directory. This location can be overridden by setting
2752 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2753 running as root.
2754
2755 When &%-oX%& is used on the command line to start a listening daemon, the
2756 process id is not written to the normal pid file path. However, &%-oP%& can be
2757 used to specify a path on the command line if a pid file is required.
2758
2759 The SIGHUP signal
2760 .cindex "SIGHUP"
2761 .cindex "daemon" "restarting"
2762 can be used to cause the daemon to re-execute itself. This should be done
2763 whenever Exim's configuration file, or any file that is incorporated into it by
2764 means of the &%.include%& facility, is changed, and also whenever a new version
2765 of Exim is installed. It is not necessary to do this when other files that are
2766 referenced from the configuration (for example, alias files) are changed,
2767 because these are reread each time they are used.
2768
2769 .vitem &%-bdf%&
2770 .oindex "&%-bdf%&"
2771 This option has the same effect as &%-bd%& except that it never disconnects
2772 from the controlling terminal, even when no debugging is specified.
2773
2774 .vitem &%-be%&
2775 .oindex "&%-be%&"
2776 .cindex "testing" "string expansion"
2777 .cindex "expansion" "testing"
2778 Run Exim in expansion testing mode. Exim discards its root privilege, to
2779 prevent ordinary users from using this mode to read otherwise inaccessible
2780 files. If no arguments are given, Exim runs interactively, prompting for lines
2781 of data. Otherwise, it processes each argument in turn.
2782
2783 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2784 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2785 used without command line arguments. If successful, it uses the &[readline()]&
2786 function, which provides extensive line-editing facilities, for reading the
2787 test data. A line history is supported.
2788
2789 Long expansion expressions can be split over several lines by using backslash
2790 continuations. As in Exim's run time configuration, white space at the start of
2791 continuation lines is ignored. Each argument or data line is passed through the
2792 string expansion mechanism, and the result is output. Variable values from the
2793 configuration file (for example, &$qualify_domain$&) are available, but no
2794 message-specific values (such as &$sender_domain$&) are set, because no message
2795 is being processed (but see &%-bem%& and &%-Mset%&).
2796
2797 &*Note*&: If you use this mechanism to test lookups, and you change the data
2798 files or databases you are using, you must exit and restart Exim before trying
2799 the same lookup again. Otherwise, because each Exim process caches the results
2800 of lookups, you will just get the same result as before.
2801
2802 .vitem &%-bem%&&~<&'filename'&>
2803 .oindex "&%-bem%&"
2804 .cindex "testing" "string expansion"
2805 .cindex "expansion" "testing"
2806 This option operates like &%-be%& except that it must be followed by the name
2807 of a file. For example:
2808 .code
2809 exim -bem /tmp/testmessage
2810 .endd
2811 The file is read as a message (as if receiving a locally-submitted non-SMTP
2812 message) before any of the test expansions are done. Thus, message-specific
2813 variables such as &$message_size$& and &$header_from:$& are available. However,
2814 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2815 recipients are read from the headers in the normal way, and are shown in the
2816 &$recipients$& variable. Note that recipients cannot be given on the command
2817 line, because further arguments are taken as strings to expand (just like
2818 &%-be%&).
2819
2820 .vitem &%-bF%&&~<&'filename'&>
2821 .oindex "&%-bF%&"
2822 .cindex "system filter" "testing"
2823 .cindex "testing" "system filter"
2824 This option is the same as &%-bf%& except that it assumes that the filter being
2825 tested is a system filter. The additional commands that are available only in
2826 system filters are recognized.
2827
2828 .vitem &%-bf%&&~<&'filename'&>
2829 .oindex "&%-bf%&"
2830 .cindex "filter" "testing"
2831 .cindex "testing" "filter file"
2832 .cindex "forward file" "testing"
2833 .cindex "testing" "forward file"
2834 .cindex "Sieve filter" "testing"
2835 This option runs Exim in user filter testing mode; the file is the filter file
2836 to be tested, and a test message must be supplied on the standard input. If
2837 there are no message-dependent tests in the filter, an empty file can be
2838 supplied.
2839
2840 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2841 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2842 filter and a user filter in the same run. For example:
2843 .code
2844 exim -bF /system/filter -bf /user/filter </test/message
2845 .endd
2846 This is helpful when the system filter adds header lines or sets filter
2847 variables that are used by the user filter.
2848
2849 If the test filter file does not begin with one of the special lines
2850 .code
2851 # Exim filter
2852 # Sieve filter
2853 .endd
2854 it is taken to be a normal &_.forward_& file, and is tested for validity under
2855 that interpretation. See sections &<<SECTitenonfilred>>& to
2856 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2857 redirection lists.
2858
2859 The result of an Exim command that uses &%-bf%&, provided no errors are
2860 detected, is a list of the actions that Exim would try to take if presented
2861 with the message for real. More details of filter testing are given in the
2862 separate document entitled &'Exim's interfaces to mail filtering'&.
2863
2864 When testing a filter file,
2865 .cindex "&""From""& line"
2866 .cindex "envelope sender"
2867 .oindex "&%-f%&" "for filter testing"
2868 the envelope sender can be set by the &%-f%& option,
2869 or by a &"From&~"& line at the start of the test message. Various parameters
2870 that would normally be taken from the envelope recipient address of the message
2871 can be set by means of additional command line options (see the next four
2872 options).
2873
2874 .vitem &%-bfd%&&~<&'domain'&>
2875 .oindex "&%-bfd%&"
2876 .vindex "&$qualify_domain$&"
2877 This sets the domain of the recipient address when a filter file is being
2878 tested by means of the &%-bf%& option. The default is the value of
2879 &$qualify_domain$&.
2880
2881 .vitem &%-bfl%&&~<&'local&~part'&>
2882 .oindex "&%-bfl%&"
2883 This sets the local part of the recipient address when a filter file is being
2884 tested by means of the &%-bf%& option. The default is the username of the
2885 process that calls Exim. A local part should be specified with any prefix or
2886 suffix stripped, because that is how it appears to the filter when a message is
2887 actually being delivered.
2888
2889 .vitem &%-bfp%&&~<&'prefix'&>
2890 .oindex "&%-bfp%&"
2891 This sets the prefix of the local part of the recipient address when a filter
2892 file is being tested by means of the &%-bf%& option. The default is an empty
2893 prefix.
2894
2895 .vitem &%-bfs%&&~<&'suffix'&>
2896 .oindex "&%-bfs%&"
2897 This sets the suffix of the local part of the recipient address when a filter
2898 file is being tested by means of the &%-bf%& option. The default is an empty
2899 suffix.
2900
2901 .vitem &%-bh%&&~<&'IP&~address'&>
2902 .oindex "&%-bh%&"
2903 .cindex "testing" "incoming SMTP"
2904 .cindex "SMTP" "testing incoming"
2905 .cindex "testing" "relay control"
2906 .cindex "relaying" "testing configuration"
2907 .cindex "policy control" "testing"
2908 .cindex "debugging" "&%-bh%& option"
2909 This option runs a fake SMTP session as if from the given IP address, using the
2910 standard input and output. The IP address may include a port number at the end,
2911 after a full stop. For example:
2912 .code
2913 exim -bh 10.9.8.7.1234
2914 exim -bh fe80::a00:20ff:fe86:a061.5678
2915 .endd
2916 When an IPv6 address is given, it is converted into canonical form. In the case
2917 of the second example above, the value of &$sender_host_address$& after
2918 conversion to the canonical form is
2919 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2920
2921 Comments as to what is going on are written to the standard error file. These
2922 include lines beginning with &"LOG"& for anything that would have been logged.
2923 This facility is provided for testing configuration options for incoming
2924 messages, to make sure they implement the required policy. For example, you can
2925 test your relay controls using &%-bh%&.
2926
2927 &*Warning 1*&:
2928 .cindex "RFC 1413"
2929 You can test features of the configuration that rely on ident (RFC 1413)
2930 information by using the &%-oMt%& option. However, Exim cannot actually perform
2931 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2932 connection.
2933
2934 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2935 are also skipped when testing using &%-bh%&. If you want these callouts to
2936 occur, use &%-bhc%& instead.
2937
2938 Messages supplied during the testing session are discarded, and nothing is
2939 written to any of the real log files. There may be pauses when DNS (and other)
2940 lookups are taking place, and of course these may time out. The &%-oMi%& option
2941 can be used to specify a specific IP interface and port if this is important,
2942 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2943 session were authenticated.
2944
2945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2946 output just states whether a given recipient address from a given host is
2947 acceptable or not. See section &<<SECTcheckaccess>>&.
2948
2949 Features such as authentication and encryption, where the client input is not
2950 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2951 specialized SMTP test program such as
2952 &url(http://jetmore.org/john/code/#swaks,swaks).
2953
2954 .vitem &%-bhc%&&~<&'IP&~address'&>
2955 .oindex "&%-bhc%&"
2956 This option operates in the same way as &%-bh%&, except that address
2957 verification callouts are performed if required. This includes consulting and
2958 updating the callout cache database.
2959
2960 .vitem &%-bi%&
2961 .oindex "&%-bi%&"
2962 .cindex "alias file" "building"
2963 .cindex "building alias file"
2964 .cindex "Sendmail compatibility" "&%-bi%& option"
2965 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2966 Exim does not have the concept of a single alias file, and so it cannot mimic
2967 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2968 tend to appear in various scripts such as NIS make files, so the option must be
2969 recognized.
2970
2971 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2972 configuration option is run, under the uid and gid of the caller of Exim. If
2973 the &%-oA%& option is used, its value is passed to the command as an argument.
2974 The command set by &%bi_command%& may not contain arguments. The command can
2975 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2976 if this is required. If the &%bi_command%& option is not set, calling Exim with
2977 &%-bi%& is a no-op.
2978
2979 . // Keep :help first, then the rest in alphabetical order
2980 .vitem &%-bI:help%&
2981 .oindex "&%-bI:help%&"
2982 .cindex "querying exim information"
2983 We shall provide various options starting &`-bI:`& for querying Exim for
2984 information.  The output of many of these will be intended for machine
2985 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2986 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2987 options shall cause Exim to exit after producing the requested output.
2988
2989 .vitem &%-bI:dscp%&
2990 .oindex "&%-bI:dscp%&"
2991 .cindex "DSCP" "values"
2992 This option causes Exim to emit an alphabetically sorted list of all
2993 recognised DSCP names.
2994
2995 .vitem &%-bI:sieve%&
2996 .oindex "&%-bI:sieve%&"
2997 .cindex "Sieve filter" "capabilities"
2998 This option causes Exim to emit an alphabetically sorted list of all supported
2999 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3000 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3001 &`SIEVE`& capability response line.  As the precise list may depend upon
3002 compile-time build options, which this option will adapt to, this is the only
3003 way to guarantee a correct response.
3004
3005 .vitem &%-bm%&
3006 .oindex "&%-bm%&"
3007 .cindex "local message reception"
3008 This option runs an Exim receiving process that accepts an incoming,
3009 locally-generated message on the standard input. The recipients are given as the
3010 command arguments (except when &%-t%& is also present &-- see below). Each
3011 argument can be a comma-separated list of RFC 2822 addresses. This is the
3012 default option for selecting the overall action of an Exim call; it is assumed
3013 if no other conflicting option is present.
3014
3015 If any addresses in the message are unqualified (have no domain), they are
3016 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3017 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3018 suppressing this for special cases.
3019
3020 Policy checks on the contents of local messages can be enforced by means of
3021 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3022
3023 .cindex "return code" "for &%-bm%&"
3024 The return code is zero if the message is successfully accepted. Otherwise, the
3025 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3026
3027 The format
3028 .cindex "message" "format"
3029 .cindex "format" "message"
3030 .cindex "&""From""& line"
3031 .cindex "UUCP" "&""From""& line"
3032 .cindex "Sendmail compatibility" "&""From""& line"
3033 of the message must be as defined in RFC 2822, except that, for
3034 compatibility with Sendmail and Smail, a line in one of the forms
3035 .code
3036 From sender Fri Jan  5 12:55 GMT 1997
3037 From sender Fri, 5 Jan 97 12:55:01
3038 .endd
3039 (with the weekday optional, and possibly with additional text after the date)
3040 is permitted to appear at the start of the message. There appears to be no
3041 authoritative specification of the format of this line. Exim recognizes it by
3042 matching against the regular expression defined by the &%uucp_from_pattern%&
3043 option, which can be changed if necessary.
3044
3045 .oindex "&%-f%&" "overriding &""From""& line"
3046 The specified sender is treated as if it were given as the argument to the
3047 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3048 preference to the address taken from the message. The caller of Exim must be a
3049 trusted user for the sender of a message to be set in this way.
3050
3051 .vitem &%-bmalware%&&~<&'filename'&>
3052 .oindex "&%-bmalware%&"
3053 .cindex "testing", "malware"
3054 .cindex "malware scan test"
3055 This debugging option causes Exim to scan the given file,
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%configure_file%& is given as an argument, the name of the run time
3114 configuration file is output.
3115 If a list of configuration files was supplied, the value that is output here
3116 is the name of the file that was actually used.
3117
3118 .cindex "options" "hiding name of"
3119 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3120 name will not be output.
3121
3122 .cindex "daemon" "process id (pid)"
3123 .cindex "pid (process id)" "of daemon"
3124 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3125 directories where log files and daemon pid files are written are output,
3126 respectively. If these values are unset, log files are written in a
3127 sub-directory of the spool directory called &%log%&, and the pid file is
3128 written directly into the spool directory.
3129
3130 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3131 .code
3132 exim -bP +local_domains
3133 .endd
3134 it searches for a matching named list of any type (domain, host, address, or
3135 local part) and outputs what it finds.
3136
3137 .cindex "options" "router &-- extracting"
3138 .cindex "options" "transport &-- extracting"
3139 .cindex "options" "authenticator &-- extracting"
3140 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3141 followed by the name of an appropriate driver instance, the option settings for
3142 that driver are output. For example:
3143 .code
3144 exim -bP transport local_delivery
3145 .endd
3146 The generic driver options are output first, followed by the driver's private
3147 options. A list of the names of drivers of a particular type can be obtained by
3148 using one of the words &%router_list%&, &%transport_list%&, or
3149 &%authenticator_list%&, and a complete list of all drivers with their option
3150 settings can be obtained by using &%routers%&, &%transports%&, or
3151 &%authenticators%&.
3152
3153 .cindex "options" "macro &-- extracting"
3154 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3155 are available, similarly to the drivers.  Because macros are sometimes used
3156 for storing passwords, this option is restricted.
3157 The output format is one item per line.
3158
3159 .vitem &%-bp%&
3160 .oindex "&%-bp%&"
3161 .cindex "queue" "listing messages on"
3162 .cindex "listing" "messages on the queue"
3163 This option requests a listing of the contents of the mail queue on the
3164 standard output. If the &%-bp%& option is followed by a list of message ids,
3165 just those messages are listed. By default, this option can be used only by an
3166 admin user. However, the &%queue_list_requires_admin%& option can be set false
3167 to allow any user to see the queue.
3168
3169 Each message on the queue is displayed as in the following example:
3170 .code
3171 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3172           red.king@looking-glass.fict.example
3173           <other addresses>
3174 .endd
3175 .cindex "message" "size in queue listing"
3176 .cindex "size" "of message"
3177 The first line contains the length of time the message has been on the queue
3178 (in this case 25 minutes), the size of the message (2.9K), the unique local
3179 identifier for the message, and the message sender, as contained in the
3180 envelope. For bounce messages, the sender address is empty, and appears as
3181 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3182 the default sender address, the user's login name is shown in parentheses
3183 before the sender address.
3184
3185 .cindex "frozen messages" "in queue listing"
3186 If the message is frozen (attempts to deliver it are suspended) then the text
3187 &"*** frozen ***"& is displayed at the end of this line.
3188
3189 The recipients of the message (taken from the envelope, not the headers) are
3190 displayed on subsequent lines. Those addresses to which the message has already
3191 been delivered are marked with the letter D. If an original address gets
3192 expanded into several addresses via an alias or forward file, the original is
3193 displayed with a D only when deliveries for all of its child addresses are
3194 complete.
3195
3196
3197 .vitem &%-bpa%&
3198 .oindex "&%-bpa%&"
3199 This option operates like &%-bp%&, but in addition it shows delivered addresses
3200 that were generated from the original top level address(es) in each message by
3201 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3202 of just &"D"&.
3203
3204
3205 .vitem &%-bpc%&
3206 .oindex "&%-bpc%&"
3207 .cindex "queue" "count of messages on"
3208 This option counts the number of messages on the queue, and writes the total
3209 to the standard output. It is restricted to admin users, unless
3210 &%queue_list_requires_admin%& is set false.
3211
3212
3213 .vitem &%-bpr%&
3214 .oindex "&%-bpr%&"
3215 This option operates like &%-bp%&, but the output is not sorted into
3216 chronological order of message arrival. This can speed it up when there are
3217 lots of messages on the queue, and is particularly useful if the output is
3218 going to be post-processed in a way that doesn't need the sorting.
3219
3220 .vitem &%-bpra%&
3221 .oindex "&%-bpra%&"
3222 This option is a combination of &%-bpr%& and &%-bpa%&.
3223
3224 .vitem &%-bpru%&
3225 .oindex "&%-bpru%&"
3226 This option is a combination of &%-bpr%& and &%-bpu%&.
3227
3228
3229 .vitem &%-bpu%&
3230 .oindex "&%-bpu%&"
3231 This option operates like &%-bp%& but shows only undelivered top-level
3232 addresses for each message displayed. Addresses generated by aliasing or
3233 forwarding are not shown, unless the message was deferred after processing by a
3234 router with the &%one_time%& option set.
3235
3236
3237 .vitem &%-brt%&
3238 .oindex "&%-brt%&"
3239 .cindex "testing" "retry configuration"
3240 .cindex "retry" "configuration testing"
3241 This option is for testing retry rules, and it must be followed by up to three
3242 arguments. It causes Exim to look for a retry rule that matches the values
3243 and to write it to the standard output. For example:
3244 .code
3245 exim -brt bach.comp.mus.example
3246 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3247 .endd
3248 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3249 argument, which is required, can be a complete address in the form
3250 &'local_part@domain'&, or it can be just a domain name. If the second argument
3251 contains a dot, it is interpreted as an optional second domain name; if no
3252 retry rule is found for the first argument, the second is tried. This ties in
3253 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3254 rule is found that matches the host, one that matches the mail domain is
3255 sought. Finally, an argument that is the name of a specific delivery error, as
3256 used in setting up retry rules, can be given. For example:
3257 .code
3258 exim -brt haydn.comp.mus.example quota_3d
3259 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3260 .endd
3261
3262 .vitem &%-brw%&
3263 .oindex "&%-brw%&"
3264 .cindex "testing" "rewriting"
3265 .cindex "rewriting" "testing"
3266 This option is for testing address rewriting rules, and it must be followed by
3267 a single argument, consisting of either a local part without a domain, or a
3268 complete address with a fully qualified domain. Exim outputs how this address
3269 would be rewritten for each possible place it might appear. See chapter
3270 &<<CHAPrewrite>>& for further details.
3271
3272 .vitem &%-bS%&
3273 .oindex "&%-bS%&"
3274 .cindex "SMTP" "batched incoming"
3275 .cindex "batched SMTP input"
3276 This option is used for batched SMTP input, which is an alternative interface
3277 for non-interactive local message submission. A number of messages can be
3278 submitted in a single run. However, despite its name, this is not really SMTP
3279 input. Exim reads each message's envelope from SMTP commands on the standard
3280 input, but generates no responses. If the caller is trusted, or
3281 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3282 believed; otherwise the sender is always the caller of Exim.
3283
3284 The message itself is read from the standard input, in SMTP format (leading
3285 dots doubled), terminated by a line containing just a single dot. An error is
3286 provoked if the terminating dot is missing. A further message may then follow.
3287
3288 As for other local message submissions, the contents of incoming batch SMTP
3289 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3290 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3291 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3292
3293 Some other SMTP commands are recognized in the input. HELO and EHLO act
3294 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3295 QUIT quits, ignoring the rest of the standard input.
3296
3297 .cindex "return code" "for &%-bS%&"
3298 If any error is encountered, reports are written to the standard output and
3299 error streams, and Exim gives up immediately. The return code is 0 if no error
3300 was detected; it is 1 if one or more messages were accepted before the error
3301 was detected; otherwise it is 2.
3302
3303 More details of input using batched SMTP are given in section
3304 &<<SECTincomingbatchedSMTP>>&.
3305
3306 .vitem &%-bs%&
3307 .oindex "&%-bs%&"
3308 .cindex "SMTP" "local input"
3309 .cindex "local SMTP input"
3310 This option causes Exim to accept one or more messages by reading SMTP commands
3311 on the standard input, and producing SMTP replies on the standard output. SMTP
3312 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3313 Some user agents use this interface as a way of passing locally-generated
3314 messages to the MTA.
3315
3316 In
3317 .cindex "sender" "source of"
3318 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3319 set, the senders of messages are taken from the SMTP MAIL commands.
3320 Otherwise the content of these commands is ignored and the sender is set up as
3321 the calling user. Unqualified addresses are automatically qualified using
3322 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3323 &%-bnq%& option is used.
3324
3325 .cindex "inetd"
3326 The
3327 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3328 using a listening daemon. Exim can distinguish the two cases by checking
3329 whether the standard input is a TCP/IP socket. When Exim is called from
3330 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3331 above concerning senders and qualification do not apply. In this situation,
3332 Exim behaves in exactly the same way as it does when receiving a message via
3333 the listening daemon.
3334
3335 .vitem &%-bt%&
3336 .oindex "&%-bt%&"
3337 .cindex "testing" "addresses"
3338 .cindex "address" "testing"
3339 This option runs Exim in address testing mode, in which each argument is taken
3340 as a recipient address to be tested for deliverability. The results are
3341 written to the standard output. If a test fails, and the caller is not an admin
3342 user, no details of the failure are output, because these might contain
3343 sensitive information such as usernames and passwords for database lookups.
3344
3345 If no arguments are given, Exim runs in an interactive manner, prompting with a
3346 right angle bracket for addresses to be tested.
3347
3348 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3349 &[readline()]& function, because it is running as &'root'& and there are
3350 security issues.
3351
3352 Each address is handled as if it were the recipient address of a message
3353 (compare the &%-bv%& option). It is passed to the routers and the result is
3354 written to the standard output. However, any router that has
3355 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3356 genuine routing tests if your first router passes everything to a scanner
3357 program.
3358
3359 .cindex "return code" "for &%-bt%&"
3360 The return code is 2 if any address failed outright; it is 1 if no address
3361 failed outright but at least one could not be resolved for some reason. Return
3362 code 0 is given only when all addresses succeed.
3363
3364 .cindex "duplicate addresses"
3365 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3366 addresses after routing is complete, so that only one delivery takes place.
3367 This does not happen when testing with &%-bt%&; the full results of routing are
3368 always shown.
3369
3370 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3371 routers in the configuration makes any tests on the sender address of a
3372 message,
3373 .oindex "&%-f%&" "for address testing"
3374 you can use the &%-f%& option to set an appropriate sender when running
3375 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3376 default qualifying domain. However, if you have set up (for example) routers
3377 whose behaviour depends on the contents of an incoming message, you cannot test
3378 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3379 doing such tests.
3380
3381 .vitem &%-bV%&
3382 .oindex "&%-bV%&"
3383 .cindex "version number of Exim"
3384 This option causes Exim to write the current version number, compilation
3385 number, and compilation date of the &'exim'& binary to the standard output.
3386 It also lists the DBM library that is being used, the optional modules (such as
3387 specific lookup types), the drivers that are included in the binary, and the
3388 name of the run time configuration file that is in use.
3389
3390 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3391 configuration file. However, this is a static check only. It cannot check
3392 values that are to be expanded. For example, although a misspelt ACL verb is
3393 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3394 alone to discover (for example) all the typos in the configuration; some
3395 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3396 dynamic testing facilities.
3397
3398 .vitem &%-bv%&
3399 .oindex "&%-bv%&"
3400 .cindex "verifying address" "using &%-bv%&"
3401 .cindex "address" "verification"
3402 This option runs Exim in address verification mode, in which each argument is
3403 taken as a recipient address to be verified by the routers. (This does
3404 not involve any verification callouts). During normal operation, verification
3405 happens mostly as a consequence processing a &%verify%& condition in an ACL
3406 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3407 including callouts, see the &%-bh%& and &%-bhc%& options.
3408
3409 If verification fails, and the caller is not an admin user, no details of the
3410 failure are output, because these might contain sensitive information such as
3411 usernames and passwords for database lookups.
3412
3413 If no arguments are given, Exim runs in an interactive manner, prompting with a
3414 right angle bracket for addresses to be verified.
3415
3416 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3417 &[readline()]& function, because it is running as &'exim'& and there are
3418 security issues.
3419
3420 Verification differs from address testing (the &%-bt%& option) in that routers
3421 that have &%no_verify%& set are skipped, and if the address is accepted by a
3422 router that has &%fail_verify%& set, verification fails. The address is
3423 verified as a recipient if &%-bv%& is used; to test verification for a sender
3424 address, &%-bvs%& should be used.
3425
3426 If the &%-v%& option is not set, the output consists of a single line for each
3427 address, stating whether it was verified or not, and giving a reason in the
3428 latter case. Without &%-v%&, generating more than one address by redirection
3429 causes verification to end successfully, without considering the generated
3430 addresses. However, if just one address is generated, processing continues,
3431 and the generated address must verify successfully for the overall verification
3432 to succeed.
3433
3434 When &%-v%& is set, more details are given of how the address has been handled,
3435 and in the case of address redirection, all the generated addresses are also
3436 considered. Verification may succeed for some and fail for others.
3437
3438 The
3439 .cindex "return code" "for &%-bv%&"
3440 return code is 2 if any address failed outright; it is 1 if no address
3441 failed outright but at least one could not be resolved for some reason. Return
3442 code 0 is given only when all addresses succeed.
3443
3444 If any of the routers in the configuration makes any tests on the sender
3445 address of a message, you should use the &%-f%& option to set an appropriate
3446 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3447 calling user at the default qualifying domain.
3448
3449 .vitem &%-bvs%&
3450 .oindex "&%-bvs%&"
3451 This option acts like &%-bv%&, but verifies the address as a sender rather
3452 than a recipient address. This affects any rewriting and qualification that
3453 might happen.
3454
3455 .vitem &%-bw%&
3456 .oindex "&%-bw%&"
3457 .cindex "daemon"
3458 .cindex "inetd"
3459 .cindex "inetd" "wait mode"
3460 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3461 similarly to the &%-bd%& option.  All port specifications on the command-line
3462 and in the configuration file are ignored.  Queue-running may not be specified.
3463
3464 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3465 listening for connections.  This permits the system to start up and have
3466 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3467 each port only when the first connection is received.
3468
3469 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3470 which the daemon will exit, which should cause inetd to listen once more.
3471
3472 .vitem &%-C%&&~<&'filelist'&>
3473 .oindex "&%-C%&"
3474 .cindex "configuration file" "alternate"
3475 .cindex "CONFIGURE_FILE"
3476 .cindex "alternate configuration file"
3477 This option causes Exim to find the run time configuration file from the given
3478 list instead of from the list specified by the CONFIGURE_FILE
3479 compile-time setting. Usually, the list will consist of just a single file
3480 name, but it can be a colon-separated list of names. In this case, the first
3481 file that exists is used. Failure to open an existing file stops Exim from
3482 proceeding any further along the list, and an error is generated.
3483
3484 When this option is used by a caller other than root, and the list is different
3485 from the compiled-in list, Exim gives up its root privilege immediately, and
3486 runs with the real and effective uid and gid set to those of the caller.
3487 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3488 file contains a list of full pathnames, one per line, for configuration files
3489 which are trusted. Root privilege is retained for any configuration file so
3490 listed, as long as the caller is the Exim user (or the user specified in the
3491 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3492 not writeable by inappropriate users or groups.
3493
3494 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3495 configuration using &%-C%& right through message reception and delivery,
3496 even if the caller is root. The reception works, but by that time, Exim is
3497 running as the Exim user, so when it re-executes to regain privilege for the
3498 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3499 test reception and delivery using two separate commands (one to put a message
3500 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3501
3502 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3503 prefix string with which any file named in a &%-C%& command line option
3504 must start. In addition, the file name must not contain the sequence &`/../`&.
3505 However, if the value of the &%-C%& option is identical to the value of
3506 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3507 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3508 unset, any file name can be used with &%-C%&.
3509
3510 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3511 to a directory to which only root has access. This prevents someone who has
3512 broken into the Exim account from running a privileged Exim with an arbitrary
3513 configuration file.
3514
3515 The &%-C%& facility is useful for ensuring that configuration files are
3516 syntactically correct, but cannot be used for test deliveries, unless the
3517 caller is privileged, or unless it is an exotic configuration that does not
3518 require privilege. No check is made on the owner or group of the files
3519 specified by this option.
3520
3521
3522 .vitem &%-D%&<&'macro'&>=<&'value'&>
3523 .oindex "&%-D%&"
3524 .cindex "macro" "setting on command line"
3525 This option can be used to override macro definitions in the configuration file
3526 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3527 unprivileged caller, it causes Exim to give up its root privilege.
3528 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3529 completely disabled, and its use causes an immediate error exit.
3530
3531 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3532 colon-separated list of macros which are considered safe and, if &%-D%& only
3533 supplies macros from this list, and the values are acceptable, then Exim will
3534 not give up root privilege if the caller is root, the Exim run-time user, or
3535 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3536 to be removed in the future.  Acceptable values for the macros satisfy the
3537 regexp: &`^[A-Za-z0-9_/.-]*$`&
3538
3539 The entire option (including equals sign if present) must all be within one
3540 command line item. &%-D%& can be used to set the value of a macro to the empty
3541 string, in which case the equals sign is optional. These two commands are
3542 synonymous:
3543 .code
3544 exim -DABC  ...
3545 exim -DABC= ...
3546 .endd
3547 To include spaces in a macro definition item, quotes must be used. If you use
3548 quotes, spaces are permitted around the macro name and the equals sign. For
3549 example:
3550 .code
3551 exim '-D ABC = something' ...
3552 .endd
3553 &%-D%& may be repeated up to 10 times on a command line.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .new
3815 .vitem &%-MCD%&
3816 .oindex "&%-MCD%&"
3817 This option is not intended for use by external callers. It is used internally
3818 by Exim in conjunction with the &%-MC%& option. It signifies that the
3819 remote host supports the ESMTP &_DSN_& extension.
3820 .wen
3821
3822 .vitem &%-MCP%&
3823 .oindex "&%-MCP%&"
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 server to
3826 which Exim is connected supports pipelining.
3827
3828 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3829 .oindex "&%-MCQ%&"
3830 This option is not intended for use by external callers. It is used internally
3831 by Exim in conjunction with the &%-MC%& option when the original delivery was
3832 started by a queue runner. It passes on the process id of the queue runner,
3833 together with the file descriptor number of an open pipe. Closure of the pipe
3834 signals the final completion of the sequence of processes that are passing
3835 messages through the same SMTP connection.
3836
3837 .vitem &%-MCS%&
3838 .oindex "&%-MCS%&"
3839 This option is not intended for use by external callers. It is used internally
3840 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3841 SMTP SIZE option should be used on messages delivered down the existing
3842 connection.
3843
3844 .vitem &%-MCT%&
3845 .oindex "&%-MCT%&"
3846 This option is not intended for use by external callers. It is used internally
3847 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3848 host to which Exim is connected supports TLS encryption.
3849
3850 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3851 .oindex "&%-Mc%&"
3852 .cindex "hints database" "not overridden by &%-Mc%&"
3853 .cindex "delivery" "manually started &-- not forced"
3854 This option requests Exim to run a delivery attempt on each message in turn,
3855 but unlike the &%-M%& option, it does check for retry hints, and respects any
3856 that are found. This option is not very useful to external callers. It is
3857 provided mainly for internal use by Exim when it needs to re-invoke itself in
3858 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3859 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3860 respects retry times and other options such as &%hold_domains%& that are
3861 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3862 If you want to run a specific delivery as if in a queue run, you should use
3863 &%-q%& with a message id argument. A distinction between queue run deliveries
3864 and other deliveries is made in one or two places.
3865
3866 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3867 .oindex "&%-Mes%&"
3868 .cindex "message" "changing sender"
3869 .cindex "sender" "changing"
3870 This option requests Exim to change the sender address in the message to the
3871 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3872 &"edit sender"&). There must be exactly two arguments. The first argument must
3873 be a message id, and the second one an email address. However, if the message
3874 is active (in the middle of a delivery attempt), its status is not altered.
3875 This option can be used only by an admin user.
3876
3877 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3878 .oindex "&%-Mf%&"
3879 .cindex "freezing messages"
3880 .cindex "message" "manually freezing"
3881 This option requests Exim to mark each listed message as &"frozen"&. This
3882 prevents any delivery attempts taking place until the message is &"thawed"&,
3883 either manually or as a result of the &%auto_thaw%& configuration option.
3884 However, if any of the messages are active (in the middle of a delivery
3885 attempt), their status is not altered. This option can be used only by an admin
3886 user.
3887
3888 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3889 .oindex "&%-Mg%&"
3890 .cindex "giving up on messages"
3891 .cindex "message" "abandoning delivery attempts"
3892 .cindex "delivery" "abandoning further attempts"
3893 This option requests Exim to give up trying to deliver the listed messages,
3894 including any that are frozen. However, if any of the messages are active,
3895 their status is not altered. For non-bounce messages, a delivery error message
3896 is sent to the sender, containing the text &"cancelled by administrator"&.
3897 Bounce messages are just discarded. This option can be used only by an admin
3898 user.
3899
3900 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3901 .oindex "&%-Mmad%&"
3902 .cindex "delivery" "cancelling all"
3903 This option requests Exim to mark all the recipient addresses in the messages
3904 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3905 message is active (in the middle of a delivery attempt), its status is not
3906 altered. This option can be used only by an admin user.
3907
3908 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3909 .oindex "&%-Mmd%&"
3910 .cindex "delivery" "cancelling by address"
3911 .cindex "recipient" "removing"
3912 .cindex "removing recipients"
3913 This option requests Exim to mark the given addresses as already delivered
3914 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3915 the remaining ones must be email addresses. These are matched to recipient
3916 addresses in the message in a case-sensitive manner. If the message is active
3917 (in the middle of a delivery attempt), its status is not altered. This option
3918 can be used only by an admin user.
3919
3920 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3921 .oindex "&%-Mrm%&"
3922 .cindex "removing messages"
3923 .cindex "abandoning mail"
3924 .cindex "message" "manually discarding"
3925 This option requests Exim to remove the given messages from the queue. No
3926 bounce messages are sent; each message is simply forgotten. However, if any of
3927 the messages are active, their status is not altered. This option can be used
3928 only by an admin user or by the user who originally caused the message to be
3929 placed on the queue.
3930
3931 .vitem &%-Mset%&&~<&'message&~id'&>
3932 .oindex "&%-Mset%&
3933 .cindex "testing" "string expansion"
3934 .cindex "expansion" "testing"
3935 This option is useful only in conjunction with &%-be%& (that is, when testing
3936 string expansions). Exim loads the given message from its spool before doing
3937 the test expansions, thus setting message-specific variables such as
3938 &$message_size$& and the header variables. The &$recipients$& variable is made
3939 available. This feature is provided to make it easier to test expansions that
3940 make use of these variables. However, this option can be used only by an admin
3941 user. See also &%-bem%&.
3942
3943 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mt%&"
3945 .cindex "thawing messages"
3946 .cindex "unfreezing messages"
3947 .cindex "frozen messages" "thawing"
3948 .cindex "message" "thawing frozen"
3949 This option requests Exim to &"thaw"& any of the listed messages that are
3950 &"frozen"&, so that delivery attempts can resume. However, if any of the
3951 messages are active, their status is not altered. This option can be used only
3952 by an admin user.
3953
3954 .vitem &%-Mvb%&&~<&'message&~id'&>
3955 .oindex "&%-Mvb%&"
3956 .cindex "listing" "message body"
3957 .cindex "message" "listing body of"
3958 This option causes the contents of the message body (-D) spool file to be
3959 written to the standard output. This option can be used only by an admin user.
3960
3961 .vitem &%-Mvc%&&~<&'message&~id'&>
3962 .oindex "&%-Mvc%&"
3963 .cindex "message" "listing in RFC 2822 format"
3964 .cindex "listing" "message in RFC 2822 format"
3965 This option causes a copy of the complete message (header lines plus body) to
3966 be written to the standard output in RFC 2822 format. This option can be used
3967 only by an admin user.
3968
3969 .vitem &%-Mvh%&&~<&'message&~id'&>
3970 .oindex "&%-Mvh%&"
3971 .cindex "listing" "message headers"
3972 .cindex "header lines" "listing"
3973 .cindex "message" "listing header lines"
3974 This option causes the contents of the message headers (-H) spool file to be
3975 written to the standard output. This option can be used only by an admin user.
3976
3977 .vitem &%-Mvl%&&~<&'message&~id'&>
3978 .oindex "&%-Mvl%&"
3979 .cindex "listing" "message log"
3980 .cindex "message" "listing message log"
3981 This option causes the contents of the message log spool file to be written to
3982 the standard output. This option can be used only by an admin user.
3983
3984 .vitem &%-m%&
3985 .oindex "&%-m%&"
3986 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3987 treats it that way too.
3988
3989 .vitem &%-N%&
3990 .oindex "&%-N%&"
3991 .cindex "debugging" "&%-N%& option"
3992 .cindex "debugging" "suppressing delivery"
3993 This is a debugging option that inhibits delivery of a message at the transport
3994 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3995 it just doesn't actually transport the message, but instead behaves as if it
3996 had successfully done so. However, it does not make any updates to the retry
3997 database, and the log entries for deliveries are flagged with &"*>"& rather
3998 than &"=>"&.
3999
4000 Because &%-N%& discards any message to which it applies, only root or the Exim
4001 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4002 words, an ordinary user can use it only when supplying an incoming message to
4003 which it will apply. Although transportation never fails when &%-N%& is set, an
4004 address may be deferred because of a configuration problem on a transport, or a
4005 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4006 the message, and applies to any subsequent delivery attempts that may happen
4007 for that message.
4008
4009 .vitem &%-n%&
4010 .oindex "&%-n%&"
4011 This option is interpreted by Sendmail to mean &"no aliasing"&.
4012 For normal modes of operation, it is ignored by Exim.
4013 When combined with &%-bP%& it suppresses the name of an option from being output.
4014
4015 .vitem &%-O%&&~<&'data'&>
4016 .oindex "&%-O%&"
4017 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4018 Exim.
4019
4020 .vitem &%-oA%&&~<&'file&~name'&>
4021 .oindex "&%-oA%&"
4022 .cindex "Sendmail compatibility" "&%-oA%& option"
4023 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4024 alternative alias file name. Exim handles &%-bi%& differently; see the
4025 description above.
4026
4027 .vitem &%-oB%&&~<&'n'&>
4028 .oindex "&%-oB%&"
4029 .cindex "SMTP" "passed connection"
4030 .cindex "SMTP" "multiple deliveries"
4031 .cindex "multiple SMTP deliveries"
4032 This is a debugging option which limits the maximum number of messages that can
4033 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4034 transport. If <&'n'&> is omitted, the limit is set to 1.
4035
4036 .vitem &%-odb%&
4037 .oindex "&%-odb%&"
4038 .cindex "background delivery"
4039 .cindex "delivery" "in the background"
4040 This option applies to all modes in which Exim accepts incoming messages,
4041 including the listening daemon. It requests &"background"& delivery of such
4042 messages, which means that the accepting process automatically starts a
4043 delivery process for each message received, but does not wait for the delivery
4044 processes to finish.
4045
4046 When all the messages have been received, the reception process exits,
4047 leaving the delivery processes to finish in their own time. The standard output
4048 and error streams are closed at the start of each delivery process.
4049 This is the default action if none of the &%-od%& options are present.
4050
4051 If one of the queueing options in the configuration file
4052 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4053 overrides it if &%queue_only_override%& is set true, which is the default
4054 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4055
4056 .vitem &%-odf%&
4057 .oindex "&%-odf%&"
4058 .cindex "foreground delivery"
4059 .cindex "delivery" "in the foreground"
4060 This option requests &"foreground"& (synchronous) delivery when Exim has
4061 accepted a locally-generated message. (For the daemon it is exactly the same as
4062 &%-odb%&.) A delivery process is automatically started to deliver the message,
4063 and Exim waits for it to complete before proceeding.
4064
4065 The original Exim reception process does not finish until the delivery
4066 process for the final message has ended. The standard error stream is left open
4067 during deliveries.
4068
4069 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4070 false and one of the queueing options in the configuration file is in effect.
4071
4072 If there is a temporary delivery error during foreground delivery, the
4073 message is left on the queue for later delivery, and the original reception
4074 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4075 restricted configuration that never queues messages.
4076
4077
4078 .vitem &%-odi%&
4079 .oindex "&%-odi%&"
4080 This option is synonymous with &%-odf%&. It is provided for compatibility with
4081 Sendmail.
4082
4083 .vitem &%-odq%&
4084 .oindex "&%-odq%&"
4085 .cindex "non-immediate delivery"
4086 .cindex "delivery" "suppressing immediate"
4087 .cindex "queueing incoming messages"
4088 This option applies to all modes in which Exim accepts incoming messages,
4089 including the listening daemon. It specifies that the accepting process should
4090 not automatically start a delivery process for each message received. Messages
4091 are placed on the queue, and remain there until a subsequent queue runner
4092 process encounters them. There are several configuration options (such as
4093 &%queue_only%&) that can be used to queue incoming messages under certain
4094 conditions. This option overrides all of them and also &%-odqs%&. It always
4095 forces queueing.
4096
4097 .vitem &%-odqs%&
4098 .oindex "&%-odqs%&"
4099 .cindex "SMTP" "delaying delivery"
4100 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4101 However, like &%-odb%& and &%-odi%&, this option has no effect if
4102 &%queue_only_override%& is false and one of the queueing options in the
4103 configuration file is in effect.
4104
4105 When &%-odqs%& does operate, a delivery process is started for each incoming
4106 message, in the background by default, but in the foreground if &%-odi%& is
4107 also present. The recipient addresses are routed, and local deliveries are done
4108 in the normal way. However, if any SMTP deliveries are required, they are not
4109 done at this time, so the message remains on the queue until a subsequent queue
4110 runner process encounters it. Because routing was done, Exim knows which
4111 messages are waiting for which hosts, and so a number of messages for the same
4112 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4113 configuration option has the same effect for specific domains. See also the
4114 &%-qq%& option.
4115
4116 .vitem &%-oee%&
4117 .oindex "&%-oee%&"
4118 .cindex "error" "reporting"
4119 If an error is detected while a non-SMTP message is being received (for
4120 example, a malformed address), the error is reported to the sender in a mail
4121 message.
4122
4123 .cindex "return code" "for &%-oee%&"
4124 Provided
4125 this error message is successfully sent, the Exim receiving process
4126 exits with a return code of zero. If not, the return code is 2 if the problem
4127 is that the original message has no recipients, or 1 for any other error.
4128 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4129
4130 .vitem &%-oem%&
4131 .oindex "&%-oem%&"
4132 .cindex "error" "reporting"
4133 .cindex "return code" "for &%-oem%&"
4134 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4135 return code, whether or not the error message was successfully sent.
4136 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4137
4138 .vitem &%-oep%&
4139 .oindex "&%-oep%&"
4140 .cindex "error" "reporting"
4141 If an error is detected while a non-SMTP message is being received, the
4142 error is reported by writing a message to the standard error file (stderr).
4143 .cindex "return code" "for &%-oep%&"
4144 The return code is 1 for all errors.
4145
4146 .vitem &%-oeq%&
4147 .oindex "&%-oeq%&"
4148 .cindex "error" "reporting"
4149 This option is supported for compatibility with Sendmail, but has the same
4150 effect as &%-oep%&.
4151
4152 .vitem &%-oew%&
4153 .oindex "&%-oew%&"
4154 .cindex "error" "reporting"
4155 This option is supported for compatibility with Sendmail, but has the same
4156 effect as &%-oem%&.
4157
4158 .vitem &%-oi%&
4159 .oindex "&%-oi%&"
4160 .cindex "dot" "in incoming non-SMTP message"
4161 This option, which has the same effect as &%-i%&, specifies that a dot on a
4162 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4163 single dot does terminate, though Exim does no special processing for other
4164 lines that start with a dot. This option is set by default if Exim is called as
4165 &'rmail'&. See also &%-ti%&.
4166
4167 .vitem &%-oitrue%&
4168 .oindex "&%-oitrue%&"
4169 This option is treated as synonymous with &%-oi%&.
4170
4171 .vitem &%-oMa%&&~<&'host&~address'&>
4172 .oindex "&%-oMa%&"
4173 .cindex "sender" "host address, specifying for local message"
4174 A number of options starting with &%-oM%& can be used to set values associated
4175 with remote hosts on locally-submitted messages (that is, messages not received
4176 over TCP/IP). These options can be used by any caller in conjunction with the
4177 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4178 other circumstances, they are ignored unless the caller is trusted.
4179
4180 The &%-oMa%& option sets the sender host address. This may include a port
4181 number at the end, after a full stop (period). For example:
4182 .code
4183 exim -bs -oMa 10.9.8.7.1234
4184 .endd
4185 An alternative syntax is to enclose the IP address in square brackets,
4186 followed by a colon and the port number:
4187 .code
4188 exim -bs -oMa [10.9.8.7]:1234
4189 .endd
4190 The IP address is placed in the &$sender_host_address$& variable, and the
4191 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4192 are present on the command line, the sender host IP address is taken from
4193 whichever one is last.
4194
4195 .vitem &%-oMaa%&&~<&'name'&>
4196 .oindex "&%-oMaa%&"
4197 .cindex "authentication" "name, specifying for local message"
4198 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4199 option sets the value of &$sender_host_authenticated$& (the authenticator
4200 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4201 This option can be used with &%-bh%& and &%-bs%& to set up an
4202 authenticated SMTP session without actually using the SMTP AUTH command.
4203
4204 .vitem &%-oMai%&&~<&'string'&>
4205 .oindex "&%-oMai%&"
4206 .cindex "authentication" "id, specifying for local message"
4207 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4208 option sets the value of &$authenticated_id$& (the id that was authenticated).
4209 This overrides the default value (the caller's login id, except with &%-bh%&,
4210 where there is no default) for messages from local sources. See chapter
4211 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4212
4213 .vitem &%-oMas%&&~<&'address'&>
4214 .oindex "&%-oMas%&"
4215 .cindex "authentication" "sender, specifying for local message"
4216 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4217 option sets the authenticated sender value in &$authenticated_sender$&. It
4218 overrides the sender address that is created from the caller's login id for
4219 messages from local sources, except when &%-bh%& is used, when there is no
4220 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4221 specified on a MAIL command overrides this value. See chapter
4222 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4223
4224 .vitem &%-oMi%&&~<&'interface&~address'&>
4225 .oindex "&%-oMi%&"
4226 .cindex "interface" "address, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4228 option sets the IP interface address value. A port number may be included,
4229 using the same syntax as for &%-oMa%&. The interface address is placed in
4230 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4231
4232 .vitem &%-oMm%&&~<&'message&~reference'&>
4233 .oindex "&%-oMm%&"
4234 .cindex "message reference" "message reference, specifying for local message"
4235 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4236 option sets the message reference, e.g. message-id, and is logged during
4237 delivery. This is useful when some kind of audit trail is required to tie
4238 messages together. The format of the message reference is checked and will
4239 abort if the format is invalid. The option will only be accepted if exim is
4240 running in trusted mode, not as any regular user.
4241
4242 The best example of a message reference is when Exim sends a bounce message.
4243 The message reference is the message-id of the original message for which Exim
4244 is sending the bounce.
4245
4246 .vitem &%-oMr%&&~<&'protocol&~name'&>
4247 .oindex "&%-oMr%&"
4248 .cindex "protocol, specifying for local message"
4249 .vindex "&$received_protocol$&"
4250 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4251 option sets the received protocol value that is stored in
4252 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4253 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4254 SMTP protocol names (see the description of &$received_protocol$& in section
4255 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4256 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4257 be set by &%-oMr%&.
4258
4259 .vitem &%-oMs%&&~<&'host&~name'&>
4260 .oindex "&%-oMs%&"
4261 .cindex "sender" "host name, specifying for local message"
4262 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4263 option sets the sender host name in &$sender_host_name$&. When this option is
4264 present, Exim does not attempt to look up a host name from an IP address; it
4265 uses the name it is given.
4266
4267 .vitem &%-oMt%&&~<&'ident&~string'&>
4268 .oindex "&%-oMt%&"
4269 .cindex "sender" "ident string, specifying for local message"
4270 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4271 option sets the sender ident value in &$sender_ident$&. The default setting for
4272 local callers is the login id of the calling process, except when &%-bh%& is
4273 used, when there is no default.
4274
4275 .vitem &%-om%&
4276 .oindex "&%-om%&"
4277 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4278 In Sendmail, this option means &"me too"&, indicating that the sender of a
4279 message should receive a copy of the message if the sender appears in an alias
4280 expansion. Exim always does this, so the option does nothing.
4281
4282 .vitem &%-oo%&
4283 .oindex "&%-oo%&"
4284 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4285 This option is ignored. In Sendmail it specifies &"old style headers"&,
4286 whatever that means.
4287
4288 .vitem &%-oP%&&~<&'path'&>
4289 .oindex "&%-oP%&"
4290 .cindex "pid (process id)" "of daemon"
4291 .cindex "daemon" "process id (pid)"
4292 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4293 value. The option specifies the file to which the process id of the daemon is
4294 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4295 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4296 because in those cases, the normal pid file is not used.
4297
4298 .vitem &%-or%&&~<&'time'&>
4299 .oindex "&%-or%&"
4300 .cindex "timeout" "for non-SMTP input"
4301 This option sets a timeout value for incoming non-SMTP messages. If it is not
4302 set, Exim will wait forever for the standard input. The value can also be set
4303 by the &%receive_timeout%& option. The format used for specifying times is
4304 described in section &<<SECTtimeformat>>&.
4305
4306 .vitem &%-os%&&~<&'time'&>
4307 .oindex "&%-os%&"
4308 .cindex "timeout" "for SMTP input"
4309 .cindex "SMTP" "input timeout"
4310 This option sets a timeout value for incoming SMTP messages. The timeout
4311 applies to each SMTP command and block of data. The value can also be set by
4312 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4313 for specifying times is described in section &<<SECTtimeformat>>&.
4314
4315 .vitem &%-ov%&
4316 .oindex "&%-ov%&"
4317 This option has exactly the same effect as &%-v%&.
4318
4319 .vitem &%-oX%&&~<&'number&~or&~string'&>
4320 .oindex "&%-oX%&"
4321 .cindex "TCP/IP" "setting listening ports"
4322 .cindex "TCP/IP" "setting listening interfaces"
4323 .cindex "port" "receiving TCP/IP"
4324 This option is relevant only when the &%-bd%& (start listening daemon) option
4325 is also given. It controls which ports and interfaces the daemon uses. Details
4326 of the syntax, and how it interacts with configuration file options, are given
4327 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4328 file is written unless &%-oP%& is also present to specify a pid file name.
4329
4330 .vitem &%-pd%&
4331 .oindex "&%-pd%&"
4332 .cindex "Perl" "starting the interpreter"
4333 This option applies when an embedded Perl interpreter is linked with Exim (see
4334 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4335 option, forcing the starting of the interpreter to be delayed until it is
4336 needed.
4337
4338 .vitem &%-ps%&
4339 .oindex "&%-ps%&"
4340 .cindex "Perl" "starting the interpreter"
4341 This option applies when an embedded Perl interpreter is linked with Exim (see
4342 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4343 option, forcing the starting of the interpreter to occur as soon as Exim is
4344 started.
4345
4346 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4347 .oindex "&%-p%&"
4348 For compatibility with Sendmail, this option is equivalent to
4349 .display
4350 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4351 .endd
4352 It sets the incoming protocol and host name (for trusted callers). The
4353 host name and its colon can be omitted when only the protocol is to be set.
4354 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4355 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4356 or &`s`& using this option (but that does not seem a real limitation).
4357
4358 .vitem &%-q%&
4359 .oindex "&%-q%&"
4360 .cindex "queue runner" "starting manually"
4361 This option is normally restricted to admin users. However, there is a
4362 configuration option called &%prod_requires_admin%& which can be set false to
4363 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4364 and &%-S%& options).
4365
4366 .cindex "queue runner" "description of operation"
4367 The &%-q%& option starts one queue runner process. This scans the queue of
4368 waiting messages, and runs a delivery process for each one in turn. It waits
4369 for each delivery process to finish before starting the next one. A delivery
4370 process may not actually do any deliveries if the retry times for the addresses
4371 have not been reached. Use &%-qf%& (see below) if you want to override this.
4372
4373 If
4374 .cindex "SMTP" "passed connection"
4375 .cindex "SMTP" "multiple deliveries"
4376 .cindex "multiple SMTP deliveries"
4377 the delivery process spawns other processes to deliver other messages down
4378 passed SMTP connections, the queue runner waits for these to finish before
4379 proceeding.
4380
4381 When all the queued messages have been considered, the original queue runner
4382 process terminates. In other words, a single pass is made over the waiting
4383 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4384 this to be repeated periodically.
4385
4386 Exim processes the waiting messages in an unpredictable order. It isn't very
4387 random, but it is likely to be different each time, which is all that matters.
4388 If one particular message screws up a remote MTA, other messages to the same
4389 MTA have a chance of getting through if they get tried first.
4390
4391 It is possible to cause the messages to be processed in lexical message id
4392 order, which is essentially the order in which they arrived, by setting the
4393 &%queue_run_in_order%& option, but this is not recommended for normal use.
4394
4395 .vitem &%-q%&<&'qflags'&>
4396 The &%-q%& option may be followed by one or more flag letters that change its
4397 behaviour. They are all optional, but if more than one is present, they must
4398 appear in the correct order. Each flag is described in a separate item below.
4399
4400 .vitem &%-qq...%&
4401 .oindex "&%-qq%&"
4402 .cindex "queue" "double scanning"
4403 .cindex "queue" "routing"
4404 .cindex "routing" "whole queue before delivery"
4405 An option starting with &%-qq%& requests a two-stage queue run. In the first
4406 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4407 every domain. Addresses are routed, local deliveries happen, but no remote
4408 transports are run.
4409
4410 .cindex "hints database" "remembering routing"
4411 The hints database that remembers which messages are waiting for specific hosts
4412 is updated, as if delivery to those hosts had been deferred. After this is
4413 complete, a second, normal queue scan happens, with routing and delivery taking
4414 place as normal. Messages that are routed to the same host should mostly be
4415 delivered down a single SMTP
4416 .cindex "SMTP" "passed connection"
4417 .cindex "SMTP" "multiple deliveries"
4418 .cindex "multiple SMTP deliveries"
4419 connection because of the hints that were set up during the first queue scan.
4420 This option may be useful for hosts that are connected to the Internet
4421 intermittently.
4422
4423 .vitem &%-q[q]i...%&
4424 .oindex "&%-qi%&"
4425 .cindex "queue" "initial delivery"
4426 If the &'i'& flag is present, the queue runner runs delivery processes only for
4427 those messages that haven't previously been tried. (&'i'& stands for &"initial
4428 delivery"&.) This can be helpful if you are putting messages on the queue using
4429 &%-odq%& and want a queue runner just to process the new messages.
4430
4431 .vitem &%-q[q][i]f...%&
4432 .oindex "&%-qf%&"
4433 .cindex "queue" "forcing delivery"
4434 .cindex "delivery" "forcing in queue run"
4435 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4436 message, whereas without &'f'& only those non-frozen addresses that have passed
4437 their retry times are tried.
4438
4439 .vitem &%-q[q][i]ff...%&
4440 .oindex "&%-qff%&"
4441 .cindex "frozen messages" "forcing delivery"
4442 If &'ff'& is present, a delivery attempt is forced for every message, whether
4443 frozen or not.
4444
4445 .vitem &%-q[q][i][f[f]]l%&
4446 .oindex "&%-ql%&"
4447 .cindex "queue" "local deliveries only"
4448 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4449 be done. If a message requires any remote deliveries, it remains on the queue
4450 for later delivery.
4451
4452 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4453 .cindex "queue" "delivering specific messages"
4454 When scanning the queue, Exim can be made to skip over messages whose ids are
4455 lexically less than a given value by following the &%-q%& option with a
4456 starting message id. For example:
4457 .code
4458 exim -q 0t5C6f-0000c8-00
4459 .endd
4460 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4461 second message id is given, messages whose ids are lexically greater than it
4462 are also skipped. If the same id is given twice, for example,
4463 .code
4464 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4465 .endd
4466 just one delivery process is started, for that message. This differs from
4467 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4468 that it counts as a delivery from a queue run. Note that the selection
4469 mechanism does not affect the order in which the messages are scanned. There
4470 are also other ways of selecting specific sets of messages for delivery in a
4471 queue run &-- see &%-R%& and &%-S%&.
4472
4473 .vitem &%-q%&<&'qflags'&><&'time'&>
4474 .cindex "queue runner" "starting periodically"
4475 .cindex "periodic queue running"
4476 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4477 starting a queue runner process at intervals specified by the given time value
4478 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4479 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4480 single daemon process handles both functions. A common way of starting up a
4481 combined daemon at system boot time is to use a command such as
4482 .code
4483 /usr/exim/bin/exim -bd -q30m
4484 .endd
4485 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4486 process every 30 minutes.
4487
4488 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4489 pid file is written unless one is explicitly requested by the &%-oP%& option.
4490
4491 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4492 .oindex "&%-qR%&"
4493 This option is synonymous with &%-R%&. It is provided for Sendmail
4494 compatibility.
4495
4496 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4497 .oindex "&%-qS%&"
4498 This option is synonymous with &%-S%&.
4499
4500 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4501 .oindex "&%-R%&"
4502 .cindex "queue runner" "for specific recipients"
4503 .cindex "delivery" "to given domain"
4504 .cindex "domain" "delivery to"
4505 The <&'rsflags'&> may be empty, in which case the white space before the string
4506 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4507 which are the possible values for <&'rsflags'&>. White space is required if
4508 <&'rsflags'&> is not empty.
4509
4510 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4511 perform a single queue run, except that, when scanning the messages on the
4512 queue, Exim processes only those that have at least one undelivered recipient
4513 address containing the given string, which is checked in a case-independent
4514 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4515 regular expression; otherwise it is a literal string.
4516
4517 If you want to do periodic queue runs for messages with specific recipients,
4518 you can combine &%-R%& with &%-q%& and a time value. For example:
4519 .code
4520 exim -q25m -R @special.domain.example
4521 .endd
4522 This example does a queue run for messages with recipients in the given domain
4523 every 25 minutes. Any additional flags that are specified with &%-q%& are
4524 applied to each queue run.
4525
4526 Once a message is selected for delivery by this mechanism, all its addresses
4527 are processed. For the first selected message, Exim overrides any retry
4528 information and forces a delivery attempt for each undelivered address. This
4529 means that if delivery of any address in the first message is successful, any
4530 existing retry information is deleted, and so delivery attempts for that
4531 address in subsequently selected messages (which are processed without forcing)
4532 will run. However, if delivery of any address does not succeed, the retry
4533 information is updated, and in subsequently selected messages, the failing
4534 address will be skipped.
4535
4536 .cindex "frozen messages" "forcing delivery"
4537 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4538 all selected messages, not just the first; frozen messages are included when
4539 &'ff'& is present.
4540
4541 The &%-R%& option makes it straightforward to initiate delivery of all messages
4542 to a given domain after a host has been down for some time. When the SMTP
4543 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4544 effect is to run Exim with the &%-R%& option, but it can be configured to run
4545 an arbitrary command instead.
4546
4547 .vitem &%-r%&
4548 .oindex "&%-r%&"
4549 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4550
4551 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4552 .oindex "&%-S%&"
4553 .cindex "delivery" "from given sender"
4554 .cindex "queue runner" "for specific senders"
4555 This option acts like &%-R%& except that it checks the string against each
4556 message's sender instead of against the recipients. If &%-R%& is also set, both
4557 conditions must be met for a message to be selected. If either of the options
4558 has &'f'& or &'ff'& in its flags, the associated action is taken.
4559
4560 .vitem &%-Tqt%&&~<&'times'&>
4561 .oindex "&%-Tqt%&"
4562 This is an option that is exclusively for use by the Exim testing suite. It is not
4563 recognized when Exim is run normally. It allows for the setting up of explicit
4564 &"queue times"& so that various warning/retry features can be tested.
4565
4566 .vitem &%-t%&
4567 .oindex "&%-t%&"
4568 .cindex "recipient" "extracting from header lines"
4569 .cindex "&'Bcc:'& header line"
4570 .cindex "&'Cc:'& header line"
4571 .cindex "&'To:'& header line"
4572 When Exim is receiving a locally-generated, non-SMTP message on its standard
4573 input, the &%-t%& option causes the recipients of the message to be obtained
4574 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4575 from the command arguments. The addresses are extracted before any rewriting
4576 takes place and the &'Bcc:'& header line, if present, is then removed.
4577
4578 .cindex "Sendmail compatibility" "&%-t%& option"
4579 If the command has any arguments, they specify addresses to which the message
4580 is &'not'& to be delivered. That is, the argument addresses are removed from
4581 the recipients list obtained from the headers. This is compatible with Smail 3
4582 and in accordance with the documented behaviour of several versions of
4583 Sendmail, as described in man pages on a number of operating systems (e.g.
4584 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4585 argument addresses to those obtained from the headers, and the O'Reilly
4586 Sendmail book documents it that way. Exim can be made to add argument addresses
4587 instead of subtracting them by setting the option
4588 &%extract_addresses_remove_arguments%& false.
4589
4590 .cindex "&%Resent-%& header lines" "with &%-t%&"
4591 If there are any &%Resent-%& header lines in the message, Exim extracts
4592 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4593 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4594 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4595 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4596
4597 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4598 message is resent several times). The RFC also specifies that they should be
4599 added at the front of the message, and separated by &'Received:'& lines. It is
4600 not at all clear how &%-t%& should operate in the present of multiple sets,
4601 nor indeed exactly what constitutes a &"set"&.
4602 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4603 are often added at the end of the header, and if a message is resent more than
4604 once, it is common for the original set of &%Resent-%& headers to be renamed as
4605 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4606
4607 .vitem &%-ti%&
4608 .oindex "&%-ti%&"
4609 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4610 compatibility with Sendmail.
4611
4612 .vitem &%-tls-on-connect%&
4613 .oindex "&%-tls-on-connect%&"
4614 .cindex "TLS" "use without STARTTLS"
4615 .cindex "TLS" "automatic start"
4616 This option is available when Exim is compiled with TLS support. It forces all
4617 incoming SMTP connections to behave as if the incoming port is listed in the
4618 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4619 &<<CHAPTLS>>& for further details.
4620
4621
4622 .vitem &%-U%&
4623 .oindex "&%-U%&"
4624 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4625 Sendmail uses this option for &"initial message submission"&, and its
4626 documentation states that in future releases, it may complain about
4627 syntactically invalid messages rather than fixing them when this flag is not
4628 set. Exim ignores this option.
4629
4630 .vitem &%-v%&
4631 .oindex "&%-v%&"
4632 This option causes Exim to write information to the standard error stream,
4633 describing what it is doing. In particular, it shows the log lines for
4634 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4635 dialogue is shown. Some of the log lines shown may not actually be written to
4636 the log if the setting of &%log_selector%& discards them. Any relevant
4637 selectors are shown with each log line. If none are shown, the logging is
4638 unconditional.
4639
4640 .vitem &%-x%&
4641 .oindex "&%-x%&"
4642 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4643 National Language Support extended characters in the body of the mail item"&).
4644 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4645 this option.
4646
4647 .vitem &%-X%&&~<&'logfile'&>
4648 .oindex "&%-X%&"
4649 This option is interpreted by Sendmail to cause debug information to be sent
4650 to the named file.  It is ignored by Exim.
4651
4652 .vitem &%-z%&&~<&'log-line'&>
4653 .oindex "&%-z%&"
4654 This option writes its argument to Exim's logfile.
4655 Use is restricted to administrators; the intent is for operational notes.
4656 Quotes should be used to maintain a multi-word item as a single argument,
4657 under most shells.
4658 .endlist
4659
4660 .ecindex IIDclo1
4661 .ecindex IIDclo2
4662
4663
4664 . ////////////////////////////////////////////////////////////////////////////
4665 . Insert a stylized DocBook comment here, to identify the end of the command
4666 . line options. This is for the benefit of the Perl script that automatically
4667 . creates a man page for the options.
4668 . ////////////////////////////////////////////////////////////////////////////
4669
4670 .literal xml
4671 <!-- === End of command line options === -->
4672 .literal off
4673
4674
4675
4676
4677
4678 . ////////////////////////////////////////////////////////////////////////////
4679 . ////////////////////////////////////////////////////////////////////////////
4680
4681
4682 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4683          "The runtime configuration file"
4684
4685 .cindex "run time configuration"
4686 .cindex "configuration file" "general description"
4687 .cindex "CONFIGURE_FILE"
4688 .cindex "configuration file" "errors in"
4689 .cindex "error" "in configuration file"
4690 .cindex "return code" "for bad configuration"
4691 Exim uses a single run time configuration file that is read whenever an Exim
4692 binary is executed. Note that in normal operation, this happens frequently,
4693 because Exim is designed to operate in a distributed manner, without central
4694 control.
4695
4696 If a syntax error is detected while reading the configuration file, Exim
4697 writes a message on the standard error, and exits with a non-zero return code.
4698 The message is also written to the panic log. &*Note*&: Only simple syntax
4699 errors can be detected at this time. The values of any expanded options are
4700 not checked until the expansion happens, even when the expansion does not
4701 actually alter the string.
4702
4703 The name of the configuration file is compiled into the binary for security
4704 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4705 most configurations, this specifies a single file. However, it is permitted to
4706 give a colon-separated list of file names, in which case Exim uses the first
4707 existing file in the list.
4708
4709 .cindex "EXIM_USER"
4710 .cindex "EXIM_GROUP"
4711 .cindex "CONFIGURE_OWNER"
4712 .cindex "CONFIGURE_GROUP"
4713 .cindex "configuration file" "ownership"
4714 .cindex "ownership" "configuration file"
4715 The run time configuration file must be owned by root or by the user that is
4716 specified at compile time by the CONFIGURE_OWNER option (if set). The
4717 configuration file must not be world-writeable, or group-writeable unless its
4718 group is the root group or the one specified at compile time by the
4719 CONFIGURE_GROUP option.
4720
4721 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4722 to root, anybody who is able to edit the run time configuration file has an
4723 easy way to run commands as root. If you specify a user or group in the
4724 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4725 who are members of that group will trivially be able to obtain root privileges.
4726
4727 Up to Exim version 4.72, the run time configuration file was also permitted to
4728 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4729 since it offered a simple privilege escalation for any attacker who managed to
4730 compromise the Exim user account.
4731
4732 A default configuration file, which will work correctly in simple situations,
4733 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4734 defines just one file name, the installation process copies the default
4735 configuration to a new file of that name if it did not previously exist. If
4736 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4737 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4738 configuration.
4739
4740
4741
4742 .section "Using a different configuration file" "SECID40"
4743 .cindex "configuration file" "alternate"
4744 A one-off alternate configuration can be specified by the &%-C%& command line
4745 option, which may specify a single file or a list of files. However, when
4746 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4747 unless the argument for &%-C%& is identical to the built-in value from
4748 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4749 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4750 is useful mainly for checking the syntax of configuration files before
4751 installing them. No owner or group checks are done on a configuration file
4752 specified by &%-C%&, if root privilege has been dropped.
4753
4754 Even the Exim user is not trusted to specify an arbitrary configuration file
4755 with the &%-C%& option to be used with root privileges, unless that file is
4756 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4757 testing a configuration using &%-C%& right through message reception and
4758 delivery, even if the caller is root. The reception works, but by that time,
4759 Exim is running as the Exim user, so when it re-execs to regain privilege for
4760 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4761 can test reception and delivery using two separate commands (one to put a
4762 message on the queue, using &%-odq%&, and another to do the delivery, using
4763 &%-M%&).
4764
4765 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4766 prefix string with which any file named in a &%-C%& command line option must
4767 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4768 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4769 name can be used with &%-C%&.
4770
4771 One-off changes to a configuration can be specified by the &%-D%& command line
4772 option, which defines and overrides values for macros used inside the
4773 configuration file. However, like &%-C%&, the use of this option by a
4774 non-privileged user causes Exim to discard its root privilege.
4775 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4776 completely disabled, and its use causes an immediate error exit.
4777
4778 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4779 to declare certain macro names trusted, such that root privilege will not
4780 necessarily be discarded.
4781 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4782 considered safe and, if &%-D%& only supplies macros from this list, and the
4783 values are acceptable, then Exim will not give up root privilege if the caller
4784 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4785 transition mechanism and is expected to be removed in the future.  Acceptable
4786 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4787
4788 Some sites may wish to use the same Exim binary on different machines that
4789 share a file system, but to use different configuration files on each machine.
4790 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4791 looks for a file whose name is the configuration file name followed by a dot
4792 and the machine's node name, as obtained from the &[uname()]& function. If this
4793 file does not exist, the standard name is tried. This processing occurs for
4794 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4795
4796 In some esoteric situations different versions of Exim may be run under
4797 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4798 help with this. See the comments in &_src/EDITME_& for details.
4799
4800
4801
4802 .section "Configuration file format" "SECTconffilfor"
4803 .cindex "configuration file" "format of"
4804 .cindex "format" "configuration file"
4805 Exim's configuration file is divided into a number of different parts. General
4806 option settings must always appear at the start of the file. The other parts
4807 are all optional, and may appear in any order. Each part other than the first
4808 is introduced by the word &"begin"& followed by the name of the part. The
4809 optional parts are:
4810
4811 .ilist
4812 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4813 &<<CHAPACL>>&).
4814 .next
4815 .cindex "AUTH" "configuration"
4816 &'authenticators'&: Configuration settings for the authenticator drivers. These
4817 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4818 .next
4819 &'routers'&: Configuration settings for the router drivers. Routers process
4820 addresses and determine how the message is to be delivered (see chapters
4821 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4822 .next
4823 &'transports'&: Configuration settings for the transport drivers. Transports
4824 define mechanisms for copying messages to destinations (see chapters
4825 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4826 .next
4827 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4828 If there is no retry section, or if it is empty (that is, no retry rules are
4829 defined), Exim will not retry deliveries. In this situation, temporary errors
4830 are treated the same as permanent errors. Retry rules are discussed in chapter
4831 &<<CHAPretry>>&.
4832 .next
4833 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4834 when new addresses are generated during delivery. Rewriting is discussed in
4835 chapter &<<CHAPrewrite>>&.
4836 .next
4837 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4838 want to use this feature, you must set
4839 .code
4840 LOCAL_SCAN_HAS_OPTIONS=yes
4841 .endd
4842 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4843 facility are given in chapter &<<CHAPlocalscan>>&.
4844 .endlist
4845
4846 .cindex "configuration file" "leading white space in"
4847 .cindex "configuration file" "trailing white space in"
4848 .cindex "white space" "in configuration file"
4849 Leading and trailing white space in configuration lines is always ignored.
4850
4851 Blank lines in the file, and lines starting with a # character (ignoring
4852 leading white space) are treated as comments and are ignored. &*Note*&: A
4853 # character other than at the beginning of a line is not treated specially,
4854 and does not introduce a comment.
4855
4856 Any non-comment line can be continued by ending it with a backslash. Note that
4857 the general rule for white space means that trailing white space after the
4858 backslash and leading white space at the start of continuation
4859 lines is ignored. Comment lines beginning with # (but not empty lines) may
4860 appear in the middle of a sequence of continuation lines.
4861
4862 A convenient way to create a configuration file is to start from the
4863 default, which is supplied in &_src/configure.default_&, and add, delete, or
4864 change settings as required.
4865
4866 The ACLs, retry rules, and rewriting rules have their own syntax which is
4867 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4868 respectively. The other parts of the configuration file have some syntactic
4869 items in common, and these are described below, from section &<<SECTcos>>&
4870 onwards. Before that, the inclusion, macro, and conditional facilities are
4871 described.
4872
4873
4874
4875 .section "File inclusions in the configuration file" "SECID41"
4876 .cindex "inclusions in configuration file"
4877 .cindex "configuration file" "including other files"
4878 .cindex "&`.include`& in configuration file"
4879 .cindex "&`.include_if_exists`& in configuration file"
4880 You can include other files inside Exim's run time configuration file by
4881 using this syntax:
4882 .display
4883 &`.include`& <&'file name'&>
4884 &`.include_if_exists`& <&'file name'&>
4885 .endd
4886 on a line by itself. Double quotes round the file name are optional. If you use
4887 the first form, a configuration error occurs if the file does not exist; the
4888 second form does nothing for non-existent files. In all cases, an absolute file
4889 name is required.
4890
4891 Includes may be nested to any depth, but remember that Exim reads its
4892 configuration file often, so it is a good idea to keep them to a minimum.
4893 If you change the contents of an included file, you must HUP the daemon,
4894 because an included file is read only when the configuration itself is read.
4895
4896 The processing of inclusions happens early, at a physical line level, so, like
4897 comment lines, an inclusion can be used in the middle of an option setting,
4898 for example:
4899 .code
4900 hosts_lookup = a.b.c \
4901                .include /some/file
4902 .endd
4903 Include processing happens after macro processing (see below). Its effect is to
4904 process the lines of the included file as if they occurred inline where the
4905 inclusion appears.
4906
4907
4908
4909 .section "Macros in the configuration file" "SECTmacrodefs"
4910 .cindex "macro" "description of"
4911 .cindex "configuration file" "macros"
4912 If a line in the main part of the configuration (that is, before the first
4913 &"begin"& line) begins with an upper case letter, it is taken as a macro
4914 definition, and must be of the form
4915 .display
4916 <&'name'&> = <&'rest of line'&>
4917 .endd
4918 The name must consist of letters, digits, and underscores, and need not all be
4919 in upper case, though that is recommended. The rest of the line, including any
4920 continuations, is the replacement text, and has leading and trailing white
4921 space removed. Quotes are not removed. The replacement text can never end with
4922 a backslash character, but this doesn't seem to be a serious limitation.
4923
4924 Macros may also be defined between router, transport, authenticator, or ACL
4925 definitions. They may not, however, be defined within an individual driver or
4926 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4927
4928 .section "Macro substitution" "SECID42"
4929 Once a macro is defined, all subsequent lines in the file (and any included
4930 files) are scanned for the macro name; if there are several macros, the line is
4931 scanned for each in turn, in the order in which the macros are defined. The
4932 replacement text is not re-scanned for the current macro, though it is scanned
4933 for subsequently defined macros. For this reason, a macro name may not contain
4934 the name of a previously defined macro as a substring. You could, for example,
4935 define
4936 .display
4937 &`ABCD_XYZ = `&<&'something'&>
4938 &`ABCD = `&<&'something else'&>
4939 .endd
4940 but putting the definitions in the opposite order would provoke a configuration
4941 error. Macro expansion is applied to individual physical lines from the file,
4942 before checking for line continuation or file inclusion (see above). If a line
4943 consists solely of a macro name, and the expansion of the macro is empty, the
4944 line is ignored. A macro at the start of a line may turn the line into a
4945 comment line or a &`.include`& line.
4946
4947
4948 .section "Redefining macros" "SECID43"
4949 Once defined, the value of a macro can be redefined later in the configuration
4950 (or in an included file). Redefinition is specified by using &'=='& instead of
4951 &'='&. For example:
4952 .code
4953 MAC =  initial value
4954 ...
4955 MAC == updated value
4956 .endd
4957 Redefinition does not alter the order in which the macros are applied to the
4958 subsequent lines of the configuration file. It is still the same order in which
4959 the macros were originally defined. All that changes is the macro's value.
4960 Redefinition makes it possible to accumulate values. For example:
4961 .code
4962 MAC =  initial value
4963 ...
4964 MAC == MAC and something added
4965 .endd
4966 This can be helpful in situations where the configuration file is built
4967 from a number of other files.
4968
4969 .section "Overriding macro values" "SECID44"
4970 The values set for macros in the configuration file can be overridden by the
4971 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4972 used, unless called by root or the Exim user. A definition on the command line
4973 using the &%-D%& option causes all definitions and redefinitions within the
4974 file to be ignored.
4975
4976
4977
4978 .section "Example of macro usage" "SECID45"
4979 As an example of macro usage, consider a configuration where aliases are looked
4980 up in a MySQL database. It helps to keep the file less cluttered if long
4981 strings such as SQL statements are defined separately as macros, for example:
4982 .code
4983 ALIAS_QUERY = select mailbox from user where \
4984               login='${quote_mysql:$local_part}';
4985 .endd
4986 This can then be used in a &(redirect)& router setting like this:
4987 .code
4988 data = ${lookup mysql{ALIAS_QUERY}}
4989 .endd
4990 In earlier versions of Exim macros were sometimes used for domain, host, or
4991 address lists. In Exim 4 these are handled better by named lists &-- see
4992 section &<<SECTnamedlists>>&.
4993
4994
4995 .section "Conditional skips in the configuration file" "SECID46"
4996 .cindex "configuration file" "conditional skips"
4997 .cindex "&`.ifdef`&"
4998 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4999 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5000 portions of the configuration file. The processing happens whenever the file is
5001 read (that is, when an Exim binary starts to run).
5002
5003 The implementation is very simple. Instances of the first four directives must
5004 be followed by text that includes the names of one or macros. The condition
5005 that is tested is whether or not any macro substitution has taken place in the
5006 line. Thus:
5007 .code
5008 .ifdef AAA
5009 message_size_limit = 50M
5010 .else
5011 message_size_limit = 100M
5012 .endif
5013 .endd
5014 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5015 otherwise. If there is more than one macro named on the line, the condition
5016 is true if any of them are defined. That is, it is an &"or"& condition. To
5017 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5018
5019 Although you can use a macro expansion to generate one of these directives,
5020 it is not very useful, because the condition &"there was a macro substitution
5021 in this line"& will always be true.
5022
5023 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5024 to clarify complicated nestings.
5025
5026
5027
5028 .section "Common option syntax" "SECTcos"
5029 .cindex "common option syntax"
5030 .cindex "syntax of common options"
5031 .cindex "configuration file" "common option syntax"
5032 For the main set of options, driver options, and &[local_scan()]& options,
5033 each setting is on a line by itself, and starts with a name consisting of
5034 lower-case letters and underscores. Many options require a data value, and in
5035 these cases the name must be followed by an equals sign (with optional white
5036 space) and then the value. For example:
5037 .code
5038 qualify_domain = mydomain.example.com
5039 .endd
5040 .cindex "hiding configuration option values"
5041 .cindex "configuration options" "hiding value of"
5042 .cindex "options" "hiding value of"
5043 Some option settings may contain sensitive data, for example, passwords for
5044 accessing databases. To stop non-admin users from using the &%-bP%& command
5045 line option to read these values, you can precede the option settings with the
5046 word &"hide"&. For example:
5047 .code
5048 hide mysql_servers = localhost/users/admin/secret-password
5049 .endd
5050 For non-admin users, such options are displayed like this:
5051 .code
5052 mysql_servers = <value not displayable>
5053 .endd
5054 If &"hide"& is used on a driver option, it hides the value of that option on
5055 all instances of the same driver.
5056
5057 The following sections describe the syntax used for the different data types
5058 that are found in option settings.
5059
5060
5061 .section "Boolean options" "SECID47"
5062 .cindex "format" "boolean"
5063 .cindex "boolean configuration values"
5064 .oindex "&%no_%&&'xxx'&"
5065 .oindex "&%not_%&&'xxx'&"
5066 Options whose type is given as boolean are on/off switches. There are two
5067 different ways of specifying such options: with and without a data value. If
5068 the option name is specified on its own without data, the switch is turned on;
5069 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5070 boolean options may be followed by an equals sign and one of the words
5071 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5072 the following two settings have exactly the same effect:
5073 .code
5074 queue_only
5075 queue_only = true
5076 .endd
5077 The following two lines also have the same (opposite) effect:
5078 .code
5079 no_queue_only
5080 queue_only = false
5081 .endd
5082 You can use whichever syntax you prefer.
5083
5084
5085
5086
5087 .section "Integer values" "SECID48"
5088 .cindex "integer configuration values"
5089 .cindex "format" "integer"
5090 If an option's type is given as &"integer"&, the value can be given in decimal,
5091 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5092 number is assumed. Otherwise, it is treated as an octal number unless it starts
5093 with the characters &"0x"&, in which case the remainder is interpreted as a
5094 hexadecimal number.
5095
5096 If an integer value is followed by the letter K, it is multiplied by 1024; if
5097 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5098 of integer option settings are output, values which are an exact multiple of
5099 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5100 and M. The printing style is independent of the actual input format that was
5101 used.
5102
5103
5104 .section "Octal integer values" "SECID49"
5105 .cindex "integer format"
5106 .cindex "format" "octal integer"
5107 If an option's type is given as &"octal integer"&, its value is always
5108 interpreted as an octal number, whether or not it starts with the digit zero.
5109 Such options are always output in octal.
5110
5111
5112 .section "Fixed point numbers" "SECID50"
5113 .cindex "fixed point configuration values"
5114 .cindex "format" "fixed point"
5115 If an option's type is given as &"fixed-point"&, its value must be a decimal
5116 integer, optionally followed by a decimal point and up to three further digits.
5117
5118
5119
5120 .section "Time intervals" "SECTtimeformat"
5121 .cindex "time interval" "specifying in configuration"
5122 .cindex "format" "time interval"
5123 A time interval is specified as a sequence of numbers, each followed by one of
5124 the following letters, with no intervening white space:
5125
5126 .table2 30pt
5127 .irow &%s%& seconds
5128 .irow &%m%& minutes
5129 .irow &%h%& hours
5130 .irow &%d%& days
5131 .irow &%w%& weeks
5132 .endtable
5133
5134 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5135 intervals are output in the same format. Exim does not restrict the values; it
5136 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5137
5138
5139
5140 .section "String values" "SECTstrings"
5141 .cindex "string" "format of configuration values"
5142 .cindex "format" "string"
5143 If an option's type is specified as &"string"&, the value can be specified with
5144 or without double-quotes. If it does not start with a double-quote, the value
5145 consists of the remainder of the line plus any continuation lines, starting at
5146 the first character after any leading white space, with trailing white space
5147 removed, and with no interpretation of the characters in the string. Because
5148 Exim removes comment lines (those beginning with #) at an early stage, they can
5149 appear in the middle of a multi-line string. The following two settings are
5150 therefore equivalent:
5151 .code
5152 trusted_users = uucp:mail
5153 trusted_users = uucp:\
5154                 # This comment line is ignored
5155                 mail
5156 .endd
5157 .cindex "string" "quoted"
5158 .cindex "escape characters in quoted strings"
5159 If a string does start with a double-quote, it must end with a closing
5160 double-quote, and any backslash characters other than those used for line
5161 continuation are interpreted as escape characters, as follows:
5162
5163 .table2 100pt
5164 .irow &`\\`&                     "single backslash"
5165 .irow &`\n`&                     "newline"
5166 .irow &`\r`&                     "carriage return"
5167 .irow &`\t`&                     "tab"
5168 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5169 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5170                                    character"
5171 .endtable
5172
5173 If a backslash is followed by some other character, including a double-quote
5174 character, that character replaces the pair.
5175
5176 Quoting is necessary only if you want to make use of the backslash escapes to
5177 insert special characters, or if you need to specify a value with leading or
5178 trailing spaces. These cases are rare, so quoting is almost never needed in
5179 current versions of Exim. In versions of Exim before 3.14, quoting was required
5180 in order to continue lines, so you may come across older configuration files
5181 and examples that apparently quote unnecessarily.
5182
5183
5184 .section "Expanded strings" "SECID51"
5185 .cindex "expansion" "definition of"
5186 Some strings in the configuration file are subjected to &'string expansion'&,
5187 by which means various parts of the string may be changed according to the
5188 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5189 is as just described; in particular, the handling of backslashes in quoted
5190 strings is done as part of the input process, before expansion takes place.
5191 However, backslash is also an escape character for the expander, so any
5192 backslashes that are required for that reason must be doubled if they are
5193 within a quoted configuration string.
5194
5195
5196 .section "User and group names" "SECID52"
5197 .cindex "user name" "format of"
5198 .cindex "format" "user name"
5199 .cindex "groups" "name format"
5200 .cindex "format" "group name"
5201 User and group names are specified as strings, using the syntax described
5202 above, but the strings are interpreted specially. A user or group name must
5203 either consist entirely of digits, or be a name that can be looked up using the
5204 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5205
5206
5207 .section "List construction" "SECTlistconstruct"
5208 .cindex "list" "syntax of in configuration"
5209 .cindex "format" "list item in configuration"
5210 .cindex "string" "list, definition of"
5211 The data for some configuration options is a list of items, with colon as the
5212 default separator. Many of these options are shown with type &"string list"& in
5213 the descriptions later in this document. Others are listed as &"domain list"&,
5214 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5215 are all the same; however, those other than &"string list"& are subject to
5216 particular kinds of interpretation, as described in chapter
5217 &<<CHAPdomhosaddlists>>&.
5218
5219 In all these cases, the entire list is treated as a single string as far as the
5220 input syntax is concerned. The &%trusted_users%& setting in section
5221 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5222 in a list, it must be entered as two colons. Leading and trailing white space
5223 on each item in a list is ignored. This makes it possible to include items that
5224 start with a colon, and in particular, certain forms of IPv6 address. For
5225 example, the list
5226 .code
5227 local_interfaces = 127.0.0.1 : ::::1
5228 .endd
5229 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5230
5231 &*Note*&: Although leading and trailing white space is ignored in individual
5232 list items, it is not ignored when parsing the list. The space after the first
5233 colon in the example above is necessary. If it were not there, the list would
5234 be interpreted as the two items 127.0.0.1:: and 1.
5235
5236 .section "Changing list separators" "SECID53"
5237 .cindex "list separator" "changing"
5238 .cindex "IPv6" "addresses in lists"
5239 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5240 introduced to allow the separator character to be changed. If a list begins
5241 with a left angle bracket, followed by any punctuation character, that
5242 character is used instead of colon as the list separator. For example, the list
5243 above can be rewritten to use a semicolon separator like this:
5244 .code
5245 local_interfaces = <; 127.0.0.1 ; ::1
5246 .endd
5247 This facility applies to all lists, with the exception of the list in
5248 &%log_file_path%&. It is recommended that the use of non-colon separators be
5249 confined to circumstances where they really are needed.
5250
5251 .cindex "list separator" "newline as"
5252 .cindex "newline" "as list separator"
5253 It is also possible to use newline and other control characters (those with
5254 code values less than 32, plus DEL) as separators in lists. Such separators
5255 must be provided literally at the time the list is processed. For options that
5256 are string-expanded, you can write the separator using a normal escape
5257 sequence. This will be processed by the expander before the string is
5258 interpreted as a list. For example, if a newline-separated list of domains is
5259 generated by a lookup, you can process it directly by a line such as this:
5260 .code
5261 domains = <\n ${lookup mysql{.....}}
5262 .endd
5263 This avoids having to change the list separator in such data. You are unlikely
5264 to want to use a control character as a separator in an option that is not
5265 expanded, because the value is literal text. However, it can be done by giving
5266 the value in quotes. For example:
5267 .code
5268 local_interfaces = "<\n 127.0.0.1 \n ::1"
5269 .endd
5270 Unlike printing character separators, which can be included in list items by
5271 doubling, it is not possible to include a control character as data when it is
5272 set as the separator. Two such characters in succession are interpreted as
5273 enclosing an empty list item.
5274
5275
5276
5277 .section "Empty items in lists" "SECTempitelis"
5278 .cindex "list" "empty item in"
5279 An empty item at the end of a list is always ignored. In other words, trailing
5280 separator characters are ignored. Thus, the list in
5281 .code
5282 senders = user@domain :
5283 .endd
5284 contains only a single item. If you want to include an empty string as one item
5285 in a list, it must not be the last item. For example, this list contains three
5286 items, the second of which is empty:
5287 .code
5288 senders = user1@domain : : user2@domain
5289 .endd
5290 &*Note*&: There must be white space between the two colons, as otherwise they
5291 are interpreted as representing a single colon data character (and the list
5292 would then contain just one item). If you want to specify a list that contains
5293 just one, empty item, you can do it as in this example:
5294 .code
5295 senders = :
5296 .endd
5297 In this case, the first item is empty, and the second is discarded because it
5298 is at the end of the list.
5299
5300
5301
5302
5303 .section "Format of driver configurations" "SECTfordricon"
5304 .cindex "drivers" "configuration format"
5305 There are separate parts in the configuration for defining routers, transports,
5306 and authenticators. In each part, you are defining a number of driver
5307 instances, each with its own set of options. Each driver instance is defined by
5308 a sequence of lines like this:
5309 .display
5310 <&'instance name'&>:
5311   <&'option'&>
5312   ...
5313   <&'option'&>
5314 .endd
5315 In the following example, the instance name is &(localuser)&, and it is
5316 followed by three options settings:
5317 .code
5318 localuser:
5319   driver = accept
5320   check_local_user
5321   transport = local_delivery
5322 .endd
5323 For each driver instance, you specify which Exim code module it uses &-- by the
5324 setting of the &%driver%& option &-- and (optionally) some configuration
5325 settings. For example, in the case of transports, if you want a transport to
5326 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5327 a local file you would use the &(appendfile)& driver. Each of the drivers is
5328 described in detail in its own separate chapter later in this manual.
5329
5330 You can have several routers, transports, or authenticators that are based on
5331 the same underlying driver (each must have a different instance name).
5332
5333 The order in which routers are defined is important, because addresses are
5334 passed to individual routers one by one, in order. The order in which
5335 transports are defined does not matter at all. The order in which
5336 authenticators are defined is used only when Exim, as a client, is searching
5337 them to find one that matches an authentication mechanism offered by the
5338 server.
5339
5340 .cindex "generic options"
5341 .cindex "options" "generic &-- definition of"
5342 Within a driver instance definition, there are two kinds of option: &'generic'&
5343 and &'private'&. The generic options are those that apply to all drivers of the
5344 same type (that is, all routers, all transports or all authenticators). The
5345 &%driver%& option is a generic option that must appear in every definition.
5346 .cindex "private options"
5347 The private options are special for each driver, and none need appear, because
5348 they all have default values.
5349
5350 The options may appear in any order, except that the &%driver%& option must
5351 precede any private options, since these depend on the particular driver. For
5352 this reason, it is recommended that &%driver%& always be the first option.
5353
5354 Driver instance names, which are used for reference in log entries and
5355 elsewhere, can be any sequence of letters, digits, and underscores (starting
5356 with a letter) and must be unique among drivers of the same type. A router and
5357 a transport (for example) can each have the same name, but no two router
5358 instances can have the same name. The name of a driver instance should not be
5359 confused with the name of the underlying driver module. For example, the
5360 configuration lines:
5361 .code
5362 remote_smtp:
5363   driver = smtp
5364 .endd
5365 create an instance of the &(smtp)& transport driver whose name is
5366 &(remote_smtp)&. The same driver code can be used more than once, with
5367 different instance names and different option settings each time. A second
5368 instance of the &(smtp)& transport, with different options, might be defined
5369 thus:
5370 .code
5371 special_smtp:
5372   driver = smtp
5373   port = 1234
5374   command_timeout = 10s
5375 .endd
5376 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5377 these transport instances from routers, and these names would appear in log
5378 lines.
5379
5380 Comment lines may be present in the middle of driver specifications. The full
5381 list of option settings for any particular driver instance, including all the
5382 defaulted values, can be extracted by making use of the &%-bP%& command line
5383 option.
5384
5385
5386
5387
5388
5389
5390 . ////////////////////////////////////////////////////////////////////////////
5391 . ////////////////////////////////////////////////////////////////////////////
5392
5393 .chapter "The default configuration file" "CHAPdefconfil"
5394 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5395 .cindex "default" "configuration file &""walk through""&"
5396 The default configuration file supplied with Exim as &_src/configure.default_&
5397 is sufficient for a host with simple mail requirements. As an introduction to
5398 the way Exim is configured, this chapter &"walks through"& the default
5399 configuration, giving brief explanations of the settings. Detailed descriptions
5400 of the options are given in subsequent chapters. The default configuration file
5401 itself contains extensive comments about ways you might want to modify the
5402 initial settings. However, note that there are many options that are not
5403 mentioned at all in the default configuration.
5404
5405
5406
5407 .section "Main configuration settings" "SECTdefconfmain"
5408 The main (global) configuration option settings must always come first in the
5409 file. The first thing you'll see in the file, after some initial comments, is
5410 the line
5411 .code
5412 # primary_hostname =
5413 .endd
5414 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5415 to know the official, fully qualified name of your host, and this is where you
5416 can specify it. However, in most cases you do not need to set this option. When
5417 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5418
5419 The first three non-comment configuration lines are as follows:
5420 .code
5421 domainlist local_domains    = @
5422 domainlist relay_to_domains =
5423 hostlist   relay_from_hosts = 127.0.0.1
5424 .endd
5425 These are not, in fact, option settings. They are definitions of two named
5426 domain lists and one named host list. Exim allows you to give names to lists of
5427 domains, hosts, and email addresses, in order to make it easier to manage the
5428 configuration file (see section &<<SECTnamedlists>>&).
5429
5430 The first line defines a domain list called &'local_domains'&; this is used
5431 later in the configuration to identify domains that are to be delivered
5432 on the local host.
5433
5434 .cindex "@ in a domain list"
5435 There is just one item in this list, the string &"@"&. This is a special form
5436 of entry which means &"the name of the local host"&. Thus, if the local host is
5437 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5438 be delivered locally. Because the local host's name is referenced indirectly,
5439 the same configuration file can be used on different hosts.
5440
5441 The second line defines a domain list called &'relay_to_domains'&, but the
5442 list itself is empty. Later in the configuration we will come to the part that
5443 controls mail relaying through the local host; it allows relaying to any
5444 domains in this list. By default, therefore, no relaying on the basis of a mail
5445 domain is permitted.
5446
5447 The third line defines a host list called &'relay_from_hosts'&. This list is
5448 used later in the configuration to permit relaying from any host or IP address
5449 that matches the list. The default contains just the IP address of the IPv4
5450 loopback interface, which means that processes on the local host are able to
5451 submit mail for relaying by sending it over TCP/IP to that interface. No other
5452 hosts are permitted to submit messages for relaying.
5453
5454 Just to be sure there's no misunderstanding: at this point in the configuration
5455 we aren't actually setting up any controls. We are just defining some domains
5456 and hosts that will be used in the controls that are specified later.
5457
5458 The next two configuration lines are genuine option settings:
5459 .code
5460 acl_smtp_rcpt = acl_check_rcpt
5461 acl_smtp_data = acl_check_data
5462 .endd
5463 These options specify &'Access Control Lists'& (ACLs) that are to be used
5464 during an incoming SMTP session for every recipient of a message (every RCPT
5465 command), and after the contents of the message have been received,
5466 respectively. The names of the lists are &'acl_check_rcpt'& and
5467 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5468 section of the configuration. The RCPT ACL controls which recipients are
5469 accepted for an incoming message &-- if a configuration does not provide an ACL
5470 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5471 contents of a message to be checked.
5472
5473 Two commented-out option settings are next:
5474 .code
5475 # av_scanner = clamd:/tmp/clamd
5476 # spamd_address = 127.0.0.1 783
5477 .endd
5478 These are example settings that can be used when Exim is compiled with the
5479 content-scanning extension. The first specifies the interface to the virus
5480 scanner, and the second specifies the interface to SpamAssassin. Further
5481 details are given in chapter &<<CHAPexiscan>>&.
5482
5483 Three more commented-out option settings follow:
5484 .code
5485 # tls_advertise_hosts = *
5486 # tls_certificate = /etc/ssl/exim.crt
5487 # tls_privatekey = /etc/ssl/exim.pem
5488 .endd
5489 These are example settings that can be used when Exim is compiled with
5490 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5491 first one specifies the list of clients that are allowed to use TLS when
5492 connecting to this server; in this case the wildcard means all clients. The
5493 other options specify where Exim should find its TLS certificate and private
5494 key, which together prove the server's identity to any clients that connect.
5495 More details are given in chapter &<<CHAPTLS>>&.
5496
5497 Another two commented-out option settings follow:
5498 .code
5499 # daemon_smtp_ports = 25 : 465 : 587
5500 # tls_on_connect_ports = 465
5501 .endd
5502 .cindex "port" "465 and 587"
5503 .cindex "port" "for message submission"
5504 .cindex "message" "submission, ports for"
5505 .cindex "ssmtp protocol"
5506 .cindex "smtps protocol"
5507 .cindex "SMTP" "ssmtp protocol"
5508 .cindex "SMTP" "smtps protocol"
5509 These options provide better support for roaming users who wish to use this
5510 server for message submission. They are not much use unless you have turned on
5511 TLS (as described in the previous paragraph) and authentication (about which
5512 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5513 on end-user networks, so RFC 4409 specifies that message submission should use
5514 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5515 configured to use port 587 correctly, so these settings also enable the
5516 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5517 &<<SECTsupobssmt>>&).
5518
5519 Two more commented-out options settings follow:
5520 .code
5521 # qualify_domain =
5522 # qualify_recipient =
5523 .endd
5524 The first of these specifies a domain that Exim uses when it constructs a
5525 complete email address from a local login name. This is often needed when Exim
5526 receives a message from a local process. If you do not set &%qualify_domain%&,
5527 the value of &%primary_hostname%& is used. If you set both of these options,
5528 you can have different qualification domains for sender and recipient
5529 addresses. If you set only the first one, its value is used in both cases.
5530
5531 .cindex "domain literal" "recognizing format"
5532 The following line must be uncommented if you want Exim to recognize
5533 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5534 (an IP address within square brackets) instead of a named domain.
5535 .code
5536 # allow_domain_literals
5537 .endd
5538 The RFCs still require this form, but many people think that in the modern
5539 Internet it makes little sense to permit mail to be sent to specific hosts by
5540 quoting their IP addresses. This ancient format has been used by people who
5541 try to abuse hosts by using them for unwanted relaying. However, some
5542 people believe there are circumstances (for example, messages addressed to
5543 &'postmaster'&) where domain literals are still useful.
5544
5545 The next configuration line is a kind of trigger guard:
5546 .code
5547 never_users = root
5548 .endd
5549 It specifies that no delivery must ever be run as the root user. The normal
5550 convention is to set up &'root'& as an alias for the system administrator. This
5551 setting is a guard against slips in the configuration.
5552 The list of users specified by &%never_users%& is not, however, the complete
5553 list; the build-time configuration in &_Local/Makefile_& has an option called
5554 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5555 contents of &%never_users%& are added to this list. By default
5556 FIXED_NEVER_USERS also specifies root.
5557
5558 When a remote host connects to Exim in order to send mail, the only information
5559 Exim has about the host's identity is its IP address. The next configuration
5560 line,
5561 .code
5562 host_lookup = *
5563 .endd
5564 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5565 in order to get a host name. This improves the quality of the logging
5566 information, but if you feel it is too expensive, you can remove it entirely,
5567 or restrict the lookup to hosts on &"nearby"& networks.
5568 Note that it is not always possible to find a host name from an IP address,
5569 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5570 unreachable.
5571
5572 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5573 1413 (hence their names):
5574 .code
5575 rfc1413_hosts = *
5576 rfc1413_query_timeout = 0s
5577 .endd
5578 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5579 Few hosts offer RFC1413 service these days; calls have to be
5580 terminated by a timeout and this needlessly delays the startup
5581 of an incoming SMTP connection.
5582 If you have hosts for which you trust RFC1413 and need this
5583 information, you can change this.
5584
5585 This line enables an efficiency SMTP option.  It is negotiated by clients
5586 and not expected to cause problems but can be disabled if needed.
5587 .code
5588 prdr_enable = true
5589 .endd
5590
5591 When Exim receives messages over SMTP connections, it expects all addresses to
5592 be fully qualified with a domain, as required by the SMTP definition. However,
5593 if you are running a server to which simple clients submit messages, you may
5594 find that they send unqualified addresses. The two commented-out options:
5595 .code
5596 # sender_unqualified_hosts =
5597 # recipient_unqualified_hosts =
5598 .endd
5599 show how you can specify hosts that are permitted to send unqualified sender
5600 and recipient addresses, respectively.
5601
5602 The &%percent_hack_domains%& option is also commented out:
5603 .code
5604 # percent_hack_domains =
5605 .endd
5606 It provides a list of domains for which the &"percent hack"& is to operate.
5607 This is an almost obsolete form of explicit email routing. If you do not know
5608 anything about it, you can safely ignore this topic.
5609
5610 The last two settings in the main part of the default configuration are
5611 concerned with messages that have been &"frozen"& on Exim's queue. When a
5612 message is frozen, Exim no longer continues to try to deliver it. Freezing
5613 occurs when a bounce message encounters a permanent failure because the sender
5614 address of the original message that caused the bounce is invalid, so the
5615 bounce cannot be delivered. This is probably the most common case, but there
5616 are also other conditions that cause freezing, and frozen messages are not
5617 always bounce messages.
5618 .code
5619 ignore_bounce_errors_after = 2d
5620 timeout_frozen_after = 7d
5621 .endd
5622 The first of these options specifies that failing bounce messages are to be
5623 discarded after 2 days on the queue. The second specifies that any frozen
5624 message (whether a bounce message or not) is to be timed out (and discarded)
5625 after a week. In this configuration, the first setting ensures that no failing
5626 bounce message ever lasts a week.
5627
5628
5629
5630 .section "ACL configuration" "SECID54"
5631 .cindex "default" "ACLs"
5632 .cindex "&ACL;" "default configuration"
5633 In the default configuration, the ACL section follows the main configuration.
5634 It starts with the line
5635 .code
5636 begin acl
5637 .endd
5638 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5639 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5640 and &%acl_smtp_data%& above.
5641
5642 .cindex "RCPT" "ACL for"
5643 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5644 RCPT command specifies one of the message's recipients. The ACL statements
5645 are considered in order, until the recipient address is either accepted or
5646 rejected. The RCPT command is then accepted or rejected, according to the
5647 result of the ACL processing.
5648 .code
5649 acl_check_rcpt:
5650 .endd
5651 This line, consisting of a name terminated by a colon, marks the start of the
5652 ACL, and names it.
5653 .code
5654 accept  hosts = :
5655 .endd
5656 This ACL statement accepts the recipient if the sending host matches the list.
5657 But what does that strange list mean? It doesn't actually contain any host
5658 names or IP addresses. The presence of the colon puts an empty item in the
5659 list; Exim matches this only if the incoming message did not come from a remote
5660 host, because in that case, the remote hostname is empty. The colon is
5661 important. Without it, the list itself is empty, and can never match anything.
5662
5663 What this statement is doing is to accept unconditionally all recipients in
5664 messages that are submitted by SMTP from local processes using the standard
5665 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5666 manner.
5667 .code
5668 deny    message       = Restricted characters in address
5669         domains       = +local_domains
5670         local_parts   = ^[.] : ^.*[@%!/|]
5671
5672 deny    message       = Restricted characters in address
5673         domains       = !+local_domains
5674         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5675 .endd
5676 These statements are concerned with local parts that contain any of the
5677 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5678 Although these characters are entirely legal in local parts (in the case of
5679 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5680 in Internet mail addresses.
5681
5682 The first three have in the past been associated with explicitly routed
5683 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5684 option). Addresses containing these characters are regularly tried by spammers
5685 in an attempt to bypass relaying restrictions, and also by open relay testing
5686 programs. Unless you really need them it is safest to reject these characters
5687 at this early stage. This configuration is heavy-handed in rejecting these
5688 characters for all messages it accepts from remote hosts. This is a deliberate
5689 policy of being as safe as possible.
5690
5691 The first rule above is stricter, and is applied to messages that are addressed
5692 to one of the local domains handled by this host. This is implemented by the
5693 first condition, which restricts it to domains that are listed in the
5694 &'local_domains'& domain list. The &"+"& character is used to indicate a
5695 reference to a named list. In this configuration, there is just one domain in
5696 &'local_domains'&, but in general there may be many.
5697
5698 The second condition on the first statement uses two regular expressions to
5699 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5700 or &"|"&. If you have local accounts that include these characters, you will
5701 have to modify this rule.
5702
5703 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5704 allows them because they have been encountered in practice. (Consider the
5705 common convention of local parts constructed as
5706 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5707 the author of Exim, who has no second initial.) However, a local part starting
5708 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5709 file name (for example, for a mailing list). This is also true for local parts
5710 that contain slashes. A pipe symbol can also be troublesome if the local part
5711 is incorporated unthinkingly into a shell command line.
5712
5713 The second rule above applies to all other domains, and is less strict. This
5714 allows your own users to send outgoing messages to sites that use slashes
5715 and vertical bars in their local parts. It blocks local parts that begin
5716 with a dot, slash, or vertical bar, but allows these characters within the
5717 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5718 and &"!"& is blocked, as before. The motivation here is to prevent your users
5719 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5720 .code
5721 accept  local_parts   = postmaster
5722         domains       = +local_domains
5723 .endd
5724 This statement, which has two conditions, accepts an incoming address if the
5725 local part is &'postmaster'& and the domain is one of those listed in the
5726 &'local_domains'& domain list. The &"+"& character is used to indicate a
5727 reference to a named list. In this configuration, there is just one domain in
5728 &'local_domains'&, but in general there may be many.
5729
5730 The presence of this statement means that mail to postmaster is never blocked
5731 by any of the subsequent tests. This can be helpful while sorting out problems
5732 in cases where the subsequent tests are incorrectly denying access.
5733 .code
5734 require verify        = sender
5735 .endd
5736 This statement requires the sender address to be verified before any subsequent
5737 ACL statement can be used. If verification fails, the incoming recipient
5738 address is refused. Verification consists of trying to route the address, to
5739 see if a bounce message could be delivered to it. In the case of remote
5740 addresses, basic verification checks only the domain, but &'callouts'& can be
5741 used for more verification if required. Section &<<SECTaddressverification>>&
5742 discusses the details of address verification.
5743 .code
5744 accept  hosts         = +relay_from_hosts
5745         control       = submission
5746 .endd
5747 This statement accepts the address if the message is coming from one of the
5748 hosts that are defined as being allowed to relay through this host. Recipient
5749 verification is omitted here, because in many cases the clients are dumb MUAs
5750 that do not cope well with SMTP error responses. For the same reason, the
5751 second line specifies &"submission mode"& for messages that are accepted. This
5752 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5753 messages that are deficient in some way, for example, because they lack a
5754 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5755 probably add recipient verification here, and disable submission mode.
5756 .code
5757 accept  authenticated = *
5758         control       = submission
5759 .endd
5760 This statement accepts the address if the client host has authenticated itself.
5761 Submission mode is again specified, on the grounds that such messages are most
5762 likely to come from MUAs. The default configuration does not define any
5763 authenticators, though it does include some nearly complete commented-out
5764 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5765 fact authenticate until you complete the authenticator definitions.
5766 .code
5767 require message = relay not permitted
5768         domains = +local_domains : +relay_to_domains
5769 .endd
5770 This statement rejects the address if its domain is neither a local domain nor
5771 one of the domains for which this host is a relay.
5772 .code
5773 require verify = recipient
5774 .endd
5775 This statement requires the recipient address to be verified; if verification
5776 fails, the address is rejected.
5777 .code
5778 # deny    message     = rejected because $sender_host_address \
5779 #                       is in a black list at $dnslist_domain\n\
5780 #                       $dnslist_text
5781 #         dnslists    = black.list.example
5782 #
5783 # warn    dnslists    = black.list.example
5784 #         add_header  = X-Warning: $sender_host_address is in \
5785 #                       a black list at $dnslist_domain
5786 #         log_message = found in $dnslist_domain
5787 .endd
5788 These commented-out lines are examples of how you could configure Exim to check
5789 sending hosts against a DNS black list. The first statement rejects messages
5790 from blacklisted hosts, whereas the second just inserts a warning header
5791 line.
5792 .code
5793 # require verify = csa
5794 .endd
5795 This commented-out line is an example of how you could turn on client SMTP
5796 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5797 records.
5798 .code
5799 accept
5800 .endd
5801 The final statement in the first ACL unconditionally accepts any recipient
5802 address that has successfully passed all the previous tests.
5803 .code
5804 acl_check_data:
5805 .endd
5806 This line marks the start of the second ACL, and names it. Most of the contents
5807 of this ACL are commented out:
5808 .code
5809 # deny    malware   = *
5810 #         message   = This message contains a virus \
5811 #                     ($malware_name).
5812 .endd
5813 These lines are examples of how to arrange for messages to be scanned for
5814 viruses when Exim has been compiled with the content-scanning extension, and a
5815 suitable virus scanner is installed. If the message is found to contain a
5816 virus, it is rejected with the given custom error message.
5817 .code
5818 # warn    spam      = nobody
5819 #         message   = X-Spam_score: $spam_score\n\
5820 #                     X-Spam_score_int: $spam_score_int\n\
5821 #                     X-Spam_bar: $spam_bar\n\
5822 #                     X-Spam_report: $spam_report
5823 .endd
5824 These lines are an example of how to arrange for messages to be scanned by
5825 SpamAssassin when Exim has been compiled with the content-scanning extension,
5826 and SpamAssassin has been installed. The SpamAssassin check is run with
5827 &`nobody`& as its user parameter, and the results are added to the message as a
5828 series of extra header line. In this case, the message is not rejected,
5829 whatever the spam score.
5830 .code
5831 accept
5832 .endd
5833 This final line in the DATA ACL accepts the message unconditionally.
5834
5835
5836 .section "Router configuration" "SECID55"
5837 .cindex "default" "routers"
5838 .cindex "routers" "default"
5839 The router configuration comes next in the default configuration, introduced
5840 by the line
5841 .code
5842 begin routers
5843 .endd
5844 Routers are the modules in Exim that make decisions about where to send
5845 messages. An address is passed to each router in turn, until it is either
5846 accepted, or failed. This means that the order in which you define the routers
5847 matters. Each router is fully described in its own chapter later in this
5848 manual. Here we give only brief overviews.
5849 .code
5850 # domain_literal:
5851 #   driver = ipliteral
5852 #   domains = !+local_domains
5853 #   transport = remote_smtp
5854 .endd
5855 .cindex "domain literal" "default router"
5856 This router is commented out because the majority of sites do not want to
5857 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5858 you uncomment this router, you also need to uncomment the setting of
5859 &%allow_domain_literals%& in the main part of the configuration.
5860 .code
5861 dnslookup:
5862   driver = dnslookup
5863   domains = ! +local_domains
5864   transport = remote_smtp
5865   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5866   no_more
5867 .endd
5868 The first uncommented router handles addresses that do not involve any local
5869 domains. This is specified by the line
5870 .code
5871 domains = ! +local_domains
5872 .endd
5873 The &%domains%& option lists the domains to which this router applies, but the
5874 exclamation mark is a negation sign, so the router is used only for domains
5875 that are not in the domain list called &'local_domains'& (which was defined at
5876 the start of the configuration). The plus sign before &'local_domains'&
5877 indicates that it is referring to a named list. Addresses in other domains are
5878 passed on to the following routers.
5879
5880 The name of the router driver is &(dnslookup)&,
5881 and is specified by the &%driver%& option. Do not be confused by the fact that
5882 the name of this router instance is the same as the name of the driver. The
5883 instance name is arbitrary, but the name set in the &%driver%& option must be
5884 one of the driver modules that is in the Exim binary.
5885
5886 The &(dnslookup)& router routes addresses by looking up their domains in the
5887 DNS in order to obtain a list of hosts to which the address is routed. If the
5888 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5889 specified by the &%transport%& option. If the router does not find the domain
5890 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5891 the address fails and is bounced.
5892
5893 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5894 be entirely ignored. This option is present because a number of cases have been
5895 encountered where MX records in the DNS point to host names
5896 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5897 Completely ignoring these IP addresses causes Exim to fail to route the
5898 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5899 continue to try to deliver the message periodically until the address timed
5900 out.
5901 .code
5902 system_aliases:
5903   driver = redirect
5904   allow_fail
5905   allow_defer
5906   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5907 # user = exim
5908   file_transport = address_file
5909   pipe_transport = address_pipe
5910 .endd
5911 Control reaches this and subsequent routers only for addresses in the local
5912 domains. This router checks to see whether the local part is defined as an
5913 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5914 data that it looks up from that file. If no data is found for the local part,
5915 the value of the &%data%& option is empty, causing the address to be passed to
5916 the next router.
5917
5918 &_/etc/aliases_& is a conventional name for the system aliases file that is
5919 often used. That is why it is referenced by from the default configuration
5920 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5921 &_Local/Makefile_& before building Exim.
5922 .code
5923 userforward:
5924   driver = redirect
5925   check_local_user
5926 # local_part_suffix = +* : -*
5927 # local_part_suffix_optional
5928   file = $home/.forward
5929 # allow_filter
5930   no_verify
5931   no_expn
5932   check_ancestor
5933   file_transport = address_file
5934   pipe_transport = address_pipe
5935   reply_transport = address_reply
5936 .endd
5937 This is the most complicated router in the default configuration. It is another
5938 redirection router, but this time it is looking for forwarding data set up by
5939 individual users. The &%check_local_user%& setting specifies a check that the
5940 local part of the address is the login name of a local user. If it is not, the
5941 router is skipped. The two commented options that follow &%check_local_user%&,
5942 namely:
5943 .code
5944 # local_part_suffix = +* : -*
5945 # local_part_suffix_optional
5946 .endd
5947 .vindex "&$local_part_suffix$&"
5948 show how you can specify the recognition of local part suffixes. If the first
5949 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5950 by any sequence of characters, is removed from the local part and placed in the
5951 variable &$local_part_suffix$&. The second suffix option specifies that the
5952 presence of a suffix in the local part is optional. When a suffix is present,
5953 the check for a local login uses the local part with the suffix removed.
5954
5955 When a local user account is found, the file called &_.forward_& in the user's
5956 home directory is consulted. If it does not exist, or is empty, the router
5957 declines. Otherwise, the contents of &_.forward_& are interpreted as
5958 redirection data (see chapter &<<CHAPredirect>>& for more details).
5959
5960 .cindex "Sieve filter" "enabling in default router"
5961 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5962 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5963 is commented out by default), the contents of the file are interpreted as a set
5964 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5965 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5966 separate document entitled &'Exim's interfaces to mail filtering'&.
5967
5968 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5969 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5970 There are two reasons for doing this:
5971
5972 .olist
5973 Whether or not a local user has a &_.forward_& file is not really relevant when
5974 checking an address for validity; it makes sense not to waste resources doing
5975 unnecessary work.
5976 .next
5977 More importantly, when Exim is verifying addresses or handling an EXPN
5978 command during an SMTP session, it is running as the Exim user, not as root.
5979 The group is the Exim group, and no additional groups are set up.
5980 It may therefore not be possible for Exim to read users' &_.forward_& files at
5981 this time.
5982 .endlist
5983
5984 The setting of &%check_ancestor%& prevents the router from generating a new
5985 address that is the same as any previous address that was redirected. (This
5986 works round a problem concerning a bad interaction between aliasing and
5987 forwarding &-- see section &<<SECTredlocmai>>&).
5988
5989 The final three option settings specify the transports that are to be used when
5990 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5991 auto-reply, respectively. For example, if a &_.forward_& file contains
5992 .code
5993 a.nother@elsewhere.example, /home/spqr/archive
5994 .endd
5995 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5996 transport.
5997 .code
5998 localuser:
5999   driver = accept
6000   check_local_user
6001 # local_part_suffix = +* : -*
6002 # local_part_suffix_optional
6003   transport = local_delivery
6004 .endd
6005 The final router sets up delivery into local mailboxes, provided that the local
6006 part is the name of a local login, by accepting the address and assigning it to
6007 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6008 routers, so the address is bounced. The commented suffix settings fulfil the
6009 same purpose as they do for the &(userforward)& router.
6010
6011
6012 .section "Transport configuration" "SECID56"
6013 .cindex "default" "transports"
6014 .cindex "transports" "default"
6015 Transports define mechanisms for actually delivering messages. They operate
6016 only when referenced from routers, so the order in which they are defined does
6017 not matter. The transports section of the configuration starts with
6018 .code
6019 begin transports
6020 .endd
6021 One remote transport and four local transports are defined.
6022 .code
6023 remote_smtp:
6024   driver = smtp
6025   hosts_try_prdr = *
6026 .endd
6027 This transport is used for delivering messages over SMTP connections.
6028 The list of remote hosts comes from the router.
6029 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6030 It is negotiated between client and server
6031 and not expected to cause problems but can be disabled if needed.
6032 All other options are defaulted.
6033 .code
6034 local_delivery:
6035   driver = appendfile
6036   file = /var/mail/$local_part
6037   delivery_date_add
6038   envelope_to_add
6039   return_path_add
6040 # group = mail
6041 # mode = 0660
6042 .endd
6043 This &(appendfile)& transport is used for local delivery to user mailboxes in
6044 traditional BSD mailbox format. By default it runs under the uid and gid of the
6045 local user, which requires the sticky bit to be set on the &_/var/mail_&
6046 directory. Some systems use the alternative approach of running mail deliveries
6047 under a particular group instead of using the sticky bit. The commented options
6048 show how this can be done.
6049
6050 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6051 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6052 similarly-named options above.
6053 .code
6054 address_pipe:
6055   driver = pipe
6056   return_output
6057 .endd
6058 This transport is used for handling deliveries to pipes that are generated by
6059 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6060 option specifies that any output generated by the pipe is to be returned to the
6061 sender.
6062 .code
6063 address_file:
6064   driver = appendfile
6065   delivery_date_add
6066   envelope_to_add
6067   return_path_add
6068 .endd
6069 This transport is used for handling deliveries to files that are generated by
6070 redirection. The name of the file is not specified in this instance of
6071 &(appendfile)&, because it comes from the &(redirect)& router.
6072 .code
6073 address_reply:
6074   driver = autoreply
6075 .endd
6076 This transport is used for handling automatic replies generated by users'
6077 filter files.
6078
6079
6080
6081 .section "Default retry rule" "SECID57"
6082 .cindex "retry" "default rule"
6083 .cindex "default" "retry rule"
6084 The retry section of the configuration file contains rules which affect the way
6085 Exim retries deliveries that cannot be completed at the first attempt. It is
6086 introduced by the line
6087 .code
6088 begin retry
6089 .endd
6090 In the default configuration, there is just one rule, which applies to all
6091 errors:
6092 .code
6093 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6094 .endd
6095 This causes any temporarily failing address to be retried every 15 minutes for
6096 2 hours, then at intervals starting at one hour and increasing by a factor of
6097 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6098 is not delivered after 4 days of temporary failure, it is bounced.
6099
6100 If the retry section is removed from the configuration, or is empty (that is,
6101 if no retry rules are defined), Exim will not retry deliveries. This turns
6102 temporary errors into permanent errors.
6103
6104
6105 .section "Rewriting configuration" "SECID58"
6106 The rewriting section of the configuration, introduced by
6107 .code
6108 begin rewrite
6109 .endd
6110 contains rules for rewriting addresses in messages as they arrive. There are no
6111 rewriting rules in the default configuration file.
6112
6113
6114
6115 .section "Authenticators configuration" "SECTdefconfauth"
6116 .cindex "AUTH" "configuration"
6117 The authenticators section of the configuration, introduced by
6118 .code
6119 begin authenticators
6120 .endd
6121 defines mechanisms for the use of the SMTP AUTH command. The default
6122 configuration file contains two commented-out example authenticators
6123 which support plaintext username/password authentication using the
6124 standard PLAIN mechanism and the traditional but non-standard LOGIN
6125 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6126 to support most MUA software.
6127
6128 The example PLAIN authenticator looks like this:
6129 .code
6130 #PLAIN:
6131 #  driver                  = plaintext
6132 #  server_set_id           = $auth2
6133 #  server_prompts          = :
6134 #  server_condition        = Authentication is not yet configured
6135 #  server_advertise_condition = ${if def:tls_in_cipher }
6136 .endd
6137 And the example LOGIN authenticator looks like this:
6138 .code
6139 #LOGIN:
6140 #  driver                  = plaintext
6141 #  server_set_id           = $auth1
6142 #  server_prompts          = <| Username: | Password:
6143 #  server_condition        = Authentication is not yet configured
6144 #  server_advertise_condition = ${if def:tls_in_cipher }
6145 .endd
6146
6147 The &%server_set_id%& option makes Exim remember the authenticated username
6148 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6149 &%server_prompts%& option configures the &(plaintext)& authenticator so
6150 that it implements the details of the specific authentication mechanism,
6151 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6152 when Exim offers authentication to clients; in the examples, this is only
6153 when TLS or SSL has been started, so to enable the authenticators you also
6154 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6155
6156 The &%server_condition%& setting defines how to verify that the username and
6157 password are correct. In the examples it just produces an error message.
6158 To make the authenticators work, you can use a string expansion
6159 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6160
6161 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6162 usercode and password are in different positions.
6163 Chapter &<<CHAPplaintext>>& covers both.
6164
6165 .ecindex IIDconfiwal
6166
6167
6168
6169 . ////////////////////////////////////////////////////////////////////////////
6170 . ////////////////////////////////////////////////////////////////////////////
6171
6172 .chapter "Regular expressions" "CHAPregexp"
6173
6174 .cindex "regular expressions" "library"
6175 .cindex "PCRE"
6176 Exim supports the use of regular expressions in many of its options. It
6177 uses the PCRE regular expression library; this provides regular expression
6178 matching that is compatible with Perl 5. The syntax and semantics of
6179 regular expressions is discussed in many Perl reference books, and also in
6180 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6181 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6182
6183 The documentation for the syntax and semantics of the regular expressions that
6184 are supported by PCRE is included in the PCRE distribution, and no further
6185 description is included here. The PCRE functions are called from Exim using
6186 the default option settings (that is, with no PCRE options set), except that
6187 the PCRE_CASELESS option is set when the matching is required to be
6188 case-insensitive.
6189
6190 In most cases, when a regular expression is required in an Exim configuration,
6191 it has to start with a circumflex, in order to distinguish it from plain text
6192 or an &"ends with"& wildcard. In this example of a configuration setting, the
6193 second item in the colon-separated list is a regular expression.
6194 .code
6195 domains = a.b.c : ^\\d{3} : *.y.z : ...
6196 .endd
6197 The doubling of the backslash is required because of string expansion that
6198 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6199 of this issue, and a way of avoiding the need for doubling backslashes. The
6200 regular expression that is eventually used in this example contains just one
6201 backslash. The circumflex is included in the regular expression, and has the
6202 normal effect of &"anchoring"& it to the start of the string that is being
6203 matched.
6204
6205 There are, however, two cases where a circumflex is not required for the
6206 recognition of a regular expression: these are the &%match%& condition in a
6207 string expansion, and the &%matches%& condition in an Exim filter file. In
6208 these cases, the relevant string is always treated as a regular expression; if
6209 it does not start with a circumflex, the expression is not anchored, and can
6210 match anywhere in the subject string.
6211
6212 In all cases, if you want a regular expression to match at the end of a string,
6213 you must code the $ metacharacter to indicate this. For example:
6214 .code
6215 domains = ^\\d{3}\\.example
6216 .endd
6217 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6218 You need to use:
6219 .code
6220 domains = ^\\d{3}\\.example\$
6221 .endd
6222 if you want &'example'& to be the top-level domain. The backslash before the
6223 $ is needed because string expansion also interprets dollar characters.
6224
6225
6226
6227 . ////////////////////////////////////////////////////////////////////////////
6228 . ////////////////////////////////////////////////////////////////////////////
6229
6230 .chapter "File and database lookups" "CHAPfdlookup"
6231 .scindex IIDfidalo1 "file" "lookups"
6232 .scindex IIDfidalo2 "database" "lookups"
6233 .cindex "lookup" "description of"
6234 Exim can be configured to look up data in files or databases as it processes
6235 messages. Two different kinds of syntax are used:
6236
6237 .olist
6238 A string that is to be expanded may contain explicit lookup requests. These
6239 cause parts of the string to be replaced by data that is obtained from the
6240 lookup. Lookups of this type are conditional expansion items. Different results
6241 can be defined for the cases of lookup success and failure. See chapter
6242 &<<CHAPexpand>>&, where string expansions are described in detail.
6243 .next
6244 Lists of domains, hosts, and email addresses can contain lookup requests as a
6245 way of avoiding excessively long linear lists. In this case, the data that is
6246 returned by the lookup is often (but not always) discarded; whether the lookup
6247 succeeds or fails is what really counts. These kinds of list are described in
6248 chapter &<<CHAPdomhosaddlists>>&.
6249 .endlist
6250
6251 String expansions, lists, and lookups interact with each other in such a way
6252 that there is no order in which to describe any one of them that does not
6253 involve references to the others. Each of these three chapters makes more sense
6254 if you have read the other two first. If you are reading this for the first
6255 time, be aware that some of it will make a lot more sense after you have read
6256 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6257
6258 .section "Examples of different lookup syntax" "SECID60"
6259 It is easy to confuse the two different kinds of lookup, especially as the
6260 lists that may contain the second kind are always expanded before being
6261 processed as lists. Therefore, they may also contain lookups of the first kind.
6262 Be careful to distinguish between the following two examples:
6263 .code
6264 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6265 domains = lsearch;/some/file
6266 .endd
6267 The first uses a string expansion, the result of which must be a domain list.
6268 No strings have been specified for a successful or a failing lookup; the
6269 defaults in this case are the looked-up data and an empty string, respectively.
6270 The expansion takes place before the string is processed as a list, and the
6271 file that is searched could contain lines like this:
6272 .code
6273 192.168.3.4: domain1:domain2:...
6274 192.168.1.9: domain3:domain4:...
6275 .endd
6276 When the lookup succeeds, the result of the expansion is a list of domains (and
6277 possibly other types of item that are allowed in domain lists).
6278
6279 In the second example, the lookup is a single item in a domain list. It causes
6280 Exim to use a lookup to see if the domain that is being processed can be found
6281 in the file. The file could contains lines like this:
6282 .code
6283 domain1:
6284 domain2:
6285 .endd
6286 Any data that follows the keys is not relevant when checking that the domain
6287 matches the list item.
6288
6289 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6290 Consider a file containing lines like this:
6291 .code
6292 192.168.5.6: lsearch;/another/file
6293 .endd
6294 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6295 first &%domains%& setting above generates the second setting, which therefore
6296 causes a second lookup to occur.
6297
6298 The rest of this chapter describes the different lookup types that are
6299 available. Any of them can be used in any part of the configuration where a
6300 lookup is permitted.
6301
6302
6303 .section "Lookup types" "SECID61"
6304 .cindex "lookup" "types of"
6305 .cindex "single-key lookup" "definition of"
6306 Two different types of data lookup are implemented:
6307
6308 .ilist
6309 The &'single-key'& type requires the specification of a file in which to look,
6310 and a single key to search for. The key must be a non-empty string for the
6311 lookup to succeed. The lookup type determines how the file is searched.
6312 .next
6313 .cindex "query-style lookup" "definition of"
6314 The &'query-style'& type accepts a generalized database query. No particular
6315 key value is assumed by Exim for query-style lookups. You can use whichever
6316 Exim variables you need to construct the database query.
6317 .endlist
6318
6319 The code for each lookup type is in a separate source file that is included in
6320 the binary of Exim only if the corresponding compile-time option is set. The
6321 default settings in &_src/EDITME_& are:
6322 .code
6323 LOOKUP_DBM=yes
6324 LOOKUP_LSEARCH=yes
6325 .endd
6326 which means that only linear searching and DBM lookups are included by default.
6327 For some types of lookup (e.g. SQL databases), you need to install appropriate
6328 libraries and header files before building Exim.
6329
6330
6331
6332
6333 .section "Single-key lookup types" "SECTsinglekeylookups"
6334 .cindex "lookup" "single-key types"
6335 .cindex "single-key lookup" "list of types"
6336 The following single-key lookup types are implemented:
6337
6338 .ilist
6339 .cindex "cdb" "description of"
6340 .cindex "lookup" "cdb"
6341 .cindex "binary zero" "in lookup key"
6342 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6343 string without a terminating binary zero. The cdb format is designed for
6344 indexed files that are read frequently and never updated, except by total
6345 re-creation. As such, it is particularly suitable for large files containing
6346 aliases or other indexed data referenced by an MTA. Information about cdb can
6347 be found in several places:
6348 .display
6349 &url(http://www.pobox.com/~djb/cdb.html)
6350 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6351 &url(http://packages.debian.org/stable/utils/freecdb.html)
6352 .endd
6353 A cdb distribution is not needed in order to build Exim with cdb support,
6354 because the code for reading cdb files is included directly in Exim itself.
6355 However, no means of building or testing cdb files is provided with Exim, so
6356 you need to obtain a cdb distribution in order to do this.
6357 .next
6358 .cindex "DBM" "lookup type"
6359 .cindex "lookup" "dbm"
6360 .cindex "binary zero" "in lookup key"
6361 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6362 DBM file by looking up the record with the given key. A terminating binary
6363 zero is included in the key that is passed to the DBM library. See section
6364 &<<SECTdb>>& for a discussion of DBM libraries.
6365
6366 .cindex "Berkeley DB library" "file format"
6367 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6368 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6369 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6370 the DB_UNKNOWN option. This enables it to handle any of the types of database
6371 that the library supports, and can be useful for accessing DBM files created by
6372 other applications. (For earlier DB versions, DB_HASH is always used.)
6373 .next
6374 .cindex "lookup" "dbmjz"
6375 .cindex "lookup" "dbm &-- embedded NULs"
6376 .cindex "sasldb2"
6377 .cindex "dbmjz lookup type"
6378 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6379 interpreted as an Exim list; the elements of the list are joined together with
6380 ASCII NUL characters to form the lookup key.  An example usage would be to
6381 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6382 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6383 &(cram_md5)& authenticator.
6384 .next
6385 .cindex "lookup" "dbmnz"
6386 .cindex "lookup" "dbm &-- terminating zero"
6387 .cindex "binary zero" "in lookup key"
6388 .cindex "Courier"
6389 .cindex "&_/etc/userdbshadow.dat_&"
6390 .cindex "dbmnz lookup type"
6391 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6392 is not included in the key that is passed to the DBM library. You may need this
6393 if you want to look up data in files that are created by or shared with some
6394 other application that does not use terminating zeros. For example, you need to
6395 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6396 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6397 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6398 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6399 .next
6400 .cindex "lookup" "dsearch"
6401 .cindex "dsearch lookup type"
6402 &(dsearch)&: The given file must be a directory; this is searched for an entry
6403 whose name is the key by calling the &[lstat()]& function. The key may not
6404 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6405 the lookup is the name of the entry, which may be a file, directory,
6406 symbolic link, or any other kind of directory entry. An example of how this
6407 lookup can be used to support virtual domains is given in section
6408 &<<SECTvirtualdomains>>&.
6409 .next
6410 .cindex "lookup" "iplsearch"
6411 .cindex "iplsearch lookup type"
6412 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6413 terminated by a colon or white space or the end of the line. The keys in the
6414 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6415 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6416 being interpreted as a key terminator. For example:
6417 .code
6418 1.2.3.4:           data for 1.2.3.4
6419 192.168.0.0/16:    data for 192.168.0.0/16
6420 "abcd::cdab":      data for abcd::cdab
6421 "abcd:abcd::/32"   data for abcd:abcd::/32
6422 .endd
6423 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6424 file is searched linearly, using the CIDR masks where present, until a matching
6425 key is found. The first key that matches is used; there is no attempt to find a
6426 &"best"& match. Apart from the way the keys are matched, the processing for
6427 &(iplsearch)& is the same as for &(lsearch)&.
6428
6429 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6430 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6431 lookup types support only literal keys.
6432
6433 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6434 the implicit key is the host's IP address rather than its name (see section
6435 &<<SECThoslispatsikey>>&).
6436 .next
6437 .cindex "linear search"
6438 .cindex "lookup" "lsearch"
6439 .cindex "lsearch lookup type"
6440 .cindex "case sensitivity" "in lsearch lookup"
6441 &(lsearch)&: The given file is a text file that is searched linearly for a
6442 line beginning with the search key, terminated by a colon or white space or the
6443 end of the line. The search is case-insensitive; that is, upper and lower case
6444 letters are treated as the same. The first occurrence of the key that is found
6445 in the file is used.
6446
6447 White space between the key and the colon is permitted. The remainder of the
6448 line, with leading and trailing white space removed, is the data. This can be
6449 continued onto subsequent lines by starting them with any amount of white
6450 space, but only a single space character is included in the data at such a
6451 junction. If the data begins with a colon, the key must be terminated by a
6452 colon, for example:
6453 .code
6454 baduser:  :fail:
6455 .endd
6456 Empty lines and lines beginning with # are ignored, even if they occur in the
6457 middle of an item. This is the traditional textual format of alias files. Note
6458 that the keys in an &(lsearch)& file are literal strings. There is no
6459 wildcarding of any kind.
6460
6461 .cindex "lookup" "lsearch &-- colons in keys"
6462 .cindex "white space" "in lsearch key"
6463 In most &(lsearch)& files, keys are not required to contain colons or #
6464 characters, or white space. However, if you need this feature, it is available.
6465 If a key begins with a doublequote character, it is terminated only by a
6466 matching quote (or end of line), and the normal escaping rules apply to its
6467 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6468 quoted keys (exactly as for unquoted keys). There is no special handling of
6469 quotes for the data part of an &(lsearch)& line.
6470
6471 .next
6472 .cindex "NIS lookup type"
6473 .cindex "lookup" "NIS"
6474 .cindex "binary zero" "in lookup key"
6475 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6476 the given key, without a terminating binary zero. There is a variant called
6477 &(nis0)& which does include the terminating binary zero in the key. This is
6478 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6479 aliases; the full map names must be used.
6480
6481 .next
6482 .cindex "wildlsearch lookup type"
6483 .cindex "lookup" "wildlsearch"
6484 .cindex "nwildlsearch lookup type"
6485 .cindex "lookup" "nwildlsearch"
6486 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6487 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6488 the file may be wildcarded. The difference between these two lookup types is
6489 that for &(wildlsearch)&, each key in the file is string-expanded before being
6490 used, whereas for &(nwildlsearch)&, no expansion takes place.
6491
6492 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6493 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6494 file that are regular expressions can be made case-sensitive by the use of
6495 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6496
6497 . ==== As this is a nested list, any displays it contains must be indented
6498 . ==== as otherwise they are too far to the left.
6499
6500 .olist
6501 The string may begin with an asterisk to mean &"ends with"&. For example:
6502 .code
6503     *.a.b.c       data for anything.a.b.c
6504     *fish         data for anythingfish
6505 .endd
6506 .next
6507 The string may begin with a circumflex to indicate a regular expression. For
6508 example, for &(wildlsearch)&:
6509 .code
6510     ^\N\d+\.a\.b\N    data for <digits>.a.b
6511 .endd
6512 Note the use of &`\N`& to disable expansion of the contents of the regular
6513 expression. If you are using &(nwildlsearch)&, where the keys are not
6514 string-expanded, the equivalent entry is:
6515 .code
6516     ^\d+\.a\.b        data for <digits>.a.b
6517 .endd
6518 The case-insensitive flag is set at the start of compiling the regular
6519 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6520 For example, to make the entire pattern case-sensitive:
6521 .code
6522     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6523 .endd
6524
6525 If the regular expression contains white space or colon characters, you must
6526 either quote it (see &(lsearch)& above), or represent these characters in other
6527 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6528 colon. This may be easier than quoting, because if you quote, you have to
6529 escape all the backslashes inside the quotes.
6530
6531 &*Note*&: It is not possible to capture substrings in a regular expression
6532 match for later use, because the results of all lookups are cached. If a lookup
6533 is repeated, the result is taken from the cache, and no actual pattern matching
6534 takes place. The values of all the numeric variables are unset after a
6535 &((n)wildlsearch)& match.
6536
6537 .next
6538 Although I cannot see it being of much use, the general matching function that
6539 is used to implement &((n)wildlsearch)& means that the string may begin with a
6540 lookup name terminated by a semicolon, and followed by lookup data. For
6541 example:
6542 .code
6543     cdb;/some/file  data for keys that match the file
6544 .endd
6545 The data that is obtained from the nested lookup is discarded.
6546 .endlist olist
6547
6548 Keys that do not match any of these patterns are interpreted literally. The
6549 continuation rules for the data are the same as for &(lsearch)&, and keys may
6550 be followed by optional colons.
6551
6552 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6553 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6554 lookup types support only literal keys.
6555 .endlist ilist
6556
6557
6558 .section "Query-style lookup types" "SECID62"
6559 .cindex "lookup" "query-style types"
6560 .cindex "query-style lookup" "list of types"
6561 The supported query-style lookup types are listed below. Further details about
6562 many of them are given in later sections.
6563
6564 .ilist
6565 .cindex "DNS" "as a lookup type"
6566 .cindex "lookup" "DNS"
6567 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6568 are given in the supplied query. The resulting data is the contents of the
6569 records. See section &<<SECTdnsdb>>&.
6570 .next
6571 .cindex "InterBase lookup type"
6572 .cindex "lookup" "InterBase"
6573 &(ibase)&: This does a lookup in an InterBase database.
6574 .next
6575 .cindex "LDAP" "lookup type"
6576 .cindex "lookup" "LDAP"
6577 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6578 returns attributes from a single entry. There is a variant called &(ldapm)&
6579 that permits values from multiple entries to be returned. A third variant
6580 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6581 any attribute values. See section &<<SECTldap>>&.
6582 .next
6583 .cindex "MySQL" "lookup type"
6584 .cindex "lookup" "MySQL"
6585 &(mysql)&: The format of the query is an SQL statement that is passed to a
6586 MySQL database. See section &<<SECTsql>>&.
6587 .next
6588 .cindex "NIS+ lookup type"
6589 .cindex "lookup" "NIS+"
6590 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6591 the field to be returned. See section &<<SECTnisplus>>&.
6592 .next
6593 .cindex "Oracle" "lookup type"
6594 .cindex "lookup" "Oracle"
6595 &(oracle)&: The format of the query is an SQL statement that is passed to an
6596 Oracle database. See section &<<SECTsql>>&.
6597 .next
6598 .cindex "lookup" "passwd"
6599 .cindex "passwd lookup type"
6600 .cindex "&_/etc/passwd_&"
6601 &(passwd)& is a query-style lookup with queries that are just user names. The
6602 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6603 success, the result string is the same as you would get from an &(lsearch)&
6604 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6605 password value. For example:
6606 .code
6607 *:42:42:King Rat:/home/kr:/bin/bash
6608 .endd
6609 .next
6610 .cindex "PostgreSQL lookup type"
6611 .cindex "lookup" "PostgreSQL"
6612 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6613 PostgreSQL database. See section &<<SECTsql>>&.
6614
6615 .next
6616 .cindex "sqlite lookup type"
6617 .cindex "lookup" "sqlite"
6618 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6619 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6620
6621 .next
6622 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6623 not likely to be useful in normal operation.
6624 .next
6625 .cindex "whoson lookup type"
6626 .cindex "lookup" "whoson"
6627 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6628 allows a server to check whether a particular (dynamically allocated) IP
6629 address is currently allocated to a known (trusted) user and, optionally, to
6630 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6631 at one time for &"POP before SMTP"& authentication, but that approach has been
6632 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6633 &"POP before SMTP"& checking using ACL statements such as
6634 .code
6635 require condition = \
6636   ${lookup whoson {$sender_host_address}{yes}{no}}
6637 .endd
6638 The query consists of a single IP address. The value returned is the name of
6639 the authenticated user, which is stored in the variable &$value$&. However, in
6640 this example, the data in &$value$& is not used; the result of the lookup is
6641 one of the fixed strings &"yes"& or &"no"&.
6642 .endlist
6643
6644
6645
6646 .section "Temporary errors in lookups" "SECID63"
6647 .cindex "lookup" "temporary error in"
6648 Lookup functions can return temporary error codes if the lookup cannot be
6649 completed. For example, an SQL or LDAP database might be unavailable. For this
6650 reason, it is not advisable to use a lookup that might do this for critical
6651 options such as a list of local domains.
6652
6653 When a lookup cannot be completed in a router or transport, delivery
6654 of the message (to the relevant address) is deferred, as for any other
6655 temporary error. In other circumstances Exim may assume the lookup has failed,
6656 or may give up altogether.
6657
6658
6659
6660 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6661 .cindex "wildcard lookups"
6662 .cindex "lookup" "default values"
6663 .cindex "lookup" "wildcard"
6664 .cindex "lookup" "* added to type"
6665 .cindex "default" "in single-key lookups"
6666 In this context, a &"default value"& is a value specified by the administrator
6667 that is to be used if a lookup fails.
6668
6669 &*Note:*& This section applies only to single-key lookups. For query-style
6670 lookups, the facilities of the query language must be used. An attempt to
6671 specify a default for a query-style lookup provokes an error.
6672
6673 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6674 and the initial lookup fails, the key &"*"& is looked up in the file to
6675 provide a default value. See also the section on partial matching below.
6676
6677 .cindex "*@ with single-key lookup"
6678 .cindex "lookup" "*@ added to type"
6679 .cindex "alias file" "per-domain default"
6680 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6681 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6682 character, a second lookup is done with everything before the last @ replaced
6683 by *. This makes it possible to provide per-domain defaults in alias files
6684 that include the domains in the keys. If the second lookup fails (or doesn't
6685 take place because there is no @ in the key), &"*"& is looked up.
6686 For example, a &(redirect)& router might contain:
6687 .code
6688 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6689 .endd
6690 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6691 looks up these keys, in this order:
6692 .code
6693 jane@eyre.example
6694 *@eyre.example
6695 *
6696 .endd
6697 The data is taken from whichever key it finds first. &*Note*&: In an
6698 &(lsearch)& file, this does not mean the first of these keys in the file. A
6699 complete scan is done for each key, and only if it is not found at all does
6700 Exim move on to try the next key.
6701
6702
6703
6704 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6705 .cindex "partial matching"
6706 .cindex "wildcard lookups"
6707 .cindex "lookup" "partial matching"
6708 .cindex "lookup" "wildcard"
6709 .cindex "asterisk" "in search type"
6710 The normal operation of a single-key lookup is to search the file for an exact
6711 match with the given key. However, in a number of situations where domains are
6712 being looked up, it is useful to be able to do partial matching. In this case,
6713 information in the file that has a key starting with &"*."& is matched by any
6714 domain that ends with the components that follow the full stop. For example, if
6715 a key in a DBM file is
6716 .code
6717 *.dates.fict.example
6718 .endd
6719 then when partial matching is enabled this is matched by (amongst others)
6720 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6721 by &'dates.fict.example'&, if that does not appear as a separate key in the
6722 file.
6723
6724 &*Note*&: Partial matching is not available for query-style lookups. It is
6725 also not available for any lookup items in address lists (see section
6726 &<<SECTaddresslist>>&).
6727
6728 Partial matching is implemented by doing a series of separate lookups using
6729 keys constructed by modifying the original subject key. This means that it can
6730 be used with any of the single-key lookup types, provided that
6731 partial matching keys
6732 beginning with a special prefix (default &"*."&) are included in the data file.
6733 Keys in the file that do not begin with the prefix are matched only by
6734 unmodified subject keys when partial matching is in use.
6735
6736 Partial matching is requested by adding the string &"partial-"& to the front of
6737 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6738 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6739 is added at the start of the subject key, and it is looked up again. If that
6740 fails, further lookups are tried with dot-separated components removed from the
6741 start of the subject key, one-by-one, and &"*."& added on the front of what
6742 remains.
6743
6744 A minimum number of two non-* components are required. This can be adjusted
6745 by including a number before the hyphen in the search type. For example,
6746 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6747 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6748 subject key is &'2250.dates.fict.example'& then the following keys are looked
6749 up when the minimum number of non-* components is two:
6750 .code
6751 2250.dates.fict.example
6752 *.2250.dates.fict.example
6753 *.dates.fict.example
6754 *.fict.example
6755 .endd
6756 As soon as one key in the sequence is successfully looked up, the lookup
6757 finishes.
6758
6759 .cindex "lookup" "partial matching &-- changing prefix"
6760 .cindex "prefix" "for partial matching"
6761 The use of &"*."& as the partial matching prefix is a default that can be
6762 changed. The motivation for this feature is to allow Exim to operate with file
6763 formats that are used by other MTAs. A different prefix can be supplied in
6764 parentheses instead of the hyphen after &"partial"&. For example:
6765 .code
6766 domains = partial(.)lsearch;/some/file
6767 .endd
6768 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6769 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6770 components is unchanged). The prefix may consist of any punctuation characters
6771 other than a closing parenthesis. It may be empty, for example:
6772 .code
6773 domains = partial1()cdb;/some/file
6774 .endd
6775 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6776 &`a.b.c`&, &`b.c`&, and &`c`&.
6777
6778 If &"partial0"& is specified, what happens at the end (when the lookup with
6779 just one non-wild component has failed, and the original key is shortened right
6780 down to the null string) depends on the prefix:
6781
6782 .ilist
6783 If the prefix has zero length, the whole lookup fails.
6784 .next
6785 If the prefix has length 1, a lookup for just the prefix is done. For
6786 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6787 .next
6788 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6789 remainder is looked up. With the default prefix, therefore, the final lookup is
6790 for &"*"& on its own.
6791 .next
6792 Otherwise, the whole prefix is looked up.
6793 .endlist
6794
6795
6796 If the search type ends in &"*"& or &"*@"& (see section
6797 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6798 this implies happens after all partial lookups have failed. If &"partial0"& is
6799 specified, adding &"*"& to the search type has no effect with the default
6800 prefix, because the &"*"& key is already included in the sequence of partial
6801 lookups. However, there might be a use for lookup types such as
6802 &"partial0(.)lsearch*"&.
6803
6804 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6805 in domain lists and the like. Partial matching works only in terms of
6806 dot-separated components; a key such as &`*fict.example`&
6807 in a database file is useless, because the asterisk in a partial matching
6808 subject key is always followed by a dot.
6809
6810
6811
6812
6813 .section "Lookup caching" "SECID64"
6814 .cindex "lookup" "caching"
6815 .cindex "caching" "lookup data"
6816 Exim caches all lookup results in order to avoid needless repetition of
6817 lookups. However, because (apart from the daemon) Exim operates as a collection
6818 of independent, short-lived processes, this caching applies only within a
6819 single Exim process. There is no inter-process lookup caching facility.
6820
6821 For single-key lookups, Exim keeps the relevant files open in case there is
6822 another lookup that needs them. In some types of configuration this can lead to
6823 many files being kept open for messages with many recipients. To avoid hitting
6824 the operating system limit on the number of simultaneously open files, Exim
6825 closes the least recently used file when it needs to open more files than its
6826 own internal limit, which can be changed via the &%lookup_open_max%& option.
6827
6828 The single-key lookup files are closed and the lookup caches are flushed at
6829 strategic points during delivery &-- for example, after all routing is
6830 complete.
6831
6832
6833
6834
6835 .section "Quoting lookup data" "SECID65"
6836 .cindex "lookup" "quoting"
6837 .cindex "quoting" "in lookups"
6838 When data from an incoming message is included in a query-style lookup, there
6839 is the possibility of special characters in the data messing up the syntax of
6840 the query. For example, a NIS+ query that contains
6841 .code
6842 [name=$local_part]
6843 .endd
6844 will be broken if the local part happens to contain a closing square bracket.
6845 For NIS+, data can be enclosed in double quotes like this:
6846 .code
6847 [name="$local_part"]
6848 .endd
6849 but this still leaves the problem of a double quote in the data. The rule for
6850 NIS+ is that double quotes must be doubled. Other lookup types have different
6851 rules, and to cope with the differing requirements, an expansion operator
6852 of the following form is provided:
6853 .code
6854 ${quote_<lookup-type>:<string>}
6855 .endd
6856 For example, the safest way to write the NIS+ query is
6857 .code
6858 [name="${quote_nisplus:$local_part}"]
6859 .endd
6860 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6861 operator can be used for all lookup types, but has no effect for single-key
6862 lookups, since no quoting is ever needed in their key strings.
6863
6864
6865
6866
6867 .section "More about dnsdb" "SECTdnsdb"
6868 .cindex "dnsdb lookup"
6869 .cindex "lookup" "dnsdb"
6870 .cindex "DNS" "as a lookup type"
6871 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6872 of a record type and a domain name, separated by an equals sign. For example,
6873 an expansion string could contain:
6874 .code
6875 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6876 .endd
6877 If the lookup succeeds, the result is placed in &$value$&, which in this case
6878 is used on its own as the result. If the lookup does not succeed, the
6879 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6880 &<<SECTforexpfai>>& for an explanation of what this means.
6881
6882 The supported DNS record types are A, CNAME, MX, NS, PTR, SPF, SRV, TLSA and TXT,
6883 and, when Exim is compiled with IPv6 support, AAAA (and A6 if that is also
6884 configured). If no type is given, TXT is assumed. When the type is PTR,
6885 the data can be an IP address, written as normal; inversion and the addition of
6886 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6887 .code
6888 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6889 .endd
6890 If the data for a PTR record is not a syntactically valid IP address, it is not
6891 altered and nothing is added.
6892
6893 For any record type, if multiple records are found (or, for A6 lookups, if a
6894 single record leads to multiple addresses), the data is returned as a
6895 concatenation, with newline as the default separator. The order, of course,
6896 depends on the DNS resolver. You can specify a different separator character
6897 between multiple records by putting a right angle-bracket followed immediately
6898 by the new separator at the start of the query. For example:
6899 .code
6900 ${lookup dnsdb{>: a=host1.example}}
6901 .endd
6902 It is permitted to specify a space as the separator character. Further
6903 white space is ignored.
6904
6905 .cindex "MX record" "in &(dnsdb)& lookup"
6906 .cindex "SRV record" "in &(dnsdb)& lookup"
6907 For an MX lookup, both the preference value and the host name are returned for
6908 each record, separated by a space. For an SRV lookup, the priority, weight,
6909 port, and host name are returned for each record, separated by spaces.
6910 An alternate field separator can be specified using a comma after the main
6911 separator character, followed immediately by the field separator.
6912
6913 .cindex "TXT record" "in &(dnsdb)& lookup"
6914 .cindex "SPF record" "in &(dnsdb)& lookup"
6915 For TXT records with multiple items of data, only the first item is returned,
6916 unless a separator for them is specified using a comma after the separator
6917 character followed immediately by the TXT record item separator. To concatenate
6918 items without a separator, use a semicolon instead. For SPF records the
6919 default behaviour is to concatenate multiple items without using a separator.
6920 .code
6921 ${lookup dnsdb{>\n,: txt=a.b.example}}
6922 ${lookup dnsdb{>\n; txt=a.b.example}}
6923 ${lookup dnsdb{spf=example.org}}
6924 .endd
6925 It is permitted to specify a space as the separator character. Further
6926 white space is ignored.
6927
6928 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6929 .cindex "dnsdb modifiers"
6930 .cindex "modifiers" "dnsdb"
6931 .cindex "options" "dnsdb"
6932 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6933 each followed by a comma,
6934 that may appear before the record type.
6935
6936 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6937 temporary DNS error for any of them, the behaviour is controlled by
6938 a defer-option modifier.
6939 The possible keywords are
6940 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6941 With &"strict"& behaviour, any temporary DNS error causes the
6942 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6943 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6944 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6945 error causes the whole lookup to defer only if none of the other lookups
6946 succeed. The default is &"lax"&, so the following lookups are equivalent:
6947 .code
6948 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6949 ${lookup dnsdb{a=one.host.com:two.host.com}}
6950 .endd
6951 Thus, in the default case, as long as at least one of the DNS lookups
6952 yields some data, the lookup succeeds.
6953
6954 .cindex "DNSSEC" "dns lookup"
6955 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6956 The possible keywords are
6957 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6958 With &"strict"& or &"lax"& DNSSEC information is requested
6959 with the lookup.
6960 With &"strict"& a response from the DNS resolver that
6961 is not labelled as authenticated data
6962 is treated as equivalent to a temporary DNS error.
6963 The default is &"never"&.
6964
6965 See also the &$lookup_dnssec_authenticated$& variable.
6966
6967
6968 .section "Pseudo dnsdb record types" "SECID66"
6969 .cindex "MX record" "in &(dnsdb)& lookup"
6970 By default, both the preference value and the host name are returned for
6971 each MX record, separated by a space. If you want only host names, you can use
6972 the pseudo-type MXH:
6973 .code
6974 ${lookup dnsdb{mxh=a.b.example}}
6975 .endd
6976 In this case, the preference values are omitted, and just the host names are
6977 returned.
6978
6979 .cindex "name server for enclosing domain"
6980 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
6981 records on the given domain, but if none are found, it removes the first
6982 component of the domain name, and tries again. This process continues until NS
6983 records are found or there are no more components left (or there is a DNS
6984 error). In other words, it may return the name servers for a top-level domain,
6985 but it never returns the root name servers. If there are no NS records for the
6986 top-level domain, the lookup fails. Consider these examples:
6987 .code
6988 ${lookup dnsdb{zns=xxx.quercite.com}}
6989 ${lookup dnsdb{zns=xxx.edu}}
6990 .endd
6991 Assuming that in each case there are no NS records for the full domain name,
6992 the first returns the name servers for &%quercite.com%&, and the second returns
6993 the name servers for &%edu%&.
6994
6995 You should be careful about how you use this lookup because, unless the
6996 top-level domain does not exist, the lookup always returns some host names. The
6997 sort of use to which this might be put is for seeing if the name servers for a
6998 given domain are on a blacklist. You can probably assume that the name servers
6999 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7000 such a list.
7001
7002 .cindex "CSA" "in &(dnsdb)& lookup"
7003 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7004 records according to the CSA rules, which are described in section
7005 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7006 not sufficient because of the extra parent domain search behaviour of CSA. The
7007 result of a successful lookup such as:
7008 .code
7009 ${lookup dnsdb {csa=$sender_helo_name}}
7010 .endd
7011 has two space-separated fields: an authorization code and a target host name.
7012 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7013 authorization required but absent, or &"?"& for unknown.
7014
7015 .cindex "A+" "in &(dnsdb)& lookup"
7016 The pseudo-type A+ performs an A6 lookup (if configured) followed by an AAAA
7017 and then an A lookup.  All results are returned; defer processing
7018 (see below) is handled separately for each lookup.  Example:
7019 .code
7020 ${lookup dnsdb {>; a+=$sender_helo_name}}
7021 .endd
7022
7023
7024 .section "Multiple dnsdb lookups" "SECID67"
7025 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7026 However, you can specify a list of domains or IP addresses in a single
7027 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7028 the default separator, but with the ability to change this. For example:
7029 .code
7030 ${lookup dnsdb{one.domain.com:two.domain.com}}
7031 ${lookup dnsdb{a=one.host.com:two.host.com}}
7032 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7033 .endd
7034 In order to retain backwards compatibility, there is one special case: if
7035 the lookup type is PTR and no change of separator is specified, Exim looks
7036 to see if the rest of the string is precisely one IPv6 address. In this
7037 case, it does not treat it as a list.
7038
7039 The data from each lookup is concatenated, with newline separators by default,
7040 in the same way that multiple DNS records for a single item are handled. A
7041 different separator can be specified, as described above.
7042
7043
7044
7045
7046 .section "More about LDAP" "SECTldap"
7047 .cindex "LDAP" "lookup, more about"
7048 .cindex "lookup" "LDAP"
7049 .cindex "Solaris" "LDAP"
7050 The original LDAP implementation came from the University of Michigan; this has
7051 become &"Open LDAP"&, and there are now two different releases. Another
7052 implementation comes from Netscape, and Solaris 7 and subsequent releases
7053 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7054 the lookup function level, their error handling is different. For this reason
7055 it is necessary to set a compile-time variable when building Exim with LDAP, to
7056 indicate which LDAP library is in use. One of the following should appear in
7057 your &_Local/Makefile_&:
7058 .code
7059 LDAP_LIB_TYPE=UMICHIGAN
7060 LDAP_LIB_TYPE=OPENLDAP1
7061 LDAP_LIB_TYPE=OPENLDAP2
7062 LDAP_LIB_TYPE=NETSCAPE
7063 LDAP_LIB_TYPE=SOLARIS
7064 .endd
7065 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7066 same interface as the University of Michigan version.
7067
7068 There are three LDAP lookup types in Exim. These behave slightly differently in
7069 the way they handle the results of a query:
7070
7071 .ilist
7072 &(ldap)& requires the result to contain just one entry; if there are more, it
7073 gives an error.
7074 .next
7075 &(ldapdn)& also requires the result to contain just one entry, but it is the
7076 Distinguished Name that is returned rather than any attribute values.
7077 .next
7078 &(ldapm)& permits the result to contain more than one entry; the attributes
7079 from all of them are returned.
7080 .endlist
7081
7082
7083 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7084 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7085 the data returned by a successful lookup is described in the next section.
7086 First we explain how LDAP queries are coded.
7087
7088
7089 .section "Format of LDAP queries" "SECTforldaque"
7090 .cindex "LDAP" "query format"
7091 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7092 the configuration of a &(redirect)& router one might have this setting:
7093 .code
7094 data = ${lookup ldap \
7095   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7096   c=UK?mailbox?base?}}
7097 .endd
7098 .cindex "LDAP" "with TLS"
7099 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7100 secure (encrypted) LDAP connections. The second of these ensures that an
7101 encrypted TLS connection is used.
7102
7103 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7104 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7105 See the &%ldap_start_tls%& option.
7106
7107 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7108 controlled. Every part of the TLS configuration can be configured by settings in
7109 &_exim.conf_&. Depending on the version of the client libraries installed on
7110 your system, some of the initialization may have required setting options in
7111 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7112 certificates. This revealed a nuance where the current UID that exim was
7113 running as could affect which config files it read. With Exim 4.83, these
7114 methods become optional, only taking effect if not specifically set in
7115 &_exim.conf_&.
7116
7117
7118 .section "LDAP quoting" "SECID68"
7119 .cindex "LDAP" "quoting"
7120 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7121 and the second because the LDAP query is represented as a URL. Furthermore,
7122 within an LDAP query, two different kinds of quoting are required. For this
7123 reason, there are two different LDAP-specific quoting operators.
7124
7125 The &%quote_ldap%& operator is designed for use on strings that are part of
7126 filter specifications. Conceptually, it first does the following conversions on
7127 the string:
7128 .code
7129 *   =>   \2A
7130 (   =>   \28
7131 )   =>   \29
7132 \   =>   \5C
7133 .endd
7134 in accordance with RFC 2254. The resulting string is then quoted according
7135 to the rules for URLs, that is, all non-alphanumeric characters except
7136 .code
7137 ! $ ' - . _ ( ) * +
7138 .endd
7139 are converted to their hex values, preceded by a percent sign. For example:
7140 .code
7141 ${quote_ldap: a(bc)*, a<yz>; }
7142 .endd
7143 yields
7144 .code
7145 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7146 .endd
7147 Removing the URL quoting, this is (with a leading and a trailing space):
7148 .code
7149 a\28bc\29\2A, a<yz>;
7150 .endd
7151 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7152 base DN specifications in queries. Conceptually, it first converts the string
7153 by inserting a backslash in front of any of the following characters:
7154 .code
7155 , + " \ < > ;
7156 .endd
7157 It also inserts a backslash before any leading spaces or # characters, and
7158 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7159 is then quoted according to the rules for URLs. For example:
7160 .code
7161 ${quote_ldap_dn: a(bc)*, a<yz>; }
7162 .endd
7163 yields
7164 .code
7165 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7166 .endd
7167 Removing the URL quoting, this is (with a trailing space):
7168 .code
7169 \ a(bc)*\, a\<yz\>\;\
7170 .endd
7171 There are some further comments about quoting in the section on LDAP
7172 authentication below.
7173
7174
7175 .section "LDAP connections" "SECID69"
7176 .cindex "LDAP" "connections"
7177 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7178 is in use, via a Unix domain socket. The example given above does not specify
7179 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7180 by starting it with
7181 .code
7182 ldap://<hostname>:<port>/...
7183 .endd
7184 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7185 used. When no server is specified in a query, a list of default servers is
7186 taken from the &%ldap_default_servers%& configuration option. This supplies a
7187 colon-separated list of servers which are tried in turn until one successfully
7188 handles a query, or there is a serious error. Successful handling either
7189 returns the requested data, or indicates that it does not exist. Serious errors
7190 are syntactical, or multiple values when only a single value is expected.
7191 Errors which cause the next server to be tried are connection failures, bind
7192 failures, and timeouts.
7193
7194 For each server name in the list, a port number can be given. The standard way
7195 of specifying a host and port is to use a colon separator (RFC 1738). Because
7196 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7197 doubled. For example
7198 .code
7199 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7200 .endd
7201 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7202 to the LDAP library with no server name, and the library's default (normally
7203 the local host) is used.
7204
7205 If you are using the OpenLDAP library, you can connect to an LDAP server using
7206 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7207 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7208 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7209 not available.
7210
7211 For this type of connection, instead of a host name for the server, a pathname
7212 for the socket is required, and the port number is not relevant. The pathname
7213 can be specified either as an item in &%ldap_default_servers%&, or inline in
7214 the query. In the former case, you can have settings such as
7215 .code
7216 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7217 .endd
7218 When the pathname is given in the query, you have to escape the slashes as
7219 &`%2F`& to fit in with the LDAP URL syntax. For example:
7220 .code
7221 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7222 .endd
7223 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7224 a pathname, it uses the Unix domain socket code, even if the query actually
7225 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7226 socket connection. This behaviour means that you can use a setting of
7227 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7228 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7229 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7230 backup host.
7231
7232 If an explicit &`ldapi`& type is given in a query when a host name is
7233 specified, an error is diagnosed. However, if there are more items in
7234 &%ldap_default_servers%&, they are tried. In other words:
7235
7236 .ilist
7237 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7238 interface.
7239 .next
7240 Using &`ldapi`& with a host name causes an error.
7241 .endlist
7242
7243
7244 Using &`ldapi`& with no host or path in the query, and no setting of
7245 &%ldap_default_servers%&, does whatever the library does by default.
7246
7247
7248
7249 .section "LDAP authentication and control information" "SECID70"
7250 .cindex "LDAP" "authentication"
7251 The LDAP URL syntax provides no way of passing authentication and other control
7252 information to the server. To make this possible, the URL in an LDAP query may
7253 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7254 spaces. If a value contains spaces it must be enclosed in double quotes, and
7255 when double quotes are used, backslash is interpreted in the usual way inside
7256 them. The following names are recognized:
7257 .display
7258 &`DEREFERENCE`&  set the dereferencing parameter
7259 &`NETTIME    `&  set a timeout for a network operation
7260 &`USER       `&  set the DN, for authenticating the LDAP bind
7261 &`PASS       `&  set the password, likewise
7262 &`REFERRALS  `&  set the referrals parameter
7263 &`SERVERS    `&  set alternate server list for this query only
7264 &`SIZE       `&  set the limit for the number of entries returned
7265 &`TIME       `&  set the maximum waiting time for a query
7266 .endd
7267 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7268 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7269 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7270 library from trying to follow referrals issued by the LDAP server.
7271
7272 The name CONNECT is an obsolete name for NETTIME, retained for
7273 backwards compatibility. This timeout (specified as a number of seconds) is
7274 enforced from the client end for operations that can be carried out over a
7275 network. Specifically, it applies to network connections and calls to the
7276 &'ldap_result()'& function. If the value is greater than zero, it is used if
7277 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7278 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7279 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7280 Netscape SDK; for OpenLDAP no action is taken.
7281
7282 The TIME parameter (also a number of seconds) is passed to the server to
7283 set a server-side limit on the time taken to complete a search.
7284
7285 The SERVERS parameter allows you to specify an alternate list of ldap servers
7286 to use for an individual lookup.  The global ldap_servers option provides a
7287 default list of ldap servers, and a single lookup can specify a single ldap
7288 server to use.  But when you need to do a lookup with a list of servers that is
7289 different than the default list (maybe different order, maybe a completely
7290 different set of servers), the SERVERS parameter allows you to specify this
7291 alternate list (colon-separated).
7292
7293 Here is an example of an LDAP query in an Exim lookup that uses some of these
7294 values. This is a single line, folded to fit on the page:
7295 .code
7296 ${lookup ldap
7297   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7298   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7299   {$value}fail}
7300 .endd
7301 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7302 any of the auxiliary data. Exim configuration settings that include lookups
7303 which contain password information should be preceded by &"hide"& to prevent
7304 non-admin users from using the &%-bP%& option to see their values.
7305
7306 The auxiliary data items may be given in any order. The default is no
7307 connection timeout (the system timeout is used), no user or password, no limit
7308 on the number of entries returned, and no time limit on queries.
7309
7310 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7311 removes any URL quoting that it may contain before passing it LDAP. Apparently
7312 some libraries do this for themselves, but some do not. Removing the URL
7313 quoting has two advantages:
7314
7315 .ilist
7316 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7317 DNs as with DNs inside actual queries.
7318 .next
7319 It permits spaces inside USER= DNs.
7320 .endlist
7321
7322 For example, a setting such as
7323 .code
7324 USER=cn=${quote_ldap_dn:$1}
7325 .endd
7326 should work even if &$1$& contains spaces.
7327
7328 Expanded data for the PASS= value should be quoted using the &%quote%&
7329 expansion operator, rather than the LDAP quote operators. The only reason this
7330 field needs quoting is to ensure that it conforms to the Exim syntax, which
7331 does not allow unquoted spaces. For example:
7332 .code
7333 PASS=${quote:$3}
7334 .endd
7335 The LDAP authentication mechanism can be used to check passwords as part of
7336 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7337 &<<CHAPexpand>>&.
7338
7339
7340
7341 .section "Format of data returned by LDAP" "SECID71"
7342 .cindex "LDAP" "returned data formats"
7343 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7344 as a sequence of values, for example
7345 .code
7346 cn=manager, o=University of Cambridge, c=UK
7347 .endd
7348 The &(ldap)& lookup type generates an error if more than one entry matches the
7349 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7350 the result between the data from different entries. It is possible for multiple
7351 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7352 you know that whatever values are returned all came from a single entry in the
7353 directory.
7354
7355 In the common case where you specify a single attribute in your LDAP query, the
7356 result is not quoted, and does not contain the attribute name. If the attribute
7357 has multiple values, they are separated by commas.
7358
7359 If you specify multiple attributes, the result contains space-separated, quoted
7360 strings, each preceded by the attribute name and an equals sign. Within the
7361 quotes, the quote character, backslash, and newline are escaped with
7362 backslashes, and commas are used to separate multiple values for the attribute.
7363 Any commas in attribute values are doubled
7364 (permitting treatment of the values as a comma-separated list).
7365 Apart from the escaping, the string within quotes takes the same form as the
7366 output when a single attribute is requested. Specifying no attributes is the
7367 same as specifying all of an entry's attributes.
7368
7369 Here are some examples of the output format. The first line of each pair is an
7370 LDAP query, and the second is the data that is returned. The attribute called
7371 &%attr1%& has two values, one of them with an embedded comma, whereas
7372 &%attr2%& has only one value:
7373 .code
7374 ldap:///o=base?attr1?sub?(uid=fred)
7375 value1.1,value1,,2
7376
7377 ldap:///o=base?attr2?sub?(uid=fred)
7378 value two
7379
7380 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7381 attr1="value1.1,value1,,2" attr2="value two"
7382
7383 ldap:///o=base??sub?(uid=fred)
7384 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7385 .endd
7386 You can
7387 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7388 results of LDAP lookups.
7389 The &%extract%& operator in string expansions can be used to pick out
7390 individual fields from data that consists of &'key'&=&'value'& pairs.
7391 The &%listextract%& operator should be used to pick out individual values
7392 of attributes, even when only a single value is expected.
7393 The doubling of embedded commas allows you to use the returned data as a
7394 comma separated list (using the "<," syntax for changing the input list separator).
7395
7396
7397
7398
7399 .section "More about NIS+" "SECTnisplus"
7400 .cindex "NIS+ lookup type"
7401 .cindex "lookup" "NIS+"
7402 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7403 and field name. If this is given, the result of a successful query is the
7404 contents of the named field; otherwise the result consists of a concatenation
7405 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7406 values containing spaces are quoted. For example, the query
7407 .code
7408 [name=mg1456],passwd.org_dir
7409 .endd
7410 might return the string
7411 .code
7412 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7413 home=/home/mg1456 shell=/bin/bash shadow=""
7414 .endd
7415 (split over two lines here to fit on the page), whereas
7416 .code
7417 [name=mg1456],passwd.org_dir:gcos
7418 .endd
7419 would just return
7420 .code
7421 Martin Guerre
7422 .endd
7423 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7424 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7425 operator is to double any quote characters within the text.
7426
7427
7428
7429 .section "SQL lookups" "SECTsql"
7430 .cindex "SQL lookup types"
7431 .cindex "MySQL" "lookup type"
7432 .cindex "PostgreSQL lookup type"
7433 .cindex "lookup" "MySQL"
7434 .cindex "lookup" "PostgreSQL"
7435 .cindex "Oracle" "lookup type"
7436 .cindex "lookup" "Oracle"
7437 .cindex "InterBase lookup type"
7438 .cindex "lookup" "InterBase"
7439 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7440 databases. Queries for these databases contain SQL statements, so an example
7441 might be
7442 .code
7443 ${lookup mysql{select mailbox from users where id='userx'}\
7444   {$value}fail}
7445 .endd
7446 If the result of the query contains more than one field, the data for each
7447 field in the row is returned, preceded by its name, so the result of
7448 .code
7449 ${lookup pgsql{select home,name from users where id='userx'}\
7450   {$value}}
7451 .endd
7452 might be
7453 .code
7454 home=/home/userx name="Mister X"
7455 .endd
7456 Empty values and values containing spaces are double quoted, with embedded
7457 quotes escaped by a backslash. If the result of the query contains just one
7458 field, the value is passed back verbatim, without a field name, for example:
7459 .code
7460 Mister X
7461 .endd
7462 If the result of the query yields more than one row, it is all concatenated,
7463 with a newline between the data for each row.
7464
7465
7466 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7467 .cindex "MySQL" "lookup type"
7468 .cindex "PostgreSQL lookup type"
7469 .cindex "lookup" "MySQL"
7470 .cindex "lookup" "PostgreSQL"
7471 .cindex "Oracle" "lookup type"
7472 .cindex "lookup" "Oracle"
7473 .cindex "InterBase lookup type"
7474 .cindex "lookup" "InterBase"
7475 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7476 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7477 option (as appropriate) must be set to a colon-separated list of server
7478 information.
7479 (For MySQL and PostgreSQL only, the global option need not be set if all
7480 queries contain their own server information &-- see section
7481 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7482 items: host name, database name, user name, and password. In the case of
7483 Oracle, the host name field is used for the &"service name"&, and the database
7484 name field is not used and should be empty. For example:
7485 .code
7486 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7487 .endd
7488 Because password data is sensitive, you should always precede the setting with
7489 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7490 option. Here is an example where two MySQL servers are listed:
7491 .code
7492 hide mysql_servers = localhost/users/root/secret:\
7493                      otherhost/users/root/othersecret
7494 .endd
7495 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7496 because this is a colon-separated list, the colon has to be doubled. For each
7497 query, these parameter groups are tried in order until a connection is made and
7498 a query is successfully processed. The result of a query may be that no data is
7499 found, but that is still a successful query. In other words, the list of
7500 servers provides a backup facility, not a list of different places to look.
7501
7502 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7503 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7504 respectively, and the characters single-quote, double-quote, and backslash
7505 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7506 addition, escapes the percent and underscore characters. This cannot be done
7507 for MySQL because these escapes are not recognized in contexts where these
7508 characters are not special.
7509
7510 .section "Specifying the server in the query" "SECTspeserque"
7511 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7512 it is possible to specify a list of servers with an individual query. This is
7513 done by starting the query with
7514 .display
7515 &`servers=`&&'server1:server2:server3:...'&&`;`&
7516 .endd
7517 Each item in the list may take one of two forms:
7518 .olist
7519 If it contains no slashes it is assumed to be just a host name. The appropriate
7520 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7521 of the same name, and the remaining parameters (database, user, password) are
7522 taken from there.
7523 .next
7524 If it contains any slashes, it is taken as a complete parameter set.
7525 .endlist
7526 The list of servers is used in exactly the same way as the global list.
7527 Once a connection to a server has happened and a query has been
7528 successfully executed, processing of the lookup ceases.
7529
7530 This feature is intended for use in master/slave situations where updates
7531 are occurring and you want to update the master rather than a slave. If the
7532 master is in the list as a backup for reading, you might have a global setting
7533 like this:
7534 .code
7535 mysql_servers = slave1/db/name/pw:\
7536                 slave2/db/name/pw:\
7537                 master/db/name/pw
7538 .endd
7539 In an updating lookup, you could then write:
7540 .code
7541 ${lookup mysql{servers=master; UPDATE ...} }
7542 .endd
7543 That query would then be sent only to the master server. If, on the other hand,
7544 the master is not to be used for reading, and so is not present in the global
7545 option, you can still update it by a query of this form:
7546 .code
7547 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7548 .endd
7549
7550
7551 .section "Special MySQL features" "SECID73"
7552 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7553 causes a connection to the server on the local host by means of a Unix domain
7554 socket. An alternate socket can be specified in parentheses. The full syntax of
7555 each item in &%mysql_servers%& is:
7556 .display
7557 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7558   <&'user'&>/<&'password'&>
7559 .endd
7560 Any of the three sub-parts of the first field can be omitted. For normal use on
7561 the local host it can be left blank or set to just &"localhost"&.
7562
7563 No database need be supplied &-- but if it is absent here, it must be given in
7564 the queries.
7565
7566 If a MySQL query is issued that does not request any data (an insert, update,
7567 or delete command), the result of the lookup is the number of rows affected.
7568
7569 &*Warning*&: This can be misleading. If an update does not actually change
7570 anything (for example, setting a field to the value it already has), the result
7571 is zero because no rows are affected.
7572
7573
7574 .section "Special PostgreSQL features" "SECID74"
7575 PostgreSQL lookups can also use Unix domain socket connections to the database.
7576 This is usually faster and costs less CPU time than a TCP/IP connection.
7577 However it can be used only if the mail server runs on the same machine as the
7578 database server. A configuration line for PostgreSQL via Unix domain sockets
7579 looks like this:
7580 .code
7581 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7582 .endd
7583 In other words, instead of supplying a host name, a path to the socket is
7584 given. The path name is enclosed in parentheses so that its slashes aren't
7585 visually confused with the delimiters for the other server parameters.
7586
7587 If a PostgreSQL query is issued that does not request any data (an insert,
7588 update, or delete command), the result of the lookup is the number of rows
7589 affected.
7590
7591 .section "More about SQLite" "SECTsqlite"
7592 .cindex "lookup" "SQLite"
7593 .cindex "sqlite lookup type"
7594 SQLite is different to the other SQL lookups because a file name is required in
7595 addition to the SQL query. An SQLite database is a single file, and there is no
7596 daemon as in the other SQL databases. The interface to Exim requires the name
7597 of the file, as an absolute path, to be given at the start of the query. It is
7598 separated from the query by white space. This means that the path name cannot
7599 contain white space. Here is a lookup expansion example:
7600 .code
7601 ${lookup sqlite {/some/thing/sqlitedb \
7602   select name from aliases where id='userx';}}
7603 .endd
7604 In a list, the syntax is similar. For example:
7605 .code
7606 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7607    select * from relays where ip='$sender_host_address';
7608 .endd
7609 The only character affected by the &%quote_sqlite%& operator is a single
7610 quote, which it doubles.
7611
7612 The SQLite library handles multiple simultaneous accesses to the database
7613 internally. Multiple readers are permitted, but only one process can
7614 update at once. Attempts to access the database while it is being updated
7615 are rejected after a timeout period, during which the SQLite library
7616 waits for the lock to be released. In Exim, the default timeout is set
7617 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7618 option.
7619 .ecindex IIDfidalo1
7620 .ecindex IIDfidalo2
7621
7622
7623 . ////////////////////////////////////////////////////////////////////////////
7624 . ////////////////////////////////////////////////////////////////////////////
7625
7626 .chapter "Domain, host, address, and local part lists" &&&
7627          "CHAPdomhosaddlists" &&&
7628          "Domain, host, and address lists"
7629 .scindex IIDdohoadli "lists of domains; hosts; etc."
7630 A number of Exim configuration options contain lists of domains, hosts,
7631 email addresses, or local parts. For example, the &%hold_domains%& option
7632 contains a list of domains whose delivery is currently suspended. These lists
7633 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7634 arguments to expansion conditions such as &%match_domain%&.
7635
7636 Each item in one of these lists is a pattern to be matched against a domain,
7637 host, email address, or local part, respectively. In the sections below, the
7638 different types of pattern for each case are described, but first we cover some
7639 general facilities that apply to all four kinds of list.
7640
7641
7642
7643 .section "Expansion of lists" "SECID75"
7644 .cindex "expansion" "of lists"
7645 Each list is expanded as a single string before it is used. The result of
7646 expansion must be a list, possibly containing empty items, which is split up
7647 into separate items for matching. By default, colon is the separator character,
7648 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7649 &<<SECTempitelis>>& for details of the list syntax; the second of these
7650 discusses the way to specify empty list items.
7651
7652
7653 If the string expansion is forced to fail, Exim behaves as if the item it is
7654 testing (domain, host, address, or local part) is not in the list. Other
7655 expansion failures cause temporary errors.
7656
7657 If an item in a list is a regular expression, backslashes, dollars and possibly
7658 other special characters in the expression must be protected against
7659 misinterpretation by the string expander. The easiest way to do this is to use
7660 the &`\N`& expansion feature to indicate that the contents of the regular
7661 expression should not be expanded. For example, in an ACL you might have:
7662 .code
7663 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7664                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7665 .endd
7666 The first item is a regular expression that is protected from expansion by
7667 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7668 senders based on the receiving domain.
7669
7670
7671
7672
7673 .section "Negated items in lists" "SECID76"
7674 .cindex "list" "negation"
7675 .cindex "negation" "in lists"
7676 Items in a list may be positive or negative. Negative items are indicated by a
7677 leading exclamation mark, which may be followed by optional white space. A list
7678 defines a set of items (domains, etc). When Exim processes one of these lists,
7679 it is trying to find out whether a domain, host, address, or local part
7680 (respectively) is in the set that is defined by the list. It works like this:
7681
7682 The list is scanned from left to right. If a positive item is matched, the
7683 subject that is being checked is in the set; if a negative item is matched, the
7684 subject is not in the set. If the end of the list is reached without the
7685 subject having matched any of the patterns, it is in the set if the last item
7686 was a negative one, but not if it was a positive one. For example, the list in
7687 .code
7688 domainlist relay_to_domains = !a.b.c : *.b.c
7689 .endd
7690 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7691 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7692 list is positive. However, if the setting were
7693 .code
7694 domainlist relay_to_domains = !a.b.c
7695 .endd
7696 then all domains other than &'a.b.c'& would match because the last item in the
7697 list is negative. In other words, a list that ends with a negative item behaves
7698 as if it had an extra item &`:*`& on the end.
7699
7700 Another way of thinking about positive and negative items in lists is to read
7701 the connector as &"or"& after a positive item and as &"and"& after a negative
7702 item.
7703
7704
7705
7706 .section "File names in lists" "SECTfilnamlis"
7707 .cindex "list" "file name in"
7708 If an item in a domain, host, address, or local part list is an absolute file
7709 name (beginning with a slash character), each line of the file is read and
7710 processed as if it were an independent item in the list, except that further
7711 file names are not allowed,
7712 and no expansion of the data from the file takes place.
7713 Empty lines in the file are ignored, and the file may also contain comment
7714 lines:
7715
7716 .ilist
7717 For domain and host lists, if a # character appears anywhere in a line of the
7718 file, it and all following characters are ignored.
7719 .next
7720 Because local parts may legitimately contain # characters, a comment in an
7721 address list or local part list file is recognized only if # is preceded by
7722 white space or the start of the line. For example:
7723 .code
7724 not#comment@x.y.z   # but this is a comment
7725 .endd
7726 .endlist
7727
7728 Putting a file name in a list has the same effect as inserting each line of the
7729 file as an item in the list (blank lines and comments excepted). However, there
7730 is one important difference: the file is read each time the list is processed,
7731 so if its contents vary over time, Exim's behaviour changes.
7732
7733 If a file name is preceded by an exclamation mark, the sense of any match
7734 within the file is inverted. For example, if
7735 .code
7736 hold_domains = !/etc/nohold-domains
7737 .endd
7738 and the file contains the lines
7739 .code
7740 !a.b.c
7741 *.b.c
7742 .endd
7743 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7744 any domain matching &`*.b.c`& is not.
7745
7746
7747
7748 .section "An lsearch file is not an out-of-line list" "SECID77"
7749 As will be described in the sections that follow, lookups can be used in lists
7750 to provide indexed methods of checking list membership. There has been some
7751 confusion about the way &(lsearch)& lookups work in lists. Because
7752 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7753 sometimes thought that it is allowed to contain wild cards and other kinds of
7754 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7755 always fixed strings, just as for any other single-key lookup type.
7756
7757 If you want to use a file to contain wild-card patterns that form part of a
7758 list, just give the file name on its own, without a search type, as described
7759 in the previous section. You could also use the &(wildlsearch)& or
7760 &(nwildlsearch)&, but there is no advantage in doing this.
7761
7762
7763
7764
7765 .section "Named lists" "SECTnamedlists"
7766 .cindex "named lists"
7767 .cindex "list" "named"
7768 A list of domains, hosts, email addresses, or local parts can be given a name
7769 which is then used to refer to the list elsewhere in the configuration. This is
7770 particularly convenient if the same list is required in several different
7771 places. It also allows lists to be given meaningful names, which can improve
7772 the readability of the configuration. For example, it is conventional to define
7773 a domain list called &'local_domains'& for all the domains that are handled
7774 locally on a host, using a configuration line such as
7775 .code
7776 domainlist local_domains = localhost:my.dom.example
7777 .endd
7778 Named lists are referenced by giving their name preceded by a plus sign, so,
7779 for example, a router that is intended to handle local domains would be
7780 configured with the line
7781 .code
7782 domains = +local_domains
7783 .endd
7784 The first router in a configuration is often one that handles all domains
7785 except the local ones, using a configuration with a negated item like this:
7786 .code
7787 dnslookup:
7788   driver = dnslookup
7789   domains = ! +local_domains
7790   transport = remote_smtp
7791   no_more
7792 .endd
7793 The four kinds of named list are created by configuration lines starting with
7794 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7795 respectively. Then there follows the name that you are defining, followed by an
7796 equals sign and the list itself. For example:
7797 .code
7798 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7799 addresslist bad_senders = cdb;/etc/badsenders
7800 .endd
7801 A named list may refer to other named lists:
7802 .code
7803 domainlist  dom1 = first.example : second.example
7804 domainlist  dom2 = +dom1 : third.example
7805 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7806 .endd
7807 &*Warning*&: If the last item in a referenced list is a negative one, the
7808 effect may not be what you intended, because the negation does not propagate
7809 out to the higher level. For example, consider:
7810 .code
7811 domainlist  dom1 = !a.b
7812 domainlist  dom2 = +dom1 : *.b
7813 .endd
7814 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7815 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7816 means it matches the second list as well. The effect is not the same as
7817 .code
7818 domainlist  dom2 = !a.b : *.b
7819 .endd
7820 where &'x.y'& does not match. It's best to avoid negation altogether in
7821 referenced lists if you can.
7822
7823 Named lists may have a performance advantage. When Exim is routing an
7824 address or checking an incoming message, it caches the result of tests on named
7825 lists. So, if you have a setting such as
7826 .code
7827 domains = +local_domains
7828 .endd
7829 on several of your routers
7830 or in several ACL statements,
7831 the actual test is done only for the first one. However, the caching works only
7832 if there are no expansions within the list itself or any sublists that it
7833 references. In other words, caching happens only for lists that are known to be
7834 the same each time they are referenced.
7835
7836 By default, there may be up to 16 named lists of each type. This limit can be
7837 extended by changing a compile-time variable. The use of domain and host lists
7838 is recommended for concepts such as local domains, relay domains, and relay
7839 hosts. The default configuration is set up like this.
7840
7841
7842
7843 .section "Named lists compared with macros" "SECID78"
7844 .cindex "list" "named compared with macro"
7845 .cindex "macro" "compared with named list"
7846 At first sight, named lists might seem to be no different from macros in the
7847 configuration file. However, macros are just textual substitutions. If you
7848 write
7849 .code
7850 ALIST = host1 : host2
7851 auth_advertise_hosts = !ALIST
7852 .endd
7853 it probably won't do what you want, because that is exactly the same as
7854 .code
7855 auth_advertise_hosts = !host1 : host2
7856 .endd
7857 Notice that the second host name is not negated. However, if you use a host
7858 list, and write
7859 .code
7860 hostlist alist = host1 : host2
7861 auth_advertise_hosts = ! +alist
7862 .endd
7863 the negation applies to the whole list, and so that is equivalent to
7864 .code
7865 auth_advertise_hosts = !host1 : !host2
7866 .endd
7867
7868
7869 .section "Named list caching" "SECID79"
7870 .cindex "list" "caching of named"
7871 .cindex "caching" "named lists"
7872 While processing a message, Exim caches the result of checking a named list if
7873 it is sure that the list is the same each time. In practice, this means that
7874 the cache operates only if the list contains no $ characters, which guarantees
7875 that it will not change when it is expanded. Sometimes, however, you may have
7876 an expanded list that you know will be the same each time within a given
7877 message. For example:
7878 .code
7879 domainlist special_domains = \
7880            ${lookup{$sender_host_address}cdb{/some/file}}
7881 .endd
7882 This provides a list of domains that depends only on the sending host's IP
7883 address. If this domain list is referenced a number of times (for example,
7884 in several ACL lines, or in several routers) the result of the check is not
7885 cached by default, because Exim does not know that it is going to be the
7886 same list each time.
7887
7888 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7889 cache the result anyway. For example:
7890 .code
7891 domainlist_cache special_domains = ${lookup{...
7892 .endd
7893 If you do this, you should be absolutely sure that caching is going to do
7894 the right thing in all cases. When in doubt, leave it out.
7895
7896
7897
7898 .section "Domain lists" "SECTdomainlist"
7899 .cindex "domain list" "patterns for"
7900 .cindex "list" "domain list"
7901 Domain lists contain patterns that are to be matched against a mail domain.
7902 The following types of item may appear in domain lists:
7903
7904 .ilist
7905 .cindex "primary host name"
7906 .cindex "host name" "matched in domain list"
7907 .oindex "&%primary_hostname%&"
7908 .cindex "domain list" "matching primary host name"
7909 .cindex "@ in a domain list"
7910 If a pattern consists of a single @ character, it matches the local host name,
7911 as set by the &%primary_hostname%& option (or defaulted). This makes it
7912 possible to use the same configuration file on several different hosts that
7913 differ only in their names.
7914 .next
7915 .cindex "@[] in a domain list"
7916 .cindex "domain list" "matching local IP interfaces"
7917 .cindex "domain literal"
7918 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7919 in square brackets (as in an email address that contains a domain literal), but
7920 only if that IP address is recognized as local for email routing purposes. The
7921 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7922 control which of a host's several IP addresses are treated as local.
7923 In today's Internet, the use of domain literals is controversial.
7924 .next
7925 .cindex "@mx_any"
7926 .cindex "@mx_primary"
7927 .cindex "@mx_secondary"
7928 .cindex "domain list" "matching MX pointers to local host"
7929 If a pattern consists of the string &`@mx_any`& it matches any domain that
7930 has an MX record pointing to the local host or to any host that is listed in
7931 .oindex "&%hosts_treat_as_local%&"
7932 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7933 are similar, except that the first matches only when a primary MX target is the
7934 local host, and the second only when no primary MX target is the local host,
7935 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7936 preference value &-- there may of course be more than one of them.
7937
7938 The MX lookup that takes place when matching a pattern of this type is
7939 performed with the resolver options for widening names turned off. Thus, for
7940 example, a single-component domain will &'not'& be expanded by adding the
7941 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7942 options of the &(dnslookup)& router for a discussion of domain widening.
7943
7944 Sometimes you may want to ignore certain IP addresses when using one of these
7945 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7946 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7947 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7948 on a router). For example:
7949 .code
7950 domains = @mx_any/ignore=127.0.0.1
7951 .endd
7952 This example matches any domain that has an MX record pointing to one of
7953 the local host's IP addresses other than 127.0.0.1.
7954
7955 The list of IP addresses is in fact processed by the same code that processes
7956 host lists, so it may contain CIDR-coded network specifications and it may also
7957 contain negative items.
7958
7959 Because the list of IP addresses is a sublist within a domain list, you have to
7960 be careful about delimiters if there is more than one address. Like any other
7961 list, the default delimiter can be changed. Thus, you might have:
7962 .code
7963 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7964           an.other.domain : ...
7965 .endd
7966 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7967 involved, it is easiest to change the delimiter for the main list as well:
7968 .code
7969 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7970           an.other.domain ? ...
7971 .endd
7972 .next
7973 .cindex "asterisk" "in domain list"
7974 .cindex "domain list" "asterisk in"
7975 .cindex "domain list" "matching &""ends with""&"
7976 If a pattern starts with an asterisk, the remaining characters of the pattern
7977 are compared with the terminating characters of the domain. The use of &"*"& in
7978 domain lists differs from its use in partial matching lookups. In a domain
7979 list, the character following the asterisk need not be a dot, whereas partial
7980 matching works only in terms of dot-separated components. For example, a domain
7981 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
7982 &'cipher.key.ex'&.
7983
7984 .next
7985 .cindex "regular expressions" "in domain list"
7986 .cindex "domain list" "matching regular expression"
7987 If a pattern starts with a circumflex character, it is treated as a regular
7988 expression, and matched against the domain using a regular expression matching
7989 function. The circumflex is treated as part of the regular expression.
7990 Email domains are case-independent, so this regular expression match is by
7991 default case-independent, but you can make it case-dependent by starting it
7992 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
7993 are given in chapter &<<CHAPregexp>>&.
7994
7995 &*Warning*&: Because domain lists are expanded before being processed, you
7996 must escape any backslash and dollar characters in the regular expression, or
7997 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
7998 it is not to be expanded (unless you really do want to build a regular
7999 expression by expansion, of course).
8000 .next
8001 .cindex "lookup" "in domain list"
8002 .cindex "domain list" "matching by lookup"
8003 If a pattern starts with the name of a single-key lookup type followed by a
8004 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8005 must be a file name in a suitable format for the lookup type. For example, for
8006 &"cdb;"& it must be an absolute path:
8007 .code
8008 domains = cdb;/etc/mail/local_domains.cdb
8009 .endd
8010 The appropriate type of lookup is done on the file using the domain name as the
8011 key. In most cases, the data that is looked up is not used; Exim is interested
8012 only in whether or not the key is present in the file. However, when a lookup
8013 is used for the &%domains%& option on a router
8014 or a &%domains%& condition in an ACL statement, the data is preserved in the
8015 &$domain_data$& variable and can be referred to in other router options or
8016 other statements in the same ACL.
8017
8018 .next
8019 Any of the single-key lookup type names may be preceded by
8020 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8021 .code
8022 domains = partial-dbm;/partial/domains
8023 .endd
8024 This causes partial matching logic to be invoked; a description of how this
8025 works is given in section &<<SECTpartiallookup>>&.
8026
8027 .next
8028 .cindex "asterisk" "in lookup type"
8029 Any of the single-key lookup types may be followed by an asterisk. This causes
8030 a default lookup for a key consisting of a single asterisk to be done if the
8031 original lookup fails. This is not a useful feature when using a domain list to
8032 select particular domains (because any domain would match), but it might have
8033 value if the result of the lookup is being used via the &$domain_data$&
8034 expansion variable.
8035 .next
8036 If the pattern starts with the name of a query-style lookup type followed by a
8037 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8038 pattern must be an appropriate query for the lookup type, as described in
8039 chapter &<<CHAPfdlookup>>&. For example:
8040 .code
8041 hold_domains = mysql;select domain from holdlist \
8042   where domain = '${quote_mysql:$domain}';
8043 .endd
8044 In most cases, the data that is looked up is not used (so for an SQL query, for
8045 example, it doesn't matter what field you select). Exim is interested only in
8046 whether or not the query succeeds. However, when a lookup is used for the
8047 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8048 variable and can be referred to in other options.
8049 .next
8050 .cindex "domain list" "matching literal domain name"
8051 If none of the above cases apply, a caseless textual comparison is made
8052 between the pattern and the domain.
8053 .endlist
8054
8055 Here is an example that uses several different kinds of pattern:
8056 .code
8057 domainlist funny_domains = \
8058   @ : \
8059   lib.unseen.edu : \
8060   *.foundation.fict.example : \
8061   \N^[1-2]\d{3}\.fict\.example$\N : \
8062   partial-dbm;/opt/data/penguin/book : \
8063   nis;domains.byname : \
8064   nisplus;[name=$domain,status=local],domains.org_dir
8065 .endd
8066 There are obvious processing trade-offs among the various matching modes. Using
8067 an asterisk is faster than a regular expression, and listing a few names
8068 explicitly probably is too. The use of a file or database lookup is expensive,
8069 but may be the only option if hundreds of names are required. Because the
8070 patterns are tested in order, it makes sense to put the most commonly matched
8071 patterns earlier.
8072
8073
8074
8075 .section "Host lists" "SECThostlist"
8076 .cindex "host list" "patterns in"
8077 .cindex "list" "host list"
8078 Host lists are used to control what remote hosts are allowed to do. For
8079 example, some hosts may be allowed to use the local host as a relay, and some
8080 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8081 two different ways, by name or by IP address. In a host list, some types of
8082 pattern are matched to a host name, and some are matched to an IP address.
8083 You need to be particularly careful with this when single-key lookups are
8084 involved, to ensure that the right value is being used as the key.
8085
8086
8087 .section "Special host list patterns" "SECID80"
8088 .cindex "empty item in hosts list"
8089 .cindex "host list" "empty string in"
8090 If a host list item is the empty string, it matches only when no remote host is
8091 involved. This is the case when a message is being received from a local
8092 process using SMTP on the standard input, that is, when a TCP/IP connection is
8093 not used.
8094
8095 .cindex "asterisk" "in host list"
8096 The special pattern &"*"& in a host list matches any host or no host. Neither
8097 the IP address nor the name is actually inspected.
8098
8099
8100
8101 .section "Host list patterns that match by IP address" "SECThoslispatip"
8102 .cindex "host list" "matching IP addresses"
8103 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8104 the incoming address actually appears in the IPv6 host as
8105 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8106 list, it is converted into a traditional IPv4 address first. (Not all operating
8107 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8108 concerns.)
8109
8110 The following types of pattern in a host list check the remote host by
8111 inspecting its IP address:
8112
8113 .ilist
8114 If the pattern is a plain domain name (not a regular expression, not starting
8115 with *, not a lookup of any kind), Exim calls the operating system function
8116 to find the associated IP address(es). Exim uses the newer
8117 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8118 This typically causes a forward DNS lookup of the name. The result is compared
8119 with the IP address of the subject host.
8120
8121 If there is a temporary problem (such as a DNS timeout) with the host name
8122 lookup, a temporary error occurs. For example, if the list is being used in an
8123 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8124 temporary SMTP error code. If no IP address can be found for the host name,
8125 what happens is described in section &<<SECTbehipnot>>& below.
8126
8127 .next
8128 .cindex "@ in a host list"
8129 If the pattern is &"@"&, the primary host name is substituted and used as a
8130 domain name, as just described.
8131
8132 .next
8133 If the pattern is an IP address, it is matched against the IP address of the
8134 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8135 IPv6 addresses can be given in colon-separated format, but the colons have to
8136 be doubled so as not to be taken as item separators when the default list
8137 separator is used. IPv6 addresses are recognized even when Exim is compiled
8138 without IPv6 support. This means that if they appear in a host list on an
8139 IPv4-only host, Exim will not treat them as host names. They are just addresses
8140 that can never match a client host.
8141
8142 .next
8143 .cindex "@[] in a host list"
8144 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8145 the local host. For example, if the local host is an IPv4 host with one
8146 interface address 10.45.23.56, these two ACL statements have the same effect:
8147 .code
8148 accept hosts = 127.0.0.1 : 10.45.23.56
8149 accept hosts = @[]
8150 .endd
8151 .next
8152 .cindex "CIDR notation"
8153 If the pattern is an IP address followed by a slash and a mask length (for
8154 example 10.11.42.0/24), it is matched against the IP address of the subject
8155 host under the given mask. This allows, an entire network of hosts to be
8156 included (or excluded) by a single item. The mask uses CIDR notation; it
8157 specifies the number of address bits that must match, starting from the most
8158 significant end of the address.
8159
8160 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8161 of a range of addresses. It is the number of bits in the network portion of the
8162 address. The above example specifies a 24-bit netmask, so it matches all 256
8163 addresses in the 10.11.42.0 network. An item such as
8164 .code
8165 192.168.23.236/31
8166 .endd
8167 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8168 32 for an IPv4 address is the same as no mask at all; just a single address
8169 matches.
8170
8171 Here is another example which shows an IPv4 and an IPv6 network:
8172 .code
8173 recipient_unqualified_hosts = 192.168.0.0/16: \
8174                               3ffe::ffff::836f::::/48
8175 .endd
8176 The doubling of list separator characters applies only when these items
8177 appear inline in a host list. It is not required when indirecting via a file.
8178 For example:
8179 .code
8180 recipient_unqualified_hosts = /opt/exim/unqualnets
8181 .endd
8182 could make use of a file containing
8183 .code
8184 172.16.0.0/12
8185 3ffe:ffff:836f::/48
8186 .endd
8187 to have exactly the same effect as the previous example. When listing IPv6
8188 addresses inline, it is usually more convenient to use the facility for
8189 changing separator characters. This list contains the same two networks:
8190 .code
8191 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8192                                  3ffe:ffff:836f::/48
8193 .endd
8194 The separator is changed to semicolon by the leading &"<;"& at the start of the
8195 list.
8196 .endlist
8197
8198
8199
8200 .section "Host list patterns for single-key lookups by host address" &&&
8201          "SECThoslispatsikey"
8202 .cindex "host list" "lookup of IP address"
8203 When a host is to be identified by a single-key lookup of its complete IP
8204 address, the pattern takes this form:
8205 .display
8206 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8207 .endd
8208 For example:
8209 .code
8210 hosts_lookup = net-cdb;/hosts-by-ip.db
8211 .endd
8212 The text form of the IP address of the subject host is used as the lookup key.
8213 IPv6 addresses are converted to an unabbreviated form, using lower case
8214 letters, with dots as separators because colon is the key terminator in
8215 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8216 quoting the keys, but this is a facility that was added later.] The data
8217 returned by the lookup is not used.
8218
8219 .cindex "IP address" "masking"
8220 .cindex "host list" "masked IP address"
8221 Single-key lookups can also be performed using masked IP addresses, using
8222 patterns of this form:
8223 .display
8224 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8225 .endd
8226 For example:
8227 .code
8228 net24-dbm;/networks.db
8229 .endd
8230 The IP address of the subject host is masked using <&'number'&> as the mask
8231 length. A textual string is constructed from the masked value, followed by the
8232 mask, and this is used as the lookup key. For example, if the host's IP address
8233 is 192.168.34.6, the key that is looked up for the above example is
8234 &"192.168.34.0/24"&.
8235
8236 When an IPv6 address is converted to a string, dots are normally used instead
8237 of colons, so that keys in &(lsearch)& files need not contain colons (which
8238 terminate &(lsearch)& keys). This was implemented some time before the ability
8239 to quote keys was made available in &(lsearch)& files. However, the more
8240 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8241 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8242 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8243 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8244 addresses are always used.
8245
8246 Ideally, it would be nice to tidy up this anomalous situation by changing to
8247 colons in all cases, given that quoting is now available for &(lsearch)&.
8248 However, this would be an incompatible change that might break some existing
8249 configurations.
8250
8251 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8252 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8253 the former case the key strings include the mask value, whereas in the latter
8254 case the IP address is used on its own.
8255
8256
8257
8258 .section "Host list patterns that match by host name" "SECThoslispatnam"
8259 .cindex "host" "lookup failures"
8260 .cindex "unknown host name"
8261 .cindex "host list" "matching host name"
8262 There are several types of pattern that require Exim to know the name of the
8263 remote host. These are either wildcard patterns or lookups by name. (If a
8264 complete hostname is given without any wildcarding, it is used to find an IP
8265 address to match against, as described in section &<<SECThoslispatip>>&
8266 above.)
8267
8268 If the remote host name is not already known when Exim encounters one of these
8269 patterns, it has to be found from the IP address.
8270 Although many sites on the Internet are conscientious about maintaining reverse
8271 DNS data for their hosts, there are also many that do not do this.
8272 Consequently, a name cannot always be found, and this may lead to unwanted
8273 effects. Take care when configuring host lists with wildcarded name patterns.
8274 Consider what will happen if a name cannot be found.
8275
8276 Because of the problems of determining host names from IP addresses, matching
8277 against host names is not as common as matching against IP addresses.
8278
8279 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8280 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8281 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8282 are done can be changed by setting the &%host_lookup_order%& option. For
8283 security, once Exim has found one or more names, it looks up the IP addresses
8284 for these names and compares them with the IP address that it started with.
8285 Only those names whose IP addresses match are accepted. Any other names are
8286 discarded. If no names are left, Exim behaves as if the host name cannot be
8287 found. In the most common case there is only one name and one IP address.
8288
8289 There are some options that control what happens if a host name cannot be
8290 found. These are described in section &<<SECTbehipnot>>& below.
8291
8292 .cindex "host" "alias for"
8293 .cindex "alias for host"
8294 As a result of aliasing, hosts may have more than one name. When processing any
8295 of the following types of pattern, all the host's names are checked:
8296
8297 .ilist
8298 .cindex "asterisk" "in host list"
8299 If a pattern starts with &"*"& the remainder of the item must match the end of
8300 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8301 &'.b.c'&. This special simple form is provided because this is a very common
8302 requirement. Other kinds of wildcarding require the use of a regular
8303 expression.
8304 .next
8305 .cindex "regular expressions" "in host list"
8306 .cindex "host list" "regular expression in"
8307 If the item starts with &"^"& it is taken to be a regular expression which is
8308 matched against the host name. Host names are case-independent, so this regular
8309 expression match is by default case-independent, but you can make it
8310 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8311 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8312 example,
8313 .code
8314 ^(a|b)\.c\.d$
8315 .endd
8316 is a regular expression that matches either of the two hosts &'a.c.d'& or
8317 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8318 that backslash and dollar characters are not misinterpreted as part of the
8319 string expansion. The simplest way to do this is to use &`\N`& to mark that
8320 part of the string as non-expandable. For example:
8321 .code
8322 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8323 .endd
8324 &*Warning*&: If you want to match a complete host name, you must include the
8325 &`$`& terminating metacharacter in the regular expression, as in the above
8326 example. Without it, a match at the start of the host name is all that is
8327 required.
8328 .endlist
8329
8330
8331
8332
8333 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8334 .cindex "host" "lookup failures, permanent"
8335 While processing a host list, Exim may need to look up an IP address from a
8336 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8337 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8338 behaviour when it fails to find the information it is seeking is the same.
8339
8340 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8341 apply to temporary DNS errors, whose handling is described in the next section.
8342
8343 .cindex "&`+include_unknown`&"
8344 .cindex "&`+ignore_unknown`&"
8345 Exim parses a host list from left to right. If it encounters a permanent
8346 lookup failure in any item in the host list before it has found a match,
8347 Exim treats it as a failure and the default behavior is as if the host
8348 does not match the list. This may not always be what you want to happen.
8349 To change Exim's behaviour, the special items &`+include_unknown`& or
8350 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8351 not recognized in an indirected file).
8352
8353 .ilist
8354 If any item that follows &`+include_unknown`& requires information that
8355 cannot found, Exim behaves as if the host does match the list. For example,
8356 .code
8357 host_reject_connection = +include_unknown:*.enemy.ex
8358 .endd
8359 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8360 any hosts whose name it cannot find.
8361
8362 .next
8363 If any item that follows &`+ignore_unknown`& requires information that cannot
8364 be found, Exim ignores that item and proceeds to the rest of the list. For
8365 example:
8366 .code
8367 accept hosts = +ignore_unknown : friend.example : \
8368                192.168.4.5
8369 .endd
8370 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8371 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8372 name can be found for 192.168.4.5, it is rejected.
8373 .endlist
8374
8375 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8376 list. The effect of each one lasts until the next, or until the end of the
8377 list.
8378
8379 .section "Mixing wildcarded host names and addresses in host lists" &&&
8380          "SECTmixwilhos"
8381 .cindex "host list" "mixing names and addresses in"
8382
8383 This section explains the host/ip processing logic with the same concepts
8384 as the previous section, but specifically addresses what happens when a
8385 wildcarded hostname is one of the items in the hostlist.
8386
8387 .ilist
8388 If you have name lookups or wildcarded host names and
8389 IP addresses in the same host list, you should normally put the IP
8390 addresses first. For example, in an ACL you could have:
8391 .code
8392 accept hosts = 10.9.8.7 : *.friend.example
8393 .endd
8394 The reason you normally would order it this way lies in the
8395 left-to-right way that Exim processes lists.  It can test IP addresses
8396 without doing any DNS lookups, but when it reaches an item that requires
8397 a host name, it fails if it cannot find a host name to compare with the
8398 pattern. If the above list is given in the opposite order, the
8399 &%accept%& statement fails for a host whose name cannot be found, even
8400 if its IP address is 10.9.8.7.
8401
8402 .next
8403 If you really do want to do the name check first, and still recognize the IP
8404 address, you can rewrite the ACL like this:
8405 .code
8406 accept hosts = *.friend.example
8407 accept hosts = 10.9.8.7
8408 .endd
8409 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8410 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8411 &`+ignore_unknown`&, which was discussed in depth in the first example in
8412 this section.
8413 .endlist
8414
8415
8416 .section "Temporary DNS errors when looking up host information" &&&
8417          "SECTtemdnserr"
8418 .cindex "host" "lookup failures, temporary"
8419 .cindex "&`+include_defer`&"
8420 .cindex "&`+ignore_defer`&"
8421 A temporary DNS lookup failure normally causes a defer action (except when
8422 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8423 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8424 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8425 section. These options should be used with care, probably only in non-critical
8426 host lists such as whitelists.
8427
8428
8429
8430 .section "Host list patterns for single-key lookups by host name" &&&
8431          "SECThoslispatnamsk"
8432 .cindex "unknown host name"
8433 .cindex "host list" "matching host name"
8434 If a pattern is of the form
8435 .display
8436 <&'single-key-search-type'&>;<&'search-data'&>
8437 .endd
8438 for example
8439 .code
8440 dbm;/host/accept/list
8441 .endd
8442 a single-key lookup is performed, using the host name as its key. If the
8443 lookup succeeds, the host matches the item. The actual data that is looked up
8444 is not used.
8445
8446 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8447 keys in the file, not IP addresses. If you want to do lookups based on IP
8448 addresses, you must precede the search type with &"net-"& (see section
8449 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8450 two items in the same list, one doing an address lookup and one doing a name
8451 lookup, both using the same file.
8452
8453
8454
8455 .section "Host list patterns for query-style lookups" "SECID81"
8456 If a pattern is of the form
8457 .display
8458 <&'query-style-search-type'&>;<&'query'&>
8459 .endd
8460 the query is obeyed, and if it succeeds, the host matches the item. The actual
8461 data that is looked up is not used. The variables &$sender_host_address$& and
8462 &$sender_host_name$& can be used in the query. For example:
8463 .code
8464 hosts_lookup = pgsql;\
8465   select ip from hostlist where ip='$sender_host_address'
8466 .endd
8467 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8468 can use the &%sg%& expansion item to change this if you need to. If you want to
8469 use masked IP addresses in database queries, you can use the &%mask%& expansion
8470 operator.
8471
8472 If the query contains a reference to &$sender_host_name$&, Exim automatically
8473 looks up the host name if it has not already done so. (See section
8474 &<<SECThoslispatnam>>& for comments on finding host names.)
8475
8476 Historical note: prior to release 4.30, Exim would always attempt to find a
8477 host name before running the query, unless the search type was preceded by
8478 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8479 still recognized for query-style lookups, but its presence or absence has no
8480 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8481 See section &<<SECThoslispatsikey>>&.)
8482
8483
8484
8485
8486
8487 .section "Address lists" "SECTaddresslist"
8488 .cindex "list" "address list"
8489 .cindex "address list" "empty item"
8490 .cindex "address list" "patterns"
8491 Address lists contain patterns that are matched against mail addresses. There
8492 is one special case to be considered: the sender address of a bounce message is
8493 always empty. You can test for this by providing an empty item in an address
8494 list. For example, you can set up a router to process bounce messages by
8495 using this option setting:
8496 .code
8497 senders = :
8498 .endd
8499 The presence of the colon creates an empty item. If you do not provide any
8500 data, the list is empty and matches nothing. The empty sender can also be
8501 detected by a regular expression that matches an empty string,
8502 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8503
8504 Non-empty items in an address list can be straightforward email addresses. For
8505 example:
8506 .code
8507 senders = jbc@askone.example : hs@anacreon.example
8508 .endd
8509 A certain amount of wildcarding is permitted. If a pattern contains an @
8510 character, but is not a regular expression and does not begin with a
8511 semicolon-terminated lookup type (described below), the local part of the
8512 subject address is compared with the local part of the pattern, which may start
8513 with an asterisk. If the local parts match, the domain is checked in exactly
8514 the same way as for a pattern in a domain list. For example, the domain can be
8515 wildcarded, refer to a named list, or be a lookup:
8516 .code
8517 deny senders = *@*.spamming.site:\
8518                *@+hostile_domains:\
8519                bozo@partial-lsearch;/list/of/dodgy/sites:\
8520                *@dbm;/bad/domains.db
8521 .endd
8522 .cindex "local part" "starting with !"
8523 .cindex "address list" "local part starting with !"
8524 If a local part that begins with an exclamation mark is required, it has to be
8525 specified using a regular expression, because otherwise the exclamation mark is
8526 treated as a sign of negation, as is standard in lists.
8527
8528 If a non-empty pattern that is not a regular expression or a lookup does not
8529 contain an @ character, it is matched against the domain part of the subject
8530 address. The only two formats that are recognized this way are a literal
8531 domain, or a domain pattern that starts with *. In both these cases, the effect
8532 is the same as if &`*@`& preceded the pattern. For example:
8533 .code
8534 deny senders = enemy.domain : *.enemy.domain
8535 .endd
8536
8537 The following kinds of more complicated address list pattern can match any
8538 address, including the empty address that is characteristic of bounce message
8539 senders:
8540
8541 .ilist
8542 .cindex "regular expressions" "in address list"
8543 .cindex "address list" "regular expression in"
8544 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8545 done against the complete address, with the pattern as the regular expression.
8546 You must take care that backslash and dollar characters are not misinterpreted
8547 as part of the string expansion. The simplest way to do this is to use &`\N`&
8548 to mark that part of the string as non-expandable. For example:
8549 .code
8550 deny senders = \N^.*this.*@example\.com$\N : \
8551                \N^\d{8}.+@spamhaus.example$\N : ...
8552 .endd
8553 The &`\N`& sequences are removed by the expansion, so these items do indeed
8554 start with &"^"& by the time they are being interpreted as address patterns.
8555
8556 .next
8557 .cindex "address list" "lookup for complete address"
8558 Complete addresses can be looked up by using a pattern that starts with a
8559 lookup type terminated by a semicolon, followed by the data for the lookup. For
8560 example:
8561 .code
8562 deny senders = cdb;/etc/blocked.senders : \
8563   mysql;select address from blocked where \
8564   address='${quote_mysql:$sender_address}'
8565 .endd
8566 Both query-style and single-key lookup types can be used. For a single-key
8567 lookup type, Exim uses the complete address as the key. However, empty keys are
8568 not supported for single-key lookups, so a match against the empty address
8569 always fails. This restriction does not apply to query-style lookups.
8570
8571 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8572 cannot be used, and is ignored if specified, with an entry being written to the
8573 panic log.
8574 .cindex "*@ with single-key lookup"
8575 However, you can configure lookup defaults, as described in section
8576 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8577 default. For example, with this lookup:
8578 .code
8579 accept senders = lsearch*@;/some/file
8580 .endd
8581 the file could contains lines like this:
8582 .code
8583 user1@domain1.example
8584 *@domain2.example
8585 .endd
8586 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8587 that are tried is:
8588 .code
8589 nimrod@jaeger.example
8590 *@jaeger.example
8591 *
8592 .endd
8593 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8594 would mean that every address matches, thus rendering the test useless.
8595
8596 &*Warning 2*&: Do not confuse these two kinds of item:
8597 .code
8598 deny recipients = dbm*@;/some/file
8599 deny recipients = *@dbm;/some/file
8600 .endd
8601 The first does a whole address lookup, with defaulting, as just described,
8602 because it starts with a lookup type. The second matches the local part and
8603 domain independently, as described in a bullet point below.
8604 .endlist
8605
8606
8607 The following kinds of address list pattern can match only non-empty addresses.
8608 If the subject address is empty, a match against any of these pattern types
8609 always fails.
8610
8611
8612 .ilist
8613 .cindex "@@ with single-key lookup"
8614 .cindex "address list" "@@ lookup type"
8615 .cindex "address list" "split local part and domain"
8616 If a pattern starts with &"@@"& followed by a single-key lookup item
8617 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8618 split into a local part and a domain. The domain is looked up in the file. If
8619 it is not found, there is no match. If it is found, the data that is looked up
8620 from the file is treated as a colon-separated list of local part patterns, each
8621 of which is matched against the subject local part in turn.
8622
8623 .cindex "asterisk" "in address list"
8624 The lookup may be a partial one, and/or one involving a search for a default
8625 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8626 patterns that are looked up can be regular expressions or begin with &"*"&, or
8627 even be further lookups. They may also be independently negated. For example,
8628 with
8629 .code
8630 deny senders = @@dbm;/etc/reject-by-domain
8631 .endd
8632 the data from which the DBM file is built could contain lines like
8633 .code
8634 baddomain.com:  !postmaster : *
8635 .endd
8636 to reject all senders except &%postmaster%& from that domain.
8637
8638 .cindex "local part" "starting with !"
8639 If a local part that actually begins with an exclamation mark is required, it
8640 has to be specified using a regular expression. In &(lsearch)& files, an entry
8641 may be split over several lines by indenting the second and subsequent lines,
8642 but the separating colon must still be included at line breaks. White space
8643 surrounding the colons is ignored. For example:
8644 .code
8645 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8646   spammer3 : spammer4
8647 .endd
8648 As in all colon-separated lists in Exim, a colon can be included in an item by
8649 doubling.
8650
8651 If the last item in the list starts with a right angle-bracket, the remainder
8652 of the item is taken as a new key to look up in order to obtain a continuation
8653 list of local parts. The new key can be any sequence of characters. Thus one
8654 might have entries like
8655 .code
8656 aol.com: spammer1 : spammer 2 : >*
8657 xyz.com: spammer3 : >*
8658 *:       ^\d{8}$
8659 .endd
8660 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8661 local parts for all domains, in addition to the specific local parts listed for
8662 each domain. Of course, using this feature costs another lookup each time a
8663 chain is followed, but the effort needed to maintain the data is reduced.
8664
8665 .cindex "loop" "in lookups"
8666 It is possible to construct loops using this facility, and in order to catch
8667 them, the chains may be no more than fifty items long.
8668
8669 .next
8670 The @@<&'lookup'&> style of item can also be used with a query-style
8671 lookup, but in this case, the chaining facility is not available. The lookup
8672 can only return a single list of local parts.
8673 .endlist
8674
8675 &*Warning*&: There is an important difference between the address list items
8676 in these two examples:
8677 .code
8678 senders = +my_list
8679 senders = *@+my_list
8680 .endd
8681 In the first one, &`my_list`& is a named address list, whereas in the second
8682 example it is a named domain list.
8683
8684
8685
8686
8687 .section "Case of letters in address lists" "SECTcasletadd"
8688 .cindex "case of local parts"
8689 .cindex "address list" "case forcing"
8690 .cindex "case forcing in address lists"
8691 Domains in email addresses are always handled caselessly, but for local parts
8692 case may be significant on some systems (see &%caseful_local_part%& for how
8693 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8694 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8695 blocking lists should be done in a case-independent manner. Since most address
8696 lists in Exim are used for this kind of control, Exim attempts to do this by
8697 default.
8698
8699 The domain portion of an address is always lowercased before matching it to an
8700 address list. The local part is lowercased by default, and any string
8701 comparisons that take place are done caselessly. This means that the data in
8702 the address list itself, in files included as plain file names, and in any file
8703 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8704 keys in files that are looked up by a search type other than &(lsearch)& (which
8705 works caselessly) must be in lower case, because these lookups are not
8706 case-independent.
8707
8708 .cindex "&`+caseful`&"
8709 To allow for the possibility of caseful address list matching, if an item in
8710 an address list is the string &"+caseful"&, the original case of the local
8711 part is restored for any comparisons that follow, and string comparisons are no
8712 longer case-independent. This does not affect the domain, which remains in
8713 lower case. However, although independent matches on the domain alone are still
8714 performed caselessly, regular expressions that match against an entire address
8715 become case-sensitive after &"+caseful"& has been seen.
8716
8717
8718
8719 .section "Local part lists" "SECTlocparlis"
8720 .cindex "list" "local part list"
8721 .cindex "local part" "list"
8722 Case-sensitivity in local part lists is handled in the same way as for address
8723 lists, as just described. The &"+caseful"& item can be used if required. In a
8724 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8725 set false, the subject is lowercased and the matching is initially
8726 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8727 matching in the local part list, but not elsewhere in the router. If
8728 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8729 option is case-sensitive from the start.
8730
8731 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8732 comments are handled in the same way as address lists &-- they are recognized
8733 only if the # is preceded by white space or the start of the line.
8734 Otherwise, local part lists are matched in the same way as domain lists, except
8735 that the special items that refer to the local host (&`@`&, &`@[]`&,
8736 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8737 Refer to section &<<SECTdomainlist>>& for details of the other available item
8738 types.
8739 .ecindex IIDdohoadli
8740
8741
8742
8743
8744 . ////////////////////////////////////////////////////////////////////////////
8745 . ////////////////////////////////////////////////////////////////////////////
8746
8747 .chapter "String expansions" "CHAPexpand"
8748 .scindex IIDstrexp "expansion" "of strings"
8749 Many strings in Exim's run time configuration are expanded before use. Some of
8750 them are expanded every time they are used; others are expanded only once.
8751
8752 When a string is being expanded it is copied verbatim from left to right except
8753 when a dollar or backslash character is encountered. A dollar specifies the
8754 start of a portion of the string that is interpreted and replaced as described
8755 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8756 escape character, as described in the following section.
8757
8758 Whether a string is expanded depends upon the context.  Usually this is solely
8759 dependent upon the option for which a value is sought; in this documentation,
8760 options for which string expansion is performed are marked with &dagger; after
8761 the data type.  ACL rules always expand strings.  A couple of expansion
8762 conditions do not expand some of the brace-delimited branches, for security
8763 reasons.
8764
8765
8766
8767 .section "Literal text in expanded strings" "SECTlittext"
8768 .cindex "expansion" "including literal text"
8769 An uninterpreted dollar can be included in an expanded string by putting a
8770 backslash in front of it. A backslash can be used to prevent any special
8771 character being treated specially in an expansion, including backslash itself.
8772 If the string appears in quotes in the configuration file, two backslashes are
8773 required because the quotes themselves cause interpretation of backslashes when
8774 the string is read in (see section &<<SECTstrings>>&).
8775
8776 .cindex "expansion" "non-expandable substrings"
8777 A portion of the string can specified as non-expandable by placing it between
8778 two occurrences of &`\N`&. This is particularly useful for protecting regular
8779 expressions, which often contain backslashes and dollar signs. For example:
8780 .code
8781 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8782 .endd
8783 On encountering the first &`\N`&, the expander copies subsequent characters
8784 without interpretation until it reaches the next &`\N`& or the end of the
8785 string.
8786
8787
8788
8789 .section "Character escape sequences in expanded strings" "SECID82"
8790 .cindex "expansion" "escape sequences"
8791 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8792 expanded string is recognized as an escape sequence for the character newline,
8793 carriage return, or tab, respectively. A backslash followed by up to three
8794 octal digits is recognized as an octal encoding for a single character, and a
8795 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8796 encoding.
8797
8798 These escape sequences are also recognized in quoted strings when they are read
8799 in. Their interpretation in expansions as well is useful for unquoted strings,
8800 and for other cases such as looked-up strings that are then expanded.
8801
8802
8803 .section "Testing string expansions" "SECID83"
8804 .cindex "expansion" "testing"
8805 .cindex "testing" "string expansion"
8806 .oindex "&%-be%&"
8807 Many expansions can be tested by calling Exim with the &%-be%& option. This
8808 takes the command arguments, or lines from the standard input if there are no
8809 arguments, runs them through the string expansion code, and writes the results
8810 to the standard output. Variables based on configuration values are set up, but
8811 since no message is being processed, variables such as &$local_part$& have no
8812 value. Nevertheless the &%-be%& option can be useful for checking out file and
8813 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8814 and &%nhash%&.
8815
8816 Exim gives up its root privilege when it is called with the &%-be%& option, and
8817 instead runs under the uid and gid it was called with, to prevent users from
8818 using &%-be%& for reading files to which they do not have access.
8819
8820 .oindex "&%-bem%&"
8821 If you want to test expansions that include variables whose values are taken
8822 from a message, there are two other options that can be used. The &%-bem%&
8823 option is like &%-be%& except that it is followed by a file name. The file is
8824 read as a message before doing the test expansions. For example:
8825 .code
8826 exim -bem /tmp/test.message '$h_subject:'
8827 .endd
8828 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8829 Exim message identifier. For example:
8830 .code
8831 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8832 .endd
8833 This loads the message from Exim's spool before doing the test expansions, and
8834 is therefore restricted to admin users.
8835
8836
8837 .section "Forced expansion failure" "SECTforexpfai"
8838 .cindex "expansion" "forced failure"
8839 A number of expansions that are described in the following section have
8840 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8841 (which are sometimes called &"curly brackets"&). Which of the two strings is
8842 used depends on some condition that is evaluated as part of the expansion. If,
8843 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8844 the entire string expansion fails in a way that can be detected by the code
8845 that requested the expansion. This is called &"forced expansion failure"&, and
8846 its consequences depend on the circumstances. In some cases it is no different
8847 from any other expansion failure, but in others a different action may be
8848 taken. Such variations are mentioned in the documentation of the option that is
8849 being expanded.
8850
8851
8852
8853
8854 .section "Expansion items" "SECTexpansionitems"
8855 The following items are recognized in expanded strings. White space may be used
8856 between sub-items that are keywords or substrings enclosed in braces inside an
8857 outer set of braces, to improve readability. &*Warning*&: Within braces,
8858 white space is significant.
8859
8860 .vlist
8861 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8862 .cindex "expansion" "variables"
8863 Substitute the contents of the named variable, for example:
8864 .code
8865 $local_part
8866 ${domain}
8867 .endd
8868 The second form can be used to separate the name from subsequent alphanumeric
8869 characters. This form (using braces) is available only for variables; it does
8870 &'not'& apply to message headers. The names of the variables are given in
8871 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8872 given, the expansion fails.
8873
8874 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8875 .cindex "expansion" "operators"
8876 The string is first itself expanded, and then the operation specified by
8877 <&'op'&> is applied to it. For example:
8878 .code
8879 ${lc:$local_part}
8880 .endd
8881 The string starts with the first character after the colon, which may be
8882 leading white space. A list of operators is given in section &<<SECTexpop>>&
8883 below. The operator notation is used for simple expansion items that have just
8884 one argument, because it reduces the number of braces and therefore makes the
8885 string easier to understand.
8886
8887 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8888 This item inserts &"basic"& header lines. It is described with the &%header%&
8889 expansion item below.
8890
8891
8892 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8893 .cindex "expansion" "calling an acl"
8894 .cindex "&%acl%&" "call from expansion"
8895 The name and zero to nine argument strings are first expanded separately.  The expanded
8896 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8897 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8898 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8899 and may use the variables; if another acl expansion is used the values
8900 are restored after it returns.  If the ACL sets
8901 a value using a "message =" modifier and returns accept or deny, the value becomes
8902 the result of the expansion.
8903 If no message is set and the ACL returns accept or deny
8904 the expansion result is an empty string.
8905 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8906
8907
8908 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8909        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8910 .cindex "expansion" "extracting cerificate fields"
8911 .cindex "&%certextract%&" "certificate fields"
8912 .cindex "certificate" "extracting fields"
8913 The <&'certificate'&> must be a variable of type certificate.
8914 The field name is expanded and used to retrive the relevant field from
8915 the certificate.  Supported fields are:
8916 .display
8917 &`version        `&
8918 &`serial_number  `&
8919 &`subject        `& RFC4514 DN
8920 &`issuer         `& RFC4514 DN
8921 &`notbefore      `& time
8922 &`notafter       `& time
8923 &`sig_algorithm  `&
8924 &`signature      `&
8925 &`subj_altname   `& tagged list
8926 &`ocsp_uri       `& list
8927 &`crl_uri        `& list
8928 .endd
8929 If the field is found,
8930 <&'string2'&> is expanded, and replaces the whole item;
8931 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8932 variable &$value$& contains the value that has been extracted. Afterwards, it
8933 is restored to any previous value it might have had.
8934
8935 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8936 key is not found. If {<&'string2'&>} is also omitted, the value that was
8937 extracted is used.
8938
8939 Some field names take optional modifiers, appended and separated by commas.
8940
8941 The field selectors marked as "RFC4514" above
8942 output a Distinguished Name string which is
8943 not quite
8944 parseable by Exim as a comma-separated tagged list
8945 (the exceptions being elements containin commas).
8946 RDN elements of a single type may be selected by
8947 a modifier of the type label; if so the expansion
8948 result is a list (newline-separated by default).
8949 The separator may be changed by another modifer of
8950 a right angle-bracket followed immediately by the new separator.
8951 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8952
8953 The field selectors marked as "time" above
8954 take an optional modifier of "int"
8955 for which the result is the number of seconds since epoch.
8956 Otherwise the result is a human-readable string
8957 in the timezone selected by the main "timezone" option.
8958
8959 The field selectors marked as "list" above return a list,
8960 newline-separated by default,
8961 (embedded separator characters in elements are doubled).
8962 The separator may be changed by a modifier of
8963 a right angle-bracket followed immediately by the new separator.
8964
8965 The field selectors marked as "tagged" above
8966 prefix each list element with a type string and an equals sign.
8967 Elements of only one type may be selected by a modifier
8968 which is one of "dns", "uri" or "mail";
8969 if so the elenment tags are omitted.
8970
8971 If not otherwise noted field values are presented in human-readable form.
8972
8973 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8974        {*&<&'arg'&>&*}...}*&"
8975 .cindex &%dlfunc%&
8976 This expansion dynamically loads and then calls a locally-written C function.
8977 This functionality is available only if Exim is compiled with
8978 .code
8979 EXPAND_DLFUNC=yes
8980 .endd
8981 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
8982 object so that it doesn't reload the same object file in the same Exim process
8983 (but of course Exim does start new processes frequently).
8984
8985 There may be from zero to eight arguments to the function. When compiling
8986 a local function that is to be called in this way, &_local_scan.h_& should be
8987 included. The Exim variables and functions that are defined by that API
8988 are also available for dynamically loaded functions. The function itself
8989 must have the following type:
8990 .code
8991 int dlfunction(uschar **yield, int argc, uschar *argv[])
8992 .endd
8993 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
8994 function should return one of the following values:
8995
8996 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
8997 into the expanded string that is being built.
8998
8999 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9000 from &'yield'&, if it is set.
9001
9002 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9003 taken from &'yield'& if it is set.
9004
9005 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9006
9007 When compiling a function that is to be used in this way with gcc,
9008 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9009 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9010
9011 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9012        {*&<&'string3'&>&*}}*&"
9013 .cindex "expansion" "extracting substrings by key"
9014 .cindex "&%extract%&" "substrings by key"
9015 The key and <&'string1'&> are first expanded separately. Leading and trailing
9016 white space is removed from the key (but not from any of the strings). The key
9017 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9018 form:
9019 .display
9020 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9021 .endd
9022 .vindex "&$value$&"
9023 where the equals signs and spaces (but not both) are optional. If any of the
9024 values contain white space, they must be enclosed in double quotes, and any
9025 values that are enclosed in double quotes are subject to escape processing as
9026 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9027 for the value that corresponds to the key. The search is case-insensitive. If
9028 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9029 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9030 variable &$value$& contains the value that has been extracted. Afterwards, it
9031 is restored to any previous value it might have had.
9032
9033 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9034 key is not found. If {<&'string2'&>} is also omitted, the value that was
9035 extracted is used. Thus, for example, these two expansions are identical, and
9036 yield &"2001"&:
9037 .code
9038 ${extract{gid}{uid=1984 gid=2001}}
9039 ${extract{gid}{uid=1984 gid=2001}{$value}}
9040 .endd
9041 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9042 appear, for example:
9043 .code
9044 ${extract{Z}{A=... B=...}{$value} fail }
9045 .endd
9046 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9047 {<&'string2'&>} must be present for &"fail"& to be recognized.
9048
9049
9050 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9051         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9052 .cindex "expansion" "extracting substrings by number"
9053 .cindex "&%extract%&" "substrings by number"
9054 The <&'number'&> argument must consist entirely of decimal digits,
9055 apart from leading and trailing white space, which is ignored.
9056 This is what distinguishes this form of &%extract%& from the previous kind. It
9057 behaves in the same way, except that, instead of extracting a named field, it
9058 extracts from <&'string1'&> the field whose number is given as the first
9059 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9060 <&'string3'&> as before.
9061
9062 The fields in the string are separated by any one of the characters in the
9063 separator string. These may include space or tab characters.
9064 The first field is numbered one. If the number is negative, the fields are
9065 counted from the end of the string, with the rightmost one numbered -1. If the
9066 number given is zero, the entire string is returned. If the modulus of the
9067 number is greater than the number of fields in the string, the result is the
9068 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9069 provided. For example:
9070 .code
9071 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9072 .endd
9073 yields &"42"&, and
9074 .code
9075 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9076 .endd
9077 yields &"99"&. Two successive separators mean that the field between them is
9078 empty (for example, the fifth field above).
9079
9080
9081 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9082 .cindex "list" "selecting by condition"
9083 .cindex "expansion" "selecting from list by condition"
9084 .vindex "&$item$&"
9085 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9086 default, but the separator can be changed in the usual way. For each item
9087 in this list, its value is place in &$item$&, and then the condition is
9088 evaluated. If the condition is true, &$item$& is added to the output as an
9089 item in a new list; if the condition is false, the item is discarded. The
9090 separator used for the output list is the same as the one used for the
9091 input, but a separator setting is not included in the output. For example:
9092 .code
9093 ${filter{a:b:c}{!eq{$item}{b}}
9094 .endd
9095 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9096 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9097
9098
9099 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9100 .cindex "hash function" "textual"
9101 .cindex "expansion" "textual hash"
9102 This is a textual hashing function, and was the first to be implemented in
9103 early versions of Exim. In current releases, there are other hashing functions
9104 (numeric, MD5, and SHA-1), which are described below.
9105
9106 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9107 <&'n'&>. If you are using fixed values for these numbers, that is, if
9108 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9109 use the simpler operator notation that avoids some of the braces:
9110 .code
9111 ${hash_<n>_<m>:<string>}
9112 .endd
9113 The second number is optional (in both notations). If <&'n'&> is greater than
9114 or equal to the length of the string, the expansion item returns the string.
9115 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9116 function to the string. The new string consists of characters taken from the
9117 first <&'m'&> characters of the string
9118 .code
9119 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9120 .endd
9121 If <&'m'&> is not present the value 26 is used, so that only lower case
9122 letters appear. For example:
9123 .display
9124 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9125 &`$hash{5}{monty}}           `&   yields  &`monty`&
9126 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9127 .endd
9128
9129 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9130         &*$h_*&<&'header&~name'&>&*:*&" &&&
9131        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9132         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9133        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9134         &*$rh_*&<&'header&~name'&>&*:*&"
9135 .cindex "expansion" "header insertion"
9136 .vindex "&$header_$&"
9137 .vindex "&$bheader_$&"
9138 .vindex "&$rheader_$&"
9139 .cindex "header lines" "in expansion strings"
9140 .cindex "header lines" "character sets"
9141 .cindex "header lines" "decoding"
9142 Substitute the contents of the named message header line, for example
9143 .code
9144 $header_reply-to:
9145 .endd
9146 The newline that terminates a header line is not included in the expansion, but
9147 internal newlines (caused by splitting the header line over several physical
9148 lines) may be present.
9149
9150 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9151 the data in the header line is interpreted.
9152
9153 .ilist
9154 .cindex "white space" "in header lines"
9155 &%rheader%& gives the original &"raw"& content of the header line, with no
9156 processing at all, and without the removal of leading and trailing white space.
9157
9158 .next
9159 .cindex "base64 encoding" "in header lines"
9160 &%bheader%& removes leading and trailing white space, and then decodes base64
9161 or quoted-printable MIME &"words"& within the header text, but does no
9162 character set translation. If decoding of what looks superficially like a MIME
9163 &"word"& fails, the raw string is returned. If decoding
9164 .cindex "binary zero" "in header line"
9165 produces a binary zero character, it is replaced by a question mark &-- this is
9166 what Exim does for binary zeros that are actually received in header lines.
9167
9168 .next
9169 &%header%& tries to translate the string as decoded by &%bheader%& to a
9170 standard character set. This is an attempt to produce the same string as would
9171 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9172 returned. Translation is attempted only on operating systems that support the
9173 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9174 a system Makefile or in &_Local/Makefile_&.
9175 .endlist ilist
9176
9177 In a filter file, the target character set for &%header%& can be specified by a
9178 command of the following form:
9179 .code
9180 headers charset "UTF-8"
9181 .endd
9182 This command affects all references to &$h_$& (or &$header_$&) expansions in
9183 subsequently obeyed filter commands. In the absence of this command, the target
9184 character set in a filter is taken from the setting of the &%headers_charset%&
9185 option in the runtime configuration. The value of this option defaults to the
9186 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9187 ISO-8859-1.
9188
9189 Header names follow the syntax of RFC 2822, which states that they may contain
9190 any printing characters except space and colon. Consequently, curly brackets
9191 &'do not'& terminate header names, and should not be used to enclose them as
9192 if they were variables. Attempting to do so causes a syntax error.
9193
9194 Only header lines that are common to all copies of a message are visible to
9195 this mechanism. These are the original header lines that are received with the
9196 message, and any that are added by an ACL statement or by a system
9197 filter. Header lines that are added to a particular copy of a message by a
9198 router or transport are not accessible.
9199
9200 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9201 before the DATA ACL, because the header structure is not set up until the
9202 message is received. Header lines that are added in a RCPT ACL (for example)
9203 are saved until the message's incoming header lines are available, at which
9204 point they are added. When a DATA ACL is running, however, header lines added
9205 by earlier ACLs are visible.
9206
9207 Upper case and lower case letters are synonymous in header names. If the
9208 following character is white space, the terminating colon may be omitted, but
9209 this is not recommended, because you may then forget it when it is needed. When
9210 white space terminates the header name, it is included in the expanded string.
9211 If the message does not contain the given header, the expansion item is
9212 replaced by an empty string. (See the &%def%& condition in section
9213 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9214
9215 If there is more than one header with the same name, they are all concatenated
9216 to form the substitution string, up to a maximum length of 64K. Unless
9217 &%rheader%& is being used, leading and trailing white space is removed from
9218 each header before concatenation, and a completely empty header is ignored. A
9219 newline character is then inserted between non-empty headers, but there is no
9220 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9221 those headers that contain lists of addresses, a comma is also inserted at the
9222 junctions between headers. This does not happen for the &%rheader%& expansion.
9223
9224
9225 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9226 .cindex "expansion" "hmac hashing"
9227 .cindex &%hmac%&
9228 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9229 shared secret and some text into a message authentication code, as specified in
9230 RFC 2104. This differs from &`${md5:secret_text...}`& or
9231 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9232 cryptographic hash, allowing for authentication that is not possible with MD5
9233 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9234 present. For example:
9235 .code
9236 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9237 .endd
9238 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9239 produces:
9240 .code
9241 dd97e3ba5d1a61b5006108f8c8252953
9242 .endd
9243 As an example of how this might be used, you might put in the main part of
9244 an Exim configuration:
9245 .code
9246 SPAMSCAN_SECRET=cohgheeLei2thahw
9247 .endd
9248 In a router or a transport you could then have:
9249 .code
9250 headers_add = \
9251   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9252   ${hmac{md5}{SPAMSCAN_SECRET}\
9253   {${primary_hostname},${message_exim_id},$h_message-id:}}
9254 .endd
9255 Then given a message, you can check where it was scanned by looking at the
9256 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9257 this header line is authentic by recomputing the authentication code from the
9258 host name, message ID and the &'Message-id:'& header line. This can be done
9259 using Exim's &%-be%& option, or by other means, for example by using the
9260 &'hmac_md5_hex()'& function in Perl.
9261
9262
9263 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9264 .cindex "expansion" "conditional"
9265 .cindex "&%if%&, expansion item"
9266 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9267 item; otherwise <&'string2'&> is used. The available conditions are described
9268 in section &<<SECTexpcond>>& below. For example:
9269 .code
9270 ${if eq {$local_part}{postmaster} {yes}{no} }
9271 .endd
9272 The second string need not be present; if it is not and the condition is not
9273 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9274 be present instead of the second string (without any curly brackets). In this
9275 case, the expansion is forced to fail if the condition is not true (see section
9276 &<<SECTforexpfai>>&).
9277
9278 If both strings are omitted, the result is the string &`true`& if the condition
9279 is true, and the empty string if the condition is false. This makes it less
9280 cumbersome to write custom ACL and router conditions. For example, instead of
9281 .code
9282 condition = ${if >{$acl_m4}{3}{true}{false}}
9283 .endd
9284 you can use
9285 .code
9286 condition = ${if >{$acl_m4}{3}}
9287 .endd
9288
9289 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9290 .cindex "expansion" "string truncation"
9291 .cindex "&%length%& expansion item"
9292 The &%length%& item is used to extract the initial portion of a string. Both
9293 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9294 you are using a fixed value for the number, that is, if <&'string1'&> does not
9295 change when expanded, you can use the simpler operator notation that avoids
9296 some of the braces:
9297 .code
9298 ${length_<n>:<string>}
9299 .endd
9300 The result of this item is either the first <&'n'&> characters or the whole
9301 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9302 &%strlen%&, which gives the length of a string.
9303
9304
9305 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9306         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9307 .cindex "expansion" "extracting list elements by number"
9308 .cindex "&%listextract%&" "extract list elements by number"
9309 .cindex "list" "extracting elements by number"
9310 The <&'number'&> argument must consist entirely of decimal digits,
9311 apart from an optional leading minus,
9312 and leading and trailing white space (which is ignored).
9313
9314 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9315 default, but the separator can be changed in the usual way.
9316
9317 The first field of the list is numbered one.
9318 If the number is negative, the fields are
9319 counted from the end of the list, with the rightmost one numbered -1.
9320 The numbered element of the list is extracted and placed in &$value$&,
9321 then <&'string2'&> is expanded as the result.
9322
9323 If the modulus of the
9324 number is zero or greater than the number of fields in the string,
9325 the result is the expansion of <&'string3'&>.
9326
9327 For example:
9328 .code
9329 ${listextract{2}{x:42:99}}
9330 .endd
9331 yields &"42"&, and
9332 .code
9333 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9334 .endd
9335 yields &"result: 99"&.
9336
9337 If {<&'string3'&>} is omitted, an empty string is used for string3.
9338 If {<&'string2'&>} is also omitted, the value that was
9339 extracted is used.
9340 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9341
9342
9343 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9344         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9345 This is the first of one of two different types of lookup item, which are both
9346 described in the next item.
9347
9348 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9349         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9350 .cindex "expansion" "lookup in"
9351 .cindex "file" "lookups"
9352 .cindex "lookup" "in expanded string"
9353 The two forms of lookup item specify data lookups in files and databases, as
9354 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9355 lookups, and the second is used for query-style lookups. The <&'key'&>,
9356 <&'file'&>, and <&'query'&> strings are expanded before use.
9357
9358 If there is any white space in a lookup item which is part of a filter command,
9359 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9360 other place where white space is significant, the lookup item must be enclosed
9361 in double quotes. The use of data lookups in users' filter files may be locked
9362 out by the system administrator.
9363
9364 .vindex "&$value$&"
9365 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9366 During its expansion, the variable &$value$& contains the data returned by the
9367 lookup. Afterwards it reverts to the value it had previously (at the outer
9368 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9369 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9370 string on failure. If <&'string2'&> is provided, it can itself be a nested
9371 lookup, thus providing a mechanism for looking up a default value when the
9372 original lookup fails.
9373
9374 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9375 data for the outer lookup while the parameters of the second lookup are
9376 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9377 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9378 appear, and in this case, if the lookup fails, the entire expansion is forced
9379 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9380 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9381 successful lookup, and nothing in the case of failure.
9382
9383 For single-key lookups, the string &"partial"& is permitted to precede the
9384 search type in order to do partial matching, and * or *@ may follow a search
9385 type to request default lookups if the key does not match (see sections
9386 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9387
9388 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9389 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9390 and non-wild parts of the key during the expansion of the replacement text.
9391 They return to their previous values at the end of the lookup item.
9392
9393 This example looks up the postmaster alias in the conventional alias file:
9394 .code
9395 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9396 .endd
9397 This example uses NIS+ to look up the full name of the user corresponding to
9398 the local part of an address, forcing the expansion to fail if it is not found:
9399 .code
9400 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9401   {$value}fail}
9402 .endd
9403
9404
9405 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9406 .cindex "expansion" "list creation"
9407 .vindex "&$item$&"
9408 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9409 default, but the separator can be changed in the usual way. For each item
9410 in this list, its value is place in &$item$&, and then <&'string2'&> is
9411 expanded and added to the output as an item in a new list. The separator used
9412 for the output list is the same as the one used for the input, but a separator
9413 setting is not included in the output. For example:
9414 .code
9415 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9416 .endd
9417 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9418 value of &$item$& is restored to what it was before. See also the &*filter*&
9419 and &*reduce*& expansion items.
9420
9421 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9422 .cindex "expansion" "numeric hash"
9423 .cindex "hash function" "numeric"
9424 The three strings are expanded; the first two must yield numbers. Call them
9425 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9426 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9427 can use the simpler operator notation that avoids some of the braces:
9428 .code
9429 ${nhash_<n>_<m>:<string>}
9430 .endd
9431 The second number is optional (in both notations). If there is only one number,
9432 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9433 processed by a div/mod hash function that returns two numbers, separated by a
9434 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9435 example,
9436 .code
9437 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9438 .endd
9439 returns the string &"6/33"&.
9440
9441
9442
9443 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9444 .cindex "Perl" "use in expanded string"
9445 .cindex "expansion" "calling Perl from"
9446 This item is available only if Exim has been built to include an embedded Perl
9447 interpreter. The subroutine name and the arguments are first separately
9448 expanded, and then the Perl subroutine is called with those arguments. No
9449 additional arguments need be given; the maximum number permitted, including the
9450 name of the subroutine, is nine.
9451
9452 The return value of the subroutine is inserted into the expanded string, unless
9453 the return value is &%undef%&. In that case, the expansion fails in the same
9454 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9455 Whatever you return is evaluated in a scalar context. For example, if you
9456 return the name of a Perl vector, the return value is the size of the vector,
9457 not its contents.
9458
9459 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9460 with the error message that was passed to &%die%&. More details of the embedded
9461 Perl facility are given in chapter &<<CHAPperl>>&.
9462
9463 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9464 out the use of this expansion item in filter files.
9465
9466
9467 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9468 .cindex "&%prvs%& expansion item"
9469 The first argument is a complete email address and the second is secret
9470 keystring. The third argument, specifying a key number, is optional. If absent,
9471 it defaults to 0. The result of the expansion is a prvs-signed email address,
9472 to be typically used with the &%return_path%& option on an &(smtp)& transport
9473 as part of a bounce address tag validation (BATV) scheme. For more discussion
9474 and an example, see section &<<SECTverifyPRVS>>&.
9475
9476 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9477         {*&<&'string'&>&*}}*&"
9478 .cindex "&%prvscheck%& expansion item"
9479 This expansion item is the complement of the &%prvs%& item. It is used for
9480 checking prvs-signed addresses. If the expansion of the first argument does not
9481 yield a syntactically valid prvs-signed address, the whole item expands to the
9482 empty string. When the first argument does expand to a syntactically valid
9483 prvs-signed address, the second argument is expanded, with the prvs-decoded
9484 version of the address and the key number extracted from the address in the
9485 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9486
9487 These two variables can be used in the expansion of the second argument to
9488 retrieve the secret. The validity of the prvs-signed address is then checked
9489 against the secret. The result is stored in the variable &$prvscheck_result$&,
9490 which is empty for failure or &"1"& for success.
9491
9492 The third argument is optional; if it is missing, it defaults to an empty
9493 string. This argument is now expanded. If the result is an empty string, the
9494 result of the expansion is the decoded version of the address. This is the case
9495 whether or not the signature was valid. Otherwise, the result of the expansion
9496 is the expansion of the third argument.
9497
9498 All three variables can be used in the expansion of the third argument.
9499 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9500 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9501
9502 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9503 .cindex "expansion" "inserting an entire file"
9504 .cindex "file" "inserting into expansion"
9505 .cindex "&%readfile%& expansion item"
9506 The file name and end-of-line string are first expanded separately. The file is
9507 then read, and its contents replace the entire item. All newline characters in
9508 the file are replaced by the end-of-line string if it is present. Otherwise,
9509 newlines are left in the string.
9510 String expansion is not applied to the contents of the file. If you want this,
9511 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9512 the string expansion fails.
9513
9514 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9515 locks out the use of this expansion item in filter files.
9516
9517
9518
9519 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9520         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9521 .cindex "expansion" "inserting from a socket"
9522 .cindex "socket, use of in expansion"
9523 .cindex "&%readsocket%& expansion item"
9524 This item inserts data from a Unix domain or TCP socket into the expanded
9525 string. The minimal way of using it uses just two arguments, as in these
9526 examples:
9527 .code
9528 ${readsocket{/socket/name}{request string}}
9529 ${readsocket{inet:some.host:1234}{request string}}
9530 .endd
9531 For a Unix domain socket, the first substring must be the path to the socket.
9532 For an Internet socket, the first substring must contain &`inet:`& followed by
9533 a host name or IP address, followed by a colon and a port, which can be a
9534 number or the name of a TCP port in &_/etc/services_&. An IP address may
9535 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9536 example:
9537 .code
9538 ${readsocket{inet:[::1]:1234}{request string}}
9539 .endd
9540 Only a single host name may be given, but if looking it up yields more than
9541 one IP address, they are each tried in turn until a connection is made. For
9542 both kinds of socket, Exim makes a connection, writes the request string
9543 (unless it is an empty string) and reads from the socket until an end-of-file
9544 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9545 extend what can be done. Firstly, you can vary the timeout. For example:
9546 .code
9547 ${readsocket{/socket/name}{request string}{3s}}
9548 .endd
9549 A fourth argument allows you to change any newlines that are in the data
9550 that is read, in the same way as for &%readfile%& (see above). This example
9551 turns them into spaces:
9552 .code
9553 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9554 .endd
9555 As with all expansions, the substrings are expanded before the processing
9556 happens. Errors in these sub-expansions cause the expansion to fail. In
9557 addition, the following errors can occur:
9558
9559 .ilist
9560 Failure to create a socket file descriptor;
9561 .next
9562 Failure to connect the socket;
9563 .next
9564 Failure to write the request string;
9565 .next
9566 Timeout on reading from the socket.
9567 .endlist
9568
9569 By default, any of these errors causes the expansion to fail. However, if
9570 you supply a fifth substring, it is expanded and used when any of the above
9571 errors occurs. For example:
9572 .code
9573 ${readsocket{/socket/name}{request string}{3s}{\n}\
9574   {socket failure}}
9575 .endd
9576 You can test for the existence of a Unix domain socket by wrapping this
9577 expansion in &`${if exists`&, but there is a race condition between that test
9578 and the actual opening of the socket, so it is safer to use the fifth argument
9579 if you want to be absolutely sure of avoiding an expansion error for a
9580 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9581
9582 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9583 locks out the use of this expansion item in filter files.
9584
9585
9586 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9587 .cindex "expansion" "reducing a list to a scalar"
9588 .cindex "list" "reducing to a scalar"
9589 .vindex "&$value$&"
9590 .vindex "&$item$&"
9591 This operation reduces a list to a single, scalar string. After expansion,
9592 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9593 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9594 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9595 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9596 them. The result of that expansion is assigned to &$value$& before the next
9597 iteration. When the end of the list is reached, the final value of &$value$& is
9598 added to the expansion output. The &*reduce*& expansion item can be used in a
9599 number of ways. For example, to add up a list of numbers:
9600 .code
9601 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9602 .endd
9603 The result of that expansion would be &`6`&. The maximum of a list of numbers
9604 can be found:
9605 .code
9606 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9607 .endd
9608 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9609 restored to what they were before. See also the &*filter*& and &*map*&
9610 expansion items.
9611
9612 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9613 This item inserts &"raw"& header lines. It is described with the &%header%&
9614 expansion item above.
9615
9616 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9617         {*&<&'string2'&>&*}}*&"
9618 .cindex "expansion" "running a command"
9619 .cindex "&%run%& expansion item"
9620 The command and its arguments are first expanded as one string. The string is
9621 split apart into individual arguments by spaces, and then the command is run
9622 in a separate process, but under the same uid and gid.  As in other command
9623 executions from Exim, a shell is not used by default. If the command requires
9624 a shell, you must explicitly code it.
9625
9626 Since the arguments are split by spaces, when there is a variable expansion
9627 which has an empty result, it will cause the situation that the argument will
9628 simply be omitted when the program is actually executed by Exim. If the
9629 script/program requires a specific number of arguments and the expanded
9630 variable could possibly result in this empty expansion, the variable must be
9631 quoted. This is more difficult if the expanded variable itself could result
9632 in a string containing quotes, because it would interfere with the quotes
9633 around the command arguments. A possible guard against this is to wrap the
9634 variable in the &%sg%& operator to change any quote marks to some other
9635 character.
9636
9637 The standard input for the command exists, but is empty. The standard output
9638 and standard error are set to the same file descriptor.
9639 .cindex "return code" "from &%run%& expansion"
9640 .vindex "&$value$&"
9641 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9642 and replaces the entire item; during this expansion, the standard output/error
9643 from the command is in the variable &$value$&. If the command fails,
9644 <&'string2'&>, if present, is expanded and used. Once again, during the
9645 expansion, the standard output/error from the command is in the variable
9646 &$value$&.
9647
9648 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9649 can be the word &"fail"& (not in braces) to force expansion failure if the
9650 command does not succeed. If both strings are omitted, the result is contents
9651 of the standard output/error on success, and nothing on failure.
9652
9653 .vindex "&$run_in_acl$&"
9654 The standard output/error of the command is put in the variable &$value$&.
9655 In this ACL example, the output of a command is logged for the admin to
9656 troubleshoot:
9657 .code
9658 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9659       log_message  = Output of id: $value
9660 .endd
9661 If the command requires shell idioms, such as the > redirect operator, the
9662 shell must be invoked directly, such as with:
9663 .code
9664 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9665 .endd
9666
9667 .vindex "&$runrc$&"
9668 The return code from the command is put in the variable &$runrc$&, and this
9669 remains set afterwards, so in a filter file you can do things like this:
9670 .code
9671 if "${run{x y z}{}}$runrc" is 1 then ...
9672   elif $runrc is 2 then ...
9673   ...
9674 endif
9675 .endd
9676 If execution of the command fails (for example, the command does not exist),
9677 the return code is 127 &-- the same code that shells use for non-existent
9678 commands.
9679
9680 &*Warning*&: In a router or transport, you cannot assume the order in which
9681 option values are expanded, except for those preconditions whose order of
9682 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9683 by the expansion of one option, and use it in another.
9684
9685 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9686 out the use of this expansion item in filter files.
9687
9688
9689 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9690 .cindex "expansion" "string substitution"
9691 .cindex "&%sg%& expansion item"
9692 This item works like Perl's substitution operator (s) with the global (/g)
9693 option; hence its name. However, unlike the Perl equivalent, Exim does not
9694 modify the subject string; instead it returns the modified string for insertion
9695 into the overall expansion. The item takes three arguments: the subject string,
9696 a regular expression, and a substitution string. For example:
9697 .code
9698 ${sg{abcdefabcdef}{abc}{xyz}}
9699 .endd
9700 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9701 if any $ or \ characters are required in the regular expression or in the
9702 substitution string, they have to be escaped. For example:
9703 .code
9704 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9705 .endd
9706 yields &"defabc"&, and
9707 .code
9708 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9709 .endd
9710 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9711 the regular expression from string expansion.
9712
9713
9714
9715 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9716 .cindex sorting a list
9717 .cindex list sorting
9718 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9719 default, but the separator can be changed in the usual way.
9720 The <&'comparator'&> argument is interpreted as the operator
9721 of a two-argument expansion condition.
9722 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9723 The comparison should return true when applied to two values
9724 if the first value should sort before the second value.
9725 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9726 the element being placed in &$item$&,
9727 to give values for comparison.
9728
9729 The item result is a sorted list,
9730 with the original list separator,
9731 of the list elements (in full) of the original.
9732
9733 Examples:
9734 .code
9735 ${sort{3:2:1:4}{<}{$item}}
9736 .endd
9737 sorts a list of numbers, and
9738 .code
9739 ${sort {$lookup dnsdb{>:,,mx=example.com}} {<} {${listextract{1}{<,$item}}}}
9740 .endd
9741 will sort an MX lookup into priority order.
9742
9743
9744 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9745 .cindex "&%substr%& expansion item"
9746 .cindex "substring extraction"
9747 .cindex "expansion" "substring extraction"
9748 The three strings are expanded; the first two must yield numbers. Call them
9749 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9750 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9751 can use the simpler operator notation that avoids some of the braces:
9752 .code
9753 ${substr_<n>_<m>:<string>}
9754 .endd
9755 The second number is optional (in both notations).
9756 If it is absent in the simpler format, the preceding underscore must also be
9757 omitted.
9758
9759 The &%substr%& item can be used to extract more general substrings than
9760 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9761 length required. For example
9762 .code
9763 ${substr{3}{2}{$local_part}}
9764 .endd
9765 If the starting offset is greater than the string length the result is the
9766 null string; if the length plus starting offset is greater than the string
9767 length, the result is the right-hand part of the string, starting from the
9768 given offset. The first character in the string has offset zero.
9769
9770 The &%substr%& expansion item can take negative offset values to count
9771 from the right-hand end of its operand. The last character is offset -1, the
9772 second-last is offset -2, and so on. Thus, for example,
9773 .code
9774 ${substr{-5}{2}{1234567}}
9775 .endd
9776 yields &"34"&. If the absolute value of a negative offset is greater than the
9777 length of the string, the substring starts at the beginning of the string, and
9778 the length is reduced by the amount of overshoot. Thus, for example,
9779 .code
9780 ${substr{-5}{2}{12}}
9781 .endd
9782 yields an empty string, but
9783 .code
9784 ${substr{-3}{2}{12}}
9785 .endd
9786 yields &"1"&.
9787
9788 When the second number is omitted from &%substr%&, the remainder of the string
9789 is taken if the offset is positive. If it is negative, all characters in the
9790 string preceding the offset point are taken. For example, an offset of -1 and
9791 no length, as in these semantically identical examples:
9792 .code
9793 ${substr_-1:abcde}
9794 ${substr{-1}{abcde}}
9795 .endd
9796 yields all but the last character of the string, that is, &"abcd"&.
9797
9798
9799
9800 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9801         {*&<&'replacements'&>&*}}*&"
9802 .cindex "expansion" "character translation"
9803 .cindex "&%tr%& expansion item"
9804 This item does single-character translation on its subject string. The second
9805 argument is a list of characters to be translated in the subject string. Each
9806 matching character is replaced by the corresponding character from the
9807 replacement list. For example
9808 .code
9809 ${tr{abcdea}{ac}{13}}
9810 .endd
9811 yields &`1b3de1`&. If there are duplicates in the second character string, the
9812 last occurrence is used. If the third string is shorter than the second, its
9813 last character is replicated. However, if it is empty, no translation takes
9814 place.
9815 .endlist
9816
9817
9818
9819 .section "Expansion operators" "SECTexpop"
9820 .cindex "expansion" "operators"
9821 For expansion items that perform transformations on a single argument string,
9822 the &"operator"& notation is used because it is simpler and uses fewer braces.
9823 The substring is first expanded before the operation is applied to it. The
9824 following operations can be performed:
9825
9826 .vlist
9827 .vitem &*${address:*&<&'string'&>&*}*&
9828 .cindex "expansion" "RFC 2822 address handling"
9829 .cindex "&%address%& expansion item"
9830 The string is interpreted as an RFC 2822 address, as it might appear in a
9831 header line, and the effective address is extracted from it. If the string does
9832 not parse successfully, the result is empty.
9833
9834
9835 .vitem &*${addresses:*&<&'string'&>&*}*&
9836 .cindex "expansion" "RFC 2822 address handling"
9837 .cindex "&%addresses%& expansion item"
9838 The string (after expansion) is interpreted as a list of addresses in RFC
9839 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9840 operative address (&'local-part@domain'&) is extracted from each item, and the
9841 result of the expansion is a colon-separated list, with appropriate
9842 doubling of colons should any happen to be present in the email addresses.
9843 Syntactically invalid RFC2822 address items are omitted from the output.
9844
9845 It is possible to specify a character other than colon for the output
9846 separator by starting the string with > followed by the new separator
9847 character. For example:
9848 .code
9849 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9850 .endd
9851 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9852 expansion item, which extracts the working address from a single RFC2822
9853 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9854 processing lists.
9855
9856 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9857 a strict interpretation of header line formatting.  Exim parses the bare,
9858 unquoted portion of an email address and if it finds a comma, treats it as an
9859 email address seperator. For the example header line:
9860 .code
9861 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9862 .endd
9863 The first example below demonstrates that Q-encoded email addresses are parsed
9864 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9865 It does not see the comma because it's still encoded as "=2C".  The second
9866 example below is passed the contents of &`$header_from:`&, meaning it gets
9867 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9868 The third example shows that the presence of a comma is skipped when it is
9869 quoted.
9870 .code
9871 # exim -be '${addresses:From: \
9872 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9873 user@example.com
9874 # exim -be '${addresses:From: Last, First <user@example.com>}'
9875 Last:user@example.com
9876 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9877 user@example.com
9878 .endd
9879
9880 .vitem &*${base62:*&<&'digits'&>&*}*&
9881 .cindex "&%base62%& expansion item"
9882 .cindex "expansion" "conversion to base 62"
9883 The string must consist entirely of decimal digits. The number is converted to
9884 base 62 and output as a string of six characters, including leading zeros. In
9885 the few operating environments where Exim uses base 36 instead of base 62 for
9886 its message identifiers (because those systems do not have case-sensitive file
9887 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9888 be absolutely clear: this is &'not'& base64 encoding.
9889
9890 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9891 .cindex "&%base62d%& expansion item"
9892 .cindex "expansion" "conversion to base 62"
9893 The string must consist entirely of base-62 digits, or, in operating
9894 environments where Exim uses base 36 instead of base 62 for its message
9895 identifiers, base-36 digits. The number is converted to decimal and output as a
9896 string.
9897
9898
9899 .vitem &*${domain:*&<&'string'&>&*}*&
9900 .cindex "domain" "extraction"
9901 .cindex "expansion" "domain extraction"
9902 The string is interpreted as an RFC 2822 address and the domain is extracted
9903 from it. If the string does not parse successfully, the result is empty.
9904
9905
9906 .vitem &*${escape:*&<&'string'&>&*}*&
9907 .cindex "expansion" "escaping non-printing characters"
9908 .cindex "&%escape%& expansion item"
9909 If the string contains any non-printing characters, they are converted to
9910 escape sequences starting with a backslash. Whether characters with the most
9911 significant bit set (so-called &"8-bit characters"&) count as printing or not
9912 is controlled by the &%print_topbitchars%& option.
9913
9914
9915 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9916 .cindex "expansion" "expression evaluation"
9917 .cindex "expansion" "arithmetic expression"
9918 .cindex "&%eval%& expansion item"
9919 These items supports simple arithmetic and bitwise logical operations in
9920 expansion strings. The string (after expansion) must be a conventional
9921 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9922 logical operators, and parentheses. All operations are carried out using
9923 integer arithmetic. The operator priorities are as follows (the same as in the
9924 C programming language):
9925 .table2 70pt 300pt
9926 .irow &'highest:'& "not (~), negate (-)"
9927 .irow ""   "multiply (*), divide (/), remainder (%)"
9928 .irow ""   "plus (+), minus (-)"
9929 .irow ""   "shift-left (<<), shift-right (>>)"
9930 .irow ""   "and (&&)"
9931 .irow ""   "xor (^)"
9932 .irow &'lowest:'&  "or (|)"
9933 .endtable
9934 Binary operators with the same priority are evaluated from left to right. White
9935 space is permitted before or after operators.
9936
9937 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9938 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9939 decimal, even if they start with a leading zero; hexadecimal numbers are not
9940 permitted. This can be useful when processing numbers extracted from dates or
9941 times, which often do have leading zeros.
9942
9943 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9944 or 1024*1024*1024,
9945 respectively. Negative numbers are supported. The result of the computation is
9946 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9947
9948 .display
9949 &`${eval:1+1}            `&  yields 2
9950 &`${eval:1+2*3}          `&  yields 7
9951 &`${eval:(1+2)*3}        `&  yields 9
9952 &`${eval:2+42%5}         `&  yields 4
9953 &`${eval:0xc&amp;5}          `&  yields 4
9954 &`${eval:0xc|5}          `&  yields 13
9955 &`${eval:0xc^5}          `&  yields 9
9956 &`${eval:0xc>>1}         `&  yields 6
9957 &`${eval:0xc<<1}         `&  yields 24
9958 &`${eval:~255&amp;0x1234}    `&  yields 4608
9959 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
9960 .endd
9961
9962 As a more realistic example, in an ACL you might have
9963 .code
9964 deny   message = Too many bad recipients
9965        condition =                    \
9966          ${if and {                   \
9967            {>{$rcpt_count}{10}}       \
9968            {                          \
9969            <                          \
9970              {$recipients_count}      \
9971              {${eval:$rcpt_count/2}}  \
9972            }                          \
9973          }{yes}{no}}
9974 .endd
9975 The condition is true if there have been more than 10 RCPT commands and
9976 fewer than half of them have resulted in a valid recipient.
9977
9978
9979 .vitem &*${expand:*&<&'string'&>&*}*&
9980 .cindex "expansion" "re-expansion of substring"
9981 The &%expand%& operator causes a string to be expanded for a second time. For
9982 example,
9983 .code
9984 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
9985 .endd
9986 first looks up a string in a file while expanding the operand for &%expand%&,
9987 and then re-expands what it has found.
9988
9989
9990 .vitem &*${from_utf8:*&<&'string'&>&*}*&
9991 .cindex "Unicode"
9992 .cindex "UTF-8" "conversion from"
9993 .cindex "expansion" "UTF-8 conversion"
9994 .cindex "&%from_utf8%& expansion item"
9995 The world is slowly moving towards Unicode, although there are no standards for
9996 email yet. However, other applications (including some databases) are starting
9997 to store data in Unicode, using UTF-8 encoding. This operator converts from a
9998 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
9999 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10000 the result is an undefined sequence of bytes.
10001
10002 Unicode code points with values less than 256 are compatible with ASCII and
10003 ISO-8859-1 (also known as Latin-1).
10004 For example, character 169 is the copyright symbol in both cases, though the
10005 way it is encoded is different. In UTF-8, more than one byte is needed for
10006 characters with code values greater than 127, whereas ISO-8859-1 is a
10007 single-byte encoding (but thereby limited to 256 characters). This makes
10008 translation from UTF-8 to ISO-8859-1 straightforward.
10009
10010
10011 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10012 .cindex "hash function" "textual"
10013 .cindex "expansion" "textual hash"
10014 The &%hash%& operator is a simpler interface to the hashing function that can
10015 be used when the two parameters are fixed numbers (as opposed to strings that
10016 change when expanded). The effect is the same as
10017 .code
10018 ${hash{<n>}{<m>}{<string>}}
10019 .endd
10020 See the description of the general &%hash%& item above for details. The
10021 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10022
10023
10024
10025 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10026 .cindex "base64 encoding" "conversion from hex"
10027 .cindex "expansion" "hex to base64"
10028 .cindex "&%hex2b64%& expansion item"
10029 This operator converts a hex string into one that is base64 encoded. This can
10030 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10031
10032
10033
10034 .vitem &*${hexquote:*&<&'string'&>&*}*&
10035 .cindex "quoting" "hex-encoded unprintable characters"
10036 .cindex "&%hexquote%& expansion item"
10037 This operator converts non-printable characters in a string into a hex
10038 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10039 as is, and other byte values are converted to &`\xNN`&, for example a
10040 byte value 127 is converted to &`\x7f`&.
10041
10042
10043 .vitem &*${lc:*&<&'string'&>&*}*&
10044 .cindex "case forcing in strings"
10045 .cindex "string" "case forcing"
10046 .cindex "lower casing"
10047 .cindex "expansion" "case forcing"
10048 .cindex "&%lc%& expansion item"
10049 This forces the letters in the string into lower-case, for example:
10050 .code
10051 ${lc:$local_part}
10052 .endd
10053
10054 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10055 .cindex "expansion" "string truncation"
10056 .cindex "&%length%& expansion item"
10057 The &%length%& operator is a simpler interface to the &%length%& function that
10058 can be used when the parameter is a fixed number (as opposed to a string that
10059 changes when expanded). The effect is the same as
10060 .code
10061 ${length{<number>}{<string>}}
10062 .endd
10063 See the description of the general &%length%& item above for details. Note that
10064 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10065 when &%length%& is used as an operator.
10066
10067
10068 .vitem &*${listcount:*&<&'string'&>&*}*&
10069 .cindex "expansion" "list item count"
10070 .cindex "list" "item count"
10071 .cindex "list" "count of items"
10072 .cindex "&%listcount%& expansion item"
10073 The string is interpreted as a list and the number of items is returned.
10074
10075
10076 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10077 .cindex "expansion" "named list"
10078 .cindex "&%listnamed%& expansion item"
10079 The name is interpreted as a named list and the content of the list is returned,
10080 expanding any referenced lists, re-quoting as needed for colon-separation.
10081 If the optional type is given it must be one of "a", "d", "h" or "l"
10082 and selects address-, domain-, host- or localpart- lists to search among respectively.
10083 Otherwise all types are searched in an undefined order and the first
10084 matching list is returned.
10085
10086
10087 .vitem &*${local_part:*&<&'string'&>&*}*&
10088 .cindex "expansion" "local part extraction"
10089 .cindex "&%local_part%& expansion item"
10090 The string is interpreted as an RFC 2822 address and the local part is
10091 extracted from it. If the string does not parse successfully, the result is
10092 empty.
10093
10094
10095 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10096 .cindex "masked IP address"
10097 .cindex "IP address" "masking"
10098 .cindex "CIDR notation"
10099 .cindex "expansion" "IP address masking"
10100 .cindex "&%mask%& expansion item"
10101 If the form of the string to be operated on is not an IP address followed by a
10102 slash and an integer (that is, a network address in CIDR notation), the
10103 expansion fails. Otherwise, this operator converts the IP address to binary,
10104 masks off the least significant bits according to the bit count, and converts
10105 the result back to text, with mask appended. For example,
10106 .code
10107 ${mask:10.111.131.206/28}
10108 .endd
10109 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10110 be mostly used for looking up masked addresses in files, the result for an IPv6
10111 address uses dots to separate components instead of colons, because colon
10112 terminates a key string in lsearch files. So, for example,
10113 .code
10114 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10115 .endd
10116 returns the string
10117 .code
10118 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10119 .endd
10120 Letters in IPv6 addresses are always output in lower case.
10121
10122
10123 .vitem &*${md5:*&<&'string'&>&*}*&
10124 .cindex "MD5 hash"
10125 .cindex "expansion" "MD5 hash"
10126 .cindex "certificate fingerprint"
10127 .cindex "&%md5%& expansion item"
10128 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10129 as a 32-digit hexadecimal number, in which any letters are in lower case.
10130
10131
10132 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10133 .cindex "expansion" "numeric hash"
10134 .cindex "hash function" "numeric"
10135 The &%nhash%& operator is a simpler interface to the numeric hashing function
10136 that can be used when the two parameters are fixed numbers (as opposed to
10137 strings that change when expanded). The effect is the same as
10138 .code
10139 ${nhash{<n>}{<m>}{<string>}}
10140 .endd
10141 See the description of the general &%nhash%& item above for details.
10142
10143
10144 .vitem &*${quote:*&<&'string'&>&*}*&
10145 .cindex "quoting" "in string expansions"
10146 .cindex "expansion" "quoting"
10147 .cindex "&%quote%& expansion item"
10148 The &%quote%& operator puts its argument into double quotes if it
10149 is an empty string or
10150 contains anything other than letters, digits, underscores, dots, and hyphens.
10151 Any occurrences of double quotes and backslashes are escaped with a backslash.
10152 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10153 respectively For example,
10154 .code
10155 ${quote:ab"*"cd}
10156 .endd
10157 becomes
10158 .code
10159 "ab\"*\"cd"
10160 .endd
10161 The place where this is useful is when the argument is a substitution from a
10162 variable or a message header.
10163
10164 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10165 .cindex "&%quote_local_part%& expansion item"
10166 This operator is like &%quote%&, except that it quotes the string only if
10167 required to do so by the rules of RFC 2822 for quoting local parts. For
10168 example, a plus sign would not cause quoting (but it would for &%quote%&).
10169 If you are creating a new email address from the contents of &$local_part$&
10170 (or any other unknown data), you should always use this operator.
10171
10172
10173 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10174 .cindex "quoting" "lookup-specific"
10175 This operator applies lookup-specific quoting rules to the string. Each
10176 query-style lookup type has its own quoting rules which are described with
10177 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10178 .code
10179 ${quote_ldap:two * two}
10180 .endd
10181 returns
10182 .code
10183 two%20%5C2A%20two
10184 .endd
10185 For single-key lookup types, no quoting is ever necessary and this operator
10186 yields an unchanged string.
10187
10188
10189 .vitem &*${randint:*&<&'n'&>&*}*&
10190 .cindex "random number"
10191 This operator returns a somewhat random number which is less than the
10192 supplied number and is at least 0.  The quality of this randomness depends
10193 on how Exim was built; the values are not suitable for keying material.
10194 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10195 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10196 for versions of GnuTLS with that function.
10197 Otherwise, the implementation may be arc4random(), random() seeded by
10198 srandomdev() or srandom(), or a custom implementation even weaker than
10199 random().
10200
10201
10202 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10203 .cindex "expansion" "IP address"
10204 This operator reverses an IP address; for IPv4 addresses, the result is in
10205 dotted-quad decimal form, while for IPv6 addreses the result is in
10206 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10207 for DNS.  For example,
10208 .code
10209 ${reverse_ip:192.0.2.4}
10210 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10211 .endd
10212 returns
10213 .code
10214 4.2.0.192
10215 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
10216 .endd
10217
10218
10219 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10220 .cindex "expansion" "RFC 2047"
10221 .cindex "RFC 2047" "expansion operator"
10222 .cindex "&%rfc2047%& expansion item"
10223 This operator encodes text according to the rules of RFC 2047. This is an
10224 encoding that is used in header lines to encode non-ASCII characters. It is
10225 assumed that the input string is in the encoding specified by the
10226 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10227 contains only characters in the range 33&--126, and no instances of the
10228 characters
10229 .code
10230 ? = ( ) < > @ , ; : \ " . [ ] _
10231 .endd
10232 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10233 string, using as many &"encoded words"& as necessary to encode all the
10234 characters.
10235
10236
10237 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10238 .cindex "expansion" "RFC 2047"
10239 .cindex "RFC 2047" "decoding"
10240 .cindex "&%rfc2047d%& expansion item"
10241 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10242 bytes are replaced by question marks. Characters are converted into the
10243 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10244 not recognized unless &%check_rfc2047_length%& is set false.
10245
10246 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10247 access a header line, RFC 2047 decoding is done automatically. You do not need
10248 to use this operator as well.
10249
10250
10251
10252 .vitem &*${rxquote:*&<&'string'&>&*}*&
10253 .cindex "quoting" "in regular expressions"
10254 .cindex "regular expressions" "quoting"
10255 .cindex "&%rxquote%& expansion item"
10256 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10257 characters in its argument. This is useful when substituting the values of
10258 variables or headers inside regular expressions.
10259
10260
10261 .vitem &*${sha1:*&<&'string'&>&*}*&
10262 .cindex "SHA-1 hash"
10263 .cindex "expansion" "SHA-1 hashing"
10264 .cindex "certificate fingerprint"
10265 .cindex "&%sha2%& expansion item"
10266 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10267 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10268
10269
10270 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10271 .cindex "SHA-256 hash"
10272 .cindex "certificate fingerprint"
10273 .cindex "expansion" "SHA-256 hashing"
10274 .cindex "&%sha256%& expansion item"
10275 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10276 certificate,
10277 and returns
10278 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10279 Only arguments which are a single variable of certificate type are supported.
10280
10281
10282 .vitem &*${stat:*&<&'string'&>&*}*&
10283 .cindex "expansion" "statting a file"
10284 .cindex "file" "extracting characteristics"
10285 .cindex "&%stat%& expansion item"
10286 The string, after expansion, must be a file path. A call to the &[stat()]&
10287 function is made for this path. If &[stat()]& fails, an error occurs and the
10288 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10289 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10290 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10291 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10292 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10293 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10294 can extract individual fields using the &%extract%& expansion item.
10295
10296 The use of the &%stat%& expansion in users' filter files can be locked out by
10297 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10298 systems for files larger than 2GB.
10299
10300 .vitem &*${str2b64:*&<&'string'&>&*}*&
10301 .cindex "expansion" "base64 encoding"
10302 .cindex "base64 encoding" "in string expansion"
10303 .cindex "&%str2b64%& expansion item"
10304 This operator converts a string into one that is base64 encoded.
10305
10306
10307
10308 .vitem &*${strlen:*&<&'string'&>&*}*&
10309 .cindex "expansion" "string length"
10310 .cindex "string" "length in expansion"
10311 .cindex "&%strlen%& expansion item"
10312 The item is replace by the length of the expanded string, expressed as a
10313 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10314
10315
10316 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10317 .cindex "&%substr%& expansion item"
10318 .cindex "substring extraction"
10319 .cindex "expansion" "substring expansion"
10320 The &%substr%& operator is a simpler interface to the &%substr%& function that
10321 can be used when the two parameters are fixed numbers (as opposed to strings
10322 that change when expanded). The effect is the same as
10323 .code
10324 ${substr{<start>}{<length>}{<string>}}
10325 .endd
10326 See the description of the general &%substr%& item above for details. The
10327 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10328
10329 .vitem &*${time_eval:*&<&'string'&>&*}*&
10330 .cindex "&%time_eval%& expansion item"
10331 .cindex "time interval" "decoding"
10332 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10333 seconds.
10334
10335 .vitem &*${time_interval:*&<&'string'&>&*}*&
10336 .cindex "&%time_interval%& expansion item"
10337 .cindex "time interval" "formatting"
10338 The argument (after sub-expansion) must be a sequence of decimal digits that
10339 represents an interval of time as a number of seconds. It is converted into a
10340 number of larger units and output in Exim's normal time format, for example,
10341 &`1w3d4h2m6s`&.
10342
10343 .vitem &*${uc:*&<&'string'&>&*}*&
10344 .cindex "case forcing in strings"
10345 .cindex "string" "case forcing"
10346 .cindex "upper casing"
10347 .cindex "expansion" "case forcing"
10348 .cindex "&%uc%& expansion item"
10349 This forces the letters in the string into upper-case.
10350
10351 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10352 .cindex "correction of invalid utf-8 sequences in strings"
10353 .cindex "utf-8" "utf-8 sequences"
10354 .cindex "incorrect utf-8"
10355 .cindex "expansion" "utf-8 forcing"
10356 .cindex "&%utf8clean%& expansion item"
10357 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10358 .endlist
10359
10360
10361
10362
10363
10364
10365 .section "Expansion conditions" "SECTexpcond"
10366 .scindex IIDexpcond "expansion" "conditions"
10367 The following conditions are available for testing by the &%${if%& construct
10368 while expanding strings:
10369
10370 .vlist
10371 .vitem &*!*&<&'condition'&>
10372 .cindex "expansion" "negating a condition"
10373 .cindex "negation" "in expansion condition"
10374 Preceding any condition with an exclamation mark negates the result of the
10375 condition.
10376
10377 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10378 .cindex "numeric comparison"
10379 .cindex "expansion" "numeric comparison"
10380 There are a number of symbolic operators for doing numeric comparisons. They
10381 are:
10382 .display
10383 &`=   `&   equal
10384 &`==  `&   equal
10385 &`>   `&   greater
10386 &`>=  `&   greater or equal
10387 &`<   `&   less
10388 &`<=  `&   less or equal
10389 .endd
10390 For example:
10391 .code
10392 ${if >{$message_size}{10M} ...
10393 .endd
10394 Note that the general negation operator provides for inequality testing. The
10395 two strings must take the form of optionally signed decimal integers,
10396 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10397 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10398 As a special case, the numerical value of an empty string is taken as
10399 zero.
10400
10401 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10402 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10403 10M, not if 10M is larger than &$message_size$&.
10404
10405
10406 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10407         {*&<&'arg2'&>&*}...}*&
10408 .cindex "expansion" "calling an acl"
10409 .cindex "&%acl%&" "expansion condition"
10410 The name and zero to nine argument strings are first expanded separately.  The expanded
10411 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10412 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10413 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10414 and may use the variables; if another acl expansion is used the values
10415 are restored after it returns.  If the ACL sets
10416 a value using a "message =" modifier the variable $value becomes
10417 the result of the expansion, otherwise it is empty.
10418 If the ACL returns accept the condition is true; if deny, false.
10419 If the ACL returns defer the result is a forced-fail.
10420
10421 .vitem &*bool&~{*&<&'string'&>&*}*&
10422 .cindex "expansion" "boolean parsing"
10423 .cindex "&%bool%& expansion condition"
10424 This condition turns a string holding a true or false representation into
10425 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10426 (case-insensitively); also integer numbers map to true if non-zero,
10427 false if zero.
10428 An empty string is treated as false.
10429 Leading and trailing whitespace is ignored;
10430 thus a string consisting only of whitespace is false.
10431 All other string values will result in expansion failure.
10432
10433 When combined with ACL variables, this expansion condition will let you
10434 make decisions in one place and act on those decisions in another place.
10435 For example:
10436 .code
10437 ${if bool{$acl_m_privileged_sender} ...
10438 .endd
10439
10440
10441 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10442 .cindex "expansion" "boolean parsing"
10443 .cindex "&%bool_lax%& expansion condition"
10444 Like &%bool%&, this condition turns a string into a boolean state.  But
10445 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10446 loose definition that the Router &%condition%& option uses.  The empty string
10447 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10448 true.  Leading and trailing whitespace is ignored.
10449
10450 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10451
10452 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10453 .cindex "expansion" "encrypted comparison"
10454 .cindex "encrypted strings, comparing"
10455 .cindex "&%crypteq%& expansion condition"
10456 This condition is included in the Exim binary if it is built to support any
10457 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10458 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10459 included in the binary.
10460
10461 The &%crypteq%& condition has two arguments. The first is encrypted and
10462 compared against the second, which is already encrypted. The second string may
10463 be in the LDAP form for storing encrypted strings, which starts with the
10464 encryption type in curly brackets, followed by the data. If the second string
10465 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10466 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10467 Typically this will be a field from a password file. An example of an encrypted
10468 string in LDAP form is:
10469 .code
10470 {md5}CY9rzUYh03PK3k6DJie09g==
10471 .endd
10472 If such a string appears directly in an expansion, the curly brackets have to
10473 be quoted, because they are part of the expansion syntax. For example:
10474 .code
10475 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10476 .endd
10477 The following encryption types (whose names are matched case-independently) are
10478 supported:
10479
10480 .ilist
10481 .cindex "MD5 hash"
10482 .cindex "base64 encoding" "in encrypted password"
10483 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10484 printable characters to compare with the remainder of the second string. If the
10485 length of the comparison string is 24, Exim assumes that it is base64 encoded
10486 (as in the above example). If the length is 32, Exim assumes that it is a
10487 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10488 comparison fails.
10489
10490 .next
10491 .cindex "SHA-1 hash"
10492 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10493 printable characters to compare with the remainder of the second string. If the
10494 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10495 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10496 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10497
10498 .next
10499 .cindex "&[crypt()]&"
10500 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10501 only the first eight characters of the password. However, in modern operating
10502 systems this is no longer true, and in many cases the entire password is used,
10503 whatever its length.
10504
10505 .next
10506 .cindex "&[crypt16()]&"
10507 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10508 use up to 16 characters of the password in some operating systems. Again, in
10509 modern operating systems, more characters may be used.
10510 .endlist
10511 Exim has its own version of &[crypt16()]&, which is just a double call to
10512 &[crypt()]&. For operating systems that have their own version, setting
10513 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10514 operating system version instead of its own. This option is set by default in
10515 the OS-dependent &_Makefile_& for those operating systems that are known to
10516 support &[crypt16()]&.
10517
10518 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10519 it was not using the same algorithm as some operating systems' versions. It
10520 turns out that as well as &[crypt16()]& there is a function called
10521 &[bigcrypt()]& in some operating systems. This may or may not use the same
10522 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10523
10524 However, since there is now a move away from the traditional &[crypt()]&
10525 functions towards using SHA1 and other algorithms, tidying up this area of
10526 Exim is seen as very low priority.
10527
10528 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10529 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10530 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10531 default is &`{crypt}`&. Whatever the default, you can always use either
10532 function by specifying it explicitly in curly brackets.
10533
10534 .vitem &*def:*&<&'variable&~name'&>
10535 .cindex "expansion" "checking for empty variable"
10536 .cindex "&%def%& expansion condition"
10537 The &%def%& condition must be followed by the name of one of the expansion
10538 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10539 variable does not contain the empty string. For example:
10540 .code
10541 ${if def:sender_ident {from $sender_ident}}
10542 .endd
10543 Note that the variable name is given without a leading &%$%& character. If the
10544 variable does not exist, the expansion fails.
10545
10546 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10547         &~&*def:h_*&<&'header&~name'&>&*:*&"
10548 .cindex "expansion" "checking header line existence"
10549 This condition is true if a message is being processed and the named header
10550 exists in the message. For example,
10551 .code
10552 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10553 .endd
10554 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10555 the header name must be terminated by a colon if white space does not follow.
10556
10557 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10558        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10559 .cindex "string" "comparison"
10560 .cindex "expansion" "string comparison"
10561 .cindex "&%eq%& expansion condition"
10562 .cindex "&%eqi%& expansion condition"
10563 The two substrings are first expanded. The condition is true if the two
10564 resulting strings are identical. For &%eq%& the comparison includes the case of
10565 letters, whereas for &%eqi%& the comparison is case-independent.
10566
10567 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10568 .cindex "expansion" "file existence test"
10569 .cindex "file" "existence test"
10570 .cindex "&%exists%&, expansion condition"
10571 The substring is first expanded and then interpreted as an absolute path. The
10572 condition is true if the named file (or directory) exists. The existence test
10573 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10574 users' filter files may be locked out by the system administrator.
10575
10576 .vitem &*first_delivery*&
10577 .cindex "delivery" "first"
10578 .cindex "first delivery"
10579 .cindex "expansion" "first delivery test"
10580 .cindex "&%first_delivery%& expansion condition"
10581 This condition, which has no data, is true during a message's first delivery
10582 attempt. It is false during any subsequent delivery attempts.
10583
10584
10585 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10586        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10587 .cindex "list" "iterative conditions"
10588 .cindex "expansion" "&*forall*& condition"
10589 .cindex "expansion" "&*forany*& condition"
10590 .vindex "&$item$&"
10591 These conditions iterate over a list. The first argument is expanded to form
10592 the list. By default, the list separator is a colon, but it can be changed by
10593 the normal method. The second argument is interpreted as a condition that is to
10594 be applied to each item in the list in turn. During the interpretation of the
10595 condition, the current list item is placed in a variable called &$item$&.
10596 .ilist
10597 For &*forany*&, interpretation stops if the condition is true for any item, and
10598 the result of the whole condition is true. If the condition is false for all
10599 items in the list, the overall condition is false.
10600 .next
10601 For &*forall*&, interpretation stops if the condition is false for any item,
10602 and the result of the whole condition is false. If the condition is true for
10603 all items in the list, the overall condition is true.
10604 .endlist
10605 Note that negation of &*forany*& means that the condition must be false for all
10606 items for the overall condition to succeed, and negation of &*forall*& means
10607 that the condition must be false for at least one item. In this example, the
10608 list separator is changed to a comma:
10609 .code
10610 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10611 .endd
10612 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10613 being processed, to enable these expansion items to be nested.
10614
10615 To scan a named list, expand it with the &*listnamed*& operator.
10616
10617
10618 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10619        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10620 .cindex "string" "comparison"
10621 .cindex "expansion" "string comparison"
10622 .cindex "&%ge%& expansion condition"
10623 .cindex "&%gei%& expansion condition"
10624 The two substrings are first expanded. The condition is true if the first
10625 string is lexically greater than or equal to the second string. For &%ge%& the
10626 comparison includes the case of letters, whereas for &%gei%& the comparison is
10627 case-independent.
10628
10629 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10630        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10631 .cindex "string" "comparison"
10632 .cindex "expansion" "string comparison"
10633 .cindex "&%gt%& expansion condition"
10634 .cindex "&%gti%& expansion condition"
10635 The two substrings are first expanded. The condition is true if the first
10636 string is lexically greater than the second string. For &%gt%& the comparison
10637 includes the case of letters, whereas for &%gti%& the comparison is
10638 case-independent.
10639
10640 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10641        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10642 .cindex "string" "comparison"
10643 .cindex "list" "iterative conditions"
10644 Both strings are expanded; the second string is treated as a list of simple
10645 strings; if the first string is a member of the second, then the condition
10646 is true.
10647
10648 These are simpler to use versions of the more powerful &*forany*& condition.
10649 Examples, and the &*forany*& equivalents:
10650 .code
10651 ${if inlist{needle}{foo:needle:bar}}
10652   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10653 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10654   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10655 .endd
10656
10657 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10658        &*isip4&~{*&<&'string'&>&*}*& &&&
10659        &*isip6&~{*&<&'string'&>&*}*&
10660 .cindex "IP address" "testing string format"
10661 .cindex "string" "testing for IP address"
10662 .cindex "&%isip%& expansion condition"
10663 .cindex "&%isip4%& expansion condition"
10664 .cindex "&%isip6%& expansion condition"
10665 The substring is first expanded, and then tested to see if it has the form of
10666 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10667 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10668
10669 For an IPv4 address, the test is for four dot-separated components, each of
10670 which consists of from one to three digits. For an IPv6 address, up to eight
10671 colon-separated components are permitted, each containing from one to four
10672 hexadecimal digits. There may be fewer than eight components if an empty
10673 component (adjacent colons) is present. Only one empty component is permitted.
10674
10675 &*Note*&: The checks are just on the form of the address; actual numerical
10676 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10677 check. The main use of these tests is to distinguish between IP addresses and
10678 host names, or between IPv4 and IPv6 addresses. For example, you could use
10679 .code
10680 ${if isip4{$sender_host_address}...
10681 .endd
10682 to test which IP version an incoming SMTP connection is using.
10683
10684 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10685 .cindex "LDAP" "use for authentication"
10686 .cindex "expansion" "LDAP authentication test"
10687 .cindex "&%ldapauth%& expansion condition"
10688 This condition supports user authentication using LDAP. See section
10689 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10690 queries. For this use, the query must contain a user name and password. The
10691 query itself is not used, and can be empty. The condition is true if the
10692 password is not empty, and the user name and password are accepted by the LDAP
10693 server. An empty password is rejected without calling LDAP because LDAP binds
10694 with an empty password are considered anonymous regardless of the username, and
10695 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10696 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10697 this can be used.
10698
10699
10700 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10701        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10702 .cindex "string" "comparison"
10703 .cindex "expansion" "string comparison"
10704 .cindex "&%le%& expansion condition"
10705 .cindex "&%lei%& expansion condition"
10706 The two substrings are first expanded. The condition is true if the first
10707 string is lexically less than or equal to the second string. For &%le%& the
10708 comparison includes the case of letters, whereas for &%lei%& the comparison is
10709 case-independent.
10710
10711 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10712        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10713 .cindex "string" "comparison"
10714 .cindex "expansion" "string comparison"
10715 .cindex "&%lt%& expansion condition"
10716 .cindex "&%lti%& expansion condition"
10717 The two substrings are first expanded. The condition is true if the first
10718 string is lexically less than the second string. For &%lt%& the comparison
10719 includes the case of letters, whereas for &%lti%& the comparison is
10720 case-independent.
10721
10722
10723 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10724 .cindex "expansion" "regular expression comparison"
10725 .cindex "regular expressions" "match in expanded string"
10726 .cindex "&%match%& expansion condition"
10727 The two substrings are first expanded. The second is then treated as a regular
10728 expression and applied to the first. Because of the pre-expansion, if the
10729 regular expression contains dollar, or backslash characters, they must be
10730 escaped. Care must also be taken if the regular expression contains braces
10731 (curly brackets). A closing brace must be escaped so that it is not taken as a
10732 premature termination of <&'string2'&>. The easiest approach is to use the
10733 &`\N`& feature to disable expansion of the regular expression.
10734 For example,
10735 .code
10736 ${if match {$local_part}{\N^\d{3}\N} ...
10737 .endd
10738 If the whole expansion string is in double quotes, further escaping of
10739 backslashes is also required.
10740
10741 The condition is true if the regular expression match succeeds.
10742 The regular expression is not required to begin with a circumflex
10743 metacharacter, but if there is no circumflex, the expression is not anchored,
10744 and it may match anywhere in the subject, not just at the start. If you want
10745 the pattern to match at the end of the subject, you must include the &`$`&
10746 metacharacter at an appropriate point.
10747
10748 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10749 At the start of an &%if%& expansion the values of the numeric variable
10750 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10751 succeeds causes them to be reset to the substrings of that condition and they
10752 will have these values during the expansion of the success string. At the end
10753 of the &%if%& expansion, the previous values are restored. After testing a
10754 combination of conditions using &%or%&, the subsequent values of the numeric
10755 variables are those of the condition that succeeded.
10756
10757 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10758 .cindex "&%match_address%& expansion condition"
10759 See &*match_local_part*&.
10760
10761 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10762 .cindex "&%match_domain%& expansion condition"
10763 See &*match_local_part*&.
10764
10765 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10766 .cindex "&%match_ip%& expansion condition"
10767 This condition matches an IP address to a list of IP address patterns. It must
10768 be followed by two argument strings. The first (after expansion) must be an IP
10769 address or an empty string. The second (not expanded) is a restricted host
10770 list that can match only an IP address, not a host name. For example:
10771 .code
10772 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10773 .endd
10774 The specific types of host list item that are permitted in the list are:
10775
10776 .ilist
10777 An IP address, optionally with a CIDR mask.
10778 .next
10779 A single asterisk, which matches any IP address.
10780 .next
10781 An empty item, which matches only if the IP address is empty. This could be
10782 useful for testing for a locally submitted message or one from specific hosts
10783 in a single test such as
10784 . ==== As this is a nested list, any displays it contains must be indented
10785 . ==== as otherwise they are too far to the left. This comment applies to
10786 . ==== the use of xmlto plus fop. There's no problem when formatting with
10787 . ==== sdop, with or without the extra indent.
10788 .code
10789   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10790 .endd
10791 where the first item in the list is the empty string.
10792 .next
10793 The item @[] matches any of the local host's interface addresses.
10794 .next
10795 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10796 even if &`net-`& is not specified. There is never any attempt to turn the IP
10797 address into a host name. The most common type of linear search for
10798 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10799 masks. For example:
10800 .code
10801   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10802 .endd
10803 It is of course possible to use other kinds of lookup, and in such a case, you
10804 do need to specify the &`net-`& prefix if you want to specify a specific
10805 address mask, for example:
10806 .code
10807   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10808 .endd
10809 However, unless you are combining a &%match_ip%& condition with others, it is
10810 just as easy to use the fact that a lookup is itself a condition, and write:
10811 .code
10812   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10813 .endd
10814 .endlist ilist
10815
10816 Note that <&'string2'&> is not itself subject to string expansion, unless
10817 Exim was built with the EXPAND_LISTMATCH_RHS option.
10818
10819 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10820
10821 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10822 .cindex "domain list" "in expansion condition"
10823 .cindex "address list" "in expansion condition"
10824 .cindex "local part" "list, in expansion condition"
10825 .cindex "&%match_local_part%& expansion condition"
10826 This condition, together with &%match_address%& and &%match_domain%&, make it
10827 possible to test domain, address, and local part lists within expansions. Each
10828 condition requires two arguments: an item and a list to match. A trivial
10829 example is:
10830 .code
10831 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10832 .endd
10833 In each case, the second argument may contain any of the allowable items for a
10834 list of the appropriate type. Also, because the second argument (after
10835 expansion) is a standard form of list, it is possible to refer to a named list.
10836 Thus, you can use conditions like this:
10837 .code
10838 ${if match_domain{$domain}{+local_domains}{...
10839 .endd
10840 .cindex "&`+caseful`&"
10841 For address lists, the matching starts off caselessly, but the &`+caseful`&
10842 item can be used, as in all address lists, to cause subsequent items to
10843 have their local parts matched casefully. Domains are always matched
10844 caselessly.
10845
10846 Note that <&'string2'&> is not itself subject to string expansion, unless
10847 Exim was built with the EXPAND_LISTMATCH_RHS option.
10848
10849 &*Note*&: Host lists are &'not'& supported in this way. This is because
10850 hosts have two identities: a name and an IP address, and it is not clear
10851 how to specify cleanly how such a test would work. However, IP addresses can be
10852 matched using &%match_ip%&.
10853
10854 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10855 .cindex "PAM authentication"
10856 .cindex "AUTH" "with PAM"
10857 .cindex "Solaris" "PAM support"
10858 .cindex "expansion" "PAM authentication test"
10859 .cindex "&%pam%& expansion condition"
10860 &'Pluggable Authentication Modules'&
10861 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10862 available in the latest releases of Solaris and in some GNU/Linux
10863 distributions. The Exim support, which is intended for use in conjunction with
10864 the SMTP AUTH command, is available only if Exim is compiled with
10865 .code
10866 SUPPORT_PAM=yes
10867 .endd
10868 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10869 in some releases of GNU/Linux &%-ldl%& is also needed.
10870
10871 The argument string is first expanded, and the result must be a
10872 colon-separated list of strings. Leading and trailing white space is ignored.
10873 The PAM module is initialized with the service name &"exim"& and the user name
10874 taken from the first item in the colon-separated data string (<&'string1'&>).
10875 The remaining items in the data string are passed over in response to requests
10876 from the authentication function. In the simple case there will only be one
10877 request, for a password, so the data consists of just two strings.
10878
10879 There can be problems if any of the strings are permitted to contain colon
10880 characters. In the usual way, these have to be doubled to avoid being taken as
10881 separators. If the data is being inserted from a variable, the &%sg%& expansion
10882 item can be used to double any existing colons. For example, the configuration
10883 of a LOGIN authenticator might contain this setting:
10884 .code
10885 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10886 .endd
10887 For a PLAIN authenticator you could use:
10888 .code
10889 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10890 .endd
10891 In some operating systems, PAM authentication can be done only from a process
10892 running as root. Since Exim is running as the Exim user when receiving
10893 messages, this means that PAM cannot be used directly in those systems.
10894 A patched version of the &'pam_unix'& module that comes with the
10895 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10896 The patched module allows one special uid/gid combination, in addition to root,
10897 to authenticate. If you build the patched module to allow the Exim user and
10898 group, PAM can then be used from an Exim authenticator.
10899
10900
10901 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10902 .cindex "&'pwcheck'& daemon"
10903 .cindex "Cyrus"
10904 .cindex "expansion" "&'pwcheck'& authentication test"
10905 .cindex "&%pwcheck%& expansion condition"
10906 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10907 This is one way of making it possible for passwords to be checked by a process
10908 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10909 deprecated. Its replacement is &'saslauthd'& (see below).
10910
10911 The pwcheck support is not included in Exim by default. You need to specify
10912 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10913 building Exim. For example:
10914 .code
10915 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10916 .endd
10917 You do not need to install the full Cyrus software suite in order to use
10918 the pwcheck daemon. You can compile and install just the daemon alone
10919 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10920 access to the &_/var/pwcheck_& directory.
10921
10922 The &%pwcheck%& condition takes one argument, which must be the user name and
10923 password, separated by a colon. For example, in a LOGIN authenticator
10924 configuration, you might have this:
10925 .code
10926 server_condition = ${if pwcheck{$auth1:$auth2}}
10927 .endd
10928 Again, for a PLAIN authenticator configuration, this would be:
10929 .code
10930 server_condition = ${if pwcheck{$auth2:$auth3}}
10931 .endd
10932 .vitem &*queue_running*&
10933 .cindex "queue runner" "detecting when delivering from"
10934 .cindex "expansion" "queue runner test"
10935 .cindex "&%queue_running%& expansion condition"
10936 This condition, which has no data, is true during delivery attempts that are
10937 initiated by queue runner processes, and false otherwise.
10938
10939
10940 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10941 .cindex "Radius"
10942 .cindex "expansion" "Radius authentication"
10943 .cindex "&%radius%& expansion condition"
10944 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10945 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10946 the Radius client configuration file in order to build Exim with Radius
10947 support.
10948
10949 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10950 library, using the original API. If you are using release 0.4.0 or later of
10951 this library, you need to set
10952 .code
10953 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
10954 .endd
10955 in &_Local/Makefile_& when building Exim. You can also link Exim with the
10956 &%libradius%& library that comes with FreeBSD. To do this, set
10957 .code
10958 RADIUS_LIB_TYPE=RADLIB
10959 .endd
10960 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
10961 You may also have to supply a suitable setting in EXTRALIBS so that the
10962 Radius library can be found when Exim is linked.
10963
10964 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
10965 Radius client library, which calls the Radius server. The condition is true if
10966 the authentication is successful. For example:
10967 .code
10968 server_condition = ${if radius{<arguments>}}
10969 .endd
10970
10971
10972 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
10973         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
10974 .cindex "&'saslauthd'& daemon"
10975 .cindex "Cyrus"
10976 .cindex "expansion" "&'saslauthd'& authentication test"
10977 .cindex "&%saslauthd%& expansion condition"
10978 This condition supports user authentication using the Cyrus &'saslauthd'&
10979 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
10980 Using this daemon is one way of making it possible for passwords to be checked
10981 by a process that is not running as root.
10982
10983 The saslauthd support is not included in Exim by default. You need to specify
10984 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
10985 building Exim. For example:
10986 .code
10987 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
10988 .endd
10989 You do not need to install the full Cyrus software suite in order to use
10990 the saslauthd daemon. You can compile and install just the daemon alone
10991 from the Cyrus SASL library.
10992
10993 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
10994 two are mandatory. For example:
10995 .code
10996 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
10997 .endd
10998 The service and the realm are optional (which is why the arguments are enclosed
10999 in their own set of braces). For details of the meaning of the service and
11000 realm, and how to run the daemon, consult the Cyrus documentation.
11001 .endlist vlist
11002
11003
11004
11005 .section "Combining expansion conditions" "SECID84"
11006 .cindex "expansion" "combining conditions"
11007 Several conditions can be tested at once by combining them using the &%and%&
11008 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11009 conditions on their own, and precede their lists of sub-conditions. Each
11010 sub-condition must be enclosed in braces within the overall braces that contain
11011 the list. No repetition of &%if%& is used.
11012
11013
11014 .vlist
11015 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11016 .cindex "&""or""& expansion condition"
11017 .cindex "expansion" "&""or""& of conditions"
11018 The sub-conditions are evaluated from left to right. The condition is true if
11019 any one of the sub-conditions is true.
11020 For example,
11021 .code
11022 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11023 .endd
11024 When a true sub-condition is found, the following ones are parsed but not
11025 evaluated. If there are several &"match"& sub-conditions the values of the
11026 numeric variables afterwards are taken from the first one that succeeds.
11027
11028 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11029 .cindex "&""and""& expansion condition"
11030 .cindex "expansion" "&""and""& of conditions"
11031 The sub-conditions are evaluated from left to right. The condition is true if
11032 all of the sub-conditions are true. If there are several &"match"&
11033 sub-conditions, the values of the numeric variables afterwards are taken from
11034 the last one. When a false sub-condition is found, the following ones are
11035 parsed but not evaluated.
11036 .endlist
11037 .ecindex IIDexpcond
11038
11039
11040
11041
11042 .section "Expansion variables" "SECTexpvar"
11043 .cindex "expansion" "variables, list of"
11044 This section contains an alphabetical list of all the expansion variables. Some
11045 of them are available only when Exim is compiled with specific options such as
11046 support for TLS or the content scanning extension.
11047
11048 .vlist
11049 .vitem "&$0$&, &$1$&, etc"
11050 .cindex "numerical variables (&$1$& &$2$& etc)"
11051 When a &%match%& expansion condition succeeds, these variables contain the
11052 captured substrings identified by the regular expression during subsequent
11053 processing of the success string of the containing &%if%& expansion item.
11054 However, they do not retain their values afterwards; in fact, their previous
11055 values are restored at the end of processing an &%if%& item. The numerical
11056 variables may also be set externally by some other matching process which
11057 precedes the expansion of the string. For example, the commands available in
11058 Exim filter files include an &%if%& command with its own regular expression
11059 matching condition.
11060
11061 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11062 Within an acl condition, expansion condition or expansion item
11063 any arguments are copied to these variables,
11064 any unused variables being made empty.
11065
11066 .vitem "&$acl_c...$&"
11067 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11068 can be given any name that starts with &$acl_c$& and is at least six characters
11069 long, but the sixth character must be either a digit or an underscore. For
11070 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11071 variables persist throughout the lifetime of an SMTP connection. They can be
11072 used to pass information between ACLs and between different invocations of the
11073 same ACL. When a message is received, the values of these variables are saved
11074 with the message, and can be accessed by filters, routers, and transports
11075 during subsequent delivery.
11076
11077 .vitem "&$acl_m...$&"
11078 These variables are like the &$acl_c...$& variables, except that their values
11079 are reset after a message has been received. Thus, if several messages are
11080 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11081 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11082 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11083 message is received, the values of these variables are saved with the message,
11084 and can be accessed by filters, routers, and transports during subsequent
11085 delivery.
11086
11087 .vitem &$acl_narg$&
11088 Within an acl condition, expansion condition or expansion item
11089 this variable has the number of arguments.
11090
11091 .vitem &$acl_verify_message$&
11092 .vindex "&$acl_verify_message$&"
11093 After an address verification has failed, this variable contains the failure
11094 message. It retains its value for use in subsequent modifiers. The message can
11095 be preserved by coding like this:
11096 .code
11097 warn !verify = sender
11098      set acl_m0 = $acl_verify_message
11099 .endd
11100 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11101 &%log_message%& modifiers, to include information about the verification
11102 failure.
11103
11104 .vitem &$address_data$&
11105 .vindex "&$address_data$&"
11106 This variable is set by means of the &%address_data%& option in routers. The
11107 value then remains with the address while it is processed by subsequent routers
11108 and eventually a transport. If the transport is handling multiple addresses,
11109 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11110 for more details. &*Note*&: The contents of &$address_data$& are visible in
11111 user filter files.
11112
11113 If &$address_data$& is set when the routers are called from an ACL to verify
11114 a recipient address, the final value is still in the variable for subsequent
11115 conditions and modifiers of the ACL statement. If routing the address caused it
11116 to be redirected to just one address, the child address is also routed as part
11117 of the verification, and in this case the final value of &$address_data$& is
11118 from the child's routing.
11119
11120 If &$address_data$& is set when the routers are called from an ACL to verify a
11121 sender address, the final value is also preserved, but this time in
11122 &$sender_address_data$&, to distinguish it from data from a recipient
11123 address.
11124
11125 In both cases (recipient and sender verification), the value does not persist
11126 after the end of the current ACL statement. If you want to preserve
11127 these values for longer, you can save them in ACL variables.
11128
11129 .vitem &$address_file$&
11130 .vindex "&$address_file$&"
11131 When, as a result of aliasing, forwarding, or filtering, a message is directed
11132 to a specific file, this variable holds the name of the file when the transport
11133 is running. At other times, the variable is empty. For example, using the
11134 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11135 .code
11136 /home/r2d2/savemail
11137 .endd
11138 then when the &(address_file)& transport is running, &$address_file$&
11139 contains the text string &`/home/r2d2/savemail`&.
11140 .cindex "Sieve filter" "value of &$address_file$&"
11141 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11142 then up to the transport configuration to generate an appropriate absolute path
11143 to the relevant file.
11144
11145 .vitem &$address_pipe$&
11146 .vindex "&$address_pipe$&"
11147 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11148 this variable holds the pipe command when the transport is running.
11149
11150 .vitem "&$auth1$& &-- &$auth3$&"
11151 .vindex "&$auth1$&, &$auth2$&, etc"
11152 These variables are used in SMTP authenticators (see chapters
11153 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11154
11155 .vitem &$authenticated_id$&
11156 .cindex "authentication" "id"
11157 .vindex "&$authenticated_id$&"
11158 When a server successfully authenticates a client it may be configured to
11159 preserve some of the authentication information in the variable
11160 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11161 user/password authenticator configuration might preserve the user name for use
11162 in the routers. Note that this is not the same information that is saved in
11163 &$sender_host_authenticated$&.
11164 When a message is submitted locally (that is, not over a TCP connection)
11165 the value of &$authenticated_id$& is normally the login name of the calling
11166 process. However, a trusted user can override this by means of the &%-oMai%&
11167 command line option.
11168
11169 .vitem &$authenticated_fail_id$&
11170 .cindex "authentication" "fail" "id"
11171 .vindex "&$authenticated_fail_id$&"
11172 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11173 will contain the failed authentication id. If more than one authentication
11174 id is attempted, it will contain only the last one. The variable is
11175 available for processing in the ACL's, generally the quit or notquit ACL.
11176 A message to a local recipient could still be accepted without requiring
11177 authentication, which means this variable could also be visible in all of
11178 the ACL's as well.
11179
11180
11181 .vitem &$authenticated_sender$&
11182 .cindex "sender" "authenticated"
11183 .cindex "authentication" "sender"
11184 .cindex "AUTH" "on MAIL command"
11185 .vindex "&$authenticated_sender$&"
11186 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11187 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11188 described in section &<<SECTauthparamail>>&. Unless the data is the string
11189 &"<>"&, it is set as the authenticated sender of the message, and the value is
11190 available during delivery in the &$authenticated_sender$& variable. If the
11191 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11192
11193 .vindex "&$qualify_domain$&"
11194 When a message is submitted locally (that is, not over a TCP connection), the
11195 value of &$authenticated_sender$& is an address constructed from the login
11196 name of the calling process and &$qualify_domain$&, except that a trusted user
11197 can override this by means of the &%-oMas%& command line option.
11198
11199
11200 .vitem &$authentication_failed$&
11201 .cindex "authentication" "failure"
11202 .vindex "&$authentication_failed$&"
11203 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11204 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11205 possible to distinguish between &"did not try to authenticate"&
11206 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11207 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11208 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11209 negative response to an AUTH command, including (for example) an attempt to use
11210 an undefined mechanism.
11211
11212 .vitem &$av_failed$&
11213 .cindex "content scanning" "AV scanner failure"
11214 This variable is available when Exim is compiled with the content-scanning
11215 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11216 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11217 the ACL malware condition.
11218
11219 .vitem &$body_linecount$&
11220 .cindex "message body" "line count"
11221 .cindex "body of message" "line count"
11222 .vindex "&$body_linecount$&"
11223 When a message is being received or delivered, this variable contains the
11224 number of lines in the message's body. See also &$message_linecount$&.
11225
11226 .vitem &$body_zerocount$&
11227 .cindex "message body" "binary zero count"
11228 .cindex "body of message" "binary zero count"
11229 .cindex "binary zero" "in message body"
11230 .vindex "&$body_zerocount$&"
11231 When a message is being received or delivered, this variable contains the
11232 number of binary zero bytes (ASCII NULs) in the message's body.
11233
11234 .vitem &$bounce_recipient$&
11235 .vindex "&$bounce_recipient$&"
11236 This is set to the recipient address of a bounce message while Exim is creating
11237 it. It is useful if a customized bounce message text file is in use (see
11238 chapter &<<CHAPemsgcust>>&).
11239
11240 .vitem &$bounce_return_size_limit$&
11241 .vindex "&$bounce_return_size_limit$&"
11242 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11243 up to a multiple of 1000. It is useful when a customized error message text
11244 file is in use (see chapter &<<CHAPemsgcust>>&).
11245
11246 .vitem &$caller_gid$&
11247 .cindex "gid (group id)" "caller"
11248 .vindex "&$caller_gid$&"
11249 The real group id under which the process that called Exim was running. This is
11250 not the same as the group id of the originator of a message (see
11251 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11252 incarnation normally contains the Exim gid.
11253
11254 .vitem &$caller_uid$&
11255 .cindex "uid (user id)" "caller"
11256 .vindex "&$caller_uid$&"
11257 The real user id under which the process that called Exim was running. This is
11258 not the same as the user id of the originator of a message (see
11259 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11260 incarnation normally contains the Exim uid.
11261
11262 .vitem &$compile_date$&
11263 .vindex "&$compile_date$&"
11264 The date on which the Exim binary was compiled.
11265
11266 .vitem &$compile_number$&
11267 .vindex "&$compile_number$&"
11268 The building process for Exim keeps a count of the number
11269 of times it has been compiled. This serves to distinguish different
11270 compilations of the same version of the program.
11271
11272 .new
11273 .vitem &$config_dir$&
11274 .vindex "&$config_dir$&"
11275 The directory name of the main configuration file. That is, the content of
11276 &$config_file$& with the last component stripped. The value does not
11277 contain the trailing slash. If &$config_file$& does not contain a slash,
11278 &$config_dir$& is ".".
11279
11280 .vitem &$config_file$&
11281 .vindex "&$config_file$&"
11282 The name of the main configuration file Exim is using.
11283 .wen
11284
11285 .vitem &$demime_errorlevel$&
11286 .vindex "&$demime_errorlevel$&"
11287 This variable is available when Exim is compiled with
11288 the content-scanning extension and the obsolete &%demime%& condition. For
11289 details, see section &<<SECTdemimecond>>&.
11290
11291 .vitem &$demime_reason$&
11292 .vindex "&$demime_reason$&"
11293 This variable is available when Exim is compiled with the
11294 content-scanning extension and the obsolete &%demime%& condition. For details,
11295 see section &<<SECTdemimecond>>&.
11296
11297 .vitem &$dnslist_domain$& &&&
11298        &$dnslist_matched$& &&&
11299        &$dnslist_text$& &&&
11300        &$dnslist_value$&
11301 .vindex "&$dnslist_domain$&"
11302 .vindex "&$dnslist_matched$&"
11303 .vindex "&$dnslist_text$&"
11304 .vindex "&$dnslist_value$&"
11305 .cindex "black list (DNS)"
11306 When a DNS (black) list lookup succeeds, these variables are set to contain
11307 the following data from the lookup: the list's domain name, the key that was
11308 looked up, the contents of any associated TXT record, and the value from the
11309 main A record. See section &<<SECID204>>& for more details.
11310
11311 .vitem &$domain$&
11312 .vindex "&$domain$&"
11313 When an address is being routed, or delivered on its own, this variable
11314 contains the domain. Uppercase letters in the domain are converted into lower
11315 case for &$domain$&.
11316
11317 Global address rewriting happens when a message is received, so the value of
11318 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11319 is set during user filtering, but not during system filtering, because a
11320 message may have many recipients and the system filter is called just once.
11321
11322 When more than one address is being delivered at once (for example, several
11323 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11324 have the same domain. Transports can be restricted to handling only one domain
11325 at a time if the value of &$domain$& is required at transport time &-- this is
11326 the default for local transports. For further details of the environment in
11327 which local transports are run, see chapter &<<CHAPenvironment>>&.
11328
11329 .oindex "&%delay_warning_condition%&"
11330 At the end of a delivery, if all deferred addresses have the same domain, it is
11331 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11332
11333 The &$domain$& variable is also used in some other circumstances:
11334
11335 .ilist
11336 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11337 the recipient address. The domain of the &'sender'& address is in
11338 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11339 normally set during the running of the MAIL ACL. However, if the sender address
11340 is verified with a callout during the MAIL ACL, the sender domain is placed in
11341 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11342 the &(smtp)& transport.
11343
11344 .next
11345 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11346 &$domain$& contains the domain portion of the address that is being rewritten;
11347 it can be used in the expansion of the replacement address, for example, to
11348 rewrite domains by file lookup.
11349
11350 .next
11351 With one important exception, whenever a domain list is being scanned,
11352 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11353 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11354 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11355 that, in a RCPT ACL, the sender domain list can be dependent on the
11356 recipient domain (which is what is in &$domain$& at this time).
11357
11358 .next
11359 .cindex "ETRN" "value of &$domain$&"
11360 .oindex "&%smtp_etrn_command%&"
11361 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11362 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11363 .endlist
11364
11365
11366 .vitem &$domain_data$&
11367 .vindex "&$domain_data$&"
11368 When the &%domains%& option on a router matches a domain by
11369 means of a lookup, the data read by the lookup is available during the running
11370 of the router as &$domain_data$&. In addition, if the driver routes the
11371 address to a transport, the value is available in that transport. If the
11372 transport is handling multiple addresses, the value from the first address is
11373 used.
11374
11375 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11376 domain by means of a lookup. The data read by the lookup is available during
11377 the rest of the ACL statement. In all other situations, this variable expands
11378 to nothing.
11379
11380 .vitem &$exim_gid$&
11381 .vindex "&$exim_gid$&"
11382 This variable contains the numerical value of the Exim group id.
11383
11384 .vitem &$exim_path$&
11385 .vindex "&$exim_path$&"
11386 This variable contains the path to the Exim binary.
11387
11388 .vitem &$exim_uid$&
11389 .vindex "&$exim_uid$&"
11390 This variable contains the numerical value of the Exim user id.
11391
11392 .new
11393 .vitem &$exim_version$&
11394 .vindex "&$exim_uid$&"
11395 This variable contains the version string of the Exim build.
11396 The first character is a major version number, currently 4.
11397 Then after a dot, the next group of digits is a minor version number.
11398 There may be other characters following the minor version.
11399 .wen
11400
11401 .vitem &$found_extension$&
11402 .vindex "&$found_extension$&"
11403 This variable is available when Exim is compiled with the
11404 content-scanning extension and the obsolete &%demime%& condition. For details,
11405 see section &<<SECTdemimecond>>&.
11406
11407 .vitem &$header_$&<&'name'&>
11408 This is not strictly an expansion variable. It is expansion syntax for
11409 inserting the message header line with the given name. Note that the name must
11410 be terminated by colon or white space, because it may contain a wide variety of
11411 characters. Note also that braces must &'not'& be used.
11412
11413 .vitem &$headers_added$&
11414 .vindex "&$headers_added$&"
11415 Within an ACL this variable contains the headers added so far by
11416 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11417 The headers are a newline-separated list.
11418
11419 .vitem &$home$&
11420 .vindex "&$home$&"
11421 When the &%check_local_user%& option is set for a router, the user's home
11422 directory is placed in &$home$& when the check succeeds. In particular, this
11423 means it is set during the running of users' filter files. A router may also
11424 explicitly set a home directory for use by a transport; this can be overridden
11425 by a setting on the transport itself.
11426
11427 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11428 of the environment variable HOME.
11429
11430 .vitem &$host$&
11431 .vindex "&$host$&"
11432 If a router assigns an address to a transport (any transport), and passes a
11433 list of hosts with the address, the value of &$host$& when the transport starts
11434 to run is the name of the first host on the list. Note that this applies both
11435 to local and remote transports.
11436
11437 .cindex "transport" "filter"
11438 .cindex "filter" "transport filter"
11439 For the &(smtp)& transport, if there is more than one host, the value of
11440 &$host$& changes as the transport works its way through the list. In
11441 particular, when the &(smtp)& transport is expanding its options for encryption
11442 using TLS, or for specifying a transport filter (see chapter
11443 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11444 is connected.
11445
11446 When used in the client part of an authenticator configuration (see chapter
11447 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11448 client is connected.
11449
11450
11451 .vitem &$host_address$&
11452 .vindex "&$host_address$&"
11453 This variable is set to the remote host's IP address whenever &$host$& is set
11454 for a remote connection. It is also set to the IP address that is being checked
11455 when the &%ignore_target_hosts%& option is being processed.
11456
11457 .vitem &$host_data$&
11458 .vindex "&$host_data$&"
11459 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11460 result of the lookup is made available in the &$host_data$& variable. This
11461 allows you, for example, to do things like this:
11462 .code
11463 deny  hosts = net-lsearch;/some/file
11464 message = $host_data
11465 .endd
11466 .vitem &$host_lookup_deferred$&
11467 .cindex "host name" "lookup, failure of"
11468 .vindex "&$host_lookup_deferred$&"
11469 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11470 message comes from a remote host and there is an attempt to look up the host's
11471 name from its IP address, and the attempt is not successful, one of these
11472 variables is set to &"1"&.
11473
11474 .ilist
11475 If the lookup receives a definite negative response (for example, a DNS lookup
11476 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11477
11478 .next
11479 If there is any kind of problem during the lookup, such that Exim cannot
11480 tell whether or not the host name is defined (for example, a timeout for a DNS
11481 lookup), &$host_lookup_deferred$& is set to &"1"&.
11482 .endlist ilist
11483
11484 Looking up a host's name from its IP address consists of more than just a
11485 single reverse lookup. Exim checks that a forward lookup of at least one of the
11486 names it receives from a reverse lookup yields the original IP address. If this
11487 is not the case, Exim does not accept the looked up name(s), and
11488 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11489 IP address (for example, the existence of a PTR record in the DNS) is not
11490 sufficient on its own for the success of a host name lookup. If the reverse
11491 lookup succeeds, but there is a lookup problem such as a timeout when checking
11492 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11493 &"1"&. See also &$sender_host_name$&.
11494
11495 .vitem &$host_lookup_failed$&
11496 .vindex "&$host_lookup_failed$&"
11497 See &$host_lookup_deferred$&.
11498
11499 .vitem &$host_port$&
11500 .vindex "&$host_port$&"
11501 This variable is set to the remote host's TCP port whenever &$host$& is set
11502 for an outbound connection.
11503
11504
11505 .vitem &$inode$&
11506 .vindex "&$inode$&"
11507 The only time this variable is set is while expanding the &%directory_file%&
11508 option in the &(appendfile)& transport. The variable contains the inode number
11509 of the temporary file which is about to be renamed. It can be used to construct
11510 a unique name for the file.
11511
11512 .vitem &$interface_address$&
11513 .vindex "&$interface_address$&"
11514 This is an obsolete name for &$received_ip_address$&.
11515
11516 .vitem &$interface_port$&
11517 .vindex "&$interface_port$&"
11518 This is an obsolete name for &$received_port$&.
11519
11520 .vitem &$item$&
11521 .vindex "&$item$&"
11522 This variable is used during the expansion of &*forall*& and &*forany*&
11523 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11524 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11525 empty.
11526
11527 .vitem &$ldap_dn$&
11528 .vindex "&$ldap_dn$&"
11529 This variable, which is available only when Exim is compiled with LDAP support,
11530 contains the DN from the last entry in the most recently successful LDAP
11531 lookup.
11532
11533 .vitem &$load_average$&
11534 .vindex "&$load_average$&"
11535 This variable contains the system load average, multiplied by 1000 so that it
11536 is an integer. For example, if the load average is 0.21, the value of the
11537 variable is 210. The value is recomputed every time the variable is referenced.
11538
11539 .vitem &$local_part$&
11540 .vindex "&$local_part$&"
11541 When an address is being routed, or delivered on its own, this
11542 variable contains the local part. When a number of addresses are being
11543 delivered together (for example, multiple RCPT commands in an SMTP
11544 session), &$local_part$& is not set.
11545
11546 Global address rewriting happens when a message is received, so the value of
11547 &$local_part$& during routing and delivery is the value after rewriting.
11548 &$local_part$& is set during user filtering, but not during system filtering,
11549 because a message may have many recipients and the system filter is called just
11550 once.
11551
11552 .vindex "&$local_part_prefix$&"
11553 .vindex "&$local_part_suffix$&"
11554 If a local part prefix or suffix has been recognized, it is not included in the
11555 value of &$local_part$& during routing and subsequent delivery. The values of
11556 any prefix or suffix are in &$local_part_prefix$& and
11557 &$local_part_suffix$&, respectively.
11558
11559 When a message is being delivered to a file, pipe, or autoreply transport as a
11560 result of aliasing or forwarding, &$local_part$& is set to the local part of
11561 the parent address, not to the file name or command (see &$address_file$& and
11562 &$address_pipe$&).
11563
11564 When an ACL is running for a RCPT command, &$local_part$& contains the
11565 local part of the recipient address.
11566
11567 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11568 &$local_part$& contains the local part of the address that is being rewritten;
11569 it can be used in the expansion of the replacement address, for example.
11570
11571 In all cases, all quoting is removed from the local part. For example, for both
11572 the addresses
11573 .code
11574 "abc:xyz"@test.example
11575 abc\:xyz@test.example
11576 .endd
11577 the value of &$local_part$& is
11578 .code
11579 abc:xyz
11580 .endd
11581 If you use &$local_part$& to create another address, you should always wrap it
11582 inside a quoting operator. For example, in a &(redirect)& router you could
11583 have:
11584 .code
11585 data = ${quote_local_part:$local_part}@new.domain.example
11586 .endd
11587 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11588 to process local parts in a case-dependent manner in a router, you can set the
11589 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11590
11591 .vitem &$local_part_data$&
11592 .vindex "&$local_part_data$&"
11593 When the &%local_parts%& option on a router matches a local part by means of a
11594 lookup, the data read by the lookup is available during the running of the
11595 router as &$local_part_data$&. In addition, if the driver routes the address
11596 to a transport, the value is available in that transport. If the transport is
11597 handling multiple addresses, the value from the first address is used.
11598
11599 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11600 matches a local part by means of a lookup. The data read by the lookup is
11601 available during the rest of the ACL statement. In all other situations, this
11602 variable expands to nothing.
11603
11604 .vitem &$local_part_prefix$&
11605 .vindex "&$local_part_prefix$&"
11606 When an address is being routed or delivered, and a
11607 specific prefix for the local part was recognized, it is available in this
11608 variable, having been removed from &$local_part$&.
11609
11610 .vitem &$local_part_suffix$&
11611 .vindex "&$local_part_suffix$&"
11612 When an address is being routed or delivered, and a
11613 specific suffix for the local part was recognized, it is available in this
11614 variable, having been removed from &$local_part$&.
11615
11616 .vitem &$local_scan_data$&
11617 .vindex "&$local_scan_data$&"
11618 This variable contains the text returned by the &[local_scan()]& function when
11619 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11620
11621 .vitem &$local_user_gid$&
11622 .vindex "&$local_user_gid$&"
11623 See &$local_user_uid$&.
11624
11625 .vitem &$local_user_uid$&
11626 .vindex "&$local_user_uid$&"
11627 This variable and &$local_user_gid$& are set to the uid and gid after the
11628 &%check_local_user%& router precondition succeeds. This means that their values
11629 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11630 and &%condition%&), for the &%address_data%& expansion, and for any
11631 router-specific expansions. At all other times, the values in these variables
11632 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11633
11634 .vitem &$localhost_number$&
11635 .vindex "&$localhost_number$&"
11636 This contains the expanded value of the
11637 &%localhost_number%& option. The expansion happens after the main options have
11638 been read.
11639
11640 .vitem &$log_inodes$&
11641 .vindex "&$log_inodes$&"
11642 The number of free inodes in the disk partition where Exim's
11643 log files are being written. The value is recalculated whenever the variable is
11644 referenced. If the relevant file system does not have the concept of inodes,
11645 the value of is -1. See also the &%check_log_inodes%& option.
11646
11647 .vitem &$log_space$&
11648 .vindex "&$log_space$&"
11649 The amount of free space (as a number of kilobytes) in the disk
11650 partition where Exim's log files are being written. The value is recalculated
11651 whenever the variable is referenced. If the operating system does not have the
11652 ability to find the amount of free space (only true for experimental systems),
11653 the space value is -1. See also the &%check_log_space%& option.
11654
11655
11656 .vitem &$lookup_dnssec_authenticated$&
11657 .vindex "&$lookup_dnssec_authenticated$&"
11658 This variable is set after a DNS lookup done by
11659 a dnsdb lookup expansion, dnslookup router or smtp transport.
11660 It will be empty if &(DNSSEC)& was not requested,
11661 &"no"& if the result was not labelled as authenticated data
11662 and &"yes"& if it was.
11663
11664 .vitem &$mailstore_basename$&
11665 .vindex "&$mailstore_basename$&"
11666 This variable is set only when doing deliveries in &"mailstore"& format in the
11667 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11668 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11669 contains the basename of the files that are being written, that is, the name
11670 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11671 variable is empty.
11672
11673 .vitem &$malware_name$&
11674 .vindex "&$malware_name$&"
11675 This variable is available when Exim is compiled with the
11676 content-scanning extension. It is set to the name of the virus that was found
11677 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11678
11679 .vitem &$max_received_linelength$&
11680 .vindex "&$max_received_linelength$&"
11681 .cindex "maximum" "line length"
11682 .cindex "line length" "maximum"
11683 This variable contains the number of bytes in the longest line that was
11684 received as part of the message, not counting the line termination
11685 character(s).
11686
11687 .vitem &$message_age$&
11688 .cindex "message" "age of"
11689 .vindex "&$message_age$&"
11690 This variable is set at the start of a delivery attempt to contain the number
11691 of seconds since the message was received. It does not change during a single
11692 delivery attempt.
11693
11694 .vitem &$message_body$&
11695 .cindex "body of message" "expansion variable"
11696 .cindex "message body" "in expansion"
11697 .cindex "binary zero" "in message body"
11698 .vindex "&$message_body$&"
11699 .oindex "&%message_body_visible%&"
11700 This variable contains the initial portion of a message's body while it is
11701 being delivered, and is intended mainly for use in filter files. The maximum
11702 number of characters of the body that are put into the variable is set by the
11703 &%message_body_visible%& configuration option; the default is 500.
11704
11705 .oindex "&%message_body_newlines%&"
11706 By default, newlines are converted into spaces in &$message_body$&, to make it
11707 easier to search for phrases that might be split over a line break. However,
11708 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11709 zeros are always converted into spaces.
11710
11711 .vitem &$message_body_end$&
11712 .cindex "body of message" "expansion variable"
11713 .cindex "message body" "in expansion"
11714 .vindex "&$message_body_end$&"
11715 This variable contains the final portion of a message's
11716 body while it is being delivered. The format and maximum size are as for
11717 &$message_body$&.
11718
11719 .vitem &$message_body_size$&
11720 .cindex "body of message" "size"
11721 .cindex "message body" "size"
11722 .vindex "&$message_body_size$&"
11723 When a message is being delivered, this variable contains the size of the body
11724 in bytes. The count starts from the character after the blank line that
11725 separates the body from the header. Newlines are included in the count. See
11726 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11727
11728 .vitem &$message_exim_id$&
11729 .vindex "&$message_exim_id$&"
11730 When a message is being received or delivered, this variable contains the
11731 unique message id that is generated and used by Exim to identify the message.
11732 An id is not created for a message until after its header has been successfully
11733 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11734 line; it is the local id that Exim assigns to the message, for example:
11735 &`1BXTIK-0001yO-VA`&.
11736
11737 .vitem &$message_headers$&
11738 .vindex &$message_headers$&
11739 This variable contains a concatenation of all the header lines when a message
11740 is being processed, except for lines added by routers or transports. The header
11741 lines are separated by newline characters. Their contents are decoded in the
11742 same way as a header line that is inserted by &%bheader%&.
11743
11744 .vitem &$message_headers_raw$&
11745 .vindex &$message_headers_raw$&
11746 This variable is like &$message_headers$& except that no processing of the
11747 contents of header lines is done.
11748
11749 .vitem &$message_id$&
11750 This is an old name for &$message_exim_id$&. It is now deprecated.
11751
11752 .vitem &$message_linecount$&
11753 .vindex "&$message_linecount$&"
11754 This variable contains the total number of lines in the header and body of the
11755 message. Compare &$body_linecount$&, which is the count for the body only.
11756 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11757 number of lines received. Before delivery happens (that is, before filters,
11758 routers, and transports run) the count is increased to include the
11759 &'Received:'& header line that Exim standardly adds, and also any other header
11760 lines that are added by ACLs. The blank line that separates the message header
11761 from the body is not counted.
11762
11763 As with the special case of &$message_size$&, during the expansion of the
11764 appendfile transport's maildir_tag option in maildir format, the value of
11765 &$message_linecount$& is the precise size of the number of newlines in the
11766 file that has been written (minus one for the blank line between the
11767 header and the body).
11768
11769 Here is an example of the use of this variable in a DATA ACL:
11770 .code
11771 deny message   = Too many lines in message header
11772      condition = \
11773       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11774 .endd
11775 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11776 message has not yet been received.
11777
11778 .vitem &$message_size$&
11779 .cindex "size" "of message"
11780 .cindex "message" "size"
11781 .vindex "&$message_size$&"
11782 When a message is being processed, this variable contains its size in bytes. In
11783 most cases, the size includes those headers that were received with the
11784 message, but not those (such as &'Envelope-to:'&) that are added to individual
11785 deliveries as they are written. However, there is one special case: during the
11786 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11787 doing a delivery in maildir format, the value of &$message_size$& is the
11788 precise size of the file that has been written. See also
11789 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11790
11791 .cindex "RCPT" "value of &$message_size$&"
11792 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11793 contains the size supplied on the MAIL command, or -1 if no size was given. The
11794 value may not, of course, be truthful.
11795
11796 .vitem &$mime_$&&'xxx'&
11797 A number of variables whose names start with &$mime$& are
11798 available when Exim is compiled with the content-scanning extension. For
11799 details, see section &<<SECTscanmimepart>>&.
11800
11801 .vitem "&$n0$& &-- &$n9$&"
11802 These variables are counters that can be incremented by means
11803 of the &%add%& command in filter files.
11804
11805 .vitem &$original_domain$&
11806 .vindex "&$domain$&"
11807 .vindex "&$original_domain$&"
11808 When a top-level address is being processed for delivery, this contains the
11809 same value as &$domain$&. However, if a &"child"& address (for example,
11810 generated by an alias, forward, or filter file) is being processed, this
11811 variable contains the domain of the original address (lower cased). This
11812 differs from &$parent_domain$& only when there is more than one level of
11813 aliasing or forwarding. When more than one address is being delivered in a
11814 single transport run, &$original_domain$& is not set.
11815
11816 If a new address is created by means of a &%deliver%& command in a system
11817 filter, it is set up with an artificial &"parent"& address. This has the local
11818 part &'system-filter'& and the default qualify domain.
11819
11820 .vitem &$original_local_part$&
11821 .vindex "&$local_part$&"
11822 .vindex "&$original_local_part$&"
11823 When a top-level address is being processed for delivery, this contains the
11824 same value as &$local_part$&, unless a prefix or suffix was removed from the
11825 local part, because &$original_local_part$& always contains the full local
11826 part. When a &"child"& address (for example, generated by an alias, forward, or
11827 filter file) is being processed, this variable contains the full local part of
11828 the original address.
11829
11830 If the router that did the redirection processed the local part
11831 case-insensitively, the value in &$original_local_part$& is in lower case.
11832 This variable differs from &$parent_local_part$& only when there is more than
11833 one level of aliasing or forwarding. When more than one address is being
11834 delivered in a single transport run, &$original_local_part$& is not set.
11835
11836 If a new address is created by means of a &%deliver%& command in a system
11837 filter, it is set up with an artificial &"parent"& address. This has the local
11838 part &'system-filter'& and the default qualify domain.
11839
11840 .vitem &$originator_gid$&
11841 .cindex "gid (group id)" "of originating user"
11842 .cindex "sender" "gid"
11843 .vindex "&$caller_gid$&"
11844 .vindex "&$originator_gid$&"
11845 This variable contains the value of &$caller_gid$& that was set when the
11846 message was received. For messages received via the command line, this is the
11847 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11848 normally the gid of the Exim user.
11849
11850 .vitem &$originator_uid$&
11851 .cindex "uid (user id)" "of originating user"
11852 .cindex "sender" "uid"
11853 .vindex "&$caller_uid$&"
11854 .vindex "&$originaltor_uid$&"
11855 The value of &$caller_uid$& that was set when the message was received. For
11856 messages received via the command line, this is the uid of the sending user.
11857 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11858 user.
11859
11860 .vitem &$parent_domain$&
11861 .vindex "&$parent_domain$&"
11862 This variable is similar to &$original_domain$& (see
11863 above), except that it refers to the immediately preceding parent address.
11864
11865 .vitem &$parent_local_part$&
11866 .vindex "&$parent_local_part$&"
11867 This variable is similar to &$original_local_part$&
11868 (see above), except that it refers to the immediately preceding parent address.
11869
11870 .vitem &$pid$&
11871 .cindex "pid (process id)" "of current process"
11872 .vindex "&$pid$&"
11873 This variable contains the current process id.
11874
11875 .vitem &$pipe_addresses$&
11876 .cindex "filter" "transport filter"
11877 .cindex "transport" "filter"
11878 .vindex "&$pipe_addresses$&"
11879 This is not an expansion variable, but is mentioned here because the string
11880 &`$pipe_addresses`& is handled specially in the command specification for the
11881 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11882 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11883 It cannot be used in general expansion strings, and provokes an &"unknown
11884 variable"& error if encountered.
11885
11886 .vitem &$primary_hostname$&
11887 .vindex "&$primary_hostname$&"
11888 This variable contains the value set by &%primary_hostname%& in the
11889 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11890 a single-component name, Exim calls &[gethostbyname()]& (or
11891 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11892 qualified host name. See also &$smtp_active_hostname$&.
11893
11894
11895 .vitem &$prvscheck_address$&
11896 This variable is used in conjunction with the &%prvscheck%& expansion item,
11897 which is described in sections &<<SECTexpansionitems>>& and
11898 &<<SECTverifyPRVS>>&.
11899
11900 .vitem &$prvscheck_keynum$&
11901 This variable is used in conjunction with the &%prvscheck%& expansion item,
11902 which is described in sections &<<SECTexpansionitems>>& and
11903 &<<SECTverifyPRVS>>&.
11904
11905 .vitem &$prvscheck_result$&
11906 This variable is used in conjunction with the &%prvscheck%& expansion item,
11907 which is described in sections &<<SECTexpansionitems>>& and
11908 &<<SECTverifyPRVS>>&.
11909
11910 .vitem &$qualify_domain$&
11911 .vindex "&$qualify_domain$&"
11912 The value set for the &%qualify_domain%& option in the configuration file.
11913
11914 .vitem &$qualify_recipient$&
11915 .vindex "&$qualify_recipient$&"
11916 The value set for the &%qualify_recipient%& option in the configuration file,
11917 or if not set, the value of &$qualify_domain$&.
11918
11919 .vitem &$rcpt_count$&
11920 .vindex "&$rcpt_count$&"
11921 When a message is being received by SMTP, this variable contains the number of
11922 RCPT commands received for the current message. If this variable is used in a
11923 RCPT ACL, its value includes the current command.
11924
11925 .vitem &$rcpt_defer_count$&
11926 .vindex "&$rcpt_defer_count$&"
11927 .cindex "4&'xx'& responses" "count of"
11928 When a message is being received by SMTP, this variable contains the number of
11929 RCPT commands in the current message that have previously been rejected with a
11930 temporary (4&'xx'&) response.
11931
11932 .vitem &$rcpt_fail_count$&
11933 .vindex "&$rcpt_fail_count$&"
11934 When a message is being received by SMTP, this variable contains the number of
11935 RCPT commands in the current message that have previously been rejected with a
11936 permanent (5&'xx'&) response.
11937
11938 .vitem &$received_count$&
11939 .vindex "&$received_count$&"
11940 This variable contains the number of &'Received:'& header lines in the message,
11941 including the one added by Exim (so its value is always greater than zero). It
11942 is available in the DATA ACL, the non-SMTP ACL, and while routing and
11943 delivering.
11944
11945 .vitem &$received_for$&
11946 .vindex "&$received_for$&"
11947 If there is only a single recipient address in an incoming message, this
11948 variable contains that address when the &'Received:'& header line is being
11949 built. The value is copied after recipient rewriting has happened, but before
11950 the &[local_scan()]& function is run.
11951
11952 .vitem &$received_ip_address$&
11953 .vindex "&$received_ip_address$&"
11954 As soon as an Exim server starts processing an incoming TCP/IP connection, this
11955 variable is set to the address of the local IP interface, and &$received_port$&
11956 is set to the local port number. (The remote IP address and port are in
11957 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
11958 the port value is -1 unless it has been set using the &%-oMi%& command line
11959 option.
11960
11961 As well as being useful in ACLs (including the &"connect"& ACL), these variable
11962 could be used, for example, to make the file name for a TLS certificate depend
11963 on which interface and/or port is being used for the incoming connection. The
11964 values of &$received_ip_address$& and &$received_port$& are saved with any
11965 messages that are received, thus making these variables available at delivery
11966 time.
11967 For outbound connections see &$sending_ip_address$&.
11968
11969 .vitem &$received_port$&
11970 .vindex "&$received_port$&"
11971 See &$received_ip_address$&.
11972
11973 .vitem &$received_protocol$&
11974 .vindex "&$received_protocol$&"
11975 When a message is being processed, this variable contains the name of the
11976 protocol by which it was received. Most of the names used by Exim are defined
11977 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
11978 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
11979 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
11980 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
11981 connection and the client was successfully authenticated.
11982
11983 Exim uses the protocol name &"smtps"& for the case when encryption is
11984 automatically set up on connection without the use of STARTTLS (see
11985 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
11986 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
11987 where the client initially uses EHLO, sets up an encrypted connection using
11988 STARTTLS, and then uses HELO afterwards.
11989
11990 The &%-oMr%& option provides a way of specifying a custom protocol name for
11991 messages that are injected locally by trusted callers. This is commonly used to
11992 identify messages that are being re-injected after some kind of scanning.
11993
11994 .vitem &$received_time$&
11995 .vindex "&$received_time$&"
11996 This variable contains the date and time when the current message was received,
11997 as a number of seconds since the start of the Unix epoch.
11998
11999 .vitem &$recipient_data$&
12000 .vindex "&$recipient_data$&"
12001 This variable is set after an indexing lookup success in an ACL &%recipients%&
12002 condition. It contains the data from the lookup, and the value remains set
12003 until the next &%recipients%& test. Thus, you can do things like this:
12004 .display
12005 &`require recipients  = cdb*@;/some/file`&
12006 &`deny    `&&'some further test involving'& &`$recipient_data`&
12007 .endd
12008 &*Warning*&: This variable is set only when a lookup is used as an indexing
12009 method in the address list, using the semicolon syntax as in the example above.
12010 The variable is not set for a lookup that is used as part of the string
12011 expansion that all such lists undergo before being interpreted.
12012
12013 .vitem &$recipient_verify_failure$&
12014 .vindex "&$recipient_verify_failure$&"
12015 In an ACL, when a recipient verification fails, this variable contains
12016 information about the failure. It is set to one of the following words:
12017
12018 .ilist
12019 &"qualify"&: The address was unqualified (no domain), and the message
12020 was neither local nor came from an exempted host.
12021
12022 .next
12023 &"route"&: Routing failed.
12024
12025 .next
12026 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12027 or before the MAIL command (that is, on initial connection, HELO, or
12028 MAIL).
12029
12030 .next
12031 &"recipient"&: The RCPT command in a callout was rejected.
12032 .next
12033
12034 &"postmaster"&: The postmaster check in a callout was rejected.
12035 .endlist
12036
12037 The main use of this variable is expected to be to distinguish between
12038 rejections of MAIL and rejections of RCPT.
12039
12040 .vitem &$recipients$&
12041 .vindex "&$recipients$&"
12042 This variable contains a list of envelope recipients for a message. A comma and
12043 a space separate the addresses in the replacement text. However, the variable
12044 is not generally available, to prevent exposure of Bcc recipients in
12045 unprivileged users' filter files. You can use &$recipients$& only in these
12046 cases:
12047
12048 .olist
12049 In a system filter file.
12050 .next
12051 In the ACLs associated with the DATA command and with non-SMTP messages, that
12052 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12053 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12054 &%acl_not_smtp_mime%&.
12055 .next
12056 From within a &[local_scan()]& function.
12057 .endlist
12058
12059
12060 .vitem &$recipients_count$&
12061 .vindex "&$recipients_count$&"
12062 When a message is being processed, this variable contains the number of
12063 envelope recipients that came with the message. Duplicates are not excluded
12064 from the count. While a message is being received over SMTP, the number
12065 increases for each accepted recipient. It can be referenced in an ACL.
12066
12067
12068 .vitem &$regex_match_string$&
12069 .vindex "&$regex_match_string$&"
12070 This variable is set to contain the matching regular expression after a
12071 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12072
12073
12074 .vitem &$reply_address$&
12075 .vindex "&$reply_address$&"
12076 When a message is being processed, this variable contains the contents of the
12077 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12078 contents of the &'From:'& header line. Apart from the removal of leading
12079 white space, the value is not processed in any way. In particular, no RFC 2047
12080 decoding or character code translation takes place.
12081
12082 .vitem &$return_path$&
12083 .vindex "&$return_path$&"
12084 When a message is being delivered, this variable contains the return path &--
12085 the sender field that will be sent as part of the envelope. It is not enclosed
12086 in <> characters. At the start of routing an address, &$return_path$& has the
12087 same value as &$sender_address$&, but if, for example, an incoming message to a
12088 mailing list has been expanded by a router which specifies a different address
12089 for bounce messages, &$return_path$& subsequently contains the new bounce
12090 address, whereas &$sender_address$& always contains the original sender address
12091 that was received with the message. In other words, &$sender_address$& contains
12092 the incoming envelope sender, and &$return_path$& contains the outgoing
12093 envelope sender.
12094
12095 .vitem &$return_size_limit$&
12096 .vindex "&$return_size_limit$&"
12097 This is an obsolete name for &$bounce_return_size_limit$&.
12098
12099 .vitem &$router_name$&
12100 .cindex "router" "name"
12101 .cindex "name" "of router"
12102 .vindex "&$router_name$&"
12103 During the running of a router this variable contains its name.
12104
12105 .vitem &$runrc$&
12106 .cindex "return code" "from &%run%& expansion"
12107 .vindex "&$runrc$&"
12108 This variable contains the return code from a command that is run by the
12109 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12110 assume the order in which option values are expanded, except for those
12111 preconditions whose order of testing is documented. Therefore, you cannot
12112 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12113 another.
12114
12115 .vitem &$self_hostname$&
12116 .oindex "&%self%&" "value of host name"
12117 .vindex "&$self_hostname$&"
12118 When an address is routed to a supposedly remote host that turns out to be the
12119 local host, what happens is controlled by the &%self%& generic router option.
12120 One of its values causes the address to be passed to another router. When this
12121 happens, &$self_hostname$& is set to the name of the local host that the
12122 original router encountered. In other circumstances its contents are null.
12123
12124 .vitem &$sender_address$&
12125 .vindex "&$sender_address$&"
12126 When a message is being processed, this variable contains the sender's address
12127 that was received in the message's envelope. The case of letters in the address
12128 is retained, in both the local part and the domain. For bounce messages, the
12129 value of this variable is the empty string. See also &$return_path$&.
12130
12131 .vitem &$sender_address_data$&
12132 .vindex "&$address_data$&"
12133 .vindex "&$sender_address_data$&"
12134 If &$address_data$& is set when the routers are called from an ACL to verify a
12135 sender address, the final value is preserved in &$sender_address_data$&, to
12136 distinguish it from data from a recipient address. The value does not persist
12137 after the end of the current ACL statement. If you want to preserve it for
12138 longer, you can save it in an ACL variable.
12139
12140 .vitem &$sender_address_domain$&
12141 .vindex "&$sender_address_domain$&"
12142 The domain portion of &$sender_address$&.
12143
12144 .vitem &$sender_address_local_part$&
12145 .vindex "&$sender_address_local_part$&"
12146 The local part portion of &$sender_address$&.
12147
12148 .vitem &$sender_data$&
12149 .vindex "&$sender_data$&"
12150 This variable is set after a lookup success in an ACL &%senders%& condition or
12151 in a router &%senders%& option. It contains the data from the lookup, and the
12152 value remains set until the next &%senders%& test. Thus, you can do things like
12153 this:
12154 .display
12155 &`require senders      = cdb*@;/some/file`&
12156 &`deny    `&&'some further test involving'& &`$sender_data`&
12157 .endd
12158 &*Warning*&: This variable is set only when a lookup is used as an indexing
12159 method in the address list, using the semicolon syntax as in the example above.
12160 The variable is not set for a lookup that is used as part of the string
12161 expansion that all such lists undergo before being interpreted.
12162
12163 .vitem &$sender_fullhost$&
12164 .vindex "&$sender_fullhost$&"
12165 When a message is received from a remote host, this variable contains the host
12166 name and IP address in a single string. It ends with the IP address in square
12167 brackets, followed by a colon and a port number if the logging of ports is
12168 enabled. The format of the rest of the string depends on whether the host
12169 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12170 looking up its IP address. (Looking up the IP address can be forced by the
12171 &%host_lookup%& option, independent of verification.) A plain host name at the
12172 start of the string is a verified host name; if this is not present,
12173 verification either failed or was not requested. A host name in parentheses is
12174 the argument of a HELO or EHLO command. This is omitted if it is identical to
12175 the verified host name or to the host's IP address in square brackets.
12176
12177 .vitem &$sender_helo_name$&
12178 .vindex "&$sender_helo_name$&"
12179 When a message is received from a remote host that has issued a HELO or EHLO
12180 command, the argument of that command is placed in this variable. It is also
12181 set if HELO or EHLO is used when a message is received using SMTP locally via
12182 the &%-bs%& or &%-bS%& options.
12183
12184 .vitem &$sender_host_address$&
12185 .vindex "&$sender_host_address$&"
12186 When a message is received from a remote host using SMTP,
12187 this variable contains that
12188 host's IP address. For locally non-SMTP submitted messages, it is empty.
12189
12190 .vitem &$sender_host_authenticated$&
12191 .vindex "&$sender_host_authenticated$&"
12192 This variable contains the name (not the public name) of the authenticator
12193 driver that successfully authenticated the client from which the message was
12194 received. It is empty if there was no successful authentication. See also
12195 &$authenticated_id$&.
12196
12197 .vitem &$sender_host_dnssec$&
12198 .vindex "&$sender_host_dnssec$&"
12199 If an attempt to populate &$sender_host_name$& has been made
12200 (by reference, &%hosts_lookup%& or
12201 otherwise) then this boolean will have been set true if, and only if, the
12202 resolver library states that the reverse DNS was authenticated data.  At all
12203 other times, this variable is false.
12204
12205 It is likely that you will need to coerce DNSSEC support on in the resolver
12206 library, by setting:
12207 .code
12208 dns_dnssec_ok = 1
12209 .endd
12210
12211 Exim does not perform DNSSEC validation itself, instead leaving that to a
12212 validating resolver (eg, unbound, or bind with suitable configuration).
12213
12214 Exim does not (currently) check to see if the forward DNS was also secured
12215 with DNSSEC, only the reverse DNS.
12216
12217 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12218 mechanism in the list, then this variable will be false.
12219
12220
12221 .vitem &$sender_host_name$&
12222 .vindex "&$sender_host_name$&"
12223 When a message is received from a remote host, this variable contains the
12224 host's name as obtained by looking up its IP address. For messages received by
12225 other means, this variable is empty.
12226
12227 .vindex "&$host_lookup_failed$&"
12228 If the host name has not previously been looked up, a reference to
12229 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12230 A looked up name is accepted only if it leads back to the original IP address
12231 via a forward lookup. If either the reverse or the forward lookup fails to find
12232 any data, or if the forward lookup does not yield the original IP address,
12233 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12234
12235 .vindex "&$host_lookup_deferred$&"
12236 However, if either of the lookups cannot be completed (for example, there is a
12237 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12238 &$host_lookup_failed$& remains set to &"0"&.
12239
12240 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12241 host name again if there is a subsequent reference to &$sender_host_name$&
12242 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12243 is set to &"1"&.
12244
12245 Exim does not automatically look up every calling host's name. If you want
12246 maximum efficiency, you should arrange your configuration so that it avoids
12247 these lookups altogether. The lookup happens only if one or more of the
12248 following are true:
12249
12250 .ilist
12251 A string containing &$sender_host_name$& is expanded.
12252 .next
12253 The calling host matches the list in &%host_lookup%&. In the default
12254 configuration, this option is set to *, so it must be changed if lookups are
12255 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12256 .next
12257 Exim needs the host name in order to test an item in a host list. The items
12258 that require this are described in sections &<<SECThoslispatnam>>& and
12259 &<<SECThoslispatnamsk>>&.
12260 .next
12261 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12262 In this case, the host name is required to compare with the name quoted in any
12263 EHLO or HELO commands that the client issues.
12264 .next
12265 The remote host issues a EHLO or HELO command that quotes one of the
12266 domains in &%helo_lookup_domains%&. The default value of this option is
12267 . ==== As this is a nested list, any displays it contains must be indented
12268 . ==== as otherwise they are too far to the left.
12269 .code
12270   helo_lookup_domains = @ : @[]
12271 .endd
12272 which causes a lookup if a remote host (incorrectly) gives the server's name or
12273 IP address in an EHLO or HELO command.
12274 .endlist
12275
12276
12277 .vitem &$sender_host_port$&
12278 .vindex "&$sender_host_port$&"
12279 When a message is received from a remote host, this variable contains the port
12280 number that was used on the remote host.
12281
12282 .vitem &$sender_ident$&
12283 .vindex "&$sender_ident$&"
12284 When a message is received from a remote host, this variable contains the
12285 identification received in response to an RFC 1413 request. When a message has
12286 been received locally, this variable contains the login name of the user that
12287 called Exim.
12288
12289 .vitem &$sender_rate_$&&'xxx'&
12290 A number of variables whose names begin &$sender_rate_$& are set as part of the
12291 &%ratelimit%& ACL condition. Details are given in section
12292 &<<SECTratelimiting>>&.
12293
12294 .vitem &$sender_rcvhost$&
12295 .cindex "DNS" "reverse lookup"
12296 .cindex "reverse DNS lookup"
12297 .vindex "&$sender_rcvhost$&"
12298 This is provided specifically for use in &'Received:'& headers. It starts with
12299 either the verified host name (as obtained from a reverse DNS lookup) or, if
12300 there is no verified host name, the IP address in square brackets. After that
12301 there may be text in parentheses. When the first item is a verified host name,
12302 the first thing in the parentheses is the IP address in square brackets,
12303 followed by a colon and a port number if port logging is enabled. When the
12304 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12305 the parentheses.
12306
12307 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12308 was used and its argument was not identical to the real host name or IP
12309 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12310 all three items are present in the parentheses, a newline and tab are inserted
12311 into the string, to improve the formatting of the &'Received:'& header.
12312
12313 .vitem &$sender_verify_failure$&
12314 .vindex "&$sender_verify_failure$&"
12315 In an ACL, when a sender verification fails, this variable contains information
12316 about the failure. The details are the same as for
12317 &$recipient_verify_failure$&.
12318
12319 .vitem &$sending_ip_address$&
12320 .vindex "&$sending_ip_address$&"
12321 This variable is set whenever an outgoing SMTP connection to another host has
12322 been set up. It contains the IP address of the local interface that is being
12323 used. This is useful if a host that has more than one IP address wants to take
12324 on different personalities depending on which one is being used. For incoming
12325 connections, see &$received_ip_address$&.
12326
12327 .vitem &$sending_port$&
12328 .vindex "&$sending_port$&"
12329 This variable is set whenever an outgoing SMTP connection to another host has
12330 been set up. It contains the local port that is being used. For incoming
12331 connections, see &$received_port$&.
12332
12333 .vitem &$smtp_active_hostname$&
12334 .vindex "&$smtp_active_hostname$&"
12335 During an incoming SMTP session, this variable contains the value of the active
12336 host name, as specified by the &%smtp_active_hostname%& option. The value of
12337 &$smtp_active_hostname$& is saved with any message that is received, so its
12338 value can be consulted during routing and delivery.
12339
12340 .vitem &$smtp_command$&
12341 .vindex "&$smtp_command$&"
12342 During the processing of an incoming SMTP command, this variable contains the
12343 entire command. This makes it possible to distinguish between HELO and EHLO in
12344 the HELO ACL, and also to distinguish between commands such as these:
12345 .code
12346 MAIL FROM:<>
12347 MAIL FROM: <>
12348 .endd
12349 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12350 command, the address in &$smtp_command$& is the original address before any
12351 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12352 the address after SMTP-time rewriting.
12353
12354 .vitem &$smtp_command_argument$&
12355 .cindex "SMTP" "command, argument for"
12356 .vindex "&$smtp_command_argument$&"
12357 While an ACL is running to check an SMTP command, this variable contains the
12358 argument, that is, the text that follows the command name, with leading white
12359 space removed. Following the introduction of &$smtp_command$&, this variable is
12360 somewhat redundant, but is retained for backwards compatibility.
12361
12362 .vitem &$smtp_count_at_connection_start$&
12363 .vindex "&$smtp_count_at_connection_start$&"
12364 This variable is set greater than zero only in processes spawned by the Exim
12365 daemon for handling incoming SMTP connections. The name is deliberately long,
12366 in order to emphasize what the contents are. When the daemon accepts a new
12367 connection, it increments this variable. A copy of the variable is passed to
12368 the child process that handles the connection, but its value is fixed, and
12369 never changes. It is only an approximation of how many incoming connections
12370 there actually are, because many other connections may come and go while a
12371 single connection is being processed. When a child process terminates, the
12372 daemon decrements its copy of the variable.
12373
12374 .vitem "&$sn0$& &-- &$sn9$&"
12375 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12376 that were current at the end of the system filter file. This allows a system
12377 filter file to set values that can be tested in users' filter files. For
12378 example, a system filter could set a value indicating how likely it is that a
12379 message is junk mail.
12380
12381 .vitem &$spam_$&&'xxx'&
12382 A number of variables whose names start with &$spam$& are available when Exim
12383 is compiled with the content-scanning extension. For details, see section
12384 &<<SECTscanspamass>>&.
12385
12386
12387 .vitem &$spool_directory$&
12388 .vindex "&$spool_directory$&"
12389 The name of Exim's spool directory.
12390
12391 .vitem &$spool_inodes$&
12392 .vindex "&$spool_inodes$&"
12393 The number of free inodes in the disk partition where Exim's spool files are
12394 being written. The value is recalculated whenever the variable is referenced.
12395 If the relevant file system does not have the concept of inodes, the value of
12396 is -1. See also the &%check_spool_inodes%& option.
12397
12398 .vitem &$spool_space$&
12399 .vindex "&$spool_space$&"
12400 The amount of free space (as a number of kilobytes) in the disk partition where
12401 Exim's spool files are being written. The value is recalculated whenever the
12402 variable is referenced. If the operating system does not have the ability to
12403 find the amount of free space (only true for experimental systems), the space
12404 value is -1. For example, to check in an ACL that there is at least 50
12405 megabytes free on the spool, you could write:
12406 .code
12407 condition = ${if > {$spool_space}{50000}}
12408 .endd
12409 See also the &%check_spool_space%& option.
12410
12411
12412 .vitem &$thisaddress$&
12413 .vindex "&$thisaddress$&"
12414 This variable is set only during the processing of the &%foranyaddress%&
12415 command in a filter file. Its use is explained in the description of that
12416 command, which can be found in the separate document entitled &'Exim's
12417 interfaces to mail filtering'&.
12418
12419 .vitem &$tls_in_bits$&
12420 .vindex "&$tls_in_bits$&"
12421 Contains an approximation of the TLS cipher's bit-strength
12422 on the inbound connection; the meaning of
12423 this depends upon the TLS implementation used.
12424 If TLS has not been negotiated, the value will be 0.
12425 The value of this is automatically fed into the Cyrus SASL authenticator
12426 when acting as a server, to specify the "external SSF" (a SASL term).
12427
12428 The deprecated &$tls_bits$& variable refers to the inbound side
12429 except when used in the context of an outbound SMTP delivery, when it refers to
12430 the outbound.
12431
12432 .vitem &$tls_out_bits$&
12433 .vindex "&$tls_out_bits$&"
12434 Contains an approximation of the TLS cipher's bit-strength
12435 on an outbound SMTP connection; the meaning of
12436 this depends upon the TLS implementation used.
12437 If TLS has not been negotiated, the value will be 0.
12438
12439 .vitem &$tls_in_ourcert$&
12440 .vindex "&$tls_in_ourcert$&"
12441 This variable refers to the certificate presented to the peer of an
12442 inbound connection when the message was received.
12443 It is only useful as the argument of a
12444 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12445 or a &%def%& condition.
12446
12447 .vitem &$tls_in_peercert$&
12448 .vindex "&$tls_in_peercert$&"
12449 This variable refers to the certificate presented by the peer of an
12450 inbound connection when the message was received.
12451 It is only useful as the argument of a
12452 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12453 or a &%def%& condition.
12454
12455 .vitem &$tls_out_ourcert$&
12456 .vindex "&$tls_out_ourcert$&"
12457 This variable refers to the certificate presented to the peer of an
12458 outbound connection.  It is only useful as the argument of a
12459 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12460 or a &%def%& condition.
12461
12462 .vitem &$tls_out_peercert$&
12463 .vindex "&$tls_out_peercert$&"
12464 This variable refers to the certificate presented by the peer of an
12465 outbound connection.  It is only useful as the argument of a
12466 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12467 or a &%def%& condition.
12468
12469 .vitem &$tls_in_certificate_verified$&
12470 .vindex "&$tls_in_certificate_verified$&"
12471 This variable is set to &"1"& if a TLS certificate was verified when the
12472 message was received, and &"0"& otherwise.
12473
12474 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12475 except when used in the context of an outbound SMTP delivery, when it refers to
12476 the outbound.
12477
12478 .vitem &$tls_out_certificate_verified$&
12479 .vindex "&$tls_out_certificate_verified$&"
12480 This variable is set to &"1"& if a TLS certificate was verified when an
12481 outbound SMTP connection was made,
12482 and &"0"& otherwise.
12483
12484 .vitem &$tls_in_cipher$&
12485 .vindex "&$tls_in_cipher$&"
12486 .vindex "&$tls_cipher$&"
12487 When a message is received from a remote host over an encrypted SMTP
12488 connection, this variable is set to the cipher suite that was negotiated, for
12489 example DES-CBC3-SHA. In other circumstances, in particular, for message
12490 received over unencrypted connections, the variable is empty. Testing
12491 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12492 non-encrypted connections during ACL processing.
12493
12494 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12495 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12496 becomes the same as &$tls_out_cipher$&.
12497
12498 .vitem &$tls_out_cipher$&
12499 .vindex "&$tls_out_cipher$&"
12500 This variable is
12501 cleared before any outgoing SMTP connection is made,
12502 and then set to the outgoing cipher suite if one is negotiated. See chapter
12503 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12504 details of the &(smtp)& transport.
12505
12506 .vitem &$tls_in_ocsp$&
12507 .vindex "&$tls_in_ocsp$&"
12508 When a message is received from a remote client connection
12509 the result of any OCSP request from the client is encoded in this variable:
12510 .code
12511 0 OCSP proof was not requested (default value)
12512 1 No response to request
12513 2 Response not verified
12514 3 Verification failed
12515 4 Verification succeeded
12516 .endd
12517
12518 .vitem &$tls_out_ocsp$&
12519 .vindex "&$tls_out_ocsp$&"
12520 When a message is sent to a remote host connection
12521 the result of any OCSP request made is encoded in this variable.
12522 See &$tls_in_ocsp$& for values.
12523
12524 .vitem &$tls_in_peerdn$&
12525 .vindex "&$tls_in_peerdn$&"
12526 .vindex "&$tls_peerdn$&"
12527 When a message is received from a remote host over an encrypted SMTP
12528 connection, and Exim is configured to request a certificate from the client,
12529 the value of the Distinguished Name of the certificate is made available in the
12530 &$tls_in_peerdn$& during subsequent processing.
12531
12532 The deprecated &$tls_peerdn$& variable refers to the inbound side
12533 except when used in the context of an outbound SMTP delivery, when it refers to
12534 the outbound.
12535
12536 .vitem &$tls_out_peerdn$&
12537 .vindex "&$tls_out_peerdn$&"
12538 When a message is being delivered to a remote host over an encrypted SMTP
12539 connection, and Exim is configured to request a certificate from the server,
12540 the value of the Distinguished Name of the certificate is made available in the
12541 &$tls_out_peerdn$& during subsequent processing.
12542
12543 .vitem &$tls_in_sni$&
12544 .vindex "&$tls_in_sni$&"
12545 .vindex "&$tls_sni$&"
12546 .cindex "TLS" "Server Name Indication"
12547 When a TLS session is being established, if the client sends the Server
12548 Name Indication extension, the value will be placed in this variable.
12549 If the variable appears in &%tls_certificate%& then this option and
12550 some others, described in &<<SECTtlssni>>&,
12551 will be re-expanded early in the TLS session, to permit
12552 a different certificate to be presented (and optionally a different key to be
12553 used) to the client, based upon the value of the SNI extension.
12554
12555 The deprecated &$tls_sni$& variable refers to the inbound side
12556 except when used in the context of an outbound SMTP delivery, when it refers to
12557 the outbound.
12558
12559 .vitem &$tls_out_sni$&
12560 .vindex "&$tls_out_sni$&"
12561 .cindex "TLS" "Server Name Indication"
12562 During outbound
12563 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12564 the transport.
12565
12566 .vitem &$tod_bsdinbox$&
12567 .vindex "&$tod_bsdinbox$&"
12568 The time of day and the date, in the format required for BSD-style mailbox
12569 files, for example: Thu Oct 17 17:14:09 1995.
12570
12571 .vitem &$tod_epoch$&
12572 .vindex "&$tod_epoch$&"
12573 The time and date as a number of seconds since the start of the Unix epoch.
12574
12575 .vitem &$tod_epoch_l$&
12576 .vindex "&$tod_epoch_l$&"
12577 The time and date as a number of microseconds since the start of the Unix epoch.
12578
12579 .vitem &$tod_full$&
12580 .vindex "&$tod_full$&"
12581 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12582 +0100. The timezone is always given as a numerical offset from UTC, with
12583 positive values used for timezones that are ahead (east) of UTC, and negative
12584 values for those that are behind (west).
12585
12586 .vitem &$tod_log$&
12587 .vindex "&$tod_log$&"
12588 The time and date in the format used for writing Exim's log files, for example:
12589 1995-10-12 15:32:29, but without a timezone.
12590
12591 .vitem &$tod_logfile$&
12592 .vindex "&$tod_logfile$&"
12593 This variable contains the date in the format yyyymmdd. This is the format that
12594 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12595 flag.
12596
12597 .vitem &$tod_zone$&
12598 .vindex "&$tod_zone$&"
12599 This variable contains the numerical value of the local timezone, for example:
12600 -0500.
12601
12602 .vitem &$tod_zulu$&
12603 .vindex "&$tod_zulu$&"
12604 This variable contains the UTC date and time in &"Zulu"& format, as specified
12605 by ISO 8601, for example: 20030221154023Z.
12606
12607 .vitem &$transport_name$&
12608 .cindex "transport" "name"
12609 .cindex "name" "of transport"
12610 .vindex "&$transport_name$&"
12611 During the running of a transport, this variable contains its name.
12612
12613 .vitem &$value$&
12614 .vindex "&$value$&"
12615 This variable contains the result of an expansion lookup, extraction operation,
12616 or external command, as described above. It is also used during a
12617 &*reduce*& expansion.
12618
12619 .vitem &$verify_mode$&
12620 .vindex "&$verify_mode$&"
12621 While a router or transport is being run in verify mode
12622 or for cutthrough delivery,
12623 contains "S" for sender-verification or "R" for recipient-verification.
12624 Otherwise, empty.
12625
12626 .vitem &$version_number$&
12627 .vindex "&$version_number$&"
12628 The version number of Exim.
12629
12630 .vitem &$warn_message_delay$&
12631 .vindex "&$warn_message_delay$&"
12632 This variable is set only during the creation of a message warning about a
12633 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12634
12635 .vitem &$warn_message_recipients$&
12636 .vindex "&$warn_message_recipients$&"
12637 This variable is set only during the creation of a message warning about a
12638 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12639 .endlist
12640 .ecindex IIDstrexp
12641
12642
12643
12644 . ////////////////////////////////////////////////////////////////////////////
12645 . ////////////////////////////////////////////////////////////////////////////
12646
12647 .chapter "Embedded Perl" "CHAPperl"
12648 .scindex IIDperl "Perl" "calling from Exim"
12649 Exim can be built to include an embedded Perl interpreter. When this is done,
12650 Perl subroutines can be called as part of the string expansion process. To make
12651 use of the Perl support, you need version 5.004 or later of Perl installed on
12652 your system. To include the embedded interpreter in the Exim binary, include
12653 the line
12654 .code
12655 EXIM_PERL = perl.o
12656 .endd
12657 in your &_Local/Makefile_& and then build Exim in the normal way.
12658
12659
12660 .section "Setting up so Perl can be used" "SECID85"
12661 .oindex "&%perl_startup%&"
12662 Access to Perl subroutines is via a global configuration option called
12663 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12664 no &%perl_startup%& option in the Exim configuration file then no Perl
12665 interpreter is started and there is almost no overhead for Exim (since none of
12666 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12667 option then the associated value is taken to be Perl code which is executed in
12668 a newly created Perl interpreter.
12669
12670 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12671 need backslashes before any characters to escape special meanings. The option
12672 should usually be something like
12673 .code
12674 perl_startup = do '/etc/exim.pl'
12675 .endd
12676 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12677 use from Exim. Exim can be configured either to start up a Perl interpreter as
12678 soon as it is entered, or to wait until the first time it is needed. Starting
12679 the interpreter at the beginning ensures that it is done while Exim still has
12680 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12681 fact used in a particular run. Also, note that this does not mean that Exim is
12682 necessarily running as root when Perl is called at a later time. By default,
12683 the interpreter is started only when it is needed, but this can be changed in
12684 two ways:
12685
12686 .ilist
12687 .oindex "&%perl_at_start%&"
12688 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12689 a startup when Exim is entered.
12690 .next
12691 The command line option &%-ps%& also requests a startup when Exim is entered,
12692 overriding the setting of &%perl_at_start%&.
12693 .endlist
12694
12695 There is also a command line option &%-pd%& (for delay) which suppresses the
12696 initial startup, even if &%perl_at_start%& is set.
12697
12698
12699 .section "Calling Perl subroutines" "SECID86"
12700 When the configuration file includes a &%perl_startup%& option you can make use
12701 of the string expansion item to call the Perl subroutines that are defined
12702 by the &%perl_startup%& code. The operator is used in any of the following
12703 forms:
12704 .code
12705 ${perl{foo}}
12706 ${perl{foo}{argument}}
12707 ${perl{foo}{argument1}{argument2} ... }
12708 .endd
12709 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12710 arguments may be passed. Passing more than this results in an expansion failure
12711 with an error message of the form
12712 .code
12713 Too many arguments passed to Perl subroutine "foo" (max is 8)
12714 .endd
12715 The return value of the Perl subroutine is evaluated in a scalar context before
12716 it is passed back to Exim to be inserted into the expanded string. If the
12717 return value is &'undef'&, the expansion is forced to fail in the same way as
12718 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12719 by obeying Perl's &%die%& function, the expansion fails with the error message
12720 that was passed to &%die%&.
12721
12722
12723 .section "Calling Exim functions from Perl" "SECID87"
12724 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12725 is available to call back into Exim's string expansion function. For example,
12726 the Perl code
12727 .code
12728 my $lp = Exim::expand_string('$local_part');
12729 .endd
12730 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12731 Note those are single quotes and not double quotes to protect against
12732 &$local_part$& being interpolated as a Perl variable.
12733
12734 If the string expansion is forced to fail by a &"fail"& item, the result of
12735 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12736 expansion string, the Perl call from the original expansion string fails with
12737 an appropriate error message, in the same way as if &%die%& were used.
12738
12739 .cindex "debugging" "from embedded Perl"
12740 .cindex "log" "writing from embedded Perl"
12741 Two other Exim functions are available for use from within Perl code.
12742 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12743 debugging is enabled. If you want a newline at the end, you must supply it.
12744 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12745 timestamp. In this case, you should not supply a terminating newline.
12746
12747
12748 .section "Use of standard output and error by Perl" "SECID88"
12749 .cindex "Perl" "standard output and error"
12750 You should not write to the standard error or output streams from within your
12751 Perl code, as it is not defined how these are set up. In versions of Exim
12752 before 4.50, it is possible for the standard output or error to refer to the
12753 SMTP connection during message reception via the daemon. Writing to this stream
12754 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12755 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12756 avoided, but the output is lost.
12757
12758 .cindex "Perl" "use of &%warn%&"
12759 The Perl &%warn%& statement writes to the standard error stream by default.
12760 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12761 you have no control. When Exim starts up the Perl interpreter, it arranges for
12762 output from the &%warn%& statement to be written to the Exim main log. You can
12763 change this by including appropriate Perl magic somewhere in your Perl code.
12764 For example, to discard &%warn%& output completely, you need this:
12765 .code
12766 $SIG{__WARN__} = sub { };
12767 .endd
12768 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12769 example, the code for the subroutine is empty, so it does nothing, but you can
12770 include any Perl code that you like. The text of the &%warn%& message is passed
12771 as the first subroutine argument.
12772 .ecindex IIDperl
12773
12774
12775 . ////////////////////////////////////////////////////////////////////////////
12776 . ////////////////////////////////////////////////////////////////////////////
12777
12778 .chapter "Starting the daemon and the use of network interfaces" &&&
12779          "CHAPinterfaces" &&&
12780          "Starting the daemon"
12781 .cindex "daemon" "starting"
12782 .cindex "interface" "listening"
12783 .cindex "network interface"
12784 .cindex "interface" "network"
12785 .cindex "IP address" "for listening"
12786 .cindex "daemon" "listening IP addresses"
12787 .cindex "TCP/IP" "setting listening interfaces"
12788 .cindex "TCP/IP" "setting listening ports"
12789 A host that is connected to a TCP/IP network may have one or more physical
12790 hardware network interfaces. Each of these interfaces may be configured as one
12791 or more &"logical"& interfaces, which are the entities that a program actually
12792 works with. Each of these logical interfaces is associated with an IP address.
12793 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12794 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12795 knowledge about the host's interfaces for use in three different circumstances:
12796
12797 .olist
12798 When a listening daemon is started, Exim needs to know which interfaces
12799 and ports to listen on.
12800 .next
12801 When Exim is routing an address, it needs to know which IP addresses
12802 are associated with local interfaces. This is required for the correct
12803 processing of MX lists by removing the local host and others with the
12804 same or higher priority values. Also, Exim needs to detect cases
12805 when an address is routed to an IP address that in fact belongs to the
12806 local host. Unless the &%self%& router option or the &%allow_localhost%&
12807 option of the smtp transport is set (as appropriate), this is treated
12808 as an error situation.
12809 .next
12810 When Exim connects to a remote host, it may need to know which interface to use
12811 for the outgoing connection.
12812 .endlist
12813
12814
12815 Exim's default behaviour is likely to be appropriate in the vast majority
12816 of cases. If your host has only one interface, and you want all its IP
12817 addresses to be treated in the same way, and you are using only the
12818 standard SMTP port, you should not need to take any special action. The
12819 rest of this chapter does not apply to you.
12820
12821 In a more complicated situation you may want to listen only on certain
12822 interfaces, or on different ports, and for this reason there are a number of
12823 options that can be used to influence Exim's behaviour. The rest of this
12824 chapter describes how they operate.
12825
12826 When a message is received over TCP/IP, the interface and port that were
12827 actually used are set in &$received_ip_address$& and &$received_port$&.
12828
12829
12830
12831 .section "Starting a listening daemon" "SECID89"
12832 When a listening daemon is started (by means of the &%-bd%& command line
12833 option), the interfaces and ports on which it listens are controlled by the
12834 following options:
12835
12836 .ilist
12837 &%daemon_smtp_ports%& contains a list of default ports
12838 or service names.
12839 (For backward compatibility, this option can also be specified in the singular.)
12840 .next
12841 &%local_interfaces%& contains list of interface IP addresses on which to
12842 listen. Each item may optionally also specify a port.
12843 .endlist
12844
12845 The default list separator in both cases is a colon, but this can be changed as
12846 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12847 it is usually best to change the separator to avoid having to double all the
12848 colons. For example:
12849 .code
12850 local_interfaces = <; 127.0.0.1 ; \
12851                       192.168.23.65 ; \
12852                       ::1 ; \
12853                       3ffe:ffff:836f::fe86:a061
12854 .endd
12855 There are two different formats for specifying a port along with an IP address
12856 in &%local_interfaces%&:
12857
12858 .olist
12859 The port is added onto the address with a dot separator. For example, to listen
12860 on port 1234 on two different IP addresses:
12861 .code
12862 local_interfaces = <; 192.168.23.65.1234 ; \
12863                       3ffe:ffff:836f::fe86:a061.1234
12864 .endd
12865 .next
12866 The IP address is enclosed in square brackets, and the port is added
12867 with a colon separator, for example:
12868 .code
12869 local_interfaces = <; [192.168.23.65]:1234 ; \
12870                       [3ffe:ffff:836f::fe86:a061]:1234
12871 .endd
12872 .endlist
12873
12874 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12875 default setting contains just one port:
12876 .code
12877 daemon_smtp_ports = smtp
12878 .endd
12879 If more than one port is listed, each interface that does not have its own port
12880 specified listens on all of them. Ports that are listed in
12881 &%daemon_smtp_ports%& can be identified either by name (defined in
12882 &_/etc/services_&) or by number. However, when ports are given with individual
12883 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12884
12885
12886
12887 .section "Special IP listening addresses" "SECID90"
12888 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12889 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12890 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12891 instead of setting up separate listening sockets for each interface. The
12892 default value of &%local_interfaces%& is
12893 .code
12894 local_interfaces = 0.0.0.0
12895 .endd
12896 when Exim is built without IPv6 support; otherwise it is:
12897 .code
12898 local_interfaces = <; ::0 ; 0.0.0.0
12899 .endd
12900 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12901
12902
12903
12904 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12905 The &%-oX%& command line option can be used to override the values of
12906 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12907 instance. Another way of doing this would be to use macros and the &%-D%&
12908 option. However, &%-oX%& can be used by any admin user, whereas modification of
12909 the runtime configuration by &%-D%& is allowed only when the caller is root or
12910 exim.
12911
12912 The value of &%-oX%& is a list of items. The default colon separator can be
12913 changed in the usual way if required. If there are any items that do not
12914 contain dots or colons (that is, are not IP addresses), the value of
12915 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
12916 items that do contain dots or colons, the value of &%local_interfaces%& is
12917 replaced by those items. Thus, for example,
12918 .code
12919 -oX 1225
12920 .endd
12921 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
12922 whereas
12923 .code
12924 -oX 192.168.34.5.1125
12925 .endd
12926 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
12927 (However, since &%local_interfaces%& now contains no items without ports, the
12928 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
12929
12930
12931
12932 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
12933 .cindex "ssmtp protocol"
12934 .cindex "smtps protocol"
12935 .cindex "SMTP" "ssmtp protocol"
12936 .cindex "SMTP" "smtps protocol"
12937 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
12938 before the STARTTLS command was standardized for SMTP. Some legacy clients
12939 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
12940 list of port numbers or service names,
12941 connections to those ports must use SSMTP. The most
12942 common use of this option is expected to be
12943 .code
12944 tls_on_connect_ports = 465
12945 .endd
12946 because 465 is the usual port number used by the legacy clients. There is also
12947 a command line option &%-tls-on-connect%&, which forces all ports to behave in
12948 this way when a daemon is started.
12949
12950 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
12951 daemon to listen on those ports. You must still specify them in
12952 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
12953 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
12954 connections via the daemon.)
12955
12956
12957
12958
12959 .section "IPv6 address scopes" "SECID92"
12960 .cindex "IPv6" "address scopes"
12961 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
12962 can, in principle, have the same link-local IPv6 address on different
12963 interfaces. Thus, additional information is needed, over and above the IP
12964 address, to distinguish individual interfaces. A convention of using a
12965 percent sign followed by something (often the interface name) has been
12966 adopted in some cases, leading to addresses like this:
12967 .code
12968 fe80::202:b3ff:fe03:45c1%eth0
12969 .endd
12970 To accommodate this usage, a percent sign followed by an arbitrary string is
12971 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
12972 to convert a textual IPv6 address for actual use. This function recognizes the
12973 percent convention in operating systems that support it, and it processes the
12974 address appropriately. Unfortunately, some older libraries have problems with
12975 &[getaddrinfo()]&. If
12976 .code
12977 IPV6_USE_INET_PTON=yes
12978 .endd
12979 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
12980 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
12981 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
12982 function.) Of course, this means that the additional functionality of
12983 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
12984
12985 .section "Disabling IPv6" "SECID93"
12986 .cindex "IPv6" "disabling"
12987 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
12988 run on a host whose kernel does not support IPv6. The binary will fall back to
12989 using IPv4, but it may waste resources looking up AAAA records, and trying to
12990 connect to IPv6 addresses, causing delays to mail delivery. If you set the
12991 .oindex "&%disable_ipv6%&"
12992 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
12993 activities take place. AAAA records are never looked up, and any IPv6 addresses
12994 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
12995 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
12996 to handle IPv6 literal addresses.
12997
12998 On the other hand, when IPv6 is in use, there may be times when you want to
12999 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13000 option to globally suppress the lookup of AAAA records for specified domains,
13001 and you can use the &%ignore_target_hosts%& generic router option to ignore
13002 IPv6 addresses in an individual router.
13003
13004
13005
13006 .section "Examples of starting a listening daemon" "SECID94"
13007 The default case in an IPv6 environment is
13008 .code
13009 daemon_smtp_ports = smtp
13010 local_interfaces = <; ::0 ; 0.0.0.0
13011 .endd
13012 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13013 Either one or two sockets may be used, depending on the characteristics of
13014 the TCP/IP stack. (This is complicated and messy; for more information,
13015 read the comments in the &_daemon.c_& source file.)
13016
13017 To specify listening on ports 25 and 26 on all interfaces:
13018 .code
13019 daemon_smtp_ports = 25 : 26
13020 .endd
13021 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13022 .code
13023 local_interfaces = <; ::0.25     ; ::0.26 \
13024                       0.0.0.0.25 ; 0.0.0.0.26
13025 .endd
13026 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13027 IPv4 loopback address only:
13028 .code
13029 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13030 .endd
13031 To specify listening on the default port on specific interfaces only:
13032 .code
13033 local_interfaces = 10.0.0.67 : 192.168.34.67
13034 .endd
13035 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13036
13037
13038
13039 .section "Recognizing the local host" "SECTreclocipadd"
13040 The &%local_interfaces%& option is also used when Exim needs to determine
13041 whether or not an IP address refers to the local host. That is, the IP
13042 addresses of all the interfaces on which a daemon is listening are always
13043 treated as local.
13044
13045 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13046 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13047 available interfaces from the operating system, and extracts the relevant
13048 (that is, IPv4 or IPv6) addresses to use for checking.
13049
13050 Some systems set up large numbers of virtual interfaces in order to provide
13051 many virtual web servers. In this situation, you may want to listen for
13052 email on only a few of the available interfaces, but nevertheless treat all
13053 interfaces as local when routing. You can do this by setting
13054 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13055 &"all"& wildcard values. These addresses are recognized as local, but are not
13056 used for listening. Consider this example:
13057 .code
13058 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13059                       192.168.53.235 ; \
13060                       3ffe:2101:12:1:a00:20ff:fe86:a061
13061
13062 extra_local_interfaces = <; ::0 ; 0.0.0.0
13063 .endd
13064 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13065 address, but all available interface addresses are treated as local when
13066 Exim is routing.
13067
13068 In some environments the local host name may be in an MX list, but with an IP
13069 address that is not assigned to any local interface. In other cases it may be
13070 desirable to treat other host names as if they referred to the local host. Both
13071 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13072 This contains host names rather than IP addresses. When a host is referenced
13073 during routing, either via an MX record or directly, it is treated as the local
13074 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13075 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13076
13077
13078
13079 .section "Delivering to a remote host" "SECID95"
13080 Delivery to a remote host is handled by the smtp transport. By default, it
13081 allows the system's TCP/IP functions to choose which interface to use (if
13082 there is more than one) when connecting to a remote host. However, the
13083 &%interface%& option can be set to specify which interface is used. See the
13084 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13085 details.
13086
13087
13088
13089
13090 . ////////////////////////////////////////////////////////////////////////////
13091 . ////////////////////////////////////////////////////////////////////////////
13092
13093 .chapter "Main configuration" "CHAPmainconfig"
13094 .scindex IIDconfima "configuration file" "main section"
13095 .scindex IIDmaiconf "main configuration"
13096 The first part of the run time configuration file contains three types of item:
13097
13098 .ilist
13099 Macro definitions: These lines start with an upper case letter. See section
13100 &<<SECTmacrodefs>>& for details of macro processing.
13101 .next
13102 Named list definitions: These lines start with one of the words &"domainlist"&,
13103 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13104 section &<<SECTnamedlists>>&.
13105 .next
13106 Main configuration settings: Each setting occupies one line of the file
13107 (with possible continuations). If any setting is preceded by the word
13108 &"hide"&, the &%-bP%& command line option displays its value to admin users
13109 only. See section &<<SECTcos>>& for a description of the syntax of these option
13110 settings.
13111 .endlist
13112
13113 This chapter specifies all the main configuration options, along with their
13114 types and default values. For ease of finding a particular option, they appear
13115 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13116 are now so many options, they are first listed briefly in functional groups, as
13117 an aid to finding the name of the option you are looking for. Some options are
13118 listed in more than one group.
13119
13120 .section "Miscellaneous" "SECID96"
13121 .table2
13122 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13123 .row &%disable_ipv6%&                "do no IPv6 processing"
13124 .row &%keep_malformed%&              "for broken files &-- should not happen"
13125 .row &%localhost_number%&            "for unique message ids in clusters"
13126 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13127 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13128 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13129 .row &%print_topbitchars%&           "top-bit characters are printing"
13130 .row &%timezone%&                    "force time zone"
13131 .endtable
13132
13133
13134 .section "Exim parameters" "SECID97"
13135 .table2
13136 .row &%exim_group%&                  "override compiled-in value"
13137 .row &%exim_path%&                   "override compiled-in value"
13138 .row &%exim_user%&                   "override compiled-in value"
13139 .row &%primary_hostname%&            "default from &[uname()]&"
13140 .row &%split_spool_directory%&       "use multiple directories"
13141 .row &%spool_directory%&             "override compiled-in value"
13142 .endtable
13143
13144
13145
13146 .section "Privilege controls" "SECID98"
13147 .table2
13148 .row &%admin_groups%&                "groups that are Exim admin users"
13149 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13150 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13151 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13152 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13153 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13154 .row &%never_users%&                 "do not run deliveries as these"
13155 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13156 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13157 .row &%trusted_groups%&              "groups that are trusted"
13158 .row &%trusted_users%&               "users that are trusted"
13159 .endtable
13160
13161
13162
13163 .section "Logging" "SECID99"
13164 .table2
13165 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13166 .row &%log_file_path%&               "override compiled-in value"
13167 .row &%log_selector%&                "set/unset optional logging"
13168 .row &%log_timezone%&                "add timezone to log lines"
13169 .row &%message_logs%&                "create per-message logs"
13170 .row &%preserve_message_logs%&       "after message completion"
13171 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13172 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13173 .row &%syslog_facility%&             "set syslog &""facility""& field"
13174 .row &%syslog_processname%&          "set syslog &""ident""& field"
13175 .row &%syslog_timestamp%&            "timestamp syslog lines"
13176 .row &%write_rejectlog%&             "control use of message log"
13177 .endtable
13178
13179
13180
13181 .section "Frozen messages" "SECID100"
13182 .table2
13183 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13184 .row &%freeze_tell%&                 "send message when freezing"
13185 .row &%move_frozen_messages%&        "to another directory"
13186 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13187 .endtable
13188
13189
13190
13191 .section "Data lookups" "SECID101"
13192 .table2
13193 .row &%ibase_servers%&               "InterBase servers"
13194 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13195 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13196 .row &%ldap_cert_file%&              "client cert file for LDAP"
13197 .row &%ldap_cert_key%&               "client key file for LDAP"
13198 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13199 .row &%ldap_default_servers%&        "used if no server in query"
13200 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13201 .row &%ldap_start_tls%&              "require TLS within LDAP"
13202 .row &%ldap_version%&                "set protocol version"
13203 .row &%lookup_open_max%&             "lookup files held open"
13204 .row &%mysql_servers%&               "default MySQL servers"
13205 .row &%oracle_servers%&              "Oracle servers"
13206 .row &%pgsql_servers%&               "default PostgreSQL servers"
13207 .row &%sqlite_lock_timeout%&         "as it says"
13208 .endtable
13209
13210
13211
13212 .section "Message ids" "SECID102"
13213 .table2
13214 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13215 .row &%message_id_header_text%&      "ditto"
13216 .endtable
13217
13218
13219
13220 .section "Embedded Perl Startup" "SECID103"
13221 .table2
13222 .row &%perl_at_start%&               "always start the interpreter"
13223 .row &%perl_startup%&                "code to obey when starting Perl"
13224 .endtable
13225
13226
13227
13228 .section "Daemon" "SECID104"
13229 .table2
13230 .row &%daemon_smtp_ports%&           "default ports"
13231 .row &%daemon_startup_retries%&      "number of times to retry"
13232 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13233 .row &%extra_local_interfaces%&      "not necessarily listened on"
13234 .row &%local_interfaces%&            "on which to listen, with optional ports"
13235 .row &%pid_file_path%&               "override compiled-in value"
13236 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13237 .endtable
13238
13239
13240
13241 .section "Resource control" "SECID105"
13242 .table2
13243 .row &%check_log_inodes%&            "before accepting a message"
13244 .row &%check_log_space%&             "before accepting a message"
13245 .row &%check_spool_inodes%&          "before accepting a message"
13246 .row &%check_spool_space%&           "before accepting a message"
13247 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13248 .row &%queue_only_load%&             "queue incoming if load high"
13249 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13250 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13251 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13252 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13253 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13254 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13255 .row &%smtp_accept_max_per_connection%& "messages per connection"
13256 .row &%smtp_accept_max_per_host%&    "connections from one host"
13257 .row &%smtp_accept_queue%&           "queue mail if more connections"
13258 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13259                                            connection"
13260 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13261 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13262 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13263 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13264 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13265 .endtable
13266
13267
13268
13269 .section "Policy controls" "SECID106"
13270 .table2
13271 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13272 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13273 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13274 .row &%acl_smtp_auth%&               "ACL for AUTH"
13275 .row &%acl_smtp_connect%&            "ACL for connection"
13276 .row &%acl_smtp_data%&               "ACL for DATA"
13277 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13278 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13279 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13280 .row &%acl_smtp_expn%&               "ACL for EXPN"
13281 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13282 .row &%acl_smtp_mail%&               "ACL for MAIL"
13283 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13284 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13285 .row &%acl_smtp_predata%&            "ACL for start of data"
13286 .row &%acl_smtp_quit%&               "ACL for QUIT"
13287 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13288 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13289 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13290 .row &%av_scanner%&                  "specify virus scanner"
13291 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13292                                       words""&"
13293 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13294 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13295 .row &%header_maxsize%&              "total size of message header"
13296 .row &%header_line_maxsize%&         "individual header line limit"
13297 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13298 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13299 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13300 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13301 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13302 .row &%host_lookup%&                 "host name looked up for these hosts"
13303 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13304 .row &%host_reject_connection%&      "reject connection from these hosts"
13305 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13306 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13307 .row &%message_size_limit%&          "for all messages"
13308 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13309 .row &%spamd_address%&               "set interface to SpamAssassin"
13310 .row &%strict_acl_vars%&             "object to unset ACL variables"
13311 .endtable
13312
13313
13314
13315 .section "Callout cache" "SECID107"
13316 .table2
13317 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13318                                          item"
13319 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13320                                          item"
13321 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13322 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13323 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13324 .endtable
13325
13326
13327
13328 .section "TLS" "SECID108"
13329 .table2
13330 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13331 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13332 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13333 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13334 .row &%tls_certificate%&             "location of server certificate"
13335 .row &%tls_crl%&                     "certificate revocation list"
13336 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13337 .row &%tls_dhparam%&                 "DH parameters for server"
13338 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13339 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13340 .row &%tls_privatekey%&              "location of server private key"
13341 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13342 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13343 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13344 .row &%tls_verify_certificates%&     "expected client certificates"
13345 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13346 .endtable
13347
13348
13349
13350 .section "Local user handling" "SECID109"
13351 .table2
13352 .row &%finduser_retries%&            "useful in NIS environments"
13353 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13354 .row &%gecos_pattern%&               "ditto"
13355 .row &%max_username_length%&         "for systems that truncate"
13356 .row &%unknown_login%&               "used when no login name found"
13357 .row &%unknown_username%&            "ditto"
13358 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13359 .row &%uucp_from_sender%&            "ditto"
13360 .endtable
13361
13362
13363
13364 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13365 .table2
13366 .row &%header_maxsize%&              "total size of message header"
13367 .row &%header_line_maxsize%&         "individual header line limit"
13368 .row &%message_size_limit%&          "applies to all messages"
13369 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13370 .row &%received_header_text%&        "expanded to make &'Received:'&"
13371 .row &%received_headers_max%&        "for mail loop detection"
13372 .row &%recipients_max%&              "limit per message"
13373 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13374 .endtable
13375
13376
13377
13378
13379 .section "Non-SMTP incoming messages" "SECID111"
13380 .table2
13381 .row &%receive_timeout%&             "for non-SMTP messages"
13382 .endtable
13383
13384
13385
13386
13387
13388 .section "Incoming SMTP messages" "SECID112"
13389 See also the &'Policy controls'& section above.
13390
13391 .table2
13392 .row &%host_lookup%&                 "host name looked up for these hosts"
13393 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13394 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13395 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13396 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13397 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13398 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13399 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13400 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13401 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13402 .row &%smtp_accept_max_per_connection%& "messages per connection"
13403 .row &%smtp_accept_max_per_host%&    "connections from one host"
13404 .row &%smtp_accept_queue%&           "queue mail if more connections"
13405 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13406                                            connection"
13407 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13408 .row &%smtp_active_hostname%&        "host name to use in messages"
13409 .row &%smtp_banner%&                 "text for welcome banner"
13410 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13411 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13412 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13413 .row &%smtp_etrn_command%&           "what to run for ETRN"
13414 .row &%smtp_etrn_serialize%&         "only one at once"
13415 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13416 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13417 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13418 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13419 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13420 .row &%smtp_receive_timeout%&        "per command or data line"
13421 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13422 .row &%smtp_return_error_details%&   "give detail on rejections"
13423 .endtable
13424
13425
13426
13427 .section "SMTP extensions" "SECID113"
13428 .table2
13429 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13430 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13431 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13432 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13433 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13434 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13435 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13436 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13437 .endtable
13438
13439
13440
13441 .section "Processing messages" "SECID114"
13442 .table2
13443 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13444 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13445 .row &%allow_utf8_domains%&          "in addresses"
13446 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13447                                       words""&"
13448 .row &%delivery_date_remove%&        "from incoming messages"
13449 .row &%envelope_to_remove%&          "from incoming messages"
13450 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13451 .row &%headers_charset%&             "default for translations"
13452 .row &%qualify_domain%&              "default for senders"
13453 .row &%qualify_recipient%&           "default for recipients"
13454 .row &%return_path_remove%&          "from incoming messages"
13455 .row &%strip_excess_angle_brackets%& "in addresses"
13456 .row &%strip_trailing_dot%&          "at end of addresses"
13457 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13458 .endtable
13459
13460
13461
13462 .section "System filter" "SECID115"
13463 .table2
13464 .row &%system_filter%&               "locate system filter"
13465 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13466                                             directory"
13467 .row &%system_filter_file_transport%& "transport for delivery to a file"
13468 .row &%system_filter_group%&         "group for filter running"
13469 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13470 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13471 .row &%system_filter_user%&          "user for filter running"
13472 .endtable
13473
13474
13475
13476 .section "Routing and delivery" "SECID116"
13477 .table2
13478 .row &%disable_ipv6%&                "do no IPv6 processing"
13479 .row &%dns_again_means_nonexist%&    "for broken domains"
13480 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13481 .row &%dns_dnssec_ok%&               "parameter for resolver"
13482 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13483 .row &%dns_retrans%&                 "parameter for resolver"
13484 .row &%dns_retry%&                   "parameter for resolver"
13485 .row &%dns_use_edns0%&               "parameter for resolver"
13486 .row &%hold_domains%&                "hold delivery for these domains"
13487 .row &%local_interfaces%&            "for routing checks"
13488 .row &%queue_domains%&               "no immediate delivery for these"
13489 .row &%queue_only%&                  "no immediate delivery at all"
13490 .row &%queue_only_file%&             "no immediate delivery if file exists"
13491 .row &%queue_only_load%&             "no immediate delivery if load is high"
13492 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13493 .row &%queue_only_override%&         "allow command line to override"
13494 .row &%queue_run_in_order%&          "order of arrival"
13495 .row &%queue_run_max%&               "of simultaneous queue runners"
13496 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13497 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13498 .row &%remote_sort_domains%&         "order of remote deliveries"
13499 .row &%retry_data_expire%&           "timeout for retry data"
13500 .row &%retry_interval_max%&          "safety net for retry rules"
13501 .endtable
13502
13503
13504
13505 .section "Bounce and warning messages" "SECID117"
13506 .table2
13507 .row &%bounce_message_file%&         "content of bounce"
13508 .row &%bounce_message_text%&         "content of bounce"
13509 .row &%bounce_return_body%&          "include body if returning message"
13510 .row &%bounce_return_message%&       "include original message in bounce"
13511 .row &%bounce_return_size_limit%&    "limit on returned message"
13512 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13513 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13514 .row &%errors_copy%&                 "copy bounce messages"
13515 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13516 .row &%delay_warning%&               "time schedule"
13517 .row &%delay_warning_condition%&     "condition for warning messages"
13518 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13519 .row &%smtp_return_error_details%&   "give detail on rejections"
13520 .row &%warn_message_file%&           "content of warning message"
13521 .endtable
13522
13523
13524
13525 .section "Alphabetical list of main options" "SECTalomo"
13526 Those options that undergo string expansion before use are marked with
13527 &dagger;.
13528
13529 .option accept_8bitmime main boolean true
13530 .cindex "8BITMIME"
13531 .cindex "8-bit characters"
13532 .cindex "log" "selectors"
13533 .cindex "log" "8BITMIME"
13534 This option causes Exim to send 8BITMIME in its response to an SMTP
13535 EHLO command, and to accept the BODY= parameter on MAIL commands.
13536 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13537 takes no steps to do anything special with messages received by this route.
13538
13539 Historically Exim kept this option off by default, but the maintainers
13540 feel that in today's Internet, this causes more problems than it solves.
13541 It now defaults to true.
13542 A more detailed analysis of the issues is provided by Dan Bernstein:
13543 .display
13544 &url(http://cr.yp.to/smtp/8bitmime.html)
13545 .endd
13546
13547 To log received 8BITMIME status use
13548 .code
13549 log_selector = +8bitmime
13550 .endd
13551
13552 .option acl_not_smtp main string&!! unset
13553 .cindex "&ACL;" "for non-SMTP messages"
13554 .cindex "non-SMTP messages" "ACLs for"
13555 This option defines the ACL that is run when a non-SMTP message has been
13556 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13557 further details.
13558
13559 .option acl_not_smtp_mime main string&!! unset
13560 This option defines the ACL that is run for individual MIME parts of non-SMTP
13561 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13562 SMTP messages.
13563
13564 .option acl_not_smtp_start main string&!! unset
13565 .cindex "&ACL;" "at start of non-SMTP message"
13566 .cindex "non-SMTP messages" "ACLs for"
13567 This option defines the ACL that is run before Exim starts reading a
13568 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13569
13570 .option acl_smtp_auth main string&!! unset
13571 .cindex "&ACL;" "setting up for SMTP commands"
13572 .cindex "AUTH" "ACL for"
13573 This option defines the ACL that is run when an SMTP AUTH command is
13574 received. See chapter &<<CHAPACL>>& for further details.
13575
13576 .option acl_smtp_connect main string&!! unset
13577 .cindex "&ACL;" "on SMTP connection"
13578 This option defines the ACL that is run when an SMTP connection is received.
13579 See chapter &<<CHAPACL>>& for further details.
13580
13581 .option acl_smtp_data main string&!! unset
13582 .cindex "DATA" "ACL for"
13583 This option defines the ACL that is run after an SMTP DATA command has been
13584 processed and the message itself has been received, but before the final
13585 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13586
13587 .new
13588 .option acl_smtp_data_prdr main string&!! accept
13589 .cindex "PRDR" "ACL for"
13590 .cindex "DATA" "PRDR ACL for"
13591 .cindex "&ACL;" "PRDR-related"
13592 .cindex "&ACL;" "per-user data processing"
13593 .wen
13594 This option defines the ACL that,
13595 if the PRDR feature has been negotiated,
13596 is run for each recipient after an SMTP DATA command has been
13597 processed and the message itself has been received, but before the
13598 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13599
13600 .option acl_smtp_etrn main string&!! unset
13601 .cindex "ETRN" "ACL for"
13602 This option defines the ACL that is run when an SMTP ETRN command is
13603 received. See chapter &<<CHAPACL>>& for further details.
13604
13605 .option acl_smtp_expn main string&!! unset
13606 .cindex "EXPN" "ACL for"
13607 This option defines the ACL that is run when an SMTP EXPN command is
13608 received. See chapter &<<CHAPACL>>& for further details.
13609
13610 .option acl_smtp_helo main string&!! unset
13611 .cindex "EHLO" "ACL for"
13612 .cindex "HELO" "ACL for"
13613 This option defines the ACL that is run when an SMTP EHLO or HELO
13614 command is received. See chapter &<<CHAPACL>>& for further details.
13615
13616
13617 .option acl_smtp_mail main string&!! unset
13618 .cindex "MAIL" "ACL for"
13619 This option defines the ACL that is run when an SMTP MAIL command is
13620 received. See chapter &<<CHAPACL>>& for further details.
13621
13622 .option acl_smtp_mailauth main string&!! unset
13623 .cindex "AUTH" "on MAIL command"
13624 This option defines the ACL that is run when there is an AUTH parameter on
13625 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13626 &<<CHAPSMTPAUTH>>& for details of authentication.
13627
13628 .option acl_smtp_mime main string&!! unset
13629 .cindex "MIME content scanning" "ACL for"
13630 This option is available when Exim is built with the content-scanning
13631 extension. It defines the ACL that is run for each MIME part in a message. See
13632 section &<<SECTscanmimepart>>& for details.
13633
13634 .option acl_smtp_predata main string&!! unset
13635 This option defines the ACL that is run when an SMTP DATA command is
13636 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13637 further details.
13638
13639 .option acl_smtp_quit main string&!! unset
13640 .cindex "QUIT, ACL for"
13641 This option defines the ACL that is run when an SMTP QUIT command is
13642 received. See chapter &<<CHAPACL>>& for further details.
13643
13644 .option acl_smtp_rcpt main string&!! unset
13645 .cindex "RCPT" "ACL for"
13646 This option defines the ACL that is run when an SMTP RCPT command is
13647 received. See chapter &<<CHAPACL>>& for further details.
13648
13649 .option acl_smtp_starttls main string&!! unset
13650 .cindex "STARTTLS, ACL for"
13651 This option defines the ACL that is run when an SMTP STARTTLS command is
13652 received. See chapter &<<CHAPACL>>& for further details.
13653
13654 .option acl_smtp_vrfy main string&!! unset
13655 .cindex "VRFY" "ACL for"
13656 This option defines the ACL that is run when an SMTP VRFY command is
13657 received. See chapter &<<CHAPACL>>& for further details.
13658
13659 .option admin_groups main "string list&!!" unset
13660 .cindex "admin user"
13661 This option is expanded just once, at the start of Exim's processing. If the
13662 current group or any of the supplementary groups of an Exim caller is in this
13663 colon-separated list, the caller has admin privileges. If all your system
13664 programmers are in a specific group, for example, you can give them all Exim
13665 admin privileges by putting that group in &%admin_groups%&. However, this does
13666 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13667 To permit this, you have to add individuals to the Exim group.
13668
13669 .option allow_domain_literals main boolean false
13670 .cindex "domain literal"
13671 If this option is set, the RFC 2822 domain literal format is permitted in
13672 email addresses. The option is not set by default, because the domain literal
13673 format is not normally required these days, and few people know about it. It
13674 has, however, been exploited by mail abusers.
13675
13676 Unfortunately, it seems that some DNS black list maintainers are using this
13677 format to report black listing to postmasters. If you want to accept messages
13678 addressed to your hosts by IP address, you need to set
13679 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13680 domains (defined in the named domain list &%local_domains%& in the default
13681 configuration). This &"magic string"& matches the domain literal form of all
13682 the local host's IP addresses.
13683
13684
13685 .option allow_mx_to_ip main boolean false
13686 .cindex "MX record" "pointing to IP address"
13687 It appears that more and more DNS zone administrators are breaking the rules
13688 and putting domain names that look like IP addresses on the right hand side of
13689 MX records. Exim follows the rules and rejects this, giving an error message
13690 that explains the mis-configuration. However, some other MTAs support this
13691 practice, so to avoid &"Why can't Exim do this?"& complaints,
13692 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13693 recommended, except when you have no other choice.
13694
13695 .option allow_utf8_domains main boolean false
13696 .cindex "domain" "UTF-8 characters in"
13697 .cindex "UTF-8" "in domain name"
13698 Lots of discussion is going on about internationalized domain names. One
13699 camp is strongly in favour of just using UTF-8 characters, and it seems
13700 that at least two other MTAs permit this. This option allows Exim users to
13701 experiment if they wish.
13702
13703 If it is set true, Exim's domain parsing function allows valid
13704 UTF-8 multicharacters to appear in domain name components, in addition to
13705 letters, digits, and hyphens. However, just setting this option is not
13706 enough; if you want to look up these domain names in the DNS, you must also
13707 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13708 suitable setting is:
13709 .code
13710 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13711   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13712 .endd
13713 Alternatively, you can just disable this feature by setting
13714 .code
13715 dns_check_names_pattern =
13716 .endd
13717 That is, set the option to an empty string so that no check is done.
13718
13719
13720 .option auth_advertise_hosts main "host list&!!" *
13721 .cindex "authentication" "advertising"
13722 .cindex "AUTH" "advertising"
13723 If any server authentication mechanisms are configured, Exim advertises them in
13724 response to an EHLO command only if the calling host matches this list.
13725 Otherwise, Exim does not advertise AUTH.
13726 Exim does not accept AUTH commands from clients to which it has not
13727 advertised the availability of AUTH. The advertising of individual
13728 authentication mechanisms can be controlled by the use of the
13729 &%server_advertise_condition%& generic authenticator option on the individual
13730 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13731
13732 Certain mail clients (for example, Netscape) require the user to provide a name
13733 and password for authentication if AUTH is advertised, even though it may
13734 not be needed (the host may accept messages from hosts on its local LAN without
13735 authentication, for example). The &%auth_advertise_hosts%& option can be used
13736 to make these clients more friendly by excluding them from the set of hosts to
13737 which Exim advertises AUTH.
13738
13739 .cindex "AUTH" "advertising when encrypted"
13740 If you want to advertise the availability of AUTH only when the connection
13741 is encrypted using TLS, you can make use of the fact that the value of this
13742 option is expanded, with a setting like this:
13743 .code
13744 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13745 .endd
13746 .vindex "&$tls_in_cipher$&"
13747 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13748 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13749 expansion is *, which matches all hosts.
13750
13751
13752 .option auto_thaw main time 0s
13753 .cindex "thawing messages"
13754 .cindex "unfreezing messages"
13755 If this option is set to a time greater than zero, a queue runner will try a
13756 new delivery attempt on any frozen message, other than a bounce message, if
13757 this much time has passed since it was frozen. This may result in the message
13758 being re-frozen if nothing has changed since the last attempt. It is a way of
13759 saying &"keep on trying, even though there are big problems"&.
13760
13761 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13762 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13763 thought to be very useful any more, and its use should probably be avoided.
13764
13765
13766 .option av_scanner main string "see below"
13767 This option is available if Exim is built with the content-scanning extension.
13768 It specifies which anti-virus scanner to use. The default value is:
13769 .code
13770 sophie:/var/run/sophie
13771 .endd
13772 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13773 before use. See section &<<SECTscanvirus>>& for further details.
13774
13775
13776 .option bi_command main string unset
13777 .oindex "&%-bi%&"
13778 This option supplies the name of a command that is run when Exim is called with
13779 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13780 just the command name, it is not a complete command line. If an argument is
13781 required, it must come from the &%-oA%& command line option.
13782
13783
13784 .option bounce_message_file main string unset
13785 .cindex "bounce message" "customizing"
13786 .cindex "customizing" "bounce message"
13787 This option defines a template file containing paragraphs of text to be used
13788 for constructing bounce messages.  Details of the file's contents are given in
13789 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13790
13791
13792 .option bounce_message_text main string unset
13793 When this option is set, its contents are included in the default bounce
13794 message immediately after &"This message was created automatically by mail
13795 delivery software."& It is not used if &%bounce_message_file%& is set.
13796
13797 .option bounce_return_body main boolean true
13798 .cindex "bounce message" "including body"
13799 This option controls whether the body of an incoming message is included in a
13800 bounce message when &%bounce_return_message%& is true. The default setting
13801 causes the entire message, both header and body, to be returned (subject to the
13802 value of &%bounce_return_size_limit%&). If this option is false, only the
13803 message header is included. In the case of a non-SMTP message containing an
13804 error that is detected during reception, only those header lines preceding the
13805 point at which the error was detected are returned.
13806 .cindex "bounce message" "including original"
13807
13808 .option bounce_return_message main boolean true
13809 If this option is set false, none of the original message is included in
13810 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13811 &%bounce_return_body%&.
13812
13813
13814 .option bounce_return_size_limit main integer 100K
13815 .cindex "size" "of bounce, limit"
13816 .cindex "bounce message" "size limit"
13817 .cindex "limit" "bounce message size"
13818 This option sets a limit in bytes on the size of messages that are returned to
13819 senders as part of bounce messages when &%bounce_return_message%& is true. The
13820 limit should be less than the value of the global &%message_size_limit%& and of
13821 any &%message_size_limit%& settings on transports, to allow for the bounce text
13822 that Exim generates. If this option is set to zero there is no limit.
13823
13824 When the body of any message that is to be included in a bounce message is
13825 greater than the limit, it is truncated, and a comment pointing this out is
13826 added at the top. The actual cutoff may be greater than the value given, owing
13827 to the use of buffering for transferring the message in chunks (typically 8K in
13828 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13829 messages.
13830
13831 .option bounce_sender_authentication main string unset
13832 .cindex "bounce message" "sender authentication"
13833 .cindex "authentication" "bounce message"
13834 .cindex "AUTH" "on bounce message"
13835 This option provides an authenticated sender address that is sent with any
13836 bounce messages generated by Exim that are sent over an authenticated SMTP
13837 connection. A typical setting might be:
13838 .code
13839 bounce_sender_authentication = mailer-daemon@my.domain.example
13840 .endd
13841 which would cause bounce messages to be sent using the SMTP command:
13842 .code
13843 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13844 .endd
13845 The value of &%bounce_sender_authentication%& must always be a complete email
13846 address.
13847
13848 .option callout_domain_negative_expire main time 3h
13849 .cindex "caching" "callout timeouts"
13850 .cindex "callout" "caching timeouts"
13851 This option specifies the expiry time for negative callout cache data for a
13852 domain. See section &<<SECTcallver>>& for details of callout verification, and
13853 section &<<SECTcallvercache>>& for details of the caching.
13854
13855
13856 .option callout_domain_positive_expire main time 7d
13857 This option specifies the expiry time for positive callout cache data for a
13858 domain. See section &<<SECTcallver>>& for details of callout verification, and
13859 section &<<SECTcallvercache>>& for details of the caching.
13860
13861
13862 .option callout_negative_expire main time 2h
13863 This option specifies the expiry time for negative callout cache data for an
13864 address. See section &<<SECTcallver>>& for details of callout verification, and
13865 section &<<SECTcallvercache>>& for details of the caching.
13866
13867
13868 .option callout_positive_expire main time 24h
13869 This option specifies the expiry time for positive callout cache data for an
13870 address. See section &<<SECTcallver>>& for details of callout verification, and
13871 section &<<SECTcallvercache>>& for details of the caching.
13872
13873
13874 .option callout_random_local_part main string&!! "see below"
13875 This option defines the &"random"& local part that can be used as part of
13876 callout verification. The default value is
13877 .code
13878 $primary_hostname-$tod_epoch-testing
13879 .endd
13880 See section &<<CALLaddparcall>>& for details of how this value is used.
13881
13882
13883 .option check_log_inodes main integer 0
13884 See &%check_spool_space%& below.
13885
13886
13887 .option check_log_space main integer 0
13888 See &%check_spool_space%& below.
13889
13890 .oindex "&%check_rfc2047_length%&"
13891 .cindex "RFC 2047" "disabling length check"
13892 .option check_rfc2047_length main boolean true
13893 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
13894 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
13895 word; strings to be encoded that exceed this length are supposed to use
13896 multiple encoded words. By default, Exim does not recognize encoded words that
13897 exceed the maximum length. However, it seems that some software, in violation
13898 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
13899 set false, Exim recognizes encoded words of any length.
13900
13901
13902 .option check_spool_inodes main integer 0
13903 See &%check_spool_space%& below.
13904
13905
13906 .option check_spool_space main integer 0
13907 .cindex "checking disk space"
13908 .cindex "disk space, checking"
13909 .cindex "spool directory" "checking space"
13910 The four &%check_...%& options allow for checking of disk resources before a
13911 message is accepted.
13912
13913 .vindex "&$log_inodes$&"
13914 .vindex "&$log_space$&"
13915 .vindex "&$spool_inodes$&"
13916 .vindex "&$spool_space$&"
13917 When any of these options are set, they apply to all incoming messages. If you
13918 want to apply different checks to different kinds of message, you can do so by
13919 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
13920 &$spool_space$& in an ACL with appropriate additional conditions.
13921
13922
13923 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
13924 either value is greater than zero, for example:
13925 .code
13926 check_spool_space = 10M
13927 check_spool_inodes = 100
13928 .endd
13929 The spool partition is the one that contains the directory defined by
13930 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
13931 transit.
13932
13933 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
13934 files are written if either is greater than zero. These should be set only if
13935 &%log_file_path%& and &%spool_directory%& refer to different partitions.
13936
13937 If there is less space or fewer inodes than requested, Exim refuses to accept
13938 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
13939 error response to the MAIL command. If ESMTP is in use and there was a
13940 SIZE parameter on the MAIL command, its value is added to the
13941 &%check_spool_space%& value, and the check is performed even if
13942 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
13943
13944 The values for &%check_spool_space%& and &%check_log_space%& are held as a
13945 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
13946
13947 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
13948 failure a message is written to stderr and Exim exits with a non-zero code, as
13949 it obviously cannot send an error message of any kind.
13950
13951 .option daemon_smtp_ports main string &`smtp`&
13952 .cindex "port" "for daemon"
13953 .cindex "TCP/IP" "setting listening ports"
13954 This option specifies one or more default SMTP ports on which the Exim daemon
13955 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
13956 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
13957
13958 .option daemon_startup_retries main integer 9
13959 .cindex "daemon startup, retrying"
13960 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
13961 the daemon at startup when it cannot immediately bind a listening socket
13962 (typically because the socket is already in use): &%daemon_startup_retries%&
13963 defines the number of retries after the first failure, and
13964 &%daemon_startup_sleep%& defines the length of time to wait between retries.
13965
13966 .option daemon_startup_sleep main time 30s
13967 See &%daemon_startup_retries%&.
13968
13969 .option delay_warning main "time list" 24h
13970 .cindex "warning of delay"
13971 .cindex "delay warning, specifying"
13972 When a message is delayed, Exim sends a warning message to the sender at
13973 intervals specified by this option. The data is a colon-separated list of times
13974 after which to send warning messages. If the value of the option is an empty
13975 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
13976 message has been on the queue for longer than the last time, the last interval
13977 between the times is used to compute subsequent warning times. For example,
13978 with
13979 .code
13980 delay_warning = 4h:8h:24h
13981 .endd
13982 the first message is sent after 4 hours, the second after 8 hours, and
13983 the third one after 24 hours. After that, messages are sent every 16 hours,
13984 because that is the interval between the last two times on the list. If you set
13985 just one time, it specifies the repeat interval. For example, with:
13986 .code
13987 delay_warning = 6h
13988 .endd
13989 messages are repeated every six hours. To stop warnings after a given time, set
13990 a very large time at the end of the list. For example:
13991 .code
13992 delay_warning = 2h:12h:99d
13993 .endd
13994 Note that the option is only evaluated at the time a delivery attempt fails,
13995 which depends on retry and queue-runner configuration.
13996 Typically retries will be configured more frequently than warning messages.
13997
13998 .option delay_warning_condition main string&!! "see below"
13999 .vindex "&$domain$&"
14000 The string is expanded at the time a warning message might be sent. If all the
14001 deferred addresses have the same domain, it is set in &$domain$& during the
14002 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14003 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14004 &"false"& (the comparison being done caselessly) then the warning message is
14005 not sent. The default is:
14006 .code
14007 delay_warning_condition = ${if or {\
14008   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14009   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14010   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14011   } {no}{yes}}
14012 .endd
14013 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14014 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14015 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14016 &"auto-replied"& in an &'Auto-Submitted:'& header.
14017
14018 .option deliver_drop_privilege main boolean false
14019 .cindex "unprivileged delivery"
14020 .cindex "delivery" "unprivileged"
14021 If this option is set true, Exim drops its root privilege at the start of a
14022 delivery process, and runs as the Exim user throughout. This severely restricts
14023 the kinds of local delivery that are possible, but is viable in certain types
14024 of configuration. There is a discussion about the use of root privilege in
14025 chapter &<<CHAPsecurity>>&.
14026
14027 .option deliver_queue_load_max main fixed-point unset
14028 .cindex "load average"
14029 .cindex "queue runner" "abandoning"
14030 When this option is set, a queue run is abandoned if the system load average
14031 becomes greater than the value of the option. The option has no effect on
14032 ancient operating systems on which Exim cannot determine the load average.
14033 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14034
14035
14036 .option delivery_date_remove main boolean true
14037 .cindex "&'Delivery-date:'& header line"
14038 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14039 message when it is delivered, in exactly the same way as &'Return-path:'& is
14040 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14041 should not be present in incoming messages, and this option causes them to be
14042 removed at the time the message is received, to avoid any problems that might
14043 occur when a delivered message is subsequently sent on to some other recipient.
14044
14045 .option disable_fsync main boolean false
14046 .cindex "&[fsync()]&, disabling"
14047 This option is available only if Exim was built with the compile-time option
14048 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14049 a runtime configuration generates an &"unknown option"& error. You should not
14050 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14051 really, really, really understand what you are doing. &'No pre-compiled
14052 distributions of Exim should ever make this option available.'&
14053
14054 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14055 updated files' data to be written to disc before continuing. Unexpected events
14056 such as crashes and power outages may cause data to be lost or scrambled.
14057 Here be Dragons. &*Beware.*&
14058
14059
14060 .option disable_ipv6 main boolean false
14061 .cindex "IPv6" "disabling"
14062 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14063 activities take place. AAAA records are never looked up, and any IPv6 addresses
14064 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14065 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14066 to handle IPv6 literal addresses.
14067
14068
14069 .option dns_again_means_nonexist main "domain list&!!" unset
14070 .cindex "DNS" "&""try again""& response; overriding"
14071 DNS lookups give a &"try again"& response for the DNS errors
14072 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14073 keep trying to deliver a message, or to give repeated temporary errors to
14074 incoming mail. Sometimes the effect is caused by a badly set up name server and
14075 may persist for a long time. If a domain which exhibits this problem matches
14076 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14077 This option should be used with care. You can make it apply to reverse lookups
14078 by a setting such as this:
14079 .code
14080 dns_again_means_nonexist = *.in-addr.arpa
14081 .endd
14082 This option applies to all DNS lookups that Exim does. It also applies when the
14083 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14084 since these are most likely to be caused by DNS lookup problems. The
14085 &(dnslookup)& router has some options of its own for controlling what happens
14086 when lookups for MX or SRV records give temporary errors. These more specific
14087 options are applied after this global option.
14088
14089 .option dns_check_names_pattern main string "see below"
14090 .cindex "DNS" "pre-check of name syntax"
14091 When this option is set to a non-empty string, it causes Exim to check domain
14092 names for characters that are not allowed in host names before handing them to
14093 the DNS resolver, because some resolvers give temporary errors for names that
14094 contain unusual characters. If a domain name contains any unwanted characters,
14095 a &"not found"& result is forced, and the resolver is not called. The check is
14096 done by matching the domain name against a regular expression, which is the
14097 value of this option. The default pattern is
14098 .code
14099 dns_check_names_pattern = \
14100   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14101 .endd
14102 which permits only letters, digits, slashes, and hyphens in components, but
14103 they must start and end with a letter or digit. Slashes are not, in fact,
14104 permitted in host names, but they are found in certain NS records (which can be
14105 accessed in Exim by using a &%dnsdb%& lookup). If you set
14106 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14107 empty string.
14108
14109 .option dns_csa_search_limit main integer 5
14110 This option controls the depth of parental searching for CSA SRV records in the
14111 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14112
14113 .option dns_csa_use_reverse main boolean true
14114 This option controls whether or not an IP address, given as a CSA domain, is
14115 reversed and looked up in the reverse DNS, as described in more detail in
14116 section &<<SECTverifyCSA>>&.
14117
14118
14119 .option dns_dnssec_ok main integer -1
14120 .cindex "DNS" "resolver options"
14121 .cindex "DNS" "DNSSEC"
14122 If this option is set to a non-negative number then Exim will initialise the
14123 DNS resolver library to either use or not use DNSSEC, overriding the system
14124 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14125
14126 If the resolver library does not support DNSSEC then this option has no effect.
14127
14128
14129 .option dns_ipv4_lookup main "domain list&!!" unset
14130 .cindex "IPv6" "DNS lookup for AAAA records"
14131 .cindex "DNS" "IPv6 lookup for AAAA records"
14132 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14133 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14134 (A records) when trying to find IP addresses for hosts, unless the host's
14135 domain matches this list.
14136
14137 This is a fudge to help with name servers that give big delays or otherwise do
14138 not work for the AAAA record type. In due course, when the world's name
14139 servers have all been upgraded, there should be no need for this option.
14140
14141
14142 .option dns_retrans main time 0s
14143 .cindex "DNS" "resolver options"
14144 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14145 retransmission and retry parameters for DNS lookups. Values of zero (the
14146 defaults) leave the system default settings unchanged. The first value is the
14147 time between retries, and the second is the number of retries. It isn't
14148 totally clear exactly how these settings affect the total time a DNS lookup may
14149 take. I haven't found any documentation about timeouts on DNS lookups; these
14150 parameter values are available in the external resolver interface structure,
14151 but nowhere does it seem to describe how they are used or what you might want
14152 to set in them.
14153
14154
14155 .option dns_retry main integer 0
14156 See &%dns_retrans%& above.
14157
14158
14159 .option dns_use_edns0 main integer -1
14160 .cindex "DNS" "resolver options"
14161 .cindex "DNS" "EDNS0"
14162 If this option is set to a non-negative number then Exim will initialise the
14163 DNS resolver library to either use or not use EDNS0 extensions, overriding
14164 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14165 on.
14166
14167 If the resolver library does not support EDNS0 then this option has no effect.
14168
14169
14170 .option drop_cr main boolean false
14171 This is an obsolete option that is now a no-op. It used to affect the way Exim
14172 handled CR and LF characters in incoming messages. What happens now is
14173 described in section &<<SECTlineendings>>&.
14174
14175 .new
14176 .option dsn_advertise_hosts main "host list&!!" unset
14177 .cindex "bounce messages" "success"
14178 .cindex "DSN" "success"
14179 .cindex "Delivery Status Notification" "success"
14180 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14181 and accepted from, these hosts.
14182 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14183 and RET and ORCPT options on MAIL FROM commands.
14184 A NOTIFY=SUCCESS option requests success-DSN messages.
14185 A NOTIFY= option with no argument requests that no delay or failure DSNs
14186 are sent.
14187 .wen
14188
14189 .option dsn_from main "string&!!" "see below"
14190 .cindex "&'From:'& header line" "in bounces"
14191 .cindex "bounce messages" "&'From:'& line, specifying"
14192 This option can be used to vary the contents of &'From:'& header lines in
14193 bounces and other automatically generated messages (&"Delivery Status
14194 Notifications"& &-- hence the name of the option). The default setting is:
14195 .code
14196 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14197 .endd
14198 The value is expanded every time it is needed. If the expansion fails, a
14199 panic is logged, and the default value is used.
14200
14201 .option envelope_to_remove main boolean true
14202 .cindex "&'Envelope-to:'& header line"
14203 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14204 message when it is delivered, in exactly the same way as &'Return-path:'& is
14205 handled. &'Envelope-to:'& records the original recipient address from the
14206 messages's envelope that caused the delivery to happen. Such headers should not
14207 be present in incoming messages, and this option causes them to be removed at
14208 the time the message is received, to avoid any problems that might occur when a
14209 delivered message is subsequently sent on to some other recipient.
14210
14211
14212 .option errors_copy main "string list&!!" unset
14213 .cindex "bounce message" "copy to other address"
14214 .cindex "copy of bounce message"
14215 Setting this option causes Exim to send bcc copies of bounce messages that it
14216 generates to other addresses. &*Note*&: This does not apply to bounce messages
14217 coming from elsewhere. The value of the option is a colon-separated list of
14218 items. Each item consists of a pattern, terminated by white space, followed by
14219 a comma-separated list of email addresses. If a pattern contains spaces, it
14220 must be enclosed in double quotes.
14221
14222 Each pattern is processed in the same way as a single item in an address list
14223 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14224 the bounce message, the message is copied to the addresses on the list. The
14225 items are scanned in order, and once a matching one is found, no further items
14226 are examined. For example:
14227 .code
14228 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14229               rqps@mydomain   hostmaster@mydomain.example,\
14230                               postmaster@mydomain.example
14231 .endd
14232 .vindex "&$domain$&"
14233 .vindex "&$local_part$&"
14234 The address list is expanded before use. The expansion variables &$local_part$&
14235 and &$domain$& are set from the original recipient of the error message, and if
14236 there was any wildcard matching in the pattern, the expansion
14237 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14238 variables &$0$&, &$1$&, etc. are set in the normal way.
14239
14240
14241 .option errors_reply_to main string unset
14242 .cindex "bounce message" "&'Reply-to:'& in"
14243 By default, Exim's bounce and delivery warning messages contain the header line
14244 .display
14245 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14246 .endd
14247 .oindex &%quota_warn_message%&
14248 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14249 A warning message that is generated by the &%quota_warn_message%& option in an
14250 &(appendfile)& transport may contain its own &'From:'& header line that
14251 overrides the default.
14252
14253 Experience shows that people reply to bounce messages. If the
14254 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14255 and warning messages. For example:
14256 .code
14257 errors_reply_to = postmaster@my.domain.example
14258 .endd
14259 The value of the option is not expanded. It must specify a valid RFC 2822
14260 address. However, if a warning message that is generated by the
14261 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14262 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14263 not used.
14264
14265
14266 .option exim_group main string "compile-time configured"
14267 .cindex "gid (group id)" "Exim's own"
14268 .cindex "Exim group"
14269 This option changes the gid under which Exim runs when it gives up root
14270 privilege. The default value is compiled into the binary. The value of this
14271 option is used only when &%exim_user%& is also set. Unless it consists entirely
14272 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14273 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14274 security issues.
14275
14276
14277 .option exim_path main string "see below"
14278 .cindex "Exim binary, path name"
14279 This option specifies the path name of the Exim binary, which is used when Exim
14280 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14281 the directory configured at compile time by the BIN_DIRECTORY setting. It
14282 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14283 other place.
14284 &*Warning*&: Do not use a macro to define the value of this option, because
14285 you will break those Exim utilities that scan the configuration file to find
14286 where the binary is. (They then use the &%-bP%& option to extract option
14287 settings such as the value of &%spool_directory%&.)
14288
14289
14290 .option exim_user main string "compile-time configured"
14291 .cindex "uid (user id)" "Exim's own"
14292 .cindex "Exim user"
14293 This option changes the uid under which Exim runs when it gives up root
14294 privilege. The default value is compiled into the binary. Ownership of the run
14295 time configuration file and the use of the &%-C%& and &%-D%& command line
14296 options is checked against the values in the binary, not what is set here.
14297
14298 Unless it consists entirely of digits, the string is looked up using
14299 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14300 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14301 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14302
14303
14304 .option extra_local_interfaces main "string list" unset
14305 This option defines network interfaces that are to be considered local when
14306 routing, but which are not used for listening by the daemon. See section
14307 &<<SECTreclocipadd>>& for details.
14308
14309
14310 . Allow this long option name to split; give it unsplit as a fifth argument
14311 . for the automatic .oindex that is generated by .option.
14312
14313 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14314          extract_addresses_remove_arguments
14315 .oindex "&%-t%&"
14316 .cindex "command line" "addresses with &%-t%&"
14317 .cindex "Sendmail compatibility" "&%-t%& option"
14318 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14319 are present on the command line when the &%-t%& option is used to build an
14320 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14321 line addresses are removed from the recipients list. This is also how Smail
14322 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14323 command line addresses are added to those obtained from the header lines. When
14324 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14325 argument headers. If it is set false, Exim adds rather than removes argument
14326 addresses.
14327
14328
14329 .option finduser_retries main integer 0
14330 .cindex "NIS, retrying user lookups"
14331 On systems running NIS or other schemes in which user and group information is
14332 distributed from a remote system, there can be times when &[getpwnam()]& and
14333 related functions fail, even when given valid data, because things time out.
14334 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14335 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14336 many extra times to find a user or a group, waiting for one second between
14337 retries.
14338
14339 .cindex "&_/etc/passwd_&" "multiple reading of"
14340 You should not set this option greater than zero if your user information is in
14341 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14342 search the file multiple times for non-existent users, and also cause delay.
14343
14344
14345
14346 .option freeze_tell main "string list, comma separated" unset
14347 .cindex "freezing messages" "sending a message when freezing"
14348 On encountering certain errors, or when configured to do so in a system filter,
14349 ACL, or special router, Exim freezes a message. This means that no further
14350 delivery attempts take place until an administrator thaws the message, or the
14351 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14352 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14353 warning message whenever it freezes something, unless the message it is
14354 freezing is a locally-generated bounce message. (Without this exception there
14355 is the possibility of looping.) The warning message is sent to the addresses
14356 supplied as the comma-separated value of this option. If several of the
14357 message's addresses cause freezing, only a single message is sent. If the
14358 freezing was automatic, the reason(s) for freezing can be found in the message
14359 log. If you configure freezing in a filter or ACL, you must arrange for any
14360 logging that you require.
14361
14362
14363 .option gecos_name main string&!! unset
14364 .cindex "HP-UX"
14365 .cindex "&""gecos""& field, parsing"
14366 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14367 password file to hold other information in addition to users' real names. Exim
14368 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14369 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14370 of the field are used unchanged, except that, if an ampersand is encountered,
14371 it is replaced by the user's login name with the first character forced to
14372 upper case, since this is a convention that is observed on many systems.
14373
14374 When these options are set, &%gecos_pattern%& is treated as a regular
14375 expression that is to be applied to the field (again with && replaced by the
14376 login name), and if it matches, &%gecos_name%& is expanded and used as the
14377 user's name.
14378
14379 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14380 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14381 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14382 name terminates at the first comma, the following can be used:
14383 .code
14384 gecos_pattern = ([^,]*)
14385 gecos_name = $1
14386 .endd
14387
14388 .option gecos_pattern main string unset
14389 See &%gecos_name%& above.
14390
14391
14392 .option gnutls_compat_mode main boolean unset
14393 This option controls whether GnuTLS is used in compatibility mode in an Exim
14394 server. This reduces security slightly, but improves interworking with older
14395 implementations of TLS.
14396
14397
14398 option gnutls_allow_auto_pkcs11 main boolean unset
14399 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14400 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14401
14402 See
14403 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14404 for documentation.
14405
14406
14407
14408 .option headers_charset main string "see below"
14409 This option sets a default character set for translating from encoded MIME
14410 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14411 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14412 ultimate default is ISO-8859-1. For more details see the description of header
14413 insertions in section &<<SECTexpansionitems>>&.
14414
14415
14416
14417 .option header_maxsize main integer "see below"
14418 .cindex "header section" "maximum size of"
14419 .cindex "limit" "size of message header section"
14420 This option controls the overall maximum size of a message's header
14421 section. The default is the value of HEADER_MAXSIZE in
14422 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14423 sections are rejected.
14424
14425
14426 .option header_line_maxsize main integer 0
14427 .cindex "header lines" "maximum size of"
14428 .cindex "limit" "size of one header line"
14429 This option limits the length of any individual header line in a message, after
14430 all the continuations have been joined together. Messages with individual
14431 header lines that are longer than the limit are rejected. The default value of
14432 zero means &"no limit"&.
14433
14434
14435
14436
14437 .option helo_accept_junk_hosts main "host list&!!" unset
14438 .cindex "HELO" "accepting junk data"
14439 .cindex "EHLO" "accepting junk data"
14440 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14441 mail, and gives an error response for invalid data. Unfortunately, there are
14442 some SMTP clients that send syntactic junk. They can be accommodated by setting
14443 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14444 if you want to do semantic checking.
14445 See also &%helo_allow_chars%& for a way of extending the permitted character
14446 set.
14447
14448
14449 .option helo_allow_chars main string unset
14450 .cindex "HELO" "underscores in"
14451 .cindex "EHLO" "underscores in"
14452 .cindex "underscore in EHLO/HELO"
14453 This option can be set to a string of rogue characters that are permitted in
14454 all EHLO and HELO names in addition to the standard letters, digits,
14455 hyphens, and dots. If you really must allow underscores, you can set
14456 .code
14457 helo_allow_chars = _
14458 .endd
14459 Note that the value is one string, not a list.
14460
14461
14462 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14463 .cindex "HELO" "forcing reverse lookup"
14464 .cindex "EHLO" "forcing reverse lookup"
14465 If the domain given by a client in a HELO or EHLO command matches this
14466 list, a reverse lookup is done in order to establish the host's true name. The
14467 default forces a lookup if the client host gives the server's name or any of
14468 its IP addresses (in brackets), something that broken clients have been seen to
14469 do.
14470
14471
14472 .option helo_try_verify_hosts main "host list&!!" unset
14473 .cindex "HELO verifying" "optional"
14474 .cindex "EHLO" "verifying, optional"
14475 By default, Exim just checks the syntax of HELO and EHLO commands (see
14476 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14477 to do more extensive checking of the data supplied by these commands. The ACL
14478 condition &`verify = helo`& is provided to make this possible.
14479 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14480 to force the check to occur. From release 4.53 onwards, this is no longer
14481 necessary. If the check has not been done before &`verify = helo`& is
14482 encountered, it is done at that time. Consequently, this option is obsolete.
14483 Its specification is retained here for backwards compatibility.
14484
14485 When an EHLO or HELO command is received, if the calling host matches
14486 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14487 EHLO command either:
14488
14489 .ilist
14490 is an IP literal matching the calling address of the host, or
14491 .next
14492 .cindex "DNS" "reverse lookup"
14493 .cindex "reverse DNS lookup"
14494 matches the host name that Exim obtains by doing a reverse lookup of the
14495 calling host address, or
14496 .next
14497 when looked up using &[gethostbyname()]& (or &[getipnodebyname()]& when
14498 available) yields the calling host address.
14499 .endlist
14500
14501 However, the EHLO or HELO command is not rejected if any of the checks
14502 fail. Processing continues, but the result of the check is remembered, and can
14503 be detected later in an ACL by the &`verify = helo`& condition.
14504
14505 .option helo_verify_hosts main "host list&!!" unset
14506 .cindex "HELO verifying" "mandatory"
14507 .cindex "EHLO" "verifying, mandatory"
14508 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14509 backwards compatibility. For hosts that match this option, Exim checks the host
14510 name given in the HELO or EHLO in the same way as for
14511 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14512 rejected with a 550 error, and entries are written to the main and reject logs.
14513 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14514 error.
14515
14516 .option hold_domains main "domain list&!!" unset
14517 .cindex "domain" "delaying delivery"
14518 .cindex "delivery" "delaying certain domains"
14519 This option allows mail for particular domains to be held on the queue
14520 manually. The option is overridden if a message delivery is forced with the
14521 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14522 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14523 item in &%hold_domains%&, no routing or delivery for that address is done, and
14524 it is deferred every time the message is looked at.
14525
14526 This option is intended as a temporary operational measure for delaying the
14527 delivery of mail while some problem is being sorted out, or some new
14528 configuration tested. If you just want to delay the processing of some
14529 domains until a queue run occurs, you should use &%queue_domains%& or
14530 &%queue_smtp_domains%&, not &%hold_domains%&.
14531
14532 A setting of &%hold_domains%& does not override Exim's code for removing
14533 messages from the queue if they have been there longer than the longest retry
14534 time in any retry rule. If you want to hold messages for longer than the normal
14535 retry times, insert a dummy retry rule with a long retry time.
14536
14537
14538 .option host_lookup main "host list&!!" unset
14539 .cindex "host name" "lookup, forcing"
14540 Exim does not look up the name of a calling host from its IP address unless it
14541 is required to compare against some host list, or the host matches
14542 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14543 option (which normally contains IP addresses rather than host names). The
14544 default configuration file contains
14545 .code
14546 host_lookup = *
14547 .endd
14548 which causes a lookup to happen for all hosts. If the expense of these lookups
14549 is felt to be too great, the setting can be changed or removed.
14550
14551 After a successful reverse lookup, Exim does a forward lookup on the name it
14552 has obtained, to verify that it yields the IP address that it started with. If
14553 this check fails, Exim behaves as if the name lookup failed.
14554
14555 .vindex "&$host_lookup_failed$&"
14556 .vindex "&$sender_host_name$&"
14557 After any kind of failure, the host name (in &$sender_host_name$&) remains
14558 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14559 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14560 &`verify = reverse_host_lookup`& in ACLs.
14561
14562
14563 .option host_lookup_order main "string list" &`bydns:byaddr`&
14564 This option specifies the order of different lookup methods when Exim is trying
14565 to find a host name from an IP address. The default is to do a DNS lookup
14566 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14567 if that fails. You can change the order of these lookups, or omit one entirely,
14568 if you want.
14569
14570 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14571 multiple PTR records in the DNS and the IP address is not listed in
14572 &_/etc/hosts_&. Different operating systems give different results in this
14573 case. That is why the default tries a DNS lookup first.
14574
14575
14576
14577 .option host_reject_connection main "host list&!!" unset
14578 .cindex "host" "rejecting connections from"
14579 If this option is set, incoming SMTP calls from the hosts listed are rejected
14580 as soon as the connection is made.
14581 This option is obsolete, and retained only for backward compatibility, because
14582 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14583 connections immediately.
14584
14585 The ability to give an immediate rejection (either by this option or using an
14586 ACL) is provided for use in unusual cases. Many hosts will just try again,
14587 sometimes without much delay. Normally, it is better to use an ACL to reject
14588 incoming messages at a later stage, such as after RCPT commands. See
14589 chapter &<<CHAPACL>>&.
14590
14591
14592 .option hosts_connection_nolog main "host list&!!" unset
14593 .cindex "host" "not logging connections from"
14594 This option defines a list of hosts for which connection logging does not
14595 happen, even though the &%smtp_connection%& log selector is set. For example,
14596 you might want not to log SMTP connections from local processes, or from
14597 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14598 the daemon; you should therefore strive to restrict its value to a short inline
14599 list of IP addresses and networks. To disable logging SMTP connections from
14600 local processes, you must create a host list with an empty item. For example:
14601 .code
14602 hosts_connection_nolog = :
14603 .endd
14604 If the &%smtp_connection%& log selector is not set, this option has no effect.
14605
14606
14607
14608 .option hosts_treat_as_local main "domain list&!!" unset
14609 .cindex "local host" "domains treated as"
14610 .cindex "host" "treated as local"
14611 If this option is set, any host names that match the domain list are treated as
14612 if they were the local host when Exim is scanning host lists obtained from MX
14613 records
14614 or other sources. Note that the value of this option is a domain list, not a
14615 host list, because it is always used to check host names, not IP addresses.
14616
14617 This option also applies when Exim is matching the special items
14618 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14619 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14620 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14621 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14622 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14623 interfaces and recognizing the local host.
14624
14625
14626 .option ibase_servers main "string list" unset
14627 .cindex "InterBase" "server list"
14628 This option provides a list of InterBase servers and associated connection data,
14629 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14630 The option is available only if Exim has been built with InterBase support.
14631
14632
14633
14634 .option ignore_bounce_errors_after main time 10w
14635 .cindex "bounce message" "discarding"
14636 .cindex "discarding bounce message"
14637 This option affects the processing of bounce messages that cannot be delivered,
14638 that is, those that suffer a permanent delivery failure. (Bounce messages that
14639 suffer temporary delivery failures are of course retried in the usual way.)
14640
14641 After a permanent delivery failure, bounce messages are frozen,
14642 because there is no sender to whom they can be returned. When a frozen bounce
14643 message has been on the queue for more than the given time, it is unfrozen at
14644 the next queue run, and a further delivery is attempted. If delivery fails
14645 again, the bounce message is discarded. This makes it possible to keep failed
14646 bounce messages around for a shorter time than the normal maximum retry time
14647 for frozen messages. For example,
14648 .code
14649 ignore_bounce_errors_after = 12h
14650 .endd
14651 retries failed bounce message deliveries after 12 hours, discarding any further
14652 failures. If the value of this option is set to a zero time period, bounce
14653 failures are discarded immediately. Setting a very long time (as in the default
14654 value) has the effect of disabling this option. For ways of automatically
14655 dealing with other kinds of frozen message, see &%auto_thaw%& and
14656 &%timeout_frozen_after%&.
14657
14658
14659 .option ignore_fromline_hosts main "host list&!!" unset
14660 .cindex "&""From""& line"
14661 .cindex "UUCP" "&""From""& line"
14662 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14663 the headers of a message. By default this is treated as the start of the
14664 message's body, which means that any following headers are not recognized as
14665 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14666 match those hosts that insist on sending it. If the sender is actually a local
14667 process rather than a remote host, and is using &%-bs%& to inject the messages,
14668 &%ignore_fromline_local%& must be set to achieve this effect.
14669
14670
14671 .option ignore_fromline_local main boolean false
14672 See &%ignore_fromline_hosts%& above.
14673
14674
14675 .option keep_malformed main time 4d
14676 This option specifies the length of time to keep messages whose spool files
14677 have been corrupted in some way. This should, of course, never happen. At the
14678 next attempt to deliver such a message, it gets removed. The incident is
14679 logged.
14680
14681
14682 .option ldap_ca_cert_dir main string unset
14683 .cindex "LDAP", "TLS CA certificate directory"
14684 This option indicates which directory contains CA certificates for verifying
14685 a TLS certificate presented by an LDAP server.
14686 While Exim does not provide a default value, your SSL library may.
14687 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14688 and constrained to be a directory.
14689
14690
14691 .option ldap_ca_cert_file main string unset
14692 .cindex "LDAP", "TLS CA certificate file"
14693 This option indicates which file contains CA certificates for verifying
14694 a TLS certificate presented by an LDAP server.
14695 While Exim does not provide a default value, your SSL library may.
14696 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14697 and constrained to be a file.
14698
14699
14700 .option ldap_cert_file main string unset
14701 .cindex "LDAP" "TLS client certificate file"
14702 This option indicates which file contains an TLS client certificate which
14703 Exim should present to the LDAP server during TLS negotiation.
14704 Should be used together with &%ldap_cert_key%&.
14705
14706
14707 .option ldap_cert_key main string unset
14708 .cindex "LDAP" "TLS client key file"
14709 This option indicates which file contains the secret/private key to use
14710 to prove identity to the LDAP server during TLS negotiation.
14711 Should be used together with &%ldap_cert_file%&, which contains the
14712 identity to be proven.
14713
14714
14715 .option ldap_cipher_suite main string unset
14716 .cindex "LDAP" "TLS cipher suite"
14717 This controls the TLS cipher-suite negotiation during TLS negotiation with
14718 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14719 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14720
14721
14722 .option ldap_default_servers main "string list" unset
14723 .cindex "LDAP" "default servers"
14724 This option provides a list of LDAP servers which are tried in turn when an
14725 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14726 details of LDAP queries. This option is available only when Exim has been built
14727 with LDAP support.
14728
14729
14730 .option ldap_require_cert main string unset.
14731 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14732 This should be one of the values "hard", "demand", "allow", "try" or "never".
14733 A value other than one of these is interpreted as "never".
14734 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14735 Although Exim does not set a default, the LDAP library probably defaults
14736 to hard/demand.
14737
14738
14739 .option ldap_start_tls main boolean false
14740 .cindex "LDAP" "whether or not to negotiate TLS"
14741 If set, Exim will attempt to negotiate TLS with the LDAP server when
14742 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14743 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14744 of SSL-on-connect.
14745 In the event of failure to negotiate TLS, the action taken is controlled
14746 by &%ldap_require_cert%&.
14747
14748
14749 .option ldap_version main integer unset
14750 .cindex "LDAP" "protocol version, forcing"
14751 This option can be used to force Exim to set a specific protocol version for
14752 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14753 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14754 the LDAP headers; otherwise it is 2. This option is available only when Exim
14755 has been built with LDAP support.
14756
14757
14758
14759 .option local_from_check main boolean true
14760 .cindex "&'Sender:'& header line" "disabling addition of"
14761 .cindex "&'From:'& header line" "disabling checking of"
14762 When a message is submitted locally (that is, not over a TCP/IP connection) by
14763 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14764 checks that the &'From:'& header line matches the login of the calling user and
14765 the domain specified by &%qualify_domain%&.
14766
14767 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14768 locally submitted message is automatically qualified by Exim, unless the
14769 &%-bnq%& command line option is used.
14770
14771 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14772 on the local part. If the &'From:'& header line does not match, Exim adds a
14773 &'Sender:'& header with an address constructed from the calling user's login
14774 and the default qualify domain.
14775
14776 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14777 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14778 &'Sender:'& header lines supplied by untrusted users, you must also set
14779 &%local_sender_retain%& to be true.
14780
14781 .cindex "envelope sender"
14782 These options affect only the header lines in the message. The envelope sender
14783 is still forced to be the login id at the qualify domain unless
14784 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14785
14786 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14787 request similar header line checking. See section &<<SECTthesenhea>>&, which
14788 has more details about &'Sender:'& processing.
14789
14790
14791
14792
14793 .option local_from_prefix main string unset
14794 When Exim checks the &'From:'& header line of locally submitted messages for
14795 matching the login id (see &%local_from_check%& above), it can be configured to
14796 ignore certain prefixes and suffixes in the local part of the address. This is
14797 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14798 appropriate lists, in the same form as the &%local_part_prefix%& and
14799 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14800 example, if
14801 .code
14802 local_from_prefix = *-
14803 .endd
14804 is set, a &'From:'& line containing
14805 .code
14806 From: anything-user@your.domain.example
14807 .endd
14808 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14809 matches the actual sender address that is constructed from the login name and
14810 qualify domain.
14811
14812
14813 .option local_from_suffix main string unset
14814 See &%local_from_prefix%& above.
14815
14816
14817 .option local_interfaces main "string list" "see below"
14818 This option controls which network interfaces are used by the daemon for
14819 listening; they are also used to identify the local host when routing. Chapter
14820 &<<CHAPinterfaces>>& contains a full description of this option and the related
14821 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14822 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14823 &%local_interfaces%& is
14824 .code
14825 local_interfaces = 0.0.0.0
14826 .endd
14827 when Exim is built without IPv6 support; otherwise it is
14828 .code
14829 local_interfaces = <; ::0 ; 0.0.0.0
14830 .endd
14831
14832 .option local_scan_timeout main time 5m
14833 .cindex "timeout" "for &[local_scan()]& function"
14834 .cindex "&[local_scan()]& function" "timeout"
14835 This timeout applies to the &[local_scan()]& function (see chapter
14836 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14837 the incoming message is rejected with a temporary error if it is an SMTP
14838 message. For a non-SMTP message, the message is dropped and Exim ends with a
14839 non-zero code. The incident is logged on the main and reject logs.
14840
14841
14842
14843 .option local_sender_retain main boolean false
14844 .cindex "&'Sender:'& header line" "retaining from local submission"
14845 When a message is submitted locally (that is, not over a TCP/IP connection) by
14846 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14847 do not want this to happen, you must set &%local_sender_retain%&, and you must
14848 also set &%local_from_check%& to be false (Exim will complain if you do not).
14849 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14850 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14851
14852
14853
14854
14855 .option localhost_number main string&!! unset
14856 .cindex "host" "locally unique number for"
14857 .cindex "message ids" "with multiple hosts"
14858 .vindex "&$localhost_number$&"
14859 Exim's message ids are normally unique only within the local host. If
14860 uniqueness among a set of hosts is required, each host must set a different
14861 value for the &%localhost_number%& option. The string is expanded immediately
14862 after reading the configuration file (so that a number can be computed from the
14863 host name, for example) and the result of the expansion must be a number in the
14864 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14865 systems). This is available in subsequent string expansions via the variable
14866 &$localhost_number$&. When &%localhost_number is set%&, the final two
14867 characters of the message id, instead of just being a fractional part of the
14868 time, are computed from the time and the local host number as described in
14869 section &<<SECTmessiden>>&.
14870
14871
14872
14873 .option log_file_path main "string list&!!" "set at compile time"
14874 .cindex "log" "file path for"
14875 This option sets the path which is used to determine the names of Exim's log
14876 files, or indicates that logging is to be to syslog, or both. It is expanded
14877 when Exim is entered, so it can, for example, contain a reference to the host
14878 name. If no specific path is set for the log files at compile or run time, they
14879 are written in a sub-directory called &_log_& in Exim's spool directory.
14880 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
14881 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
14882 used. If this string is fixed at your installation (contains no expansion
14883 variables) it is recommended that you do not set this option in the
14884 configuration file, but instead supply the path using LOG_FILE_PATH in
14885 &_Local/Makefile_& so that it is available to Exim for logging errors detected
14886 early on &-- in particular, failure to read the configuration file.
14887
14888
14889 .option log_selector main string unset
14890 .cindex "log" "selectors"
14891 This option can be used to reduce or increase the number of things that Exim
14892 writes to its log files. Its argument is made up of names preceded by plus or
14893 minus characters. For example:
14894 .code
14895 log_selector = +arguments -retry_defer
14896 .endd
14897 A list of possible names and what they control is given in the chapter on
14898 logging, in section &<<SECTlogselector>>&.
14899
14900
14901 .option log_timezone main boolean false
14902 .cindex "log" "timezone for entries"
14903 .vindex "&$tod_log$&"
14904 .vindex "&$tod_zone$&"
14905 By default, the timestamps on log lines are in local time without the
14906 timezone. This means that if your timezone changes twice a year, the timestamps
14907 in log lines are ambiguous for an hour when the clocks go back. One way of
14908 avoiding this problem is to set the timezone to UTC. An alternative is to set
14909 &%log_timezone%& true. This turns on the addition of the timezone offset to
14910 timestamps in log lines. Turning on this option can add quite a lot to the size
14911 of log files because each line is extended by 6 characters. Note that the
14912 &$tod_log$& variable contains the log timestamp without the zone, but there is
14913 another variable called &$tod_zone$& that contains just the timezone offset.
14914
14915
14916 .option lookup_open_max main integer 25
14917 .cindex "too many open files"
14918 .cindex "open files, too many"
14919 .cindex "file" "too many open"
14920 .cindex "lookup" "maximum open files"
14921 .cindex "limit" "open files for lookups"
14922 This option limits the number of simultaneously open files for single-key
14923 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
14924 Exim normally keeps these files open during routing, because often the same
14925 file is required several times. If the limit is reached, Exim closes the least
14926 recently used file. Note that if you are using the &'ndbm'& library, it
14927 actually opens two files for each logical DBM database, though it still counts
14928 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
14929 open files"& errors with NDBM, you need to reduce the value of
14930 &%lookup_open_max%&.
14931
14932
14933 .option max_username_length main integer 0
14934 .cindex "length of login name"
14935 .cindex "user name" "maximum length"
14936 .cindex "limit" "user name length"
14937 Some operating systems are broken in that they truncate long arguments to
14938 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
14939 this option is set greater than zero, any attempt to call &[getpwnam()]& with
14940 an argument that is longer behaves as if &[getpwnam()]& failed.
14941
14942
14943 .option message_body_newlines main bool false
14944 .cindex "message body" "newlines in variables"
14945 .cindex "newline" "in message body variables"
14946 .vindex "&$message_body$&"
14947 .vindex "&$message_body_end$&"
14948 By default, newlines in the message body are replaced by spaces when setting
14949 the &$message_body$& and &$message_body_end$& expansion variables. If this
14950 option is set true, this no longer happens.
14951
14952
14953 .option message_body_visible main integer 500
14954 .cindex "body of message" "visible size"
14955 .cindex "message body" "visible size"
14956 .vindex "&$message_body$&"
14957 .vindex "&$message_body_end$&"
14958 This option specifies how much of a message's body is to be included in the
14959 &$message_body$& and &$message_body_end$& expansion variables.
14960
14961
14962 .option message_id_header_domain main string&!! unset
14963 .cindex "&'Message-ID:'& header line"
14964 If this option is set, the string is expanded and used as the right hand side
14965 (domain) of the &'Message-ID:'& header that Exim creates if a
14966 locally-originated incoming message does not have one. &"Locally-originated"&
14967 means &"not received over TCP/IP."&
14968 Otherwise, the primary host name is used.
14969 Only letters, digits, dot and hyphen are accepted; any other characters are
14970 replaced by hyphens. If the expansion is forced to fail, or if the result is an
14971 empty string, the option is ignored.
14972
14973
14974 .option message_id_header_text main string&!! unset
14975 If this variable is set, the string is expanded and used to augment the text of
14976 the &'Message-id:'& header that Exim creates if a locally-originated incoming
14977 message does not have one. The text of this header is required by RFC 2822 to
14978 take the form of an address. By default, Exim uses its internal message id as
14979 the local part, and the primary host name as the domain. If this option is set,
14980 it is expanded, and provided the expansion is not forced to fail, and does not
14981 yield an empty string, the result is inserted into the header immediately
14982 before the @, separated from the internal message id by a dot. Any characters
14983 that are illegal in an address are automatically converted into hyphens. This
14984 means that variables such as &$tod_log$& can be used, because the spaces and
14985 colons will become hyphens.
14986
14987
14988 .option message_logs main boolean true
14989 .cindex "message logs" "disabling"
14990 .cindex "log" "message log; disabling"
14991 If this option is turned off, per-message log files are not created in the
14992 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
14993 Exim, by reducing the number of files involved in handling a message from a
14994 minimum of four (header spool file, body spool file, delivery journal, and
14995 per-message log) to three. The other major I/O activity is Exim's main log,
14996 which is not affected by this option.
14997
14998
14999 .option message_size_limit main string&!! 50M
15000 .cindex "message" "size limit"
15001 .cindex "limit" "message size"
15002 .cindex "size" "of message, limit"
15003 This option limits the maximum size of message that Exim will process. The
15004 value is expanded for each incoming connection so, for example, it can be made
15005 to depend on the IP address of the remote host for messages arriving via
15006 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15007 optionally followed by K or M.
15008
15009 &*Note*&: This limit cannot be made to depend on a message's sender or any
15010 other properties of an individual message, because it has to be advertised in
15011 the server's response to EHLO. String expansion failure causes a temporary
15012 error. A value of zero means no limit, but its use is not recommended. See also
15013 &%bounce_return_size_limit%&.
15014
15015 Incoming SMTP messages are failed with a 552 error if the limit is
15016 exceeded; locally-generated messages either get a stderr message or a delivery
15017 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15018 an oversized message is logged in both the main and the reject logs. See also
15019 the generic transport option &%message_size_limit%&, which limits the size of
15020 message that an individual transport can process.
15021
15022 If you use a virus-scanner and set this option to to a value larger than the
15023 maximum size that your virus-scanner is configured to support, you may get
15024 failures triggered by large mails.  The right size to configure for the
15025 virus-scanner depends upon what data is passed and the options in use but it's
15026 probably safest to just set it to a little larger than this value.  Eg, with a
15027 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15028 some problems may result.
15029
15030 A value of 0 will disable size limit checking; Exim will still advertise the
15031 SIZE extension in an EHLO response, but without a limit, so as to permit
15032 SMTP clients to still indicate the message size along with the MAIL verb.
15033
15034
15035 .option move_frozen_messages main boolean false
15036 .cindex "frozen messages" "moving"
15037 This option, which is available only if Exim has been built with the setting
15038 .code
15039 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15040 .endd
15041 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15042 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15043 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15044 standard utilities for handling such moved messages, and they do not show up in
15045 lists generated by &%-bp%& or by the Exim monitor.
15046
15047
15048 .option mua_wrapper main boolean false
15049 Setting this option true causes Exim to run in a very restrictive mode in which
15050 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15051 contains a full description of this facility.
15052
15053
15054
15055 .option mysql_servers main "string list" unset
15056 .cindex "MySQL" "server list"
15057 This option provides a list of MySQL servers and associated connection data, to
15058 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15059 option is available only if Exim has been built with MySQL support.
15060
15061
15062 .option never_users main "string list&!!" unset
15063 This option is expanded just once, at the start of Exim's processing. Local
15064 message deliveries are normally run in processes that are setuid to the
15065 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15066 It is usually desirable to prevent any deliveries from running as root, as a
15067 safety precaution.
15068
15069 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15070 list of users that must not be used for local deliveries. This list is fixed in
15071 the binary and cannot be overridden by the configuration file. By default, it
15072 contains just the single user name &"root"&. The &%never_users%& runtime option
15073 can be used to add more users to the fixed list.
15074
15075 If a message is to be delivered as one of the users on the fixed list or the
15076 &%never_users%& list, an error occurs, and delivery is deferred. A common
15077 example is
15078 .code
15079 never_users = root:daemon:bin
15080 .endd
15081 Including root is redundant if it is also on the fixed list, but it does no
15082 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15083 transport driver.
15084
15085
15086 .option openssl_options main "string list" "+no_sslv2"
15087 .cindex "OpenSSL "compatibility options"
15088 This option allows an administrator to adjust the SSL options applied
15089 by OpenSSL to connections.  It is given as a space-separated list of items,
15090 each one to be +added or -subtracted from the current value.
15091
15092 This option is only available if Exim is built against OpenSSL.  The values
15093 available for this option vary according to the age of your OpenSSL install.
15094 The &"all"& value controls a subset of flags which are available, typically
15095 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15096 list the values known on your system and Exim should support all the
15097 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15098 names lose the leading &"SSL_OP_"& and are lower-cased.
15099
15100 Note that adjusting the options can have severe impact upon the security of
15101 SSL as used by Exim.  It is possible to disable safety checks and shoot
15102 yourself in the foot in various unpleasant ways.  This option should not be
15103 adjusted lightly.  An unrecognised item will be detected at startup, by
15104 invoking Exim with the &%-bV%& flag.
15105
15106 The option affects Exim operating both as a server and as a client.
15107
15108 Historical note: prior to release 4.80, Exim defaulted this value to
15109 "+dont_insert_empty_fragments", which may still be needed for compatibility
15110 with some clients, but which lowers security by increasing exposure to
15111 some now infamous attacks.
15112
15113 Examples:
15114 .code
15115 # Make both old MS and old Eudora happy:
15116 openssl_options = -all +microsoft_big_sslv3_buffer \
15117                        +dont_insert_empty_fragments
15118
15119 # Disable older protocol versions:
15120 openssl_options = +no_sslv2 +no_sslv3
15121 .endd
15122
15123 Possible options may include:
15124 .ilist
15125 &`all`&
15126 .next
15127 &`allow_unsafe_legacy_renegotiation`&
15128 .next
15129 &`cipher_server_preference`&
15130 .next
15131 &`dont_insert_empty_fragments`&
15132 .next
15133 &`ephemeral_rsa`&
15134 .next
15135 &`legacy_server_connect`&
15136 .next
15137 &`microsoft_big_sslv3_buffer`&
15138 .next
15139 &`microsoft_sess_id_bug`&
15140 .next
15141 &`msie_sslv2_rsa_padding`&
15142 .next
15143 &`netscape_challenge_bug`&
15144 .next
15145 &`netscape_reuse_cipher_change_bug`&
15146 .next
15147 &`no_compression`&
15148 .next
15149 &`no_session_resumption_on_renegotiation`&
15150 .next
15151 &`no_sslv2`&
15152 .next
15153 &`no_sslv3`&
15154 .next
15155 &`no_ticket`&
15156 .next
15157 &`no_tlsv1`&
15158 .next
15159 &`no_tlsv1_1`&
15160 .next
15161 &`no_tlsv1_2`&
15162 .next
15163 &`safari_ecdhe_ecdsa_bug`&
15164 .next
15165 &`single_dh_use`&
15166 .next
15167 &`single_ecdh_use`&
15168 .next
15169 &`ssleay_080_client_dh_bug`&
15170 .next
15171 &`sslref2_reuse_cert_type_bug`&
15172 .next
15173 &`tls_block_padding_bug`&
15174 .next
15175 &`tls_d5_bug`&
15176 .next
15177 &`tls_rollback_bug`&
15178 .endlist
15179
15180 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15181 all clients connecting using the MacOS SecureTransport TLS facility prior
15182 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15183 to negotiate TLS then this option value might help, provided that your OpenSSL
15184 release is new enough to contain this work-around.  This may be a situation
15185 where you have to upgrade OpenSSL to get buggy clients working.
15186
15187
15188 .option oracle_servers main "string list" unset
15189 .cindex "Oracle" "server list"
15190 This option provides a list of Oracle servers and associated connection data,
15191 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15192 The option is available only if Exim has been built with Oracle support.
15193
15194
15195 .option percent_hack_domains main "domain list&!!" unset
15196 .cindex "&""percent hack""&"
15197 .cindex "source routing" "in email address"
15198 .cindex "address" "source-routed"
15199 The &"percent hack"& is the convention whereby a local part containing a
15200 percent sign is re-interpreted as a new email address, with the percent
15201 replaced by @. This is sometimes called &"source routing"&, though that term is
15202 also applied to RFC 2822 addresses that begin with an @ character. If this
15203 option is set, Exim implements the percent facility for those domains listed,
15204 but no others. This happens before an incoming SMTP address is tested against
15205 an ACL.
15206
15207 &*Warning*&: The &"percent hack"& has often been abused by people who are
15208 trying to get round relaying restrictions. For this reason, it is best avoided
15209 if at all possible. Unfortunately, a number of less security-conscious MTAs
15210 implement it unconditionally. If you are running Exim on a gateway host, and
15211 routing mail through to internal MTAs without processing the local parts, it is
15212 a good idea to reject recipient addresses with percent characters in their
15213 local parts. Exim's default configuration does this.
15214
15215
15216 .option perl_at_start main boolean false
15217 This option is available only when Exim is built with an embedded Perl
15218 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15219
15220
15221 .option perl_startup main string unset
15222 This option is available only when Exim is built with an embedded Perl
15223 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15224
15225
15226 .option pgsql_servers main "string list" unset
15227 .cindex "PostgreSQL lookup type" "server list"
15228 This option provides a list of PostgreSQL servers and associated connection
15229 data, to be used in conjunction with &(pgsql)& lookups (see section
15230 &<<SECID72>>&). The option is available only if Exim has been built with
15231 PostgreSQL support.
15232
15233
15234 .option pid_file_path main string&!! "set at compile time"
15235 .cindex "daemon" "pid file path"
15236 .cindex "pid file, path for"
15237 This option sets the name of the file to which the Exim daemon writes its
15238 process id. The string is expanded, so it can contain, for example, references
15239 to the host name:
15240 .code
15241 pid_file_path = /var/log/$primary_hostname/exim.pid
15242 .endd
15243 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15244 spool directory.
15245 The value set by the option can be overridden by the &%-oP%& command line
15246 option. A pid file is not written if a &"non-standard"& daemon is run by means
15247 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15248
15249
15250 .option pipelining_advertise_hosts main "host list&!!" *
15251 .cindex "PIPELINING" "suppressing advertising"
15252 This option can be used to suppress the advertisement of the SMTP
15253 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15254 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15255 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15256 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15257 that clients will use it; &"out of order"& commands that are &"expected"& do
15258 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15259
15260
15261 .option prdr_enable main boolean false
15262 .cindex "PRDR" "enabling on server"
15263 This option can be used to enable the Per-Recipient Data Response extension
15264 to SMTP, defined by Eric Hall.
15265 If the option is set, PRDR is advertised by Exim when operating as a server.
15266 If the client requests PRDR, and more than one recipient, for a message 
15267 an additional ACL is called for each recipient after the message content
15268 is recieved.  See section &<<SECTPRDRACL>>&.
15269
15270 .option preserve_message_logs main boolean false
15271 .cindex "message logs" "preserving"
15272 If this option is set, message log files are not deleted when messages are
15273 completed. Instead, they are moved to a sub-directory of the spool directory
15274 called &_msglog.OLD_&, where they remain available for statistical or debugging
15275 purposes. This is a dangerous option to set on systems with any appreciable
15276 volume of mail. Use with care!
15277
15278
15279 .option primary_hostname main string "see below"
15280 .cindex "name" "of local host"
15281 .cindex "host" "name of local"
15282 .cindex "local host" "name of"
15283 .vindex "&$primary_hostname$&"
15284 This specifies the name of the current host. It is used in the default EHLO or
15285 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15286 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15287 The value is also used by default in some SMTP response messages from an Exim
15288 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15289
15290 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15291 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15292 contains only one component, Exim passes it to &[gethostbyname()]& (or
15293 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15294 version. The variable &$primary_hostname$& contains the host name, whether set
15295 explicitly by this option, or defaulted.
15296
15297
15298 .option print_topbitchars main boolean false
15299 .cindex "printing characters"
15300 .cindex "8-bit characters"
15301 By default, Exim considers only those characters whose codes lie in the range
15302 32&--126 to be printing characters. In a number of circumstances (for example,
15303 when writing log entries) non-printing characters are converted into escape
15304 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15305 is set, code values of 128 and above are also considered to be printing
15306 characters.
15307
15308 This option also affects the header syntax checks performed by the
15309 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15310 the user's full name when constructing From: and Sender: addresses (as
15311 described in section &<<SECTconstr>>&). Setting this option can cause
15312 Exim to generate eight bit message headers that do not conform to the
15313 standards.
15314
15315
15316 .option process_log_path main string unset
15317 .cindex "process log path"
15318 .cindex "log" "process log"
15319 .cindex "&'exiwhat'&"
15320 This option sets the name of the file to which an Exim process writes its
15321 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15322 utility script. If this option is unset, the file called &_exim-process.info_&
15323 in Exim's spool directory is used. The ability to specify the name explicitly
15324 can be useful in environments where two different Exims are running, using
15325 different spool directories.
15326
15327
15328 .option prod_requires_admin main boolean true
15329 .oindex "&%-M%&"
15330 .oindex "&%-R%&"
15331 .oindex "&%-q%&"
15332 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15333 admin user unless &%prod_requires_admin%& is set false. See also
15334 &%queue_list_requires_admin%&.
15335
15336
15337 .option qualify_domain main string "see below"
15338 .cindex "domain" "for qualifying addresses"
15339 .cindex "address" "qualification"
15340 This option specifies the domain name that is added to any envelope sender
15341 addresses that do not have a domain qualification. It also applies to
15342 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15343 are accepted by default only for locally-generated messages. Qualification is
15344 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15345 locally-generated messages, unless the &%-bnq%& command line option is used.
15346
15347 Messages from external sources must always contain fully qualified addresses,
15348 unless the sending host matches &%sender_unqualified_hosts%& or
15349 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15350 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15351 necessary. Internally, Exim always works with fully qualified envelope
15352 addresses. If &%qualify_domain%& is not set, it defaults to the
15353 &%primary_hostname%& value.
15354
15355
15356 .option qualify_recipient main string "see below"
15357 This option allows you to specify a different domain for qualifying recipient
15358 addresses to the one that is used for senders. See &%qualify_domain%& above.
15359
15360
15361
15362 .option queue_domains main "domain list&!!" unset
15363 .cindex "domain" "specifying non-immediate delivery"
15364 .cindex "queueing incoming messages"
15365 .cindex "message" "queueing certain domains"
15366 This option lists domains for which immediate delivery is not required.
15367 A delivery process is started whenever a message is received, but only those
15368 domains that do not match are processed. All other deliveries wait until the
15369 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15370
15371
15372 .option queue_list_requires_admin main boolean true
15373 .oindex "&%-bp%&"
15374 The &%-bp%& command-line option, which lists the messages that are on the
15375 queue, requires the caller to be an admin user unless
15376 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15377
15378
15379 .option queue_only main boolean false
15380 .cindex "queueing incoming messages"
15381 .cindex "message" "queueing unconditionally"
15382 If &%queue_only%& is set, a delivery process is not automatically started
15383 whenever a message is received. Instead, the message waits on the queue for the
15384 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15385 delivered immediately when certain conditions (such as heavy load) occur.
15386
15387 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15388 and &%-odi%& command line options override &%queue_only%& unless
15389 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15390 &%queue_only_load%&, and &%smtp_accept_queue%&.
15391
15392
15393 .option queue_only_file main string unset
15394 .cindex "queueing incoming messages"
15395 .cindex "message" "queueing by file existence"
15396 This option can be set to a colon-separated list of absolute path names, each
15397 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15398 it tests for the existence of each listed path using a call to &[stat()]&. For
15399 each path that exists, the corresponding queueing option is set.
15400 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15401 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15402 .code
15403 queue_only_file = smtp/some/file
15404 .endd
15405 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15406 &_/some/file_& exists.
15407
15408
15409 .option queue_only_load main fixed-point unset
15410 .cindex "load average"
15411 .cindex "queueing incoming messages"
15412 .cindex "message" "queueing by load"
15413 If the system load average is higher than this value, incoming messages from
15414 all sources are queued, and no automatic deliveries are started. If this
15415 happens during local or remote SMTP input, all subsequent messages received on
15416 the same SMTP connection are queued by default, whatever happens to the load in
15417 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15418 false.
15419
15420 Deliveries will subsequently be performed by queue runner processes. This
15421 option has no effect on ancient operating systems on which Exim cannot
15422 determine the load average. See also &%deliver_queue_load_max%& and
15423 &%smtp_load_reserve%&.
15424
15425
15426 .option queue_only_load_latch main boolean true
15427 .cindex "load average" "re-evaluating per message"
15428 When this option is true (the default), once one message has been queued
15429 because the load average is higher than the value set by &%queue_only_load%&,
15430 all subsequent messages received on the same SMTP connection are also queued.
15431 This is a deliberate choice; even though the load average may fall below the
15432 threshold, it doesn't seem right to deliver later messages on the same
15433 connection when not delivering earlier ones. However, there are special
15434 circumstances such as very long-lived connections from scanning appliances
15435 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15436 should be set false. This causes the value of the load average to be
15437 re-evaluated for each message.
15438
15439
15440 .option queue_only_override main boolean true
15441 .cindex "queueing incoming messages"
15442 When this option is true, the &%-od%&&'x'& command line options override the
15443 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15444 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15445 to override; they are accepted, but ignored.
15446
15447
15448 .option queue_run_in_order main boolean false
15449 .cindex "queue runner" "processing messages in order"
15450 If this option is set, queue runs happen in order of message arrival instead of
15451 in an arbitrary order. For this to happen, a complete list of the entire queue
15452 must be set up before the deliveries start. When the queue is all held in a
15453 single directory (the default), a single list is created for both the ordered
15454 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15455 single list is not created when &%queue_run_in_order%& is false. In this case,
15456 the sub-directories are processed one at a time (in a random order), and this
15457 avoids setting up one huge list for the whole queue. Thus, setting
15458 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15459 when the queue is large, because of the extra work in setting up the single,
15460 large list. In most situations, &%queue_run_in_order%& should not be set.
15461
15462
15463
15464 .option queue_run_max main integer 5
15465 .cindex "queue runner" "maximum number of"
15466 This controls the maximum number of queue runner processes that an Exim daemon
15467 can run simultaneously. This does not mean that it starts them all at once,
15468 but rather that if the maximum number are still running when the time comes to
15469 start another one, it refrains from starting another one. This can happen with
15470 very large queues and/or very sluggish deliveries. This option does not,
15471 however, interlock with other processes, so additional queue runners can be
15472 started by other means, or by killing and restarting the daemon.
15473
15474 Setting this option to zero does not suppress queue runs; rather, it disables
15475 the limit, allowing any number of simultaneous queue runner processes to be
15476 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15477 the daemon's command line.
15478
15479 .option queue_smtp_domains main "domain list&!!" unset
15480 .cindex "queueing incoming messages"
15481 .cindex "message" "queueing remote deliveries"
15482 When this option is set, a delivery process is started whenever a message is
15483 received, routing is performed, and local deliveries take place.
15484 However, if any SMTP deliveries are required for domains that match
15485 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15486 message waits on the queue for the next queue run. Since routing of the message
15487 has taken place, Exim knows to which remote hosts it must be delivered, and so
15488 when the queue run happens, multiple messages for the same host are delivered
15489 over a single SMTP connection. The &%-odqs%& command line option causes all
15490 SMTP deliveries to be queued in this way, and is equivalent to setting
15491 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15492 &%queue_domains%&.
15493
15494
15495 .option receive_timeout main time 0s
15496 .cindex "timeout" "for non-SMTP input"
15497 This option sets the timeout for accepting a non-SMTP message, that is, the
15498 maximum time that Exim waits when reading a message on the standard input. If
15499 the value is zero, it will wait for ever. This setting is overridden by the
15500 &%-or%& command line option. The timeout for incoming SMTP messages is
15501 controlled by &%smtp_receive_timeout%&.
15502
15503 .option received_header_text main string&!! "see below"
15504 .cindex "customizing" "&'Received:'& header"
15505 .cindex "&'Received:'& header line" "customizing"
15506 This string defines the contents of the &'Received:'& message header that is
15507 added to each message, except for the timestamp, which is automatically added
15508 on at the end (preceded by a semicolon). The string is expanded each time it is
15509 used. If the expansion yields an empty string, no &'Received:'& header line is
15510 added to the message. Otherwise, the string should start with the text
15511 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15512 header lines. The default setting is:
15513
15514 .code
15515 received_header_text = Received: \
15516   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15517   {${if def:sender_ident \
15518   {from ${quote_local_part:$sender_ident} }}\
15519   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15520   by $primary_hostname \
15521   ${if def:received_protocol {with $received_protocol}} \
15522   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15523   (Exim $version_number)\n\t\
15524   ${if def:sender_address \
15525   {(envelope-from <$sender_address>)\n\t}}\
15526   id $message_exim_id\
15527   ${if def:received_for {\n\tfor $received_for}}
15528 .endd
15529
15530 The reference to the TLS cipher is omitted when Exim is built without TLS
15531 support. The use of conditional expansions ensures that this works for both
15532 locally generated messages and messages received from remote hosts, giving
15533 header lines such as the following:
15534 .code
15535 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15536 by marley.carol.example with esmtp (Exim 4.00)
15537 (envelope-from <bob@carol.example>)
15538 id 16IOWa-00019l-00
15539 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15540 Received: by scrooge.carol.example with local (Exim 4.00)
15541 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15542 .endd
15543 Until the body of the message has been received, the timestamp is the time when
15544 the message started to be received. Once the body has arrived, and all policy
15545 checks have taken place, the timestamp is updated to the time at which the
15546 message was accepted.
15547
15548
15549 .option received_headers_max main integer 30
15550 .cindex "loop" "prevention"
15551 .cindex "mail loop prevention"
15552 .cindex "&'Received:'& header line" "counting"
15553 When a message is to be delivered, the number of &'Received:'& headers is
15554 counted, and if it is greater than this parameter, a mail loop is assumed to
15555 have occurred, the delivery is abandoned, and an error message is generated.
15556 This applies to both local and remote deliveries.
15557
15558
15559 .option recipient_unqualified_hosts main "host list&!!" unset
15560 .cindex "unqualified addresses"
15561 .cindex "host" "unqualified addresses from"
15562 This option lists those hosts from which Exim is prepared to accept unqualified
15563 recipient addresses in message envelopes. The addresses are made fully
15564 qualified by the addition of the &%qualify_recipient%& value. This option also
15565 affects message header lines. Exim does not reject unqualified recipient
15566 addresses in headers, but it qualifies them only if the message came from a
15567 host that matches &%recipient_unqualified_hosts%&,
15568 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15569 option was not set.
15570
15571
15572 .option recipients_max main integer 0
15573 .cindex "limit" "number of recipients"
15574 .cindex "recipient" "maximum number"
15575 If this option is set greater than zero, it specifies the maximum number of
15576 original recipients for any message. Additional recipients that are generated
15577 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15578 all recipients over the limit; earlier recipients are delivered as normal.
15579 Non-SMTP messages with too many recipients are failed, and no deliveries are
15580 done.
15581
15582 .cindex "RCPT" "maximum number of incoming"
15583 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15584 RCPT commands in a single message.
15585
15586
15587 .option recipients_max_reject main boolean false
15588 If this option is set true, Exim rejects SMTP messages containing too many
15589 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15590 error to the eventual DATA command. Otherwise (the default) it gives a 452
15591 error to the surplus RCPT commands and accepts the message on behalf of the
15592 initial set of recipients. The remote server should then re-send the message
15593 for the remaining recipients at a later time.
15594
15595
15596 .option remote_max_parallel main integer 2
15597 .cindex "delivery" "parallelism for remote"
15598 This option controls parallel delivery of one message to a number of remote
15599 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15600 does all the remote deliveries for a message one by one. Otherwise, if a single
15601 message has to be delivered to more than one remote host, or if several copies
15602 have to be sent to the same remote host, up to &%remote_max_parallel%&
15603 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15604 deliveries are required, the maximum number of processes are started, and as
15605 each one finishes, another is begun. The order of starting processes is the
15606 same as if sequential delivery were being done, and can be controlled by the
15607 &%remote_sort_domains%& option. If parallel delivery takes place while running
15608 with debugging turned on, the debugging output from each delivery process is
15609 tagged with its process id.
15610
15611 This option controls only the maximum number of parallel deliveries for one
15612 message in one Exim delivery process. Because Exim has no central queue
15613 manager, there is no way of controlling the total number of simultaneous
15614 deliveries if the configuration allows a delivery attempt as soon as a message
15615 is received.
15616
15617 .cindex "number of deliveries"
15618 .cindex "delivery" "maximum number of"
15619 If you want to control the total number of deliveries on the system, you
15620 need to set the &%queue_only%& option. This ensures that all incoming messages
15621 are added to the queue without starting a delivery process. Then set up an Exim
15622 daemon to start queue runner processes at appropriate intervals (probably
15623 fairly often, for example, every minute), and limit the total number of queue
15624 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15625 delivers only one message at a time, the maximum number of deliveries that can
15626 then take place at once is &%queue_run_max%& multiplied by
15627 &%remote_max_parallel%&.
15628
15629 If it is purely remote deliveries you want to control, use
15630 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15631 doing the SMTP routing before queueing, so that several messages for the same
15632 host will eventually get delivered down the same connection.
15633
15634
15635 .option remote_sort_domains main "domain list&!!" unset
15636 .cindex "sorting remote deliveries"
15637 .cindex "delivery" "sorting remote"
15638 When there are a number of remote deliveries for a message, they are sorted by
15639 domain into the order given by this list. For example,
15640 .code
15641 remote_sort_domains = *.cam.ac.uk:*.uk
15642 .endd
15643 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15644 then to those in the &%uk%& domain, then to any others.
15645
15646
15647 .option retry_data_expire main time 7d
15648 .cindex "hints database" "data expiry"
15649 This option sets a &"use before"& time on retry information in Exim's hints
15650 database. Any older retry data is ignored. This means that, for example, once a
15651 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15652 past failures.
15653
15654
15655 .option retry_interval_max main time 24h
15656 .cindex "retry" "limit on interval"
15657 .cindex "limit" "on retry interval"
15658 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15659 intervals between delivery attempts for messages that cannot be delivered
15660 straight away. This option sets an overall limit to the length of time between
15661 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15662 the default value.
15663
15664
15665 .option return_path_remove main boolean true
15666 .cindex "&'Return-path:'& header line" "removing"
15667 RFC 2821, section 4.4, states that an SMTP server must insert a
15668 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15669 The &'Return-path:'& header preserves the sender address as received in the
15670 MAIL command. This description implies that this header should not be present
15671 in an incoming message. If &%return_path_remove%& is true, any existing
15672 &'Return-path:'& headers are removed from messages at the time they are
15673 received. Exim's transports have options for adding &'Return-path:'& headers at
15674 the time of delivery. They are normally used only for final local deliveries.
15675
15676
15677 .option return_size_limit main integer 100K
15678 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15679
15680
15681 .new
15682 .option rfc1413_hosts main "host list&!!" @[]
15683 .cindex "RFC 1413"
15684 .cindex "host" "for RFC 1413 calls"
15685 RFC 1413 identification calls are made to any client host which matches
15686 an item in the list.
15687 The default value specifies just this host, being any local interface
15688 for the system.
15689 .wen
15690
15691 .new
15692 .option rfc1413_query_timeout main time 0s
15693 .wen
15694 .cindex "RFC 1413" "query timeout"
15695 .cindex "timeout" "for RFC 1413 call"
15696 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15697 no RFC 1413 calls are ever made.
15698
15699
15700 .option sender_unqualified_hosts main "host list&!!" unset
15701 .cindex "unqualified addresses"
15702 .cindex "host" "unqualified addresses from"
15703 This option lists those hosts from which Exim is prepared to accept unqualified
15704 sender addresses. The addresses are made fully qualified by the addition of
15705 &%qualify_domain%&. This option also affects message header lines. Exim does
15706 not reject unqualified addresses in headers that contain sender addresses, but
15707 it qualifies them only if the message came from a host that matches
15708 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15709 using TCP/IP), and the &%-bnq%& option was not set.
15710
15711
15712 .option smtp_accept_keepalive main boolean true
15713 .cindex "keepalive" "on incoming connection"
15714 This option controls the setting of the SO_KEEPALIVE option on incoming
15715 TCP/IP socket connections. When set, it causes the kernel to probe idle
15716 connections periodically, by sending packets with &"old"& sequence numbers. The
15717 other end of the connection should send an acknowledgment if the connection is
15718 still okay or a reset if the connection has been aborted. The reason for doing
15719 this is that it has the beneficial effect of freeing up certain types of
15720 connection that can get stuck when the remote host is disconnected without
15721 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15722 hours to detect unreachable hosts.
15723
15724
15725
15726 .option smtp_accept_max main integer 20
15727 .cindex "limit" "incoming SMTP connections"
15728 .cindex "SMTP" "incoming connection count"
15729 .cindex "inetd"
15730 This option specifies the maximum number of simultaneous incoming SMTP calls
15731 that Exim will accept. It applies only to the listening daemon; there is no
15732 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15733 value is set to zero, no limit is applied. However, it is required to be
15734 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15735 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15736
15737 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15738 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15739 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15740 and &%smtp_load_reserve%& are then checked before accepting the connection.
15741
15742
15743 .option smtp_accept_max_nonmail main integer 10
15744 .cindex "limit" "non-mail SMTP commands"
15745 .cindex "SMTP" "limiting non-mail commands"
15746 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15747 the connection if there are too many. This option defines &"too many"&. The
15748 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15749 client looping sending EHLO, for example. The check is applied only if the
15750 client host matches &%smtp_accept_max_nonmail_hosts%&.
15751
15752 When a new message is expected, one occurrence of RSET is not counted. This
15753 allows a client to send one RSET between messages (this is not necessary,
15754 but some clients do it). Exim also allows one uncounted occurrence of HELO
15755 or EHLO, and one occurrence of STARTTLS between messages. After
15756 starting up a TLS session, another EHLO is expected, and so it too is not
15757 counted. The first occurrence of AUTH in a connection, or immediately
15758 following STARTTLS is not counted. Otherwise, all commands other than
15759 MAIL, RCPT, DATA, and QUIT are counted.
15760
15761
15762 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15763 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15764 check by setting this option. The default value makes it apply to all hosts. By
15765 changing the value, you can exclude any badly-behaved hosts that you have to
15766 live with.
15767
15768
15769 . Allow this long option name to split; give it unsplit as a fifth argument
15770 . for the automatic .oindex that is generated by .option.
15771 . We insert " &~&~" which is both pretty nasty visually and results in
15772 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15773 . zero-width-space, which would be nicer visually and results in (at least)
15774 . html that Firefox will split on when it's forced to reflow (rather than
15775 . inserting a horizontal scrollbar).  However, the text is still not
15776 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15777 . the option name to split.
15778
15779 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15780          smtp_accept_max_per_connection
15781 .cindex "SMTP" "limiting incoming message count"
15782 .cindex "limit" "messages per SMTP connection"
15783 The value of this option limits the number of MAIL commands that Exim is
15784 prepared to accept over a single SMTP connection, whether or not each command
15785 results in the transfer of a message. After the limit is reached, a 421
15786 response is given to subsequent MAIL commands. This limit is a safety
15787 precaution against a client that goes mad (incidents of this type have been
15788 seen).
15789
15790
15791 .option smtp_accept_max_per_host main string&!! unset
15792 .cindex "limit" "SMTP connections from one host"
15793 .cindex "host" "limiting SMTP connections from"
15794 This option restricts the number of simultaneous IP connections from a single
15795 host (strictly, from a single IP address) to the Exim daemon. The option is
15796 expanded, to enable different limits to be applied to different hosts by
15797 reference to &$sender_host_address$&. Once the limit is reached, additional
15798 connection attempts from the same host are rejected with error code 421. This
15799 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15800 of zero imposes no limit. If this option is set greater than zero, it is
15801 required that &%smtp_accept_max%& be non-zero.
15802
15803 &*Warning*&: When setting this option you should not use any expansion
15804 constructions that take an appreciable amount of time. The expansion and test
15805 happen in the main daemon loop, in order to reject additional connections
15806 without forking additional processes (otherwise a denial-of-service attack
15807 could cause a vast number or processes to be created). While the daemon is
15808 doing this processing, it cannot accept any other incoming connections.
15809
15810
15811
15812 .option smtp_accept_queue main integer 0
15813 .cindex "SMTP" "incoming connection count"
15814 .cindex "queueing incoming messages"
15815 .cindex "message" "queueing by SMTP connection count"
15816 If the number of simultaneous incoming SMTP connections being handled via the
15817 listening daemon exceeds this value, messages received by SMTP are just placed
15818 on the queue; no delivery processes are started automatically. The count is
15819 fixed at the start of an SMTP connection. It cannot be updated in the
15820 subprocess that receives messages, and so the queueing or not queueing applies
15821 to all messages received in the same connection.
15822
15823 A value of zero implies no limit, and clearly any non-zero value is useful only
15824 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15825 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15826 various &%-od%&&'x'& command line options.
15827
15828
15829 . See the comment on smtp_accept_max_per_connection
15830
15831 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15832          smtp_accept_queue_per_connection
15833 .cindex "queueing incoming messages"
15834 .cindex "message" "queueing by message count"
15835 This option limits the number of delivery processes that Exim starts
15836 automatically when receiving messages via SMTP, whether via the daemon or by
15837 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15838 and the number of messages received in a single SMTP session exceeds this
15839 number, subsequent messages are placed on the queue, but no delivery processes
15840 are started. This helps to limit the number of Exim processes when a server
15841 restarts after downtime and there is a lot of mail waiting for it on other
15842 systems. On large systems, the default should probably be increased, and on
15843 dial-in client systems it should probably be set to zero (that is, disabled).
15844
15845
15846 .option smtp_accept_reserve main integer 0
15847 .cindex "SMTP" "incoming call count"
15848 .cindex "host" "reserved"
15849 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15850 number of SMTP connections that are reserved for connections from the hosts
15851 that are specified in &%smtp_reserve_hosts%&. The value set in
15852 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15853 restricted to this number of connections; the option specifies a minimum number
15854 of connection slots for them, not a maximum. It is a guarantee that this group
15855 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15856 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15857 individual host.
15858
15859 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15860 set to 5, once there are 45 active connections (from any hosts), new
15861 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15862 provided the other criteria for acceptance are met.
15863
15864
15865 .option smtp_active_hostname main string&!! unset
15866 .cindex "host" "name in SMTP responses"
15867 .cindex "SMTP" "host name in responses"
15868 .vindex "&$primary_hostname$&"
15869 This option is provided for multi-homed servers that want to masquerade as
15870 several different hosts. At the start of an incoming SMTP connection, its value
15871 is expanded and used instead of the value of &$primary_hostname$& in SMTP
15872 responses. For example, it is used as domain name in the response to an
15873 incoming HELO or EHLO command.
15874
15875 .vindex "&$smtp_active_hostname$&"
15876 The active hostname is placed in the &$smtp_active_hostname$& variable, which
15877 is saved with any messages that are received. It is therefore available for use
15878 in routers and transports when the message is later delivered.
15879
15880 If this option is unset, or if its expansion is forced to fail, or if the
15881 expansion results in an empty string, the value of &$primary_hostname$& is
15882 used. Other expansion failures cause a message to be written to the main and
15883 panic logs, and the SMTP command receives a temporary error. Typically, the
15884 value of &%smtp_active_hostname%& depends on the incoming interface address.
15885 For example:
15886 .code
15887 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
15888   {cox.mydomain}{box.mydomain}}
15889 .endd
15890
15891 Although &$smtp_active_hostname$& is primarily concerned with incoming
15892 messages, it is also used as the default for HELO commands in callout
15893 verification if there is no remote transport from which to obtain a
15894 &%helo_data%& value.
15895
15896 .option smtp_banner main string&!! "see below"
15897 .cindex "SMTP" "welcome banner"
15898 .cindex "banner for SMTP"
15899 .cindex "welcome banner for SMTP"
15900 .cindex "customizing" "SMTP banner"
15901 This string, which is expanded every time it is used, is output as the initial
15902 positive response to an SMTP connection. The default setting is:
15903 .code
15904 smtp_banner = $smtp_active_hostname ESMTP Exim \
15905   $version_number $tod_full
15906 .endd
15907 Failure to expand the string causes a panic error. If you want to create a
15908 multiline response to the initial SMTP connection, use &"\n"& in the string at
15909 appropriate points, but not at the end. Note that the 220 code is not included
15910 in this string. Exim adds it automatically (several times in the case of a
15911 multiline response).
15912
15913
15914 .option smtp_check_spool_space main boolean true
15915 .cindex "checking disk space"
15916 .cindex "disk space, checking"
15917 .cindex "spool directory" "checking space"
15918 When this option is set, if an incoming SMTP session encounters the SIZE
15919 option on a MAIL command, it checks that there is enough space in the
15920 spool directory's partition to accept a message of that size, while still
15921 leaving free the amount specified by &%check_spool_space%& (even if that value
15922 is zero). If there isn't enough space, a temporary error code is returned.
15923
15924
15925 .option smtp_connect_backlog main integer 20
15926 .cindex "connection backlog"
15927 .cindex "SMTP" "connection backlog"
15928 .cindex "backlog of connections"
15929 This option specifies a maximum number of waiting SMTP connections. Exim passes
15930 this value to the TCP/IP system when it sets up its listener. Once this number
15931 of connections are waiting for the daemon's attention, subsequent connection
15932 attempts are refused at the TCP/IP level. At least, that is what the manuals
15933 say; in some circumstances such connection attempts have been observed to time
15934 out instead. For large systems it is probably a good idea to increase the
15935 value (to 50, say). It also gives some protection against denial-of-service
15936 attacks by SYN flooding.
15937
15938
15939 .option smtp_enforce_sync main boolean true
15940 .cindex "SMTP" "synchronization checking"
15941 .cindex "synchronization checking in SMTP"
15942 The SMTP protocol specification requires the client to wait for a response from
15943 the server at certain points in the dialogue. Without PIPELINING these
15944 synchronization points are after every command; with PIPELINING they are
15945 fewer, but they still exist.
15946
15947 Some spamming sites send out a complete set of SMTP commands without waiting
15948 for any response. Exim protects against this by rejecting a message if the
15949 client has sent further input when it should not have. The error response &"554
15950 SMTP synchronization error"& is sent, and the connection is dropped. Testing
15951 for this error cannot be perfect because of transmission delays (unexpected
15952 input may be on its way but not yet received when Exim checks). However, it
15953 does detect many instances.
15954
15955 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
15956 If you want to disable the check selectively (for example, only for certain
15957 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
15958 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
15959
15960
15961
15962 .option smtp_etrn_command main string&!! unset
15963 .cindex "ETRN" "command to be run"
15964 .vindex "&$domain$&"
15965 If this option is set, the given command is run whenever an SMTP ETRN
15966 command is received from a host that is permitted to issue such commands (see
15967 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
15968 are independently expanded. The expansion variable &$domain$& is set to the
15969 argument of the ETRN command, and no syntax checking is done on it. For
15970 example:
15971 .code
15972 smtp_etrn_command = /etc/etrn_command $domain \
15973                     $sender_host_address
15974 .endd
15975 A new process is created to run the command, but Exim does not wait for it to
15976 complete. Consequently, its status cannot be checked. If the command cannot be
15977 run, a line is written to the panic log, but the ETRN caller still receives
15978 a 250 success response. Exim is normally running under its own uid when
15979 receiving SMTP, so it is not possible for it to change the uid before running
15980 the command.
15981
15982
15983 .option smtp_etrn_serialize main boolean true
15984 .cindex "ETRN" "serializing"
15985 When this option is set, it prevents the simultaneous execution of more than
15986 one identical command as a result of ETRN in an SMTP connection. See
15987 section &<<SECTETRN>>& for details.
15988
15989
15990 .option smtp_load_reserve main fixed-point unset
15991 .cindex "load average"
15992 If the system load average ever gets higher than this, incoming SMTP calls are
15993 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
15994 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
15995 the load is over the limit. The option has no effect on ancient operating
15996 systems on which Exim cannot determine the load average. See also
15997 &%deliver_queue_load_max%& and &%queue_only_load%&.
15998
15999
16000
16001 .option smtp_max_synprot_errors main integer 3
16002 .cindex "SMTP" "limiting syntax and protocol errors"
16003 .cindex "limit" "SMTP syntax and protocol errors"
16004 Exim rejects SMTP commands that contain syntax or protocol errors. In
16005 particular, a syntactically invalid email address, as in this command:
16006 .code
16007 RCPT TO:<abc xyz@a.b.c>
16008 .endd
16009 causes immediate rejection of the command, before any other tests are done.
16010 (The ACL cannot be run if there is no valid address to set up for it.) An
16011 example of a protocol error is receiving RCPT before MAIL. If there are
16012 too many syntax or protocol errors in one SMTP session, the connection is
16013 dropped. The limit is set by this option.
16014
16015 .cindex "PIPELINING" "expected errors"
16016 When the PIPELINING extension to SMTP is in use, some protocol errors are
16017 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16018 Exim assumes that PIPELINING will be used if it advertises it (see
16019 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16020 not count towards the limit.
16021
16022
16023
16024 .option smtp_max_unknown_commands main integer 3
16025 .cindex "SMTP" "limiting unknown commands"
16026 .cindex "limit" "unknown SMTP commands"
16027 If there are too many unrecognized commands in an incoming SMTP session, an
16028 Exim server drops the connection. This is a defence against some kinds of abuse
16029 that subvert web
16030 clients
16031 into making connections to SMTP ports; in these circumstances, a number of
16032 non-SMTP command lines are sent first.
16033
16034
16035
16036 .option smtp_ratelimit_hosts main "host list&!!" unset
16037 .cindex "SMTP" "rate limiting"
16038 .cindex "limit" "rate of message arrival"
16039 .cindex "RCPT" "rate limiting"
16040 Some sites find it helpful to be able to limit the rate at which certain hosts
16041 can send them messages, and the rate at which an individual message can specify
16042 recipients.
16043
16044 Exim has two rate-limiting facilities. This section describes the older
16045 facility, which can limit rates within a single connection. The newer
16046 &%ratelimit%& ACL condition can limit rates across all connections. See section
16047 &<<SECTratelimiting>>& for details of the newer facility.
16048
16049 When a host matches &%smtp_ratelimit_hosts%&, the values of
16050 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16051 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16052 respectively. Each option, if set, must contain a set of four comma-separated
16053 values:
16054
16055 .ilist
16056 A threshold, before which there is no rate limiting.
16057 .next
16058 An initial time delay. Unlike other times in Exim, numbers with decimal
16059 fractional parts are allowed here.
16060 .next
16061 A factor by which to increase the delay each time.
16062 .next
16063 A maximum value for the delay. This should normally be less than 5 minutes,
16064 because after that time, the client is liable to timeout the SMTP command.
16065 .endlist
16066
16067 For example, these settings have been used successfully at the site which
16068 first suggested this feature, for controlling mail from their customers:
16069 .code
16070 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16071 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16072 .endd
16073 The first setting specifies delays that are applied to MAIL commands after
16074 two have been received over a single connection. The initial delay is 0.5
16075 seconds, increasing by a factor of 1.05 each time. The second setting applies
16076 delays to RCPT commands when more than four occur in a single message.
16077
16078
16079 .option smtp_ratelimit_mail main string unset
16080 See &%smtp_ratelimit_hosts%& above.
16081
16082
16083 .option smtp_ratelimit_rcpt main string unset
16084 See &%smtp_ratelimit_hosts%& above.
16085
16086
16087 .option smtp_receive_timeout main time 5m
16088 .cindex "timeout" "for SMTP input"
16089 .cindex "SMTP" "input timeout"
16090 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16091 input, including batch SMTP. If a line of input (either an SMTP command or a
16092 data line) is not received within this time, the SMTP connection is dropped and
16093 the message is abandoned.
16094 A line is written to the log containing one of the following messages:
16095 .code
16096 SMTP command timeout on connection from...
16097 SMTP data timeout on connection from...
16098 .endd
16099 The former means that Exim was expecting to read an SMTP command; the latter
16100 means that it was in the DATA phase, reading the contents of a message.
16101
16102
16103 .oindex "&%-os%&"
16104 The value set by this option can be overridden by the
16105 &%-os%& command-line option. A setting of zero time disables the timeout, but
16106 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16107 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16108 timeout is controlled by &%receive_timeout%& and &%-or%&.
16109
16110
16111 .option smtp_reserve_hosts main "host list&!!" unset
16112 This option defines hosts for which SMTP connections are reserved; see
16113 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16114
16115
16116 .option smtp_return_error_details main boolean false
16117 .cindex "SMTP" "details policy failures"
16118 .cindex "policy control" "rejection, returning details"
16119 In the default state, Exim uses bland messages such as
16120 &"Administrative prohibition"& when it rejects SMTP commands for policy
16121 reasons. Many sysadmins like this because it gives away little information
16122 to spammers. However, some other sysadmins who are applying strict checking
16123 policies want to give out much fuller information about failures. Setting
16124 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16125 example, instead of &"Administrative prohibition"&, it might give:
16126 .code
16127 550-Rejected after DATA: '>' missing at end of address:
16128 550 failing address in "From" header is: <user@dom.ain
16129 .endd
16130
16131 .option spamd_address main string "see below"
16132 This option is available when Exim is compiled with the content-scanning
16133 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16134 The default value is
16135 .code
16136 127.0.0.1 783
16137 .endd
16138 See section &<<SECTscanspamass>>& for more details.
16139
16140
16141
16142 .option split_spool_directory main boolean false
16143 .cindex "multiple spool directories"
16144 .cindex "spool directory" "split"
16145 .cindex "directories, multiple"
16146 If this option is set, it causes Exim to split its input directory into 62
16147 subdirectories, each with a single alphanumeric character as its name. The
16148 sixth character of the message id is used to allocate messages to
16149 subdirectories; this is the least significant base-62 digit of the time of
16150 arrival of the message.
16151
16152 Splitting up the spool in this way may provide better performance on systems
16153 where there are long mail queues, by reducing the number of files in any one
16154 directory. The msglog directory is also split up in a similar way to the input
16155 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16156 are still placed in the single directory &_msglog.OLD_&.
16157
16158 It is not necessary to take any special action for existing messages when
16159 changing &%split_spool_directory%&. Exim notices messages that are in the
16160 &"wrong"& place, and continues to process them. If the option is turned off
16161 after a period of being on, the subdirectories will eventually empty and be
16162 automatically deleted.
16163
16164 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16165 changes. Instead of creating a list of all messages in the queue, and then
16166 trying to deliver each one in turn, it constructs a list of those in one
16167 sub-directory and tries to deliver them, before moving on to the next
16168 sub-directory. The sub-directories are processed in a random order. This
16169 spreads out the scanning of the input directories, and uses less memory. It is
16170 particularly beneficial when there are lots of messages on the queue. However,
16171 if &%queue_run_in_order%& is set, none of this new processing happens. The
16172 entire queue has to be scanned and sorted before any deliveries can start.
16173
16174
16175 .option spool_directory main string&!! "set at compile time"
16176 .cindex "spool directory" "path to"
16177 This defines the directory in which Exim keeps its spool, that is, the messages
16178 it is waiting to deliver. The default value is taken from the compile-time
16179 configuration setting, if there is one. If not, this option must be set. The
16180 string is expanded, so it can contain, for example, a reference to
16181 &$primary_hostname$&.
16182
16183 If the spool directory name is fixed on your installation, it is recommended
16184 that you set it at build time rather than from this option, particularly if the
16185 log files are being written to the spool directory (see &%log_file_path%&).
16186 Otherwise log files cannot be used for errors that are detected early on, such
16187 as failures in the configuration file.
16188
16189 By using this option to override the compiled-in path, it is possible to run
16190 tests of Exim without using the standard spool.
16191
16192 .option sqlite_lock_timeout main time 5s
16193 .cindex "sqlite lookup type" "lock timeout"
16194 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16195 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16196
16197 .option strict_acl_vars main boolean false
16198 .cindex "&ACL;" "variables, handling unset"
16199 This option controls what happens if a syntactically valid but undefined ACL
16200 variable is referenced. If it is false (the default), an empty string
16201 is substituted; if it is true, an error is generated. See section
16202 &<<SECTaclvariables>>& for details of ACL variables.
16203
16204 .option strip_excess_angle_brackets main boolean false
16205 .cindex "angle brackets, excess"
16206 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16207 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16208 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16209 passed on to another MTA, the excess angle brackets are not passed on. If this
16210 option is not set, multiple pairs of angle brackets cause a syntax error.
16211
16212
16213 .option strip_trailing_dot main boolean false
16214 .cindex "trailing dot on domain"
16215 .cindex "dot" "trailing on domain"
16216 If this option is set, a trailing dot at the end of a domain in an address is
16217 ignored. If this is in the envelope and the message is passed on to another
16218 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16219 domain causes a syntax error.
16220 However, addresses in header lines are checked only when an ACL requests header
16221 syntax checking.
16222
16223
16224 .option syslog_duplication main boolean true
16225 .cindex "syslog" "duplicate log lines; suppressing"
16226 When Exim is logging to syslog, it writes the log lines for its three
16227 separate logs at different syslog priorities so that they can in principle
16228 be separated on the logging hosts. Some installations do not require this
16229 separation, and in those cases, the duplication of certain log lines is a
16230 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16231 particular log line is written to syslog. For lines that normally go to
16232 both the main log and the reject log, the reject log version (possibly
16233 containing message header lines) is written, at LOG_NOTICE priority.
16234 Lines that normally go to both the main and the panic log are written at
16235 the LOG_ALERT priority.
16236
16237
16238 .option syslog_facility main string unset
16239 .cindex "syslog" "facility; setting"
16240 This option sets the syslog &"facility"& name, used when Exim is logging to
16241 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16242 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16243 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16244 details of Exim's logging.
16245
16246
16247
16248 .option syslog_processname main string &`exim`&
16249 .cindex "syslog" "process name; setting"
16250 This option sets the syslog &"ident"& name, used when Exim is logging to
16251 syslog. The value must be no longer than 32 characters. See chapter
16252 &<<CHAPlog>>& for details of Exim's logging.
16253
16254
16255
16256 .option syslog_timestamp main boolean true
16257 .cindex "syslog" "timestamps"
16258 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16259 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16260 details of Exim's logging.
16261
16262
16263 .option system_filter main string&!! unset
16264 .cindex "filter" "system filter"
16265 .cindex "system filter" "specifying"
16266 .cindex "Sieve filter" "not available for system filter"
16267 This option specifies an Exim filter file that is applied to all messages at
16268 the start of each delivery attempt, before any routing is done. System filters
16269 must be Exim filters; they cannot be Sieve filters. If the system filter
16270 generates any deliveries to files or pipes, or any new mail messages, the
16271 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16272 which transports are to be used. Details of this facility are given in chapter
16273 &<<CHAPsystemfilter>>&.
16274
16275
16276 .option system_filter_directory_transport main string&!! unset
16277 .vindex "&$address_file$&"
16278 This sets the name of the transport driver that is to be used when the
16279 &%save%& command in a system message filter specifies a path ending in &"/"&,
16280 implying delivery of each message into a separate file in some directory.
16281 During the delivery, the variable &$address_file$& contains the path name.
16282
16283
16284 .option system_filter_file_transport main string&!! unset
16285 .cindex "file" "transport for system filter"
16286 This sets the name of the transport driver that is to be used when the &%save%&
16287 command in a system message filter specifies a path not ending in &"/"&. During
16288 the delivery, the variable &$address_file$& contains the path name.
16289
16290 .option system_filter_group main string unset
16291 .cindex "gid (group id)" "system filter"
16292 This option is used only when &%system_filter_user%& is also set. It sets the
16293 gid under which the system filter is run, overriding any gid that is associated
16294 with the user. The value may be numerical or symbolic.
16295
16296 .option system_filter_pipe_transport main string&!! unset
16297 .cindex "&(pipe)& transport" "for system filter"
16298 .vindex "&$address_pipe$&"
16299 This specifies the transport driver that is to be used when a &%pipe%& command
16300 is used in a system filter. During the delivery, the variable &$address_pipe$&
16301 contains the pipe command.
16302
16303
16304 .option system_filter_reply_transport main string&!! unset
16305 .cindex "&(autoreply)& transport" "for system filter"
16306 This specifies the transport driver that is to be used when a &%mail%& command
16307 is used in a system filter.
16308
16309
16310 .option system_filter_user main string unset
16311 .cindex "uid (user id)" "system filter"
16312 If this option is set to root, the system filter is run in the main Exim
16313 delivery process, as root.  Otherwise, the system filter runs in a separate
16314 process, as the given user, defaulting to the Exim run-time user.
16315 Unless the string consists entirely of digits, it
16316 is looked up in the password data. Failure to find the named user causes a
16317 configuration error. The gid is either taken from the password data, or
16318 specified by &%system_filter_group%&. When the uid is specified numerically,
16319 &%system_filter_group%& is required to be set.
16320
16321 If the system filter generates any pipe, file, or reply deliveries, the uid
16322 under which the filter is run is used when transporting them, unless a
16323 transport option overrides.
16324
16325
16326 .option tcp_nodelay main boolean true
16327 .cindex "daemon" "TCP_NODELAY on sockets"
16328 .cindex "Nagle algorithm"
16329 .cindex "TCP_NODELAY on listening sockets"
16330 If this option is set false, it stops the Exim daemon setting the
16331 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16332 turns off the &"Nagle algorithm"&, which is a way of improving network
16333 performance in interactive (character-by-character) situations. Turning it off
16334 should improve Exim's performance a bit, so that is what happens by default.
16335 However, it appears that some broken clients cannot cope, and time out. Hence
16336 this option. It affects only those sockets that are set up for listening by the
16337 daemon. Sockets created by the smtp transport for delivering mail always set
16338 TCP_NODELAY.
16339
16340
16341 .option timeout_frozen_after main time 0s
16342 .cindex "frozen messages" "timing out"
16343 .cindex "timeout" "frozen messages"
16344 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16345 message of any kind that has been on the queue for longer than the given time
16346 is automatically cancelled at the next queue run. If the frozen message is a
16347 bounce message, it is just discarded; otherwise, a bounce is sent to the
16348 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16349 If you want to timeout frozen bounce messages earlier than other kinds of
16350 frozen message, see &%ignore_bounce_errors_after%&.
16351
16352 &*Note:*& the default value of zero means no timeouts; with this setting,
16353 frozen messages remain on the queue forever (except for any frozen bounce
16354 messages that are released by &%ignore_bounce_errors_after%&).
16355
16356
16357 .option timezone main string unset
16358 .cindex "timezone, setting"
16359 The value of &%timezone%& is used to set the environment variable TZ while
16360 running Exim (if it is different on entry). This ensures that all timestamps
16361 created by Exim are in the required timezone. If you want all your timestamps
16362 to be in UTC (aka GMT) you should set
16363 .code
16364 timezone = UTC
16365 .endd
16366 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16367 or, if that is not set, from the value of the TZ environment variable when Exim
16368 is built. If &%timezone%& is set to the empty string, either at build or run
16369 time, any existing TZ variable is removed from the environment when Exim
16370 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16371 unfortunately not all, operating systems.
16372
16373
16374 .option tls_advertise_hosts main "host list&!!" unset
16375 .cindex "TLS" "advertising"
16376 .cindex "encryption" "on SMTP connection"
16377 .cindex "SMTP" "encrypted connection"
16378 When Exim is built with support for TLS encrypted connections, the availability
16379 of the STARTTLS command to set up an encrypted session is advertised in
16380 response to EHLO only to those client hosts that match this option. See
16381 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16382
16383
16384 .option tls_certificate main string&!! unset
16385 .cindex "TLS" "server certificate; location of"
16386 .cindex "certificate" "server, location of"
16387 The value of this option is expanded, and must then be the absolute path to a
16388 file which contains the server's certificates. The server's private key is also
16389 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16390 &<<CHAPTLS>>& for further details.
16391
16392 &*Note*&: The certificates defined by this option are used only when Exim is
16393 receiving incoming messages as a server. If you want to supply certificates for
16394 use when sending messages as a client, you must set the &%tls_certificate%&
16395 option in the relevant &(smtp)& transport.
16396
16397 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16398 if the OpenSSL build supports TLS extensions and the TLS client sends the
16399 Server Name Indication extension, then this option and others documented in
16400 &<<SECTtlssni>>& will be re-expanded.
16401
16402 .option tls_crl main string&!! unset
16403 .cindex "TLS" "server certificate revocation list"
16404 .cindex "certificate" "revocation list for server"
16405 This option specifies a certificate revocation list. The expanded value must
16406 be the name of a file that contains a CRL in PEM format.
16407
16408 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16409
16410
16411 .option tls_dh_max_bits main integer 2236
16412 .cindex "TLS" "D-H bit count"
16413 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16414 the chosen TLS library.  That value might prove to be too high for
16415 interoperability.  This option provides a maximum clamp on the value
16416 suggested, trading off security for interoperability.
16417
16418 The value must be at least 1024.
16419
16420 The value 2236 was chosen because, at time of adding the option, it was the
16421 hard-coded maximum value supported by the NSS cryptographic library, as used
16422 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16423
16424 If you prefer more security and are willing to break some clients, raise this
16425 number.
16426
16427 Note that the value passed to GnuTLS for *generating* a new prime may be a
16428 little less than this figure, because GnuTLS is inexact and may produce a
16429 larger prime than requested.
16430
16431
16432 .option tls_dhparam main string&!! unset
16433 .cindex "TLS" "D-H parameters for server"
16434 The value of this option is expanded and indicates the source of DH parameters
16435 to be used by Exim.
16436
16437 If it is a filename starting with a &`/`&, then it names a file from which DH
16438 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16439 PKCS#3 representation of the DH prime.  If the file does not exist, for
16440 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16441 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16442 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16443 and treated as though the &%tls_dhparam%& were set to "none".
16444
16445 If this option expands to the string "none", then no DH parameters will be
16446 loaded by Exim.
16447
16448 If this option expands to the string "historic" and Exim is using GnuTLS, then
16449 Exim will attempt to load a file from inside the spool directory.  If the file
16450 does not exist, Exim will attempt to create it.
16451 See section &<<SECTgnutlsparam>>& for further details.
16452
16453 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16454 a default DH prime; the default is the 2048 bit prime described in section
16455 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16456 in IKE is assigned number 23.
16457
16458 Otherwise, the option must expand to the name used by Exim for any of a number
16459 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16460 "ike" followed by the number used by IKE, of "default" which corresponds to
16461 "ike23".
16462
16463 The available primes are:
16464 &`ike1`&, &`ike2`&, &`ike5`&,
16465 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16466 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16467
16468 Some of these will be too small to be accepted by clients.
16469 Some may be too large to be accepted by clients.
16470
16471 The TLS protocol does not negotiate an acceptable size for this; clients tend
16472 to hard-drop connections if what is offered by the server is unacceptable,
16473 whether too large or too small, and there's no provision for the client to
16474 tell the server what these constraints are.  Thus, as a server operator, you
16475 need to make an educated guess as to what is most likely to work for your
16476 userbase.
16477
16478 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16479 is most likely to maximise interoperability.  The upper bound comes from
16480 applications using the Mozilla Network Security Services (NSS) library, which
16481 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16482 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16483 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16484 acceptable bound from 1024 to 2048.
16485
16486
16487 .option tls_ocsp_file main string&!! unset
16488 This option
16489 must if set expand to the absolute path to a file which contains a current
16490 status proof for the server's certificate, as obtained from the
16491 Certificate Authority.
16492
16493
16494 .option tls_on_connect_ports main "string list" unset
16495 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16496 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16497 set up without waiting for the client to issue a STARTTLS command. For
16498 further details, see section &<<SECTsupobssmt>>&.
16499
16500
16501
16502 .option tls_privatekey main string&!! unset
16503 .cindex "TLS" "server private key; location of"
16504 The value of this option is expanded, and must then be the absolute path to a
16505 file which contains the server's private key. If this option is unset, or if
16506 the expansion is forced to fail, or the result is an empty string, the private
16507 key is assumed to be in the same file as the server's certificates. See chapter
16508 &<<CHAPTLS>>& for further details.
16509
16510 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16511
16512
16513 .option tls_remember_esmtp main boolean false
16514 .cindex "TLS" "esmtp state; remembering"
16515 .cindex "TLS" "broken clients"
16516 If this option is set true, Exim violates the RFCs by remembering that it is in
16517 &"esmtp"& state after successfully negotiating a TLS session. This provides
16518 support for broken clients that fail to send a new EHLO after starting a
16519 TLS session.
16520
16521
16522 .option tls_require_ciphers main string&!! unset
16523 .cindex "TLS" "requiring specific ciphers"
16524 .cindex "cipher" "requiring specific"
16525 This option controls which ciphers can be used for incoming TLS connections.
16526 The &(smtp)& transport has an option of the same name for controlling outgoing
16527 connections. This option is expanded for each connection, so can be varied for
16528 different clients if required. The value of this option must be a list of
16529 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16530 in somewhat different ways. If GnuTLS is being used, the client controls the
16531 preference order of the available ciphers. Details are given in sections
16532 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16533
16534
16535 .option tls_try_verify_hosts main "host list&!!" unset
16536 .cindex "TLS" "client certificate verification"
16537 .cindex "certificate" "verification of client"
16538 See &%tls_verify_hosts%& below.
16539
16540
16541 .new
16542 .option tls_verify_certificates main string&!! system
16543 .cindex "TLS" "client certificate verification"
16544 .cindex "certificate" "verification of client"
16545 The value of this option is expanded, and must then be either the
16546 word "system"
16547 or the absolute path to
16548 a file or directory containing permitted certificates for clients that
16549 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16550
16551 The "system" value for the option will use a
16552 system default location compiled into the SSL library.
16553 This is not available for GnuTLS versions preceding 3.0.20,
16554 and will be taken as empty; an explicit location
16555 must be specified.
16556
16557 The use of a directory for the option value is not avilable for GnuTLS versions
16558 preceding 3.3.6 and a single file must be used.
16559
16560 With OpenSSL the certificates specified
16561 explicitly
16562 either by file or directory
16563 are added to those given by the system default location.
16564 .wen
16565
16566 These certificates should be for the certificate authorities trusted, rather
16567 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16568 the value is a file then the certificates are sent by Exim as a server to
16569 connecting clients, defining the list of accepted certificate authorities.
16570 Thus the values defined should be considered public data.  To avoid this,
16571 use the explicit directory version.
16572
16573 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16574
16575 A forced expansion failure or setting to an empty string is equivalent to
16576 being unset.
16577
16578
16579 .option tls_verify_hosts main "host list&!!" unset
16580 .cindex "TLS" "client certificate verification"
16581 .cindex "certificate" "verification of client"
16582 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16583 certificates from clients. The expected certificates are defined by
16584 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16585 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16586 &%tls_verify_certificates%& is not set.
16587
16588 Any client that matches &%tls_verify_hosts%& is constrained by
16589 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16590 present one of the listed certificates. If it does not, the connection is
16591 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16592 the host to use TLS. It can still send SMTP commands through unencrypted
16593 connections. Forcing a client to use TLS has to be done separately using an
16594 ACL to reject inappropriate commands when the connection is not encrypted.
16595
16596 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16597 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16598 certificate and checks it against &%tls_verify_certificates%&, but does not
16599 abort the connection if there is no certificate or if it does not match. This
16600 state can be detected in an ACL, which makes it possible to implement policies
16601 such as &"accept for relay only if a verified certificate has been received,
16602 but accept for local delivery if encrypted, even without a verified
16603 certificate"&.
16604
16605 Client hosts that match neither of these lists are not asked to present
16606 certificates.
16607
16608
16609 .option trusted_groups main "string list&!!" unset
16610 .cindex "trusted groups"
16611 .cindex "groups" "trusted"
16612 This option is expanded just once, at the start of Exim's processing. If this
16613 option is set, any process that is running in one of the listed groups, or
16614 which has one of them as a supplementary group, is trusted. The groups can be
16615 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16616 details of what trusted callers are permitted to do. If neither
16617 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16618 are trusted.
16619
16620 .option trusted_users main "string list&!!" unset
16621 .cindex "trusted users"
16622 .cindex "user" "trusted"
16623 This option is expanded just once, at the start of Exim's processing. If this
16624 option is set, any process that is running as one of the listed users is
16625 trusted. The users can be specified numerically or by name. See section
16626 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16627 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16628 Exim user are trusted.
16629
16630 .option unknown_login main string&!! unset
16631 .cindex "uid (user id)" "unknown caller"
16632 .vindex "&$caller_uid$&"
16633 This is a specialized feature for use in unusual configurations. By default, if
16634 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16635 gives up. The &%unknown_login%& option can be used to set a login name to be
16636 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16637 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16638 is used for the user's real name (gecos field), unless this has been set by the
16639 &%-F%& option.
16640
16641 .option unknown_username main string unset
16642 See &%unknown_login%&.
16643
16644 .option untrusted_set_sender main "address list&!!" unset
16645 .cindex "trusted users"
16646 .cindex "sender" "setting by untrusted user"
16647 .cindex "untrusted user setting sender"
16648 .cindex "user" "untrusted setting sender"
16649 .cindex "envelope sender"
16650 When an untrusted user submits a message to Exim using the standard input, Exim
16651 normally creates an envelope sender address from the user's login and the
16652 default qualification domain. Data from the &%-f%& option (for setting envelope
16653 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16654 is used) is ignored.
16655
16656 However, untrusted users are permitted to set an empty envelope sender address,
16657 to declare that a message should never generate any bounces. For example:
16658 .code
16659 exim -f '<>' user@domain.example
16660 .endd
16661 .vindex "&$sender_ident$&"
16662 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16663 other envelope sender addresses in a controlled way. When it is set, untrusted
16664 users are allowed to set envelope sender addresses that match any of the
16665 patterns in the list. Like all address lists, the string is expanded. The
16666 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16667 users to setting senders that start with their login ids
16668 followed by a hyphen
16669 by a setting like this:
16670 .code
16671 untrusted_set_sender = ^$sender_ident-
16672 .endd
16673 If you want to allow untrusted users to set envelope sender addresses without
16674 restriction, you can use
16675 .code
16676 untrusted_set_sender = *
16677 .endd
16678 The &%untrusted_set_sender%& option applies to all forms of local input, but
16679 only to the setting of the envelope sender. It does not permit untrusted users
16680 to use the other options which trusted user can use to override message
16681 parameters. Furthermore, it does not stop Exim from removing an existing
16682 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16683 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16684 overriding these actions. The handling of the &'Sender:'& header is also
16685 described in section &<<SECTthesenhea>>&.
16686
16687 The log line for a message's arrival shows the envelope sender following
16688 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16689 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16690 envelope sender address, the user's login is shown in parentheses after the
16691 sender address.
16692
16693
16694 .option uucp_from_pattern main string "see below"
16695 .cindex "&""From""& line"
16696 .cindex "UUCP" "&""From""& line"
16697 Some applications that pass messages to an MTA via a command line interface use
16698 an initial line starting with &"From&~"& to pass the envelope sender. In
16699 particular, this is used by UUCP software. Exim recognizes such a line by means
16700 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16701 matches, the sender address is constructed by expanding the contents of
16702 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16703 default pattern recognizes lines in the following two forms:
16704 .code
16705 From ph10 Fri Jan  5 12:35 GMT 1996
16706 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16707 .endd
16708 The pattern can be seen by running
16709 .code
16710 exim -bP uucp_from_pattern
16711 .endd
16712 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16713 year in the second case. The first word after &"From&~"& is matched in the
16714 regular expression by a parenthesized subpattern. The default value for
16715 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16716 (&"ph10"& in the example above) as the message's sender. See also
16717 &%ignore_fromline_hosts%&.
16718
16719
16720 .option uucp_from_sender main string&!! &`$1`&
16721 See &%uucp_from_pattern%& above.
16722
16723
16724 .option warn_message_file main string unset
16725 .cindex "warning of delay" "customizing the message"
16726 .cindex "customizing" "warning message"
16727 This option defines a template file containing paragraphs of text to be used
16728 for constructing the warning message which is sent by Exim when a message has
16729 been on the queue for a specified amount of time, as specified by
16730 &%delay_warning%&. Details of the file's contents are given in chapter
16731 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16732
16733
16734 .option write_rejectlog main boolean true
16735 .cindex "reject log" "disabling"
16736 If this option is set false, Exim no longer writes anything to the reject log.
16737 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16738 .ecindex IIDconfima
16739 .ecindex IIDmaiconf
16740
16741
16742
16743
16744 . ////////////////////////////////////////////////////////////////////////////
16745 . ////////////////////////////////////////////////////////////////////////////
16746
16747 .chapter "Generic options for routers" "CHAProutergeneric"
16748 .scindex IIDgenoprou1 "options" "generic; for routers"
16749 .scindex IIDgenoprou2 "generic options" "router"
16750 This chapter describes the generic options that apply to all routers.
16751 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16752
16753 For a general description of how a router operates, see sections
16754 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16755 which the preconditions are tested. The order of expansion of the options that
16756 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16757 &%headers_remove%&, &%transport%&.
16758
16759
16760
16761 .option address_data routers string&!! unset
16762 .cindex "router" "data attached to address"
16763 The string is expanded just before the router is run, that is, after all the
16764 precondition tests have succeeded. If the expansion is forced to fail, the
16765 router declines, the value of &%address_data%& remains unchanged, and the
16766 &%more%& option controls what happens next. Other expansion failures cause
16767 delivery of the address to be deferred.
16768
16769 .vindex "&$address_data$&"
16770 When the expansion succeeds, the value is retained with the address, and can be
16771 accessed using the variable &$address_data$& in the current router, subsequent
16772 routers, and the eventual transport.
16773
16774 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16775 that runs a user's filter file, the contents of &$address_data$& are accessible
16776 in the filter. This is not normally a problem, because such data is usually
16777 either not confidential or it &"belongs"& to the current user, but if you do
16778 put confidential data into &$address_data$& you need to remember this point.
16779
16780 Even if the router declines or passes, the value of &$address_data$& remains
16781 with the address, though it can be changed by another &%address_data%& setting
16782 on a subsequent router. If a router generates child addresses, the value of
16783 &$address_data$& propagates to them. This also applies to the special kind of
16784 &"child"& that is generated by a router with the &%unseen%& option.
16785
16786 The idea of &%address_data%& is that you can use it to look up a lot of data
16787 for the address once, and then pick out parts of the data later. For example,
16788 you could use a single LDAP lookup to return a string of the form
16789 .code
16790 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16791 .endd
16792 In the transport you could pick out the mailbox by a setting such as
16793 .code
16794 file = ${extract{mailbox}{$address_data}}
16795 .endd
16796 This makes the configuration file less messy, and also reduces the number of
16797 lookups (though Exim does cache lookups).
16798
16799 .vindex "&$sender_address_data$&"
16800 .vindex "&$address_data$&"
16801 The &%address_data%& facility is also useful as a means of passing information
16802 from one router to another, and from a router to a transport. In addition, if
16803 &$address_data$& is set by a router when verifying a recipient address from an
16804 ACL, it remains available for use in the rest of the ACL statement. After
16805 verifying a sender, the value is transferred to &$sender_address_data$&.
16806
16807
16808
16809 .option address_test routers&!? boolean true
16810 .oindex "&%-bt%&"
16811 .cindex "router" "skipping when address testing"
16812 If this option is set false, the router is skipped when routing is being tested
16813 by means of the &%-bt%& command line option. This can be a convenience when
16814 your first router sends messages to an external scanner, because it saves you
16815 having to set the &"already scanned"& indicator when testing real address
16816 routing.
16817
16818
16819
16820 .option cannot_route_message routers string&!! unset
16821 .cindex "router" "customizing &""cannot route""& message"
16822 .cindex "customizing" "&""cannot route""& message"
16823 This option specifies a text message that is used when an address cannot be
16824 routed because Exim has run out of routers. The default message is
16825 &"Unrouteable address"&. This option is useful only on routers that have
16826 &%more%& set false, or on the very last router in a configuration, because the
16827 value that is used is taken from the last router that is considered. This
16828 includes a router that is skipped because its preconditions are not met, as
16829 well as a router that declines. For example, using the default configuration,
16830 you could put:
16831 .code
16832 cannot_route_message = Remote domain not found in DNS
16833 .endd
16834 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16835 and
16836 .code
16837 cannot_route_message = Unknown local user
16838 .endd
16839 on the final router that checks for local users. If string expansion fails for
16840 this option, the default message is used. Unless the expansion failure was
16841 explicitly forced, a message about the failure is written to the main and panic
16842 logs, in addition to the normal message about the routing failure.
16843
16844
16845 .option caseful_local_part routers boolean false
16846 .cindex "case of local parts"
16847 .cindex "router" "case of local parts"
16848 By default, routers handle the local parts of addresses in a case-insensitive
16849 manner, though the actual case is preserved for transmission with the message.
16850 If you want the case of letters to be significant in a router, you must set
16851 this option true. For individual router options that contain address or local
16852 part lists (for example, &%local_parts%&), case-sensitive matching can be
16853 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16854 more details.
16855
16856 .vindex "&$local_part$&"
16857 .vindex "&$original_local_part$&"
16858 .vindex "&$parent_local_part$&"
16859 The value of the &$local_part$& variable is forced to lower case while a
16860 router is running unless &%caseful_local_part%& is set. When a router assigns
16861 an address to a transport, the value of &$local_part$& when the transport runs
16862 is the same as it was in the router. Similarly, when a router generates child
16863 addresses by aliasing or forwarding, the values of &$original_local_part$&
16864 and &$parent_local_part$& are those that were used by the redirecting router.
16865
16866 This option applies to the processing of an address by a router. When a
16867 recipient address is being processed in an ACL, there is a separate &%control%&
16868 modifier that can be used to specify case-sensitive processing within the ACL
16869 (see section &<<SECTcontrols>>&).
16870
16871
16872
16873 .option check_local_user routers&!? boolean false
16874 .cindex "local user, checking in router"
16875 .cindex "router" "checking for local user"
16876 .cindex "&_/etc/passwd_&"
16877 .vindex "&$home$&"
16878 When this option is true, Exim checks that the local part of the recipient
16879 address (with affixes removed if relevant) is the name of an account on the
16880 local system. The check is done by calling the &[getpwnam()]& function rather
16881 than trying to read &_/etc/passwd_& directly. This means that other methods of
16882 holding password data (such as NIS) are supported. If the local part is a local
16883 user, &$home$& is set from the password data, and can be tested in other
16884 preconditions that are evaluated after this one (the order of evaluation is
16885 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
16886 overridden by &%router_home_directory%&. If the local part is not a local user,
16887 the router is skipped.
16888
16889 If you want to check that the local part is either the name of a local user
16890 or matches something else, you cannot combine &%check_local_user%& with a
16891 setting of &%local_parts%&, because that specifies the logical &'and'& of the
16892 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
16893 setting to achieve this. For example:
16894 .code
16895 local_parts = passwd;$local_part : lsearch;/etc/other/users
16896 .endd
16897 Note, however, that the side effects of &%check_local_user%& (such as setting
16898 up a home directory) do not occur when a &(passwd)& lookup is used in a
16899 &%local_parts%& (or any other) precondition.
16900
16901
16902
16903 .option condition routers&!? string&!! unset
16904 .cindex "router" "customized precondition"
16905 This option specifies a general precondition test that has to succeed for the
16906 router to be called. The &%condition%& option is the last precondition to be
16907 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
16908 result is a forced failure, or an empty string, or one of the strings &"0"& or
16909 &"no"& or &"false"& (checked without regard to the case of the letters), the
16910 router is skipped, and the address is offered to the next one.
16911
16912 If the result is any other value, the router is run (as this is the last
16913 precondition to be evaluated, all the other preconditions must be true).
16914
16915 This option is unusual in that multiple &%condition%& options may be present.
16916 All &%condition%& options must succeed.
16917
16918 The &%condition%& option provides a means of applying custom conditions to the
16919 running of routers. Note that in the case of a simple conditional expansion,
16920 the default expansion values are exactly what is wanted. For example:
16921 .code
16922 condition = ${if >{$message_age}{600}}
16923 .endd
16924 Because of the default behaviour of the string expansion, this is equivalent to
16925 .code
16926 condition = ${if >{$message_age}{600}{true}{}}
16927 .endd
16928
16929 A multiple condition example, which succeeds:
16930 .code
16931 condition = ${if >{$message_age}{600}}
16932 condition = ${if !eq{${lc:$local_part}}{postmaster}}
16933 condition = foobar
16934 .endd
16935
16936 If the expansion fails (other than forced failure) delivery is deferred. Some
16937 of the other precondition options are common special cases that could in fact
16938 be specified using &%condition%&.
16939
16940 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
16941 are far older, and use one set of semantics.  ACLs are newer and when
16942 they were created, the ACL &%condition%& process was given far stricter
16943 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
16944 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
16945 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
16946 Router rules processing behavior.
16947
16948 This is best illustrated in an example:
16949 .code
16950 # If used in an ACL condition will fail with a syntax error, but
16951 # in a router condition any extra characters are treated as a string
16952
16953 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
16954 true {yes} {no}}
16955
16956 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
16957  {yes} {no}}
16958 .endd
16959 In each example above, the &%if%& statement actually ends after
16960 &"{google.com}}"&.  Since no true or false braces were defined, the
16961 default &%if%& behavior is to return a boolean true or a null answer
16962 (which evaluates to false). The rest of the line is then treated as a
16963 string. So the first example resulted in the boolean answer &"true"&
16964 with the string &" {yes} {no}}"& appended to it. The second example
16965 resulted in the null output (indicating false) with the string
16966 &" {yes} {no}}"& appended to it.
16967
16968 In fact you can put excess forward braces in too.  In the router
16969 &%condition%&, Exim's parser only looks for &"{"& symbols when they
16970 mean something, like after a &"$"& or when required as part of a
16971 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
16972 string characters.
16973
16974 Thus, in a Router, the above expansion strings will both always evaluate
16975 true, as the result of expansion is a non-empty string which doesn't
16976 match an explicit false value.  This can be tricky to debug.  By
16977 contrast, in an ACL either of those strings will always result in an
16978 expansion error because the result doesn't look sufficiently boolean.
16979
16980
16981 .option debug_print routers string&!! unset
16982 .cindex "testing" "variables in drivers"
16983 If this option is set and debugging is enabled (see the &%-d%& command line
16984 option) or in address-testing mode (see the &%-bt%& command line option),
16985 the string is expanded and included in the debugging output.
16986 If expansion of the string fails, the error message is written to the debugging
16987 output, and Exim carries on processing.
16988 This option is provided to help with checking out the values of variables and
16989 so on when debugging router configurations. For example, if a &%condition%&
16990 option appears not to be working, &%debug_print%& can be used to output the
16991 variables it references. The output happens after checks for &%domains%&,
16992 &%local_parts%&, and &%check_local_user%& but before any other preconditions
16993 are tested. A newline is added to the text if it does not end with one.
16994 The variable &$router_name$& contains the name of the router.
16995
16996
16997
16998 .option disable_logging routers boolean false
16999 If this option is set true, nothing is logged for any routing errors
17000 or for any deliveries caused by this router. You should not set this option
17001 unless you really, really know what you are doing. See also the generic
17002 transport option of the same name.
17003
17004
17005 .option domains routers&!? "domain list&!!" unset
17006 .cindex "router" "restricting to specific domains"
17007 .vindex "&$domain_data$&"
17008 If this option is set, the router is skipped unless the current domain matches
17009 the list. If the match is achieved by means of a file lookup, the data that the
17010 lookup returned for the domain is placed in &$domain_data$& for use in string
17011 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17012 a list of the order in which preconditions are evaluated.
17013
17014
17015
17016 .option driver routers string unset
17017 This option must always be set. It specifies which of the available routers is
17018 to be used.
17019
17020
17021 .new
17022 .option dsn_lasthop routers boolean false
17023 .cindex "DSN" "success"
17024 .cindex "Delivery Status Notification" "success"
17025 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17026 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17027 instead send a success DSN as if the next hop does not support DSN.
17028 Not effective on redirect routers.
17029 .wen
17030
17031
17032
17033 .option errors_to routers string&!! unset
17034 .cindex "envelope sender"
17035 .cindex "router" "changing address for errors"
17036 If a router successfully handles an address, it may assign the address to a
17037 transport for delivery or it may generate child addresses. In both cases, if
17038 there is a delivery problem during later processing, the resulting bounce
17039 message is sent to the address that results from expanding this string,
17040 provided that the address verifies successfully. The &%errors_to%& option is
17041 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17042
17043 The &%errors_to%& setting associated with an address can be overridden if it
17044 subsequently passes through other routers that have their own &%errors_to%&
17045 settings, or if the message is delivered by a transport with a &%return_path%&
17046 setting.
17047
17048 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17049 the expansion fails to verify, the errors address associated with the incoming
17050 address is used. At top level, this is the envelope sender. A non-forced
17051 expansion failure causes delivery to be deferred.
17052
17053 If an address for which &%errors_to%& has been set ends up being delivered over
17054 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17055 any bounces that are generated by other MTAs on the delivery route are also
17056 sent there. You can set &%errors_to%& to the empty string by either of these
17057 settings:
17058 .code
17059 errors_to =
17060 errors_to = ""
17061 .endd
17062 An expansion item that yields an empty string has the same effect. If you do
17063 this, a locally detected delivery error for addresses processed by this router
17064 no longer gives rise to a bounce message; the error is discarded. If the
17065 address is delivered to a remote host, the return path is set to &`<>`&, unless
17066 overridden by the &%return_path%& option on the transport.
17067
17068 .vindex "&$address_data$&"
17069 If for some reason you want to discard local errors, but use a non-empty
17070 MAIL command for remote delivery, you can preserve the original return
17071 path in &$address_data$& in the router, and reinstate it in the transport by
17072 setting &%return_path%&.
17073
17074 The most common use of &%errors_to%& is to direct mailing list bounces to the
17075 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17076 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17077
17078
17079
17080 .option expn routers&!? boolean true
17081 .cindex "address" "testing"
17082 .cindex "testing" "addresses"
17083 .cindex "EXPN" "router skipping"
17084 .cindex "router" "skipping for EXPN"
17085 If this option is turned off, the router is skipped when testing an address
17086 as a result of processing an SMTP EXPN command. You might, for example,
17087 want to turn it off on a router for users' &_.forward_& files, while leaving it
17088 on for the system alias file.
17089 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17090 are evaluated.
17091
17092 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17093 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17094 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17095
17096
17097
17098 .option fail_verify routers boolean false
17099 .cindex "router" "forcing verification failure"
17100 Setting this option has the effect of setting both &%fail_verify_sender%& and
17101 &%fail_verify_recipient%& to the same value.
17102
17103
17104
17105 .option fail_verify_recipient routers boolean false
17106 If this option is true and an address is accepted by this router when
17107 verifying a recipient, verification fails.
17108
17109
17110
17111 .option fail_verify_sender routers boolean false
17112 If this option is true and an address is accepted by this router when
17113 verifying a sender, verification fails.
17114
17115
17116
17117 .option fallback_hosts routers "string list" unset
17118 .cindex "router" "fallback hosts"
17119 .cindex "fallback" "hosts specified on router"
17120 String expansion is not applied to this option. The argument must be a
17121 colon-separated list of host names or IP addresses. The list separator can be
17122 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17123 each name or address. In fact, the format of each item is exactly the same as
17124 defined for the list of hosts in a &(manualroute)& router (see section
17125 &<<SECTformatonehostitem>>&).
17126
17127 If a router queues an address for a remote transport, this host list is
17128 associated with the address, and used instead of the transport's fallback host
17129 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17130 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17131 transport for further details.
17132
17133
17134 .option group routers string&!! "see below"
17135 .cindex "gid (group id)" "local delivery"
17136 .cindex "local transports" "uid and gid"
17137 .cindex "transport" "local"
17138 .cindex "router" "setting group"
17139 When a router queues an address for a transport, and the transport does not
17140 specify a group, the group given here is used when running the delivery
17141 process.
17142 The group may be specified numerically or by name. If expansion fails, the
17143 error is logged and delivery is deferred.
17144 The default is unset, unless &%check_local_user%& is set, when the default
17145 is taken from the password information. See also &%initgroups%& and &%user%&
17146 and the discussion in chapter &<<CHAPenvironment>>&.
17147
17148
17149
17150 .option headers_add routers list&!! unset
17151 .cindex "header lines" "adding"
17152 .cindex "router" "adding header lines"
17153 This option specifies a list of text headers, newline-separated,
17154 that is associated with any addresses that are accepted by the router.
17155 Each item is separately expanded, at routing time.  However, this
17156 option has no effect when an address is just being verified. The way in which
17157 the text is used to add header lines at transport time is described in section
17158 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17159 message is in the process of being transported. This means that references to
17160 header lines in string expansions in the transport's configuration do not
17161 &"see"& the added header lines.
17162
17163 The &%headers_add%& option is expanded after &%errors_to%&, but before
17164 &%headers_remove%& and &%transport%&. If an item is empty, or if
17165 an item expansion is forced to fail, the item has no effect. Other expansion
17166 failures are treated as configuration errors.
17167
17168 Unlike most options, &%headers_add%& can be specified multiple times
17169 for a router; all listed headers are added.
17170
17171 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17172 router that has the &%one_time%& option set.
17173
17174 .cindex "duplicate addresses"
17175 .oindex "&%unseen%&"
17176 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17177 additions are deleted when the address is passed on to subsequent routers.
17178 For a &%redirect%& router, if a generated address is the same as the incoming
17179 address, this can lead to duplicate addresses with different header
17180 modifications. Exim does not do duplicate deliveries (except, in certain
17181 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17182 which of the duplicates is discarded, so this ambiguous situation should be
17183 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17184
17185
17186
17187 .option headers_remove routers list&!! unset
17188 .cindex "header lines" "removing"
17189 .cindex "router" "removing header lines"
17190 This option specifies a list of text headers, colon-separated,
17191 that is associated with any addresses that are accepted by the router.
17192 Each item is separately expanded, at routing time.  However, this
17193 option has no effect when an address is just being verified. The way in which
17194 the text is used to remove header lines at transport time is described in
17195 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17196 the message is in the process of being transported. This means that references
17197 to header lines in string expansions in the transport's configuration still
17198 &"see"& the original header lines.
17199
17200 The &%headers_remove%& option is expanded after &%errors_to%& and
17201 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17202 the item has no effect. Other expansion failures are treated as configuration
17203 errors.
17204
17205 Unlike most options, &%headers_remove%& can be specified multiple times
17206 for a router; all listed headers are removed.
17207
17208 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17209 router that has the &%one_time%& option set.
17210
17211 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17212 removal requests are deleted when the address is passed on to subsequent
17213 routers, and this can lead to problems with duplicates -- see the similar
17214 warning for &%headers_add%& above.
17215
17216
17217 .option ignore_target_hosts routers "host list&!!" unset
17218 .cindex "IP address" "discarding"
17219 .cindex "router" "discarding IP addresses"
17220 Although this option is a host list, it should normally contain IP address
17221 entries rather than names. If any host that is looked up by the router has an
17222 IP address that matches an item in this list, Exim behaves as if that IP
17223 address did not exist. This option allows you to cope with rogue DNS entries
17224 like
17225 .code
17226 remote.domain.example.  A  127.0.0.1
17227 .endd
17228 by setting
17229 .code
17230 ignore_target_hosts = 127.0.0.1
17231 .endd
17232 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17233 discarded in this way, the router declines. In a conventional configuration, an
17234 attempt to mail to such a domain would normally provoke the &"unrouteable
17235 domain"& error, and an attempt to verify an address in the domain would fail.
17236 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17237 router declines if presented with one of the listed addresses.
17238
17239 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17240 means of the first or the second of the following settings, respectively:
17241 .code
17242 ignore_target_hosts = 0.0.0.0/0
17243 ignore_target_hosts = <; 0::0/0
17244 .endd
17245 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17246 in the second line matches all IPv6 addresses.
17247
17248 This option may also be useful for ignoring link-local and site-local IPv6
17249 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17250 is expanded before use as a list, it is possible to make it dependent on the
17251 domain that is being routed.
17252
17253 .vindex "&$host_address$&"
17254 During its expansion, &$host_address$& is set to the IP address that is being
17255 checked.
17256
17257 .option initgroups routers boolean false
17258 .cindex "additional groups"
17259 .cindex "groups" "additional"
17260 .cindex "local transports" "uid and gid"
17261 .cindex "transport" "local"
17262 If the router queues an address for a transport, and this option is true, and
17263 the uid supplied by the router is not overridden by the transport, the
17264 &[initgroups()]& function is called when running the transport to ensure that
17265 any additional groups associated with the uid are set up. See also &%group%&
17266 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17267
17268
17269
17270 .option local_part_prefix routers&!? "string list" unset
17271 .cindex "router" "prefix for local part"
17272 .cindex "prefix" "for local part, used in router"
17273 If this option is set, the router is skipped unless the local part starts with
17274 one of the given strings, or &%local_part_prefix_optional%& is true. See
17275 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17276 evaluated.
17277
17278 The list is scanned from left to right, and the first prefix that matches is
17279 used. A limited form of wildcard is available; if the prefix begins with an
17280 asterisk, it matches the longest possible sequence of arbitrary characters at
17281 the start of the local part. An asterisk should therefore always be followed by
17282 some character that does not occur in normal local parts.
17283 .cindex "multiple mailboxes"
17284 .cindex "mailbox" "multiple"
17285 Wildcarding can be used to set up multiple user mailboxes, as described in
17286 section &<<SECTmulbox>>&.
17287
17288 .vindex "&$local_part$&"
17289 .vindex "&$local_part_prefix$&"
17290 During the testing of the &%local_parts%& option, and while the router is
17291 running, the prefix is removed from the local part, and is available in the
17292 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17293 the router accepts the address, this remains true during subsequent delivery by
17294 a transport. In particular, the local part that is transmitted in the RCPT
17295 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17296 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17297 the relevant transport.
17298
17299 When an address is being verified, &%local_part_prefix%& affects only the
17300 behaviour of the router. If the callout feature of verification is in use, this
17301 means that the full address, including the prefix, will be used during the
17302 callout.
17303
17304 The prefix facility is commonly used to handle local parts of the form
17305 &%owner-something%&. Another common use is to support local parts of the form
17306 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17307 to tell a user their forwarding is broken &-- by placing a router like this one
17308 immediately before the router that handles &_.forward_& files:
17309 .code
17310 real_localuser:
17311   driver = accept
17312   local_part_prefix = real-
17313   check_local_user
17314   transport = local_delivery
17315 .endd
17316 For security, it would probably be a good idea to restrict the use of this
17317 router to locally-generated messages, using a condition such as this:
17318 .code
17319   condition = ${if match {$sender_host_address}\
17320                          {\N^(|127\.0\.0\.1)$\N}}
17321 .endd
17322
17323 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17324 both conditions must be met if not optional. Care must be taken if wildcards
17325 are used in both a prefix and a suffix on the same router. Different
17326 separator characters must be used to avoid ambiguity.
17327
17328
17329 .option local_part_prefix_optional routers boolean false
17330 See &%local_part_prefix%& above.
17331
17332
17333
17334 .option local_part_suffix routers&!? "string list" unset
17335 .cindex "router" "suffix for local part"
17336 .cindex "suffix for local part" "used in router"
17337 This option operates in the same way as &%local_part_prefix%&, except that the
17338 local part must end (rather than start) with the given string, the
17339 &%local_part_suffix_optional%& option determines whether the suffix is
17340 mandatory, and the wildcard * character, if present, must be the last
17341 character of the suffix. This option facility is commonly used to handle local
17342 parts of the form &%something-request%& and multiple user mailboxes of the form
17343 &%username-foo%&.
17344
17345
17346 .option local_part_suffix_optional routers boolean false
17347 See &%local_part_suffix%& above.
17348
17349
17350
17351 .option local_parts routers&!? "local part list&!!" unset
17352 .cindex "router" "restricting to specific local parts"
17353 .cindex "local part" "checking in router"
17354 The router is run only if the local part of the address matches the list.
17355 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17356 are evaluated, and
17357 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17358 string is expanded, it is possible to make it depend on the domain, for
17359 example:
17360 .code
17361 local_parts = dbm;/usr/local/specials/$domain
17362 .endd
17363 .vindex "&$local_part_data$&"
17364 If the match is achieved by a lookup, the data that the lookup returned
17365 for the local part is placed in the variable &$local_part_data$& for use in
17366 expansions of the router's private options. You might use this option, for
17367 example, if you have a large number of local virtual domains, and you want to
17368 send all postmaster mail to the same place without having to set up an alias in
17369 each virtual domain:
17370 .code
17371 postmaster:
17372   driver = redirect
17373   local_parts = postmaster
17374   data = postmaster@real.domain.example
17375 .endd
17376
17377
17378 .option log_as_local routers boolean "see below"
17379 .cindex "log" "delivery line"
17380 .cindex "delivery" "log line format"
17381 Exim has two logging styles for delivery, the idea being to make local
17382 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17383 recipient address is given just as the local part, without a domain. The use of
17384 this style is controlled by this option. It defaults to true for the &(accept)&
17385 router, and false for all the others. This option applies only when a
17386 router assigns an address to a transport. It has no effect on routers that
17387 redirect addresses.
17388
17389
17390
17391 .option more routers boolean&!! true
17392 The result of string expansion for this option must be a valid boolean value,
17393 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17394 result causes an error, and delivery is deferred. If the expansion is forced to
17395 fail, the default value for the option (true) is used. Other failures cause
17396 delivery to be deferred.
17397
17398 If this option is set false, and the router declines to handle the address, no
17399 further routers are tried, routing fails, and the address is bounced.
17400 .oindex "&%self%&"
17401 However, if the router explicitly passes an address to the following router by
17402 means of the setting
17403 .code
17404 self = pass
17405 .endd
17406 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17407 does not affect the behaviour if one of the precondition tests fails. In that
17408 case, the address is always passed to the next router.
17409
17410 Note that &%address_data%& is not considered to be a precondition. If its
17411 expansion is forced to fail, the router declines, and the value of &%more%&
17412 controls what happens next.
17413
17414
17415 .option pass_on_timeout routers boolean false
17416 .cindex "timeout" "of router"
17417 .cindex "router" "timeout"
17418 If a router times out during a host lookup, it normally causes deferral of the
17419 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17420 router, overriding &%no_more%&. This may be helpful for systems that are
17421 intermittently connected to the Internet, or those that want to pass to a smart
17422 host any messages that cannot immediately be delivered.
17423
17424 There are occasional other temporary errors that can occur while doing DNS
17425 lookups. They are treated in the same way as a timeout, and this option
17426 applies to all of them.
17427
17428
17429
17430 .option pass_router routers string unset
17431 .cindex "router" "go to after &""pass""&"
17432 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17433 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17434 routing to continue, and overriding a false setting of &%more%&. When one of
17435 these routers returns &"pass"&, the address is normally handed on to the next
17436 router in sequence. This can be changed by setting &%pass_router%& to the name
17437 of another router. However (unlike &%redirect_router%&) the named router must
17438 be below the current router, to avoid loops. Note that this option applies only
17439 to the special case of &"pass"&. It does not apply when a router returns
17440 &"decline"& because it cannot handle an address.
17441
17442
17443
17444 .option redirect_router routers string unset
17445 .cindex "router" "start at after redirection"
17446 Sometimes an administrator knows that it is pointless to reprocess addresses
17447 generated from alias or forward files with the same router again. For
17448 example, if an alias file translates real names into login ids there is no
17449 point searching the alias file a second time, especially if it is a large file.
17450
17451 The &%redirect_router%& option can be set to the name of any router instance.
17452 It causes the routing of any generated addresses to start at the named router
17453 instead of at the first router. This option has no effect if the router in
17454 which it is set does not generate new addresses.
17455
17456
17457
17458 .option require_files routers&!? "string list&!!" unset
17459 .cindex "file" "requiring for router"
17460 .cindex "router" "requiring file existence"
17461 This option provides a general mechanism for predicating the running of a
17462 router on the existence or non-existence of certain files or directories.
17463 Before running a router, as one of its precondition tests, Exim works its way
17464 through the &%require_files%& list, expanding each item separately.
17465
17466 Because the list is split before expansion, any colons in expansion items must
17467 be doubled, or the facility for using a different list separator must be used.
17468 If any expansion is forced to fail, the item is ignored. Other expansion
17469 failures cause routing of the address to be deferred.
17470
17471 If any expanded string is empty, it is ignored. Otherwise, except as described
17472 below, each string must be a fully qualified file path, optionally preceded by
17473 &"!"&. The paths are passed to the &[stat()]& function to test for the
17474 existence of the files or directories. The router is skipped if any paths not
17475 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17476
17477 .cindex "NFS"
17478 If &[stat()]& cannot determine whether a file exists or not, delivery of
17479 the message is deferred. This can happen when NFS-mounted filesystems are
17480 unavailable.
17481
17482 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17483 options, so you cannot use it to check for the existence of a file in which to
17484 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17485 full list of the order in which preconditions are evaluated.) However, as
17486 these options are all expanded, you can use the &%exists%& expansion condition
17487 to make such tests. The &%require_files%& option is intended for checking files
17488 that the router may be going to use internally, or which are needed by a
17489 transport (for example &_.procmailrc_&).
17490
17491 During delivery, the &[stat()]& function is run as root, but there is a
17492 facility for some checking of the accessibility of a file by another user.
17493 This is not a proper permissions check, but just a &"rough"& check that
17494 operates as follows:
17495
17496 If an item in a &%require_files%& list does not contain any forward slash
17497 characters, it is taken to be the user (and optional group, separated by a
17498 comma) to be checked for subsequent files in the list. If no group is specified
17499 but the user is specified symbolically, the gid associated with the uid is
17500 used. For example:
17501 .code
17502 require_files = mail:/some/file
17503 require_files = $local_part:$home/.procmailrc
17504 .endd
17505 If a user or group name in a &%require_files%& list does not exist, the
17506 &%require_files%& condition fails.
17507
17508 Exim performs the check by scanning along the components of the file path, and
17509 checking the access for the given uid and gid. It checks for &"x"& access on
17510 directories, and &"r"& access on the final file. Note that this means that file
17511 access control lists, if the operating system has them, are ignored.
17512
17513 &*Warning 1*&: When the router is being run to verify addresses for an
17514 incoming SMTP message, Exim is not running as root, but under its own uid. This
17515 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17516 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17517 user is not permitted to read one of the directories on the file's path.
17518
17519 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17520 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17521 without root access. In this case, if a check for access by a particular user
17522 is requested, Exim creates a subprocess that runs as that user, and tries the
17523 check again in that process.
17524
17525 The default action for handling an unresolved EACCES is to consider it to
17526 be caused by a configuration error, and routing is deferred because the
17527 existence or non-existence of the file cannot be determined. However, in some
17528 circumstances it may be desirable to treat this condition as if the file did
17529 not exist. If the file name (or the exclamation mark that precedes the file
17530 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17531 as if the file did not exist. For example:
17532 .code
17533 require_files = +/some/file
17534 .endd
17535 If the router is not an essential part of verification (for example, it
17536 handles users' &_.forward_& files), another solution is to set the &%verify%&
17537 option false so that the router is skipped when verifying.
17538
17539
17540
17541 .option retry_use_local_part routers boolean "see below"
17542 .cindex "hints database" "retry keys"
17543 .cindex "local part" "in retry keys"
17544 When a delivery suffers a temporary routing failure, a retry record is created
17545 in Exim's hints database. For addresses whose routing depends only on the
17546 domain, the key for the retry record should not involve the local part, but for
17547 other addresses, both the domain and the local part should be included.
17548 Usually, remote routing is of the former kind, and local routing is of the
17549 latter kind.
17550
17551 This option controls whether the local part is used to form the key for retry
17552 hints for addresses that suffer temporary errors while being handled by this
17553 router. The default value is true for any router that has &%check_local_user%&
17554 set, and false otherwise. Note that this option does not apply to hints keys
17555 for transport delays; they are controlled by a generic transport option of the
17556 same name.
17557
17558 The setting of &%retry_use_local_part%& applies only to the router on which it
17559 appears. If the router generates child addresses, they are routed
17560 independently; this setting does not become attached to them.
17561
17562
17563
17564 .option router_home_directory routers string&!! unset
17565 .cindex "router" "home directory for"
17566 .cindex "home directory" "for router"
17567 .vindex "&$home$&"
17568 This option sets a home directory for use while the router is running. (Compare
17569 &%transport_home_directory%&, which sets a home directory for later
17570 transporting.) In particular, if used on a &(redirect)& router, this option
17571 sets a value for &$home$& while a filter is running. The value is expanded;
17572 forced expansion failure causes the option to be ignored &-- other failures
17573 cause the router to defer.
17574
17575 Expansion of &%router_home_directory%& happens immediately after the
17576 &%check_local_user%& test (if configured), before any further expansions take
17577 place.
17578 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17579 are evaluated.)
17580 While the router is running, &%router_home_directory%& overrides the value of
17581 &$home$& that came from &%check_local_user%&.
17582
17583 When a router accepts an address and assigns it to a local transport (including
17584 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17585 delivery), the home directory setting for the transport is taken from the first
17586 of these values that is set:
17587
17588 .ilist
17589 The &%home_directory%& option on the transport;
17590 .next
17591 The &%transport_home_directory%& option on the router;
17592 .next
17593 The password data if &%check_local_user%& is set on the router;
17594 .next
17595 The &%router_home_directory%& option on the router.
17596 .endlist
17597
17598 In other words, &%router_home_directory%& overrides the password data for the
17599 router, but not for the transport.
17600
17601
17602
17603 .option self routers string freeze
17604 .cindex "MX record" "pointing to local host"
17605 .cindex "local host" "MX pointing to"
17606 This option applies to those routers that use a recipient address to find a
17607 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17608 and &(manualroute)& routers.
17609 Certain configurations of the &(queryprogram)& router can also specify a list
17610 of remote hosts.
17611 Usually such routers are configured to send the message to a remote host via an
17612 &(smtp)& transport. The &%self%& option specifies what happens when the first
17613 host on the list turns out to be the local host.
17614 The way in which Exim checks for the local host is described in section
17615 &<<SECTreclocipadd>>&.
17616
17617 Normally this situation indicates either an error in Exim's configuration (for
17618 example, the router should be configured not to process this domain), or an
17619 error in the DNS (for example, the MX should not point to this host). For this
17620 reason, the default action is to log the incident, defer the address, and
17621 freeze the message. The following alternatives are provided for use in special
17622 cases:
17623
17624 .vlist
17625 .vitem &%defer%&
17626 Delivery of the message is tried again later, but the message is not frozen.
17627
17628 .vitem "&%reroute%&: <&'domain'&>"
17629 The domain is changed to the given domain, and the address is passed back to
17630 be reprocessed by the routers. No rewriting of headers takes place. This
17631 behaviour is essentially a redirection.
17632
17633 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17634 The domain is changed to the given domain, and the address is passed back to be
17635 reprocessed by the routers. Any headers that contain the original domain are
17636 rewritten.
17637
17638 .vitem &%pass%&
17639 .oindex "&%more%&"
17640 .vindex "&$self_hostname$&"
17641 The router passes the address to the next router, or to the router named in the
17642 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17643 subsequent routing and delivery, the variable &$self_hostname$& contains the
17644 name of the local host that the router encountered. This can be used to
17645 distinguish between different cases for hosts with multiple names. The
17646 combination
17647 .code
17648 self = pass
17649 no_more
17650 .endd
17651 ensures that only those addresses that routed to the local host are passed on.
17652 Without &%no_more%&, addresses that were declined for other reasons would also
17653 be passed to the next router.
17654
17655 .vitem &%fail%&
17656 Delivery fails and an error report is generated.
17657
17658 .vitem &%send%&
17659 .cindex "local host" "sending to"
17660 The anomaly is ignored and the address is queued for the transport. This
17661 setting should be used with extreme caution. For an &(smtp)& transport, it
17662 makes sense only in cases where the program that is listening on the SMTP port
17663 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17664 different configuration file that handles the domain in another way.
17665 .endlist
17666
17667
17668
17669 .option senders routers&!? "address list&!!" unset
17670 .cindex "router" "checking senders"
17671 If this option is set, the router is skipped unless the message's sender
17672 address matches something on the list.
17673 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17674 are evaluated.
17675
17676 There are issues concerning verification when the running of routers is
17677 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17678 setting, it sets the sender to the null string. When using the &%-bt%& option
17679 to check a configuration file, it is necessary also to use the &%-f%& option to
17680 set an appropriate sender. For incoming mail, the sender is unset when
17681 verifying the sender, but is available when verifying any recipients. If the
17682 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17683 matters.
17684
17685
17686 .option translate_ip_address routers string&!! unset
17687 .cindex "IP address" "translating"
17688 .cindex "packet radio"
17689 .cindex "router" "IP address translation"
17690 There exist some rare networking situations (for example, packet radio) where
17691 it is helpful to be able to translate IP addresses generated by normal routing
17692 mechanisms into other IP addresses, thus performing a kind of manual IP
17693 routing. This should be done only if the normal IP routing of the TCP/IP stack
17694 is inadequate or broken. Because this is an extremely uncommon requirement, the
17695 code to support this option is not included in the Exim binary unless
17696 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17697
17698 .vindex "&$host_address$&"
17699 The &%translate_ip_address%& string is expanded for every IP address generated
17700 by the router, with the generated address set in &$host_address$&. If the
17701 expansion is forced to fail, no action is taken.
17702 For any other expansion error, delivery of the message is deferred.
17703 If the result of the expansion is an IP address, that replaces the original
17704 address; otherwise the result is assumed to be a host name &-- this is looked
17705 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17706 produce one or more replacement IP addresses. For example, to subvert all IP
17707 addresses in some specific networks, this could be added to a router:
17708 .code
17709 translate_ip_address = \
17710   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17711     {$value}fail}}
17712 .endd
17713 The file would contain lines like
17714 .code
17715 10.2.3.128/26    some.host
17716 10.8.4.34/26     10.44.8.15
17717 .endd
17718 You should not make use of this facility unless you really understand what you
17719 are doing.
17720
17721
17722
17723 .option transport routers string&!! unset
17724 This option specifies the transport to be used when a router accepts an address
17725 and sets it up for delivery. A transport is never needed if a router is used
17726 only for verification. The value of the option is expanded at routing time,
17727 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17728 and result must be the name of one of the configured transports. If it is not,
17729 delivery is deferred.
17730
17731 The &%transport%& option is not used by the &(redirect)& router, but it does
17732 have some private options that set up transports for pipe and file deliveries
17733 (see chapter &<<CHAPredirect>>&).
17734
17735
17736
17737 .option transport_current_directory routers string&!! unset
17738 .cindex "current directory for local transport"
17739 This option associates a current directory with any address that is routed
17740 to a local transport. This can happen either because a transport is
17741 explicitly configured for the router, or because it generates a delivery to a
17742 file or a pipe. During the delivery process (that is, at transport time), this
17743 option string is expanded and is set as the current directory, unless
17744 overridden by a setting on the transport.
17745 If the expansion fails for any reason, including forced failure, an error is
17746 logged, and delivery is deferred.
17747 See chapter &<<CHAPenvironment>>& for details of the local delivery
17748 environment.
17749
17750
17751
17752
17753 .option transport_home_directory routers string&!! "see below"
17754 .cindex "home directory" "for local transport"
17755 This option associates a home directory with any address that is routed to a
17756 local transport. This can happen either because a transport is explicitly
17757 configured for the router, or because it generates a delivery to a file or a
17758 pipe. During the delivery process (that is, at transport time), the option
17759 string is expanded and is set as the home directory, unless overridden by a
17760 setting of &%home_directory%& on the transport.
17761 If the expansion fails for any reason, including forced failure, an error is
17762 logged, and delivery is deferred.
17763
17764 If the transport does not specify a home directory, and
17765 &%transport_home_directory%& is not set for the router, the home directory for
17766 the transport is taken from the password data if &%check_local_user%& is set for
17767 the router. Otherwise it is taken from &%router_home_directory%& if that option
17768 is set; if not, no home directory is set for the transport.
17769
17770 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17771 environment.
17772
17773
17774
17775
17776 .option unseen routers boolean&!! false
17777 .cindex "router" "carrying on after success"
17778 The result of string expansion for this option must be a valid boolean value,
17779 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17780 result causes an error, and delivery is deferred. If the expansion is forced to
17781 fail, the default value for the option (false) is used. Other failures cause
17782 delivery to be deferred.
17783
17784 When this option is set true, routing does not cease if the router accepts the
17785 address. Instead, a copy of the incoming address is passed to the next router,
17786 overriding a false setting of &%more%&. There is little point in setting
17787 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17788 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17789 sometimes true and sometimes false).
17790
17791 .cindex "copy of message (&%unseen%& option)"
17792 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17793 qualifier in filter files. It can be used to cause copies of messages to be
17794 delivered to some other destination, while also carrying out a normal delivery.
17795 In effect, the current address is made into a &"parent"& that has two children
17796 &-- one that is delivered as specified by this router, and a clone that goes on
17797 to be routed further. For this reason, &%unseen%& may not be combined with the
17798 &%one_time%& option in a &(redirect)& router.
17799
17800 &*Warning*&: Header lines added to the address (or specified for removal) by
17801 this router or by previous routers affect the &"unseen"& copy of the message
17802 only. The clone that continues to be processed by further routers starts with
17803 no added headers and none specified for removal. For a &%redirect%& router, if
17804 a generated address is the same as the incoming address, this can lead to
17805 duplicate addresses with different header modifications. Exim does not do
17806 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17807 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17808 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17809 &%redirect%& router may be of help.
17810
17811 Unlike the handling of header modifications, any data that was set by the
17812 &%address_data%& option in the current or previous routers &'is'& passed on to
17813 subsequent routers.
17814
17815
17816 .option user routers string&!! "see below"
17817 .cindex "uid (user id)" "local delivery"
17818 .cindex "local transports" "uid and gid"
17819 .cindex "transport" "local"
17820 .cindex "router" "user for filter processing"
17821 .cindex "filter" "user for processing"
17822 When a router queues an address for a transport, and the transport does not
17823 specify a user, the user given here is used when running the delivery process.
17824 The user may be specified numerically or by name. If expansion fails, the
17825 error is logged and delivery is deferred.
17826 This user is also used by the &(redirect)& router when running a filter file.
17827 The default is unset, except when &%check_local_user%& is set. In this case,
17828 the default is taken from the password information. If the user is specified as
17829 a name, and &%group%& is not set, the group associated with the user is used.
17830 See also &%initgroups%& and &%group%& and the discussion in chapter
17831 &<<CHAPenvironment>>&.
17832
17833
17834
17835 .option verify routers&!? boolean true
17836 Setting this option has the effect of setting &%verify_sender%& and
17837 &%verify_recipient%& to the same value.
17838
17839
17840 .option verify_only routers&!? boolean false
17841 .cindex "EXPN" "with &%verify_only%&"
17842 .oindex "&%-bv%&"
17843 .cindex "router" "used only when verifying"
17844 If this option is set, the router is used only when verifying an address,
17845 delivering in cutthrough mode or
17846 testing with the &%-bv%& option, not when actually doing a delivery, testing
17847 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
17848 restricted to verifying only senders or recipients by means of
17849 &%verify_sender%& and &%verify_recipient%&.
17850
17851 &*Warning*&: When the router is being run to verify addresses for an incoming
17852 SMTP message, Exim is not running as root, but under its own uid. If the router
17853 accesses any files, you need to make sure that they are accessible to the Exim
17854 user or group.
17855
17856
17857 .option verify_recipient routers&!? boolean true
17858 If this option is false, the router is skipped when verifying recipient
17859 addresses,
17860 delivering in cutthrough mode
17861 or testing recipient verification using &%-bv%&.
17862 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17863 are evaluated.
17864 See also the &$verify_mode$& variable.
17865
17866
17867 .option verify_sender routers&!? boolean true
17868 If this option is false, the router is skipped when verifying sender addresses
17869 or testing sender verification using &%-bvs%&.
17870 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17871 are evaluated.
17872 See also the &$verify_mode$& variable.
17873 .ecindex IIDgenoprou1
17874 .ecindex IIDgenoprou2
17875
17876
17877
17878
17879
17880
17881 . ////////////////////////////////////////////////////////////////////////////
17882 . ////////////////////////////////////////////////////////////////////////////
17883
17884 .chapter "The accept router" "CHID4"
17885 .cindex "&(accept)& router"
17886 .cindex "routers" "&(accept)&"
17887 The &(accept)& router has no private options of its own. Unless it is being
17888 used purely for verification (see &%verify_only%&) a transport is required to
17889 be defined by the generic &%transport%& option. If the preconditions that are
17890 specified by generic options are met, the router accepts the address and queues
17891 it for the given transport. The most common use of this router is for setting
17892 up deliveries to local mailboxes. For example:
17893 .code
17894 localusers:
17895   driver = accept
17896   domains = mydomain.example
17897   check_local_user
17898   transport = local_delivery
17899 .endd
17900 The &%domains%& condition in this example checks the domain of the address, and
17901 &%check_local_user%& checks that the local part is the login of a local user.
17902 When both preconditions are met, the &(accept)& router runs, and queues the
17903 address for the &(local_delivery)& transport.
17904
17905
17906
17907
17908
17909
17910 . ////////////////////////////////////////////////////////////////////////////
17911 . ////////////////////////////////////////////////////////////////////////////
17912
17913 .chapter "The dnslookup router" "CHAPdnslookup"
17914 .scindex IIDdnsrou1 "&(dnslookup)& router"
17915 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
17916 The &(dnslookup)& router looks up the hosts that handle mail for the
17917 recipient's domain in the DNS. A transport must always be set for this router,
17918 unless &%verify_only%& is set.
17919
17920 If SRV support is configured (see &%check_srv%& below), Exim first searches for
17921 SRV records. If none are found, or if SRV support is not configured,
17922 MX records are looked up. If no MX records exist, address records are sought.
17923 However, &%mx_domains%& can be set to disable the direct use of address
17924 records.
17925
17926 MX records of equal priority are sorted by Exim into a random order. Exim then
17927 looks for address records for the host names obtained from MX or SRV records.
17928 When a host has more than one IP address, they are sorted into a random order,
17929 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
17930 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
17931 generic option, the router declines.
17932
17933 Unless they have the highest priority (lowest MX value), MX records that point
17934 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
17935 are discarded, together with any other MX records of equal or lower priority.
17936
17937 .cindex "MX record" "pointing to local host"
17938 .cindex "local host" "MX pointing to"
17939 .oindex "&%self%&" "in &(dnslookup)& router"
17940 If the host pointed to by the highest priority MX record, or looked up as an
17941 address record, is the local host, or matches &%hosts_treat_as_local%&, what
17942 happens is controlled by the generic &%self%& option.
17943
17944
17945 .section "Problems with DNS lookups" "SECTprowitdnsloo"
17946 There have been problems with DNS servers when SRV records are looked up.
17947 Some mis-behaving servers return a DNS error or timeout when a non-existent
17948 SRV record is sought. Similar problems have in the past been reported for
17949 MX records. The global &%dns_again_means_nonexist%& option can help with this
17950 problem, but it is heavy-handed because it is a global option.
17951
17952 For this reason, there are two options, &%srv_fail_domains%& and
17953 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
17954 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
17955 an attempt to look up an SRV or MX record causes one of these results, and the
17956 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
17957 such record"&. In the case of an SRV lookup, this means that the router
17958 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
17959 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
17960 case routing fails.
17961
17962
17963 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
17964 .cindex "&(dnslookup)& router" "declines"
17965 There are a few cases where a &(dnslookup)& router will decline to accept
17966 an address; if such a router is expected to handle "all remaining non-local
17967 domains", then it is important to set &%no_more%&.
17968
17969 Reasons for a &(dnslookup)& router to decline currently include:
17970 .ilist
17971 The domain does not exist in DNS
17972 .next
17973 The domain exists but the MX record's host part is just "."; this is a common
17974 convention (borrowed from SRV) used to indicate that there is no such service
17975 for this domain and to not fall back to trying A/AAAA records.
17976 .next
17977 Ditto, but for SRV records, when &%check_srv%& is set on this router.
17978 .next
17979 MX record points to a non-existent host.
17980 .next
17981 MX record points to an IP address and the main section option
17982 &%allow_mx_to_ip%& is not set.
17983 .next
17984 MX records exist and point to valid hosts, but all hosts resolve only to
17985 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
17986 .next
17987 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
17988 &%dns_check_names_pattern%& for handling one variant of this)
17989 .next
17990 &%check_secondary_mx%& is set on this router but the local host can
17991 not be found in the MX records (see below)
17992 .endlist
17993
17994
17995
17996
17997 .section "Private options for dnslookup" "SECID118"
17998 .cindex "options" "&(dnslookup)& router"
17999 The private options for the &(dnslookup)& router are as follows:
18000
18001 .option check_secondary_mx dnslookup boolean false
18002 .cindex "MX record" "checking for secondary"
18003 If this option is set, the router declines unless the local host is found in
18004 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18005 process domains for which the local host is a secondary mail exchanger
18006 differently to other domains. The way in which Exim decides whether a host is
18007 the local host is described in section &<<SECTreclocipadd>>&.
18008
18009
18010 .option check_srv dnslookup string&!! unset
18011 .cindex "SRV record" "enabling use of"
18012 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18013 addition to MX and address records. The support is disabled by default. To
18014 enable SRV support, set the &%check_srv%& option to the name of the service
18015 required. For example,
18016 .code
18017 check_srv = smtp
18018 .endd
18019 looks for SRV records that refer to the normal smtp service. The option is
18020 expanded, so the service name can vary from message to message or address
18021 to address. This might be helpful if SRV records are being used for a
18022 submission service. If the expansion is forced to fail, the &%check_srv%&
18023 option is ignored, and the router proceeds to look for MX records in the
18024 normal way.
18025
18026 When the expansion succeeds, the router searches first for SRV records for
18027 the given service (it assumes TCP protocol). A single SRV record with a
18028 host name that consists of just a single dot indicates &"no such service for
18029 this domain"&; if this is encountered, the router declines. If other kinds of
18030 SRV record are found, they are used to construct a host list for delivery
18031 according to the rules of RFC 2782. MX records are not sought in this case.
18032
18033 When no SRV records are found, MX records (and address records) are sought in
18034 the traditional way. In other words, SRV records take precedence over MX
18035 records, just as MX records take precedence over address records. Note that
18036 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18037 defined it. It is apparently believed that MX records are sufficient for email
18038 and that SRV records should not be used for this purpose. However, SRV records
18039 have an additional &"weight"& feature which some people might find useful when
18040 trying to split an SMTP load between hosts of different power.
18041
18042 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18043 when there is a DNS lookup error.
18044
18045
18046
18047 .option dnssec_request_domains dnslookup "domain list&!!" unset
18048 .cindex "MX record" "security"
18049 .cindex "DNSSEC" "MX lookup"
18050 .cindex "security" "MX lookup"
18051 .cindex "DNS" "DNSSEC"
18052 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18053 the dnssec request bit set.
18054 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18055
18056
18057
18058 .option dnssec_require_domains dnslookup "domain list&!!" unset
18059 .cindex "MX record" "security"
18060 .cindex "DNSSEC" "MX lookup"
18061 .cindex "security" "MX lookup"
18062 .cindex "DNS" "DNSSEC"
18063 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18064 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18065 (AD bit) set wil be ignored and logged as a host-lookup failure.
18066 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
18067
18068
18069
18070 .option mx_domains dnslookup "domain list&!!" unset
18071 .cindex "MX record" "required to exist"
18072 .cindex "SRV record" "required to exist"
18073 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18074 record in order to be recognized. (The name of this option could be improved.)
18075 For example, if all the mail hosts in &'fict.example'& are known to have MX
18076 records, except for those in &'discworld.fict.example'&, you could use this
18077 setting:
18078 .code
18079 mx_domains = ! *.discworld.fict.example : *.fict.example
18080 .endd
18081 This specifies that messages addressed to a domain that matches the list but
18082 has no MX record should be bounced immediately instead of being routed using
18083 the address record.
18084
18085
18086 .option mx_fail_domains dnslookup "domain list&!!" unset
18087 If the DNS lookup for MX records for one of the domains in this list causes a
18088 DNS lookup error, Exim behaves as if no MX records were found. See section
18089 &<<SECTprowitdnsloo>>& for more discussion.
18090
18091
18092
18093
18094 .option qualify_single dnslookup boolean true
18095 .cindex "DNS" "resolver options"
18096 .cindex "DNS" "qualifying single-component names"
18097 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18098 lookups. Typically, but not standardly, this causes the resolver to qualify
18099 single-component names with the default domain. For example, on a machine
18100 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18101 &'thesaurus.ref.example'& inside the resolver. For details of what your
18102 resolver actually does, consult your man pages for &'resolver'& and
18103 &'resolv.conf'&.
18104
18105
18106
18107 .option rewrite_headers dnslookup boolean true
18108 .cindex "rewriting" "header lines"
18109 .cindex "header lines" "rewriting"
18110 If the domain name in the address that is being processed is not fully
18111 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18112 an address is specified as &'dormouse@teaparty'&, the domain might be
18113 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18114 occur as a result of setting the &%widen_domains%& option. If
18115 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18116 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18117 header lines of the message are rewritten with the full domain name.
18118
18119 This option should be turned off only when it is known that no message is
18120 ever going to be sent outside an environment where the abbreviation makes
18121 sense.
18122
18123 When an MX record is looked up in the DNS and matches a wildcard record, name
18124 servers normally return a record containing the name that has been looked up,
18125 making it impossible to detect whether a wildcard was present or not. However,
18126 some name servers have recently been seen to return the wildcard entry. If the
18127 name returned by a DNS lookup begins with an asterisk, it is not used for
18128 header rewriting.
18129
18130
18131 .option same_domain_copy_routing dnslookup boolean false
18132 .cindex "address" "copying routing"
18133 Addresses with the same domain are normally routed by the &(dnslookup)& router
18134 to the same list of hosts. However, this cannot be presumed, because the router
18135 options and preconditions may refer to the local part of the address. By
18136 default, therefore, Exim routes each address in a message independently. DNS
18137 servers run caches, so repeated DNS lookups are not normally expensive, and in
18138 any case, personal messages rarely have more than a few recipients.
18139
18140 If you are running mailing lists with large numbers of subscribers at the same
18141 domain, and you are using a &(dnslookup)& router which is independent of the
18142 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18143 lookups for identical domains in one message. In this case, when &(dnslookup)&
18144 routes an address to a remote transport, any other unrouted addresses in the
18145 message that have the same domain are automatically given the same routing
18146 without processing them independently,
18147 provided the following conditions are met:
18148
18149 .ilist
18150 No router that processed the address specified &%headers_add%& or
18151 &%headers_remove%&.
18152 .next
18153 The router did not change the address in any way, for example, by &"widening"&
18154 the domain.
18155 .endlist
18156
18157
18158
18159
18160 .option search_parents dnslookup boolean false
18161 .cindex "DNS" "resolver options"
18162 When this option is true, the resolver option RES_DNSRCH is set for DNS
18163 lookups. This is different from the &%qualify_single%& option in that it
18164 applies to domains containing dots. Typically, but not standardly, it causes
18165 the resolver to search for the name in the current domain and in parent
18166 domains. For example, on a machine in the &'fict.example'& domain, if looking
18167 up &'teaparty.wonderland'& failed, the resolver would try
18168 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18169 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18170
18171 Setting this option true can cause problems in domains that have a wildcard MX
18172 record, because any domain that does not have its own MX record matches the
18173 local wildcard.
18174
18175
18176
18177 .option srv_fail_domains dnslookup "domain list&!!" unset
18178 If the DNS lookup for SRV records for one of the domains in this list causes a
18179 DNS lookup error, Exim behaves as if no SRV records were found. See section
18180 &<<SECTprowitdnsloo>>& for more discussion.
18181
18182
18183
18184
18185 .option widen_domains dnslookup "string list" unset
18186 .cindex "domain" "partial; widening"
18187 If a DNS lookup fails and this option is set, each of its strings in turn is
18188 added onto the end of the domain, and the lookup is tried again. For example,
18189 if
18190 .code
18191 widen_domains = fict.example:ref.example
18192 .endd
18193 is set and a lookup of &'klingon.dictionary'& fails,
18194 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18195 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18196 and &%search_parents%& options can cause some widening to be undertaken inside
18197 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18198 when verifying, unless &%rewrite_headers%& is false (not the default).
18199
18200
18201 .section "Effect of qualify_single and search_parents" "SECID119"
18202 When a domain from an envelope recipient is changed by the resolver as a result
18203 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18204 corresponding address in the message's header lines unless &%rewrite_headers%&
18205 is set false. Exim then re-routes the address, using the full domain.
18206
18207 These two options affect only the DNS lookup that takes place inside the router
18208 for the domain of the address that is being routed. They do not affect lookups
18209 such as that implied by
18210 .code
18211 domains = @mx_any
18212 .endd
18213 that may happen while processing a router precondition before the router is
18214 entered. No widening ever takes place for these lookups.
18215 .ecindex IIDdnsrou1
18216 .ecindex IIDdnsrou2
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226 . ////////////////////////////////////////////////////////////////////////////
18227 . ////////////////////////////////////////////////////////////////////////////
18228
18229 .chapter "The ipliteral router" "CHID5"
18230 .cindex "&(ipliteral)& router"
18231 .cindex "domain literal" "routing"
18232 .cindex "routers" "&(ipliteral)&"
18233 This router has no private options. Unless it is being used purely for
18234 verification (see &%verify_only%&) a transport is required to be defined by the
18235 generic &%transport%& option. The router accepts the address if its domain part
18236 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18237 router handles the address
18238 .code
18239 root@[192.168.1.1]
18240 .endd
18241 by setting up delivery to the host with that IP address. IPv4 domain literals
18242 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18243 are similar, but the address is preceded by &`ipv6:`&. For example:
18244 .code
18245 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18246 .endd
18247 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18248 grounds that sooner or later somebody will try it.
18249
18250 .oindex "&%self%&" "in &(ipliteral)& router"
18251 If the IP address matches something in &%ignore_target_hosts%&, the router
18252 declines. If an IP literal turns out to refer to the local host, the generic
18253 &%self%& option determines what happens.
18254
18255 The RFCs require support for domain literals; however, their use is
18256 controversial in today's Internet. If you want to use this router, you must
18257 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18258 Exim will not recognize the domain literal syntax in addresses.
18259
18260
18261
18262 . ////////////////////////////////////////////////////////////////////////////
18263 . ////////////////////////////////////////////////////////////////////////////
18264
18265 .chapter "The iplookup router" "CHID6"
18266 .cindex "&(iplookup)& router"
18267 .cindex "routers" "&(iplookup)&"
18268 The &(iplookup)& router was written to fulfil a specific requirement in
18269 Cambridge University (which in fact no longer exists). For this reason, it is
18270 not included in the binary of Exim by default. If you want to include it, you
18271 must set
18272 .code
18273 ROUTER_IPLOOKUP=yes
18274 .endd
18275 in your &_Local/Makefile_& configuration file.
18276
18277 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18278 connection to one or more specific hosts. The host can then return the same or
18279 a different address &-- in effect rewriting the recipient address in the
18280 message's envelope. The new address is then passed on to subsequent routers. If
18281 this process fails, the address can be passed on to other routers, or delivery
18282 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18283 must not be specified for it.
18284
18285 .cindex "options" "&(iplookup)& router"
18286 .option hosts iplookup string unset
18287 This option must be supplied. Its value is a colon-separated list of host
18288 names. The hosts are looked up using &[gethostbyname()]&
18289 (or &[getipnodebyname()]& when available)
18290 and are tried in order until one responds to the query. If none respond, what
18291 happens is controlled by &%optional%&.
18292
18293
18294 .option optional iplookup boolean false
18295 If &%optional%& is true, if no response is obtained from any host, the address
18296 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18297 delivery to the address is deferred.
18298
18299
18300 .option port iplookup integer 0
18301 .cindex "port" "&(iplookup)& router"
18302 This option must be supplied. It specifies the port number for the TCP or UDP
18303 call.
18304
18305
18306 .option protocol iplookup string udp
18307 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18308 protocols is to be used.
18309
18310
18311 .option query iplookup string&!! "see below"
18312 This defines the content of the query that is sent to the remote hosts. The
18313 default value is:
18314 .code
18315 $local_part@$domain $local_part@$domain
18316 .endd
18317 The repetition serves as a way of checking that a response is to the correct
18318 query in the default case (see &%response_pattern%& below).
18319
18320
18321 .option reroute iplookup string&!! unset
18322 If this option is not set, the rerouted address is precisely the byte string
18323 returned by the remote host, up to the first white space, if any. If set, the
18324 string is expanded to form the rerouted address. It can include parts matched
18325 in the response by &%response_pattern%& by means of numeric variables such as
18326 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18327 whether or not a pattern is in use. In all cases, the rerouted address must end
18328 up in the form &'local_part@domain'&.
18329
18330
18331 .option response_pattern iplookup string unset
18332 This option can be set to a regular expression that is applied to the string
18333 returned from the remote host. If the pattern does not match the response, the
18334 router declines. If &%response_pattern%& is not set, no checking of the
18335 response is done, unless the query was defaulted, in which case there is a
18336 check that the text returned after the first white space is the original
18337 address. This checks that the answer that has been received is in response to
18338 the correct question. For example, if the response is just a new domain, the
18339 following could be used:
18340 .code
18341 response_pattern = ^([^@]+)$
18342 reroute = $local_part@$1
18343 .endd
18344
18345 .option timeout iplookup time 5s
18346 This specifies the amount of time to wait for a response from the remote
18347 machine. The same timeout is used for the &[connect()]& function for a TCP
18348 call. It does not apply to UDP.
18349
18350
18351
18352
18353 . ////////////////////////////////////////////////////////////////////////////
18354 . ////////////////////////////////////////////////////////////////////////////
18355
18356 .chapter "The manualroute router" "CHID7"
18357 .scindex IIDmanrou1 "&(manualroute)& router"
18358 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18359 .cindex "domain" "manually routing"
18360 The &(manualroute)& router is so-called because it provides a way of manually
18361 routing an address according to its domain. It is mainly used when you want to
18362 route addresses to remote hosts according to your own rules, bypassing the
18363 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18364 route to local transports, a facility that may be useful if you want to save
18365 messages for dial-in hosts in local files.
18366
18367 The &(manualroute)& router compares a list of domain patterns with the domain
18368 it is trying to route. If there is no match, the router declines. Each pattern
18369 has associated with it a list of hosts and some other optional data, which may
18370 include a transport. The combination of a pattern and its data is called a
18371 &"routing rule"&. For patterns that do not have an associated transport, the
18372 generic &%transport%& option must specify a transport, unless the router is
18373 being used purely for verification (see &%verify_only%&).
18374
18375 .vindex "&$host$&"
18376 In the case of verification, matching the domain pattern is sufficient for the
18377 router to accept the address. When actually routing an address for delivery,
18378 an address that matches a domain pattern is queued for the associated
18379 transport. If the transport is not a local one, a host list must be associated
18380 with the pattern; IP addresses are looked up for the hosts, and these are
18381 passed to the transport along with the mail address. For local transports, a
18382 host list is optional. If it is present, it is passed in &$host$& as a single
18383 text string.
18384
18385 The list of routing rules can be provided as an inline string in
18386 &%route_list%&, or the data can be obtained by looking up the domain in a file
18387 or database by setting &%route_data%&. Only one of these settings may appear in
18388 any one instance of &(manualroute)&. The format of routing rules is described
18389 below, following the list of private options.
18390
18391
18392 .section "Private options for manualroute" "SECTprioptman"
18393
18394 .cindex "options" "&(manualroute)& router"
18395 The private options for the &(manualroute)& router are as follows:
18396
18397 .option host_all_ignored manualroute string defer
18398 See &%host_find_failed%&.
18399
18400 .option host_find_failed manualroute string freeze
18401 This option controls what happens when &(manualroute)& tries to find an IP
18402 address for a host, and the host does not exist. The option can be set to one
18403 of the following values:
18404 .code
18405 decline
18406 defer
18407 fail
18408 freeze
18409 ignore
18410 pass
18411 .endd
18412 The default (&"freeze"&) assumes that this state is a serious configuration
18413 error. The difference between &"pass"& and &"decline"& is that the former
18414 forces the address to be passed to the next router (or the router defined by
18415 &%pass_router%&),
18416 .oindex "&%more%&"
18417 overriding &%no_more%&, whereas the latter passes the address to the next
18418 router only if &%more%& is true.
18419
18420 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18421 cannot be found. If all the hosts in the list are ignored, the behaviour is
18422 controlled by the &%host_all_ignored%& option. This takes the same values
18423 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18424
18425 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18426 state; if a host lookup gets a temporary error, delivery is deferred unless the
18427 generic &%pass_on_timeout%& option is set.
18428
18429
18430 .option hosts_randomize manualroute boolean false
18431 .cindex "randomized host list"
18432 .cindex "host" "list of; randomized"
18433 If this option is set, the order of the items in a host list in a routing rule
18434 is randomized each time the list is used, unless an option in the routing rule
18435 overrides (see below). Randomizing the order of a host list can be used to do
18436 crude load sharing. However, if more than one mail address is routed by the
18437 same router to the same host list, the host lists are considered to be the same
18438 (even though they may be randomized into different orders) for the purpose of
18439 deciding whether to batch the deliveries into a single SMTP transaction.
18440
18441 When &%hosts_randomize%& is true, a host list may be split
18442 into groups whose order is separately randomized. This makes it possible to
18443 set up MX-like behaviour. The boundaries between groups are indicated by an
18444 item that is just &`+`& in the host list. For example:
18445 .code
18446 route_list = * host1:host2:host3:+:host4:host5
18447 .endd
18448 The order of the first three hosts and the order of the last two hosts is
18449 randomized for each use, but the first three always end up before the last two.
18450 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18451 randomized host list is passed to an &(smtp)& transport that also has
18452 &%hosts_randomize set%&, the list is not re-randomized.
18453
18454
18455 .option route_data manualroute string&!! unset
18456 If this option is set, it must expand to yield the data part of a routing rule.
18457 Typically, the expansion string includes a lookup based on the domain. For
18458 example:
18459 .code
18460 route_data = ${lookup{$domain}dbm{/etc/routes}}
18461 .endd
18462 If the expansion is forced to fail, or the result is an empty string, the
18463 router declines. Other kinds of expansion failure cause delivery to be
18464 deferred.
18465
18466
18467 .option route_list manualroute "string list" unset
18468 This string is a list of routing rules, in the form defined below. Note that,
18469 unlike most string lists, the items are separated by semicolons. This is so
18470 that they may contain colon-separated host lists.
18471
18472
18473 .option same_domain_copy_routing manualroute boolean false
18474 .cindex "address" "copying routing"
18475 Addresses with the same domain are normally routed by the &(manualroute)&
18476 router to the same list of hosts. However, this cannot be presumed, because the
18477 router options and preconditions may refer to the local part of the address. By
18478 default, therefore, Exim routes each address in a message independently. DNS
18479 servers run caches, so repeated DNS lookups are not normally expensive, and in
18480 any case, personal messages rarely have more than a few recipients.
18481
18482 If you are running mailing lists with large numbers of subscribers at the same
18483 domain, and you are using a &(manualroute)& router which is independent of the
18484 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18485 lookups for identical domains in one message. In this case, when
18486 &(manualroute)& routes an address to a remote transport, any other unrouted
18487 addresses in the message that have the same domain are automatically given the
18488 same routing without processing them independently. However, this is only done
18489 if &%headers_add%& and &%headers_remove%& are unset.
18490
18491
18492
18493
18494 .section "Routing rules in route_list" "SECID120"
18495 The value of &%route_list%& is a string consisting of a sequence of routing
18496 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18497 entered as two semicolons. Alternatively, the list separator can be changed as
18498 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18499 Empty rules are ignored. The format of each rule is
18500 .display
18501 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18502 .endd
18503 The following example contains two rules, each with a simple domain pattern and
18504 no options:
18505 .code
18506 route_list = \
18507   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18508   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18509 .endd
18510 The three parts of a rule are separated by white space. The pattern and the
18511 list of hosts can be enclosed in quotes if necessary, and if they are, the
18512 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18513 single domain pattern, which is the only mandatory item in the rule. The
18514 pattern is in the same format as one item in a domain list (see section
18515 &<<SECTdomainlist>>&),
18516 except that it may not be the name of an interpolated file.
18517 That is, it may be wildcarded, or a regular expression, or a file or database
18518 lookup (with semicolons doubled, because of the use of semicolon as a separator
18519 in a &%route_list%&).
18520
18521 The rules in &%route_list%& are searched in order until one of the patterns
18522 matches the domain that is being routed. The list of hosts and then options are
18523 then used as described below. If there is no match, the router declines. When
18524 &%route_list%& is set, &%route_data%& must not be set.
18525
18526
18527
18528 .section "Routing rules in route_data" "SECID121"
18529 The use of &%route_list%& is convenient when there are only a small number of
18530 routing rules. For larger numbers, it is easier to use a file or database to
18531 hold the routing information, and use the &%route_data%& option instead.
18532 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18533 Most commonly, &%route_data%& is set as a string that contains an
18534 expansion lookup. For example, suppose we place two routing rules in a file
18535 like this:
18536 .code
18537 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18538 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18539 .endd
18540 This data can be accessed by setting
18541 .code
18542 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18543 .endd
18544 Failure of the lookup results in an empty string, causing the router to
18545 decline. However, you do not have to use a lookup in &%route_data%&. The only
18546 requirement is that the result of expanding the string is a list of hosts,
18547 possibly followed by options, separated by white space. The list of hosts must
18548 be enclosed in quotes if it contains white space.
18549
18550
18551
18552
18553 .section "Format of the list of hosts" "SECID122"
18554 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18555 always separately expanded before use. If the expansion fails, the router
18556 declines. The result of the expansion must be a colon-separated list of names
18557 and/or IP addresses, optionally also including ports. The format of each item
18558 in the list is described in the next section. The list separator can be changed
18559 as described in section &<<SECTlistconstruct>>&.
18560
18561 If the list of hosts was obtained from a &%route_list%& item, the following
18562 variables are set during its expansion:
18563
18564 .ilist
18565 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18566 If the domain was matched against a regular expression, the numeric variables
18567 &$1$&, &$2$&, etc. may be set. For example:
18568 .code
18569 route_list = ^domain(\d+)   host-$1.text.example
18570 .endd
18571 .next
18572 &$0$& is always set to the entire domain.
18573 .next
18574 &$1$& is also set when partial matching is done in a file lookup.
18575
18576 .next
18577 .vindex "&$value$&"
18578 If the pattern that matched the domain was a lookup item, the data that was
18579 looked up is available in the expansion variable &$value$&. For example:
18580 .code
18581 route_list = lsearch;;/some/file.routes  $value
18582 .endd
18583 .endlist
18584
18585 Note the doubling of the semicolon in the pattern that is necessary because
18586 semicolon is the default route list separator.
18587
18588
18589
18590 .section "Format of one host item" "SECTformatonehostitem"
18591 Each item in the list of hosts is either a host name or an IP address,
18592 optionally with an attached port number. When no port is given, an IP address
18593 is not enclosed in brackets. When a port is specified, it overrides the port
18594 specification on the transport. The port is separated from the name or address
18595 by a colon. This leads to some complications:
18596
18597 .ilist
18598 Because colon is the default separator for the list of hosts, either
18599 the colon that specifies a port must be doubled, or the list separator must
18600 be changed. The following two examples have the same effect:
18601 .code
18602 route_list = * "host1.tld::1225 : host2.tld::1226"
18603 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18604 .endd
18605 .next
18606 When IPv6 addresses are involved, it gets worse, because they contain
18607 colons of their own. To make this case easier, it is permitted to
18608 enclose an IP address (either v4 or v6) in square brackets if a port
18609 number follows. For example:
18610 .code
18611 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18612 .endd
18613 .endlist
18614
18615 .section "How the list of hosts is used" "SECThostshowused"
18616 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18617 the hosts is tried, in the order specified, when carrying out the SMTP
18618 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18619 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18620 transport.
18621
18622 Hosts may be listed by name or by IP address. An unadorned name in the list of
18623 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18624 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18625 records in the DNS. For example:
18626 .code
18627 route_list = *  x.y.z:p.q.r/MX:e.f.g
18628 .endd
18629 If this feature is used with a port specifier, the port must come last. For
18630 example:
18631 .code
18632 route_list = *  dom1.tld/mx::1225
18633 .endd
18634 If the &%hosts_randomize%& option is set, the order of the items in the list is
18635 randomized before any lookups are done. Exim then scans the list; for any name
18636 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18637 be an interface on the local host and the item is not the first in the list,
18638 Exim discards it and any subsequent items. If it is the first item, what
18639 happens is controlled by the
18640 .oindex "&%self%&" "in &(manualroute)& router"
18641 &%self%& option of the router.
18642
18643 A name on the list that is followed by &`/MX`& is replaced with the list of
18644 hosts obtained by looking up MX records for the name. This is always a DNS
18645 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18646 below) are not relevant here. The order of these hosts is determined by the
18647 preference values in the MX records, according to the usual rules. Because
18648 randomizing happens before the MX lookup, it does not affect the order that is
18649 defined by MX preferences.
18650
18651 If the local host is present in the sublist obtained from MX records, but is
18652 not the most preferred host in that list, it and any equally or less
18653 preferred hosts are removed before the sublist is inserted into the main list.
18654
18655 If the local host is the most preferred host in the MX list, what happens
18656 depends on where in the original list of hosts the &`/MX`& item appears. If it
18657 is not the first item (that is, there are previous hosts in the main list),
18658 Exim discards this name and any subsequent items in the main list.
18659
18660 If the MX item is first in the list of hosts, and the local host is the
18661 most preferred host, what happens is controlled by the &%self%& option of the
18662 router.
18663
18664 DNS failures when lookup up the MX records are treated in the same way as DNS
18665 failures when looking up IP addresses: &%pass_on_timeout%& and
18666 &%host_find_failed%& are used when relevant.
18667
18668 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18669 whether obtained from an MX lookup or not.
18670
18671
18672
18673 .section "How the options are used" "SECThowoptused"
18674 The options are a sequence of words; in practice no more than three are ever
18675 present. One of the words can be the name of a transport; this overrides the
18676 &%transport%& option on the router for this particular routing rule only. The
18677 other words (if present) control randomization of the list of hosts on a
18678 per-rule basis, and how the IP addresses of the hosts are to be found when
18679 routing to a remote transport. These options are as follows:
18680
18681 .ilist
18682 &%randomize%&: randomize the order of the hosts in this list, overriding the
18683 setting of &%hosts_randomize%& for this routing rule only.
18684 .next
18685 &%no_randomize%&: do not randomize the order of the hosts in this list,
18686 overriding the setting of &%hosts_randomize%& for this routing rule only.
18687 .next
18688 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18689 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18690 also look in &_/etc/hosts_& or other sources of information.
18691 .next
18692 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18693 no address records are found. If there is a temporary DNS error (such as a
18694 timeout), delivery is deferred.
18695 .endlist
18696
18697 For example:
18698 .code
18699 route_list = domain1  host1:host2:host3  randomize bydns;\
18700              domain2  host4:host5
18701 .endd
18702 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18703 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18704 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18705 or &[gethostbyname()]&, and the result of the lookup is the result of that
18706 call.
18707
18708 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18709 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18710 instead of TRY_AGAIN. That is why the default action is to try a DNS
18711 lookup first. Only if that gives a definite &"no such host"& is the local
18712 function called.
18713
18714
18715
18716 If no IP address for a host can be found, what happens is controlled by the
18717 &%host_find_failed%& option.
18718
18719 .vindex "&$host$&"
18720 When an address is routed to a local transport, IP addresses are not looked up.
18721 The host list is passed to the transport in the &$host$& variable.
18722
18723
18724
18725 .section "Manualroute examples" "SECID123"
18726 In some of the examples that follow, the presence of the &%remote_smtp%&
18727 transport, as defined in the default configuration file, is assumed:
18728
18729 .ilist
18730 .cindex "smart host" "example router"
18731 The &(manualroute)& router can be used to forward all external mail to a
18732 &'smart host'&. If you have set up, in the main part of the configuration, a
18733 named domain list that contains your local domains, for example:
18734 .code
18735 domainlist local_domains = my.domain.example
18736 .endd
18737 You can arrange for all other domains to be routed to a smart host by making
18738 your first router something like this:
18739 .code
18740 smart_route:
18741   driver = manualroute
18742   domains = !+local_domains
18743   transport = remote_smtp
18744   route_list = * smarthost.ref.example
18745 .endd
18746 This causes all non-local addresses to be sent to the single host
18747 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18748 they are tried in order
18749 (but you can use &%hosts_randomize%& to vary the order each time).
18750 Another way of configuring the same thing is this:
18751 .code
18752 smart_route:
18753   driver = manualroute
18754   transport = remote_smtp
18755   route_list = !+local_domains  smarthost.ref.example
18756 .endd
18757 There is no difference in behaviour between these two routers as they stand.
18758 However, they behave differently if &%no_more%& is added to them. In the first
18759 example, the router is skipped if the domain does not match the &%domains%&
18760 precondition; the following router is always tried. If the router runs, it
18761 always matches the domain and so can never decline. Therefore, &%no_more%&
18762 would have no effect. In the second case, the router is never skipped; it
18763 always runs. However, if it doesn't match the domain, it declines. In this case
18764 &%no_more%& would prevent subsequent routers from running.
18765
18766 .next
18767 .cindex "mail hub example"
18768 A &'mail hub'& is a host which receives mail for a number of domains via MX
18769 records in the DNS and delivers it via its own private routing mechanism. Often
18770 the final destinations are behind a firewall, with the mail hub being the one
18771 machine that can connect to machines both inside and outside the firewall. The
18772 &(manualroute)& router is usually used on a mail hub to route incoming messages
18773 to the correct hosts. For a small number of domains, the routing can be inline,
18774 using the &%route_list%& option, but for a larger number a file or database
18775 lookup is easier to manage.
18776
18777 If the domain names are in fact the names of the machines to which the mail is
18778 to be sent by the mail hub, the configuration can be quite simple. For
18779 example:
18780 .code
18781 hub_route:
18782   driver = manualroute
18783   transport = remote_smtp
18784   route_list = *.rhodes.tvs.example  $domain
18785 .endd
18786 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18787 whose names are the same as the mail domains. A similar approach can be taken
18788 if the host name can be obtained from the domain name by a string manipulation
18789 that the expansion facilities can handle. Otherwise, a lookup based on the
18790 domain can be used to find the host:
18791 .code
18792 through_firewall:
18793   driver = manualroute
18794   transport = remote_smtp
18795   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18796 .endd
18797 The result of the lookup must be the name or IP address of the host (or
18798 hosts) to which the address is to be routed. If the lookup fails, the route
18799 data is empty, causing the router to decline. The address then passes to the
18800 next router.
18801
18802 .next
18803 .cindex "batched SMTP output example"
18804 .cindex "SMTP" "batched outgoing; example"
18805 You can use &(manualroute)& to deliver messages to pipes or files in batched
18806 SMTP format for onward transportation by some other means. This is one way of
18807 storing mail for a dial-up host when it is not connected. The route list entry
18808 can be as simple as a single domain name in a configuration like this:
18809 .code
18810 save_in_file:
18811   driver = manualroute
18812   transport = batchsmtp_appendfile
18813   route_list = saved.domain.example
18814 .endd
18815 though often a pattern is used to pick up more than one domain. If there are
18816 several domains or groups of domains with different transport requirements,
18817 different transports can be listed in the routing information:
18818 .code
18819 save_in_file:
18820   driver = manualroute
18821   route_list = \
18822     *.saved.domain1.example  $domain  batch_appendfile; \
18823     *.saved.domain2.example  \
18824       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18825       batch_pipe
18826 .endd
18827 .vindex "&$domain$&"
18828 .vindex "&$host$&"
18829 The first of these just passes the domain in the &$host$& variable, which
18830 doesn't achieve much (since it is also in &$domain$&), but the second does a
18831 file lookup to find a value to pass, causing the router to decline to handle
18832 the address if the lookup fails.
18833
18834 .next
18835 .cindex "UUCP" "example of router for"
18836 Routing mail directly to UUCP software is a specific case of the use of
18837 &(manualroute)& in a gateway to another mail environment. This is an example of
18838 one way it can be done:
18839 .code
18840 # Transport
18841 uucp:
18842   driver = pipe
18843   user = nobody
18844   command = /usr/local/bin/uux -r - \
18845     ${substr_-5:$host}!rmail ${local_part}
18846   return_fail_output = true
18847
18848 # Router
18849 uucphost:
18850   transport = uucp
18851   driver = manualroute
18852   route_data = \
18853     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
18854 .endd
18855 The file &_/usr/local/exim/uucphosts_& contains entries like
18856 .code
18857 darksite.ethereal.example:           darksite.UUCP
18858 .endd
18859 It can be set up more simply without adding and removing &".UUCP"& but this way
18860 makes clear the distinction between the domain name
18861 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
18862 .endlist
18863 .ecindex IIDmanrou1
18864 .ecindex IIDmanrou2
18865
18866
18867
18868
18869
18870
18871
18872
18873 . ////////////////////////////////////////////////////////////////////////////
18874 . ////////////////////////////////////////////////////////////////////////////
18875
18876 .chapter "The queryprogram router" "CHAPdriverlast"
18877 .scindex IIDquerou1 "&(queryprogram)& router"
18878 .scindex IIDquerou2 "routers" "&(queryprogram)&"
18879 .cindex "routing" "by external program"
18880 The &(queryprogram)& router routes an address by running an external command
18881 and acting on its output. This is an expensive way to route, and is intended
18882 mainly for use in lightly-loaded systems, or for performing experiments.
18883 However, if it is possible to use the precondition options (&%domains%&,
18884 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
18885 be used in special cases, even on a busy host. There are the following private
18886 options:
18887 .cindex "options" "&(queryprogram)& router"
18888
18889 .option command queryprogram string&!! unset
18890 This option must be set. It specifies the command that is to be run. The
18891 command is split up into a command name and arguments, and then each is
18892 expanded separately (exactly as for a &(pipe)& transport, described in chapter
18893 &<<CHAPpipetransport>>&).
18894
18895
18896 .option command_group queryprogram string unset
18897 .cindex "gid (group id)" "in &(queryprogram)& router"
18898 This option specifies a gid to be set when running the command while routing an
18899 address for deliver. It must be set if &%command_user%& specifies a numerical
18900 uid. If it begins with a digit, it is interpreted as the numerical value of the
18901 gid. Otherwise it is looked up using &[getgrnam()]&.
18902
18903
18904 .option command_user queryprogram string unset
18905 .cindex "uid (user id)" "for &(queryprogram)&"
18906 This option must be set. It specifies the uid which is set when running the
18907 command while routing an address for delivery. If the value begins with a digit,
18908 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
18909 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
18910 not set, a value for the gid also.
18911
18912 &*Warning:*& Changing uid and gid is possible only when Exim is running as
18913 root, which it does during a normal delivery in a conventional configuration.
18914 However, when an address is being verified during message reception, Exim is
18915 usually running as the Exim user, not as root. If the &(queryprogram)& router
18916 is called from a non-root process, Exim cannot change uid or gid before running
18917 the command. In this circumstance the command runs under the current uid and
18918 gid.
18919
18920
18921 .option current_directory queryprogram string /
18922 This option specifies an absolute path which is made the current directory
18923 before running the command.
18924
18925
18926 .option timeout queryprogram time 1h
18927 If the command does not complete within the timeout period, its process group
18928 is killed and the message is frozen. A value of zero time specifies no
18929 timeout.
18930
18931
18932 The standard output of the command is connected to a pipe, which is read when
18933 the command terminates. It should consist of a single line of output,
18934 containing up to five fields, separated by white space. The maximum length of
18935 the line is 1023 characters. Longer lines are silently truncated. The first
18936 field is one of the following words (case-insensitive):
18937
18938 .ilist
18939 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
18940 below).
18941 .next
18942 &'Decline'&: the router declines; pass the address to the next router, unless
18943 &%no_more%& is set.
18944 .next
18945 &'Fail'&: routing failed; do not pass the address to any more routers. Any
18946 subsequent text on the line is an error message. If the router is run as part
18947 of address verification during an incoming SMTP message, the message is
18948 included in the SMTP response.
18949 .next
18950 &'Defer'&: routing could not be completed at this time; try again later. Any
18951 subsequent text on the line is an error message which is logged. It is not
18952 included in any SMTP response.
18953 .next
18954 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
18955 .next
18956 &'Pass'&: pass the address to the next router (or the router specified by
18957 &%pass_router%&), overriding &%no_more%&.
18958 .next
18959 &'Redirect'&: the message is redirected. The remainder of the line is a list of
18960 new addresses, which are routed independently, starting with the first router,
18961 or the router specified by &%redirect_router%&, if set.
18962 .endlist
18963
18964 When the first word is &'accept'&, the remainder of the line consists of a
18965 number of keyed data values, as follows (split into two lines here, to fit on
18966 the page):
18967 .code
18968 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
18969 LOOKUP=byname|bydns DATA=<text>
18970 .endd
18971 The data items can be given in any order, and all are optional. If no transport
18972 is included, the transport specified by the generic &%transport%& option is
18973 used. The list of hosts and the lookup type are needed only if the transport is
18974 an &(smtp)& transport that does not itself supply a list of hosts.
18975
18976 The format of the list of hosts is the same as for the &(manualroute)& router.
18977 As well as host names and IP addresses with optional port numbers, as described
18978 in section &<<SECTformatonehostitem>>&, it may contain names followed by
18979 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
18980 (see section &<<SECThostshowused>>&).
18981
18982 If the lookup type is not specified, Exim behaves as follows when trying to
18983 find an IP address for each host: First, a DNS lookup is done. If this yields
18984 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
18985 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
18986 result of the lookup is the result of that call.
18987
18988 .vindex "&$address_data$&"
18989 If the DATA field is set, its value is placed in the &$address_data$&
18990 variable. For example, this return line
18991 .code
18992 accept hosts=x1.y.example:x2.y.example data="rule1"
18993 .endd
18994 routes the address to the default transport, passing a list of two hosts. When
18995 the transport runs, the string &"rule1"& is in &$address_data$&.
18996 .ecindex IIDquerou1
18997 .ecindex IIDquerou2
18998
18999
19000
19001
19002 . ////////////////////////////////////////////////////////////////////////////
19003 . ////////////////////////////////////////////////////////////////////////////
19004
19005 .chapter "The redirect router" "CHAPredirect"
19006 .scindex IIDredrou1 "&(redirect)& router"
19007 .scindex IIDredrou2 "routers" "&(redirect)&"
19008 .cindex "alias file" "in a &(redirect)& router"
19009 .cindex "address redirection" "&(redirect)& router"
19010 The &(redirect)& router handles several kinds of address redirection. Its most
19011 common uses are for resolving local part aliases from a central alias file
19012 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19013 files, but it has many other potential uses. The incoming address can be
19014 redirected in several different ways:
19015
19016 .ilist
19017 It can be replaced by one or more new addresses which are themselves routed
19018 independently.
19019 .next
19020 It can be routed to be delivered to a given file or directory.
19021 .next
19022 It can be routed to be delivered to a specified pipe command.
19023 .next
19024 It can cause an automatic reply to be generated.
19025 .next
19026 It can be forced to fail, optionally with a custom error message.
19027 .next
19028 It can be temporarily deferred, optionally with a custom message.
19029 .next
19030 It can be discarded.
19031 .endlist
19032
19033 The generic &%transport%& option must not be set for &(redirect)& routers.
19034 However, there are some private options which define transports for delivery to
19035 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19036 &%pipe_transport%& and &%reply_transport%& descriptions below.
19037
19038 .new
19039 If success DSNs have been requested
19040 .cindex "DSN" "success"
19041 .cindex "Delivery Status Notification" "success"
19042 redirection triggers one and the DSN options are not passed any further.
19043 .wen
19044
19045
19046
19047 .section "Redirection data" "SECID124"
19048 The router operates by interpreting a text string which it obtains either by
19049 expanding the contents of the &%data%& option, or by reading the entire
19050 contents of a file whose name is given in the &%file%& option. These two
19051 options are mutually exclusive. The first is commonly used for handling system
19052 aliases, in a configuration like this:
19053 .code
19054 system_aliases:
19055   driver = redirect
19056   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19057 .endd
19058 If the lookup fails, the expanded string in this example is empty. When the
19059 expansion of &%data%& results in an empty string, the router declines. A forced
19060 expansion failure also causes the router to decline; other expansion failures
19061 cause delivery to be deferred.
19062
19063 A configuration using &%file%& is commonly used for handling users'
19064 &_.forward_& files, like this:
19065 .code
19066 userforward:
19067   driver = redirect
19068   check_local_user
19069   file = $home/.forward
19070   no_verify
19071 .endd
19072 If the file does not exist, or causes no action to be taken (for example, it is
19073 empty or consists only of comments), the router declines. &*Warning*&: This
19074 is not the case when the file contains syntactically valid items that happen to
19075 yield empty addresses, for example, items containing only RFC 2822 address
19076 comments.
19077
19078
19079
19080 .section "Forward files and address verification" "SECID125"
19081 .cindex "address redirection" "while verifying"
19082 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19083 &_.forward_& files, as in the example above. There are two reasons for this:
19084
19085 .ilist
19086 When Exim is receiving an incoming SMTP message from a remote host, it is
19087 running under the Exim uid, not as root. Exim is unable to change uid to read
19088 the file as the user, and it may not be able to read it as the Exim user. So in
19089 practice the router may not be able to operate.
19090 .next
19091 However, even when the router can operate, the existence of a &_.forward_& file
19092 is unimportant when verifying an address. What should be checked is whether the
19093 local part is a valid user name or not. Cutting out the redirection processing
19094 saves some resources.
19095 .endlist
19096
19097
19098
19099
19100
19101
19102 .section "Interpreting redirection data" "SECID126"
19103 .cindex "Sieve filter" "specifying in redirection data"
19104 .cindex "filter" "specifying in redirection data"
19105 The contents of the data string, whether obtained from &%data%& or &%file%&,
19106 can be interpreted in two different ways:
19107
19108 .ilist
19109 If the &%allow_filter%& option is set true, and the data begins with the text
19110 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19111 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19112 respectively. Details of the syntax and semantics of filter files are described
19113 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19114 document is intended for use by end users.
19115 .next
19116 Otherwise, the data must be a comma-separated list of redirection items, as
19117 described in the next section.
19118 .endlist
19119
19120 When a message is redirected to a file (a &"mail folder"&), the file name given
19121 in a non-filter redirection list must always be an absolute path. A filter may
19122 generate a relative path &-- how this is handled depends on the transport's
19123 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19124 for the &(appendfile)& transport.
19125
19126
19127
19128 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19129 .cindex "address redirection" "non-filter list items"
19130 When the redirection data is not an Exim or Sieve filter, for example, if it
19131 comes from a conventional alias or forward file, it consists of a list of
19132 addresses, file names, pipe commands, or certain special items (see section
19133 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19134 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19135 depending on their default values. The items in the list are separated by
19136 commas or newlines.
19137 If a comma is required in an item, the entire item must be enclosed in double
19138 quotes.
19139
19140 Lines starting with a # character are comments, and are ignored, and # may
19141 also appear following a comma, in which case everything between the # and the
19142 next newline character is ignored.
19143
19144 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19145 double quotes are retained because some forms of mail address require their use
19146 (but never to enclose the entire address). In the following description,
19147 &"item"& refers to what remains after any surrounding double quotes have been
19148 removed.
19149
19150 .vindex "&$local_part$&"
19151 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19152 and the expansion contains a reference to &$local_part$&, you should make use
19153 of the &%quote_local_part%& expansion operator, in case the local part contains
19154 special characters. For example, to redirect all mail for the domain
19155 &'obsolete.example'&, retaining the existing local part, you could use this
19156 setting:
19157 .code
19158 data = ${quote_local_part:$local_part}@newdomain.example
19159 .endd
19160
19161
19162 .section "Redirecting to a local mailbox" "SECTredlocmai"
19163 .cindex "routing" "loops in"
19164 .cindex "loop" "while routing, avoidance of"
19165 .cindex "address redirection" "to local mailbox"
19166 A redirection item may safely be the same as the address currently under
19167 consideration. This does not cause a routing loop, because a router is
19168 automatically skipped if any ancestor of the address that is being processed
19169 is the same as the current address and was processed by the current router.
19170 Such an address is therefore passed to the following routers, so it is handled
19171 as if there were no redirection. When making this loop-avoidance test, the
19172 complete local part, including any prefix or suffix, is used.
19173
19174 .cindex "address redirection" "local part without domain"
19175 Specifying the same local part without a domain is a common usage in personal
19176 filter files when the user wants to have messages delivered to the local
19177 mailbox and also forwarded elsewhere. For example, the user whose login is
19178 &'cleo'& might have a &_.forward_& file containing this:
19179 .code
19180 cleo, cleopatra@egypt.example
19181 .endd
19182 .cindex "backslash in alias file"
19183 .cindex "alias file" "backslash in"
19184 For compatibility with other MTAs, such unqualified local parts may be
19185 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19186 it does make a difference if more than one domain is being handled
19187 synonymously.
19188
19189 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19190 2822 address that does not include a domain, the item is qualified using the
19191 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19192 addresses are qualified using the value in &%qualify_recipient%&, but you can
19193 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19194
19195 Care must be taken if there are alias names for local users.
19196 Consider an MTA handling a single local domain where the system alias file
19197 contains:
19198 .code
19199 Sam.Reman: spqr
19200 .endd
19201 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19202 messages in the local mailbox, and also forward copies elsewhere. He creates
19203 this forward file:
19204 .code
19205 Sam.Reman, spqr@reme.elsewhere.example
19206 .endd
19207 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19208 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19209 second time round, because it has previously routed it,
19210 and the following routers presumably cannot handle the alias. The forward file
19211 should really contain
19212 .code
19213 spqr, spqr@reme.elsewhere.example
19214 .endd
19215 but because this is such a common error, the &%check_ancestor%& option (see
19216 below) exists to provide a way to get round it. This is normally set on a
19217 &(redirect)& router that is handling users' &_.forward_& files.
19218
19219
19220
19221 .section "Special items in redirection lists" "SECTspecitredli"
19222 In addition to addresses, the following types of item may appear in redirection
19223 lists (that is, in non-filter redirection data):
19224
19225 .ilist
19226 .cindex "pipe" "in redirection list"
19227 .cindex "address redirection" "to pipe"
19228 An item is treated as a pipe command if it begins with &"|"& and does not parse
19229 as a valid RFC 2822 address that includes a domain. A transport for running the
19230 command must be specified by the &%pipe_transport%& option.
19231 Normally, either the router or the transport specifies a user and a group under
19232 which to run the delivery. The default is to use the Exim user and group.
19233
19234 Single or double quotes can be used for enclosing the individual arguments of
19235 the pipe command; no interpretation of escapes is done for single quotes. If
19236 the command contains a comma character, it is necessary to put the whole item
19237 in double quotes, for example:
19238 .code
19239 "|/some/command ready,steady,go"
19240 .endd
19241 since items in redirection lists are terminated by commas. Do not, however,
19242 quote just the command. An item such as
19243 .code
19244 |"/some/command ready,steady,go"
19245 .endd
19246 is interpreted as a pipe with a rather strange command name, and no arguments.
19247
19248 Note that the above example assumes that the text comes from a lookup source
19249 of some sort, so that the quotes are part of the data.  If composing a
19250 redirect router with a &%data%& option directly specifying this command, the
19251 quotes will be used by the configuration parser to define the extent of one
19252 string, but will not be passed down into the redirect router itself.  There
19253 are two main approaches to get around this: escape quotes to be part of the
19254 data itself, or avoid using this mechanism and instead create a custom
19255 transport with the &%command%& option set and reference that transport from
19256 an &%accept%& router.
19257
19258 .next
19259 .cindex "file" "in redirection list"
19260 .cindex "address redirection" "to file"
19261 An item is interpreted as a path name if it begins with &"/"& and does not
19262 parse as a valid RFC 2822 address that includes a domain. For example,
19263 .code
19264 /home/world/minbari
19265 .endd
19266 is treated as a file name, but
19267 .code
19268 /s=molari/o=babylon/@x400gate.way
19269 .endd
19270 is treated as an address. For a file name, a transport must be specified using
19271 the &%file_transport%& option. However, if the generated path name ends with a
19272 forward slash character, it is interpreted as a directory name rather than a
19273 file name, and &%directory_transport%& is used instead.
19274
19275 Normally, either the router or the transport specifies a user and a group under
19276 which to run the delivery. The default is to use the Exim user and group.
19277
19278 .cindex "&_/dev/null_&"
19279 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19280 bypassed at a high level, and the log entry shows &"**bypassed**"&
19281 instead of a transport name. In this case the user and group are not used.
19282
19283 .next
19284 .cindex "included address list"
19285 .cindex "address redirection" "included external list"
19286 If an item is of the form
19287 .code
19288 :include:<path name>
19289 .endd
19290 a list of further items is taken from the given file and included at that
19291 point. &*Note*&: Such a file can not be a filter file; it is just an
19292 out-of-line addition to the list. The items in the included list are separated
19293 by commas or newlines and are not subject to expansion. If this is the first
19294 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19295 the alias name. This example is incorrect:
19296 .code
19297 list1    :include:/opt/lists/list1
19298 .endd
19299 It must be given as
19300 .code
19301 list1:   :include:/opt/lists/list1
19302 .endd
19303 .next
19304 .cindex "address redirection" "to black hole"
19305 Sometimes you want to throw away mail to a particular local part. Making the
19306 &%data%& option expand to an empty string does not work, because that causes
19307 the router to decline. Instead, the alias item
19308 .cindex "black hole"
19309 .cindex "abandoning mail"
19310 &':blackhole:'& can be used. It does what its name implies. No delivery is
19311 done, and no error message is generated. This has the same effect as specifing
19312 &_/dev/null_& as a destination, but it can be independently disabled.
19313
19314 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19315 delivery is done for the original local part, even if other redirection items
19316 are present. If you are generating a multi-item list (for example, by reading a
19317 database) and need the ability to provide a no-op item, you must use
19318 &_/dev/null_&.
19319
19320 .next
19321 .cindex "delivery" "forcing failure"
19322 .cindex "delivery" "forcing deferral"
19323 .cindex "failing delivery" "forcing"
19324 .cindex "deferred delivery, forcing"
19325 .cindex "customizing" "failure message"
19326 An attempt to deliver a particular address can be deferred or forced to fail by
19327 redirection items of the form
19328 .code
19329 :defer:
19330 :fail:
19331 .endd
19332 respectively. When a redirection list contains such an item, it applies
19333 to the entire redirection; any other items in the list are ignored. Any
19334 text following &':fail:'& or &':defer:'& is placed in the error text
19335 associated with the failure. For example, an alias file might contain:
19336 .code
19337 X.Employee:  :fail: Gone away, no forwarding address
19338 .endd
19339 In the case of an address that is being verified from an ACL or as the subject
19340 of a
19341 .cindex "VRFY" "error text, display of"
19342 VRFY command, the text is included in the SMTP error response by
19343 default.
19344 .cindex "EXPN" "error text, display of"
19345 The text is not included in the response to an EXPN command. In non-SMTP cases
19346 the text is included in the error message that Exim generates.
19347
19348 .cindex "SMTP" "error codes"
19349 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19350 &':fail:'&. However, if the message starts with three digits followed by a
19351 space, optionally followed by an extended code of the form &'n.n.n'&, also
19352 followed by a space, and the very first digit is the same as the default error
19353 code, the code from the message is used instead. If the very first digit is
19354 incorrect, a panic error is logged, and the default code is used. You can
19355 suppress the use of the supplied code in a redirect router by setting the
19356 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19357 ignored.
19358
19359 .vindex "&$acl_verify_message$&"
19360 In an ACL, an explicitly provided message overrides the default, but the
19361 default message is available in the variable &$acl_verify_message$& and can
19362 therefore be included in a custom message if this is desired.
19363
19364 Normally the error text is the rest of the redirection list &-- a comma does
19365 not terminate it &-- but a newline does act as a terminator. Newlines are not
19366 normally present in alias expansions. In &(lsearch)& lookups they are removed
19367 as part of the continuation process, but they may exist in other kinds of
19368 lookup and in &':include:'& files.
19369
19370 During routing for message delivery (as opposed to verification), a redirection
19371 containing &':fail:'& causes an immediate failure of the incoming address,
19372 whereas &':defer:'& causes the message to remain on the queue so that a
19373 subsequent delivery attempt can happen at a later time. If an address is
19374 deferred for too long, it will ultimately fail, because the normal retry
19375 rules still apply.
19376
19377 .next
19378 .cindex "alias file" "exception to default"
19379 Sometimes it is useful to use a single-key search type with a default (see
19380 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19381 for exceptions to the default. These can be handled by aliasing them to
19382 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19383 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19384 results in an empty redirection list has the same effect.
19385 .endlist
19386
19387
19388 .section "Duplicate addresses" "SECTdupaddr"
19389 .cindex "duplicate addresses"
19390 .cindex "address duplicate, discarding"
19391 .cindex "pipe" "duplicated"
19392 Exim removes duplicate addresses from the list to which it is delivering, so as
19393 to deliver just one copy to each address. This does not apply to deliveries
19394 routed to pipes by different immediate parent addresses, but an indirect
19395 aliasing scheme of the type
19396 .code
19397 pipe:       |/some/command $local_part
19398 localpart1: pipe
19399 localpart2: pipe
19400 .endd
19401 does not work with a message that is addressed to both local parts, because
19402 when the second is aliased to the intermediate local part &"pipe"& it gets
19403 discarded as being the same as a previously handled address. However, a scheme
19404 such as
19405 .code
19406 localpart1: |/some/command $local_part
19407 localpart2: |/some/command $local_part
19408 .endd
19409 does result in two different pipe deliveries, because the immediate parents of
19410 the pipes are distinct.
19411
19412
19413
19414 .section "Repeated redirection expansion" "SECID128"
19415 .cindex "repeated redirection expansion"
19416 .cindex "address redirection" "repeated for each delivery attempt"
19417 When a message cannot be delivered to all of its recipients immediately,
19418 leading to two or more delivery attempts, redirection expansion is carried out
19419 afresh each time for those addresses whose children were not all previously
19420 delivered. If redirection is being used as a mailing list, this can lead to new
19421 members of the list receiving copies of old messages. The &%one_time%& option
19422 can be used to avoid this.
19423
19424
19425 .section "Errors in redirection lists" "SECID129"
19426 .cindex "address redirection" "errors"
19427 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19428 error is skipped, and an entry is written to the main log. This may be useful
19429 for mailing lists that are automatically managed. Otherwise, if an error is
19430 detected while generating the list of new addresses, the original address is
19431 deferred. See also &%syntax_errors_to%&.
19432
19433
19434
19435 .section "Private options for the redirect router" "SECID130"
19436
19437 .cindex "options" "&(redirect)& router"
19438 The private options for the &(redirect)& router are as follows:
19439
19440
19441 .option allow_defer redirect boolean false
19442 Setting this option allows the use of &':defer:'& in non-filter redirection
19443 data, or the &%defer%& command in an Exim filter file.
19444
19445
19446 .option allow_fail redirect boolean false
19447 .cindex "failing delivery" "from filter"
19448 If this option is true, the &':fail:'& item can be used in a redirection list,
19449 and the &%fail%& command may be used in an Exim filter file.
19450
19451
19452 .option allow_filter redirect boolean false
19453 .cindex "filter" "enabling use of"
19454 .cindex "Sieve filter" "enabling use of"
19455 Setting this option allows Exim to interpret redirection data that starts with
19456 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19457 are some features of Exim filter files that some administrators may wish to
19458 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19459
19460 It is also possible to lock out Exim filters or Sieve filters while allowing
19461 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19462
19463
19464 The filter is run using the uid and gid set by the generic &%user%& and
19465 &%group%& options. These take their defaults from the password data if
19466 &%check_local_user%& is set, so in the normal case of users' personal filter
19467 files, the filter is run as the relevant user. When &%allow_filter%& is set
19468 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19469
19470
19471
19472 .option allow_freeze redirect boolean false
19473 .cindex "freezing messages" "allowing in filter"
19474 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19475 This command is more normally encountered in system filters, and is disabled by
19476 default for redirection filters because it isn't something you usually want to
19477 let ordinary users do.
19478
19479
19480
19481 .option check_ancestor redirect boolean false
19482 This option is concerned with handling generated addresses that are the same
19483 as some address in the list of redirection ancestors of the current address.
19484 Although it is turned off by default in the code, it is set in the default
19485 configuration file for handling users' &_.forward_& files. It is recommended
19486 for this use of the &(redirect)& router.
19487
19488 When &%check_ancestor%& is set, if a generated address (including the domain)
19489 is the same as any ancestor of the current address, it is replaced by a copy of
19490 the current address. This helps in the case where local part A is aliased to B,
19491 and B has a &_.forward_& file pointing back to A. For example, within a single
19492 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19493 &_&~jb/.forward_& contains:
19494 .code
19495 \Joe.Bloggs, <other item(s)>
19496 .endd
19497 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19498 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19499 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19500 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19501 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19502 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19503 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19504 original address. See also the &%repeat_use%& option below.
19505
19506
19507 .option check_group redirect boolean "see below"
19508 When the &%file%& option is used, the group owner of the file is checked only
19509 when this option is set. The permitted groups are those listed in the
19510 &%owngroups%& option, together with the user's default group if
19511 &%check_local_user%& is set. If the file has the wrong group, routing is
19512 deferred. The default setting for this option is true if &%check_local_user%&
19513 is set and the &%modemask%& option permits the group write bit, or if the
19514 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19515
19516
19517
19518 .option check_owner redirect boolean "see below"
19519 When the &%file%& option is used, the owner of the file is checked only when
19520 this option is set. If &%check_local_user%& is set, the local user is
19521 permitted; otherwise the owner must be one of those listed in the &%owners%&
19522 option. The default value for this option is true if &%check_local_user%& or
19523 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19524
19525
19526 .option data redirect string&!! unset
19527 This option is mutually exclusive with &%file%&. One or other of them must be
19528 set, but not both. The contents of &%data%& are expanded, and then used as the
19529 list of forwarding items, or as a set of filtering instructions. If the
19530 expansion is forced to fail, or the result is an empty string or a string that
19531 has no effect (consists entirely of comments), the router declines.
19532
19533 When filtering instructions are used, the string must begin with &"#Exim
19534 filter"&, and all comments in the string, including this initial one, must be
19535 terminated with newline characters. For example:
19536 .code
19537 data = #Exim filter\n\
19538        if $h_to: contains Exim then save $home/mail/exim endif
19539 .endd
19540 If you are reading the data from a database where newlines cannot be included,
19541 you can use the &${sg}$& expansion item to turn the escape string of your
19542 choice into a newline.
19543
19544
19545 .option directory_transport redirect string&!! unset
19546 A &(redirect)& router sets up a direct delivery to a directory when a path name
19547 ending with a slash is specified as a new &"address"&. The transport used is
19548 specified by this option, which, after expansion, must be the name of a
19549 configured transport. This should normally be an &(appendfile)& transport.
19550
19551
19552 .option file redirect string&!! unset
19553 This option specifies the name of a file that contains the redirection data. It
19554 is mutually exclusive with the &%data%& option. The string is expanded before
19555 use; if the expansion is forced to fail, the router declines. Other expansion
19556 failures cause delivery to be deferred. The result of a successful expansion
19557 must be an absolute path. The entire file is read and used as the redirection
19558 data. If the data is an empty string or a string that has no effect (consists
19559 entirely of comments), the router declines.
19560
19561 .cindex "NFS" "checking for file existence"
19562 If the attempt to open the file fails with a &"does not exist"& error, Exim
19563 runs a check on the containing directory,
19564 unless &%ignore_enotdir%& is true (see below).
19565 If the directory does not appear to exist, delivery is deferred. This can
19566 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19567 is a mount problem. If the containing directory does exist, but the file does
19568 not, the router declines.
19569
19570
19571 .option file_transport redirect string&!! unset
19572 .vindex "&$address_file$&"
19573 A &(redirect)& router sets up a direct delivery to a file when a path name not
19574 ending in a slash is specified as a new &"address"&. The transport used is
19575 specified by this option, which, after expansion, must be the name of a
19576 configured transport. This should normally be an &(appendfile)& transport. When
19577 it is running, the file name is in &$address_file$&.
19578
19579
19580 .option filter_prepend_home redirect boolean true
19581 When this option is true, if a &(save)& command in an Exim filter specifies a
19582 relative path, and &$home$& is defined, it is automatically prepended to the
19583 relative path. If this option is set false, this action does not happen. The
19584 relative path is then passed to the transport unmodified.
19585
19586
19587 .option forbid_blackhole redirect boolean false
19588 If this option is true, the &':blackhole:'& item may not appear in a
19589 redirection list.
19590
19591
19592 .option forbid_exim_filter redirect boolean false
19593 If this option is set true, only Sieve filters are permitted when
19594 &%allow_filter%& is true.
19595
19596
19597
19598
19599 .option forbid_file redirect boolean false
19600 .cindex "delivery" "to file; forbidding"
19601 .cindex "Sieve filter" "forbidding delivery to a file"
19602 .cindex "Sieve filter" "&""keep""& facility; disabling"
19603 If this option is true, this router may not generate a new address that
19604 specifies delivery to a local file or directory, either from a filter or from a
19605 conventional forward file. This option is forced to be true if &%one_time%& is
19606 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19607 locks out the Sieve's &"keep"& facility.
19608
19609
19610 .option forbid_filter_dlfunc redirect boolean false
19611 .cindex "filter" "locking out certain features"
19612 If this option is true, string expansions in Exim filters are not allowed to
19613 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19614 functions.
19615
19616 .option forbid_filter_existstest redirect boolean false
19617 .cindex "expansion" "statting a file"
19618 If this option is true, string expansions in Exim filters are not allowed to
19619 make use of the &%exists%& condition or the &%stat%& expansion item.
19620
19621 .option forbid_filter_logwrite redirect boolean false
19622 If this option is true, use of the logging facility in Exim filters is not
19623 permitted. Logging is in any case available only if the filter is being run
19624 under some unprivileged uid (which is normally the case for ordinary users'
19625 &_.forward_& files).
19626
19627
19628 .option forbid_filter_lookup redirect boolean false
19629 If this option is true, string expansions in Exim filter files are not allowed
19630 to make use of &%lookup%& items.
19631
19632
19633 .option forbid_filter_perl redirect boolean false
19634 This option has an effect only if Exim is built with embedded Perl support. If
19635 it is true, string expansions in Exim filter files are not allowed to make use
19636 of the embedded Perl support.
19637
19638
19639 .option forbid_filter_readfile redirect boolean false
19640 If this option is true, string expansions in Exim filter files are not allowed
19641 to make use of &%readfile%& items.
19642
19643
19644 .option forbid_filter_readsocket redirect boolean false
19645 If this option is true, string expansions in Exim filter files are not allowed
19646 to make use of &%readsocket%& items.
19647
19648
19649 .option forbid_filter_reply redirect boolean false
19650 If this option is true, this router may not generate an automatic reply
19651 message. Automatic replies can be generated only from Exim or Sieve filter
19652 files, not from traditional forward files. This option is forced to be true if
19653 &%one_time%& is set.
19654
19655
19656 .option forbid_filter_run redirect boolean false
19657 If this option is true, string expansions in Exim filter files are not allowed
19658 to make use of &%run%& items.
19659
19660
19661 .option forbid_include redirect boolean false
19662 If this option is true, items of the form
19663 .code
19664 :include:<path name>
19665 .endd
19666 are not permitted in non-filter redirection lists.
19667
19668
19669 .option forbid_pipe redirect boolean false
19670 .cindex "delivery" "to pipe; forbidding"
19671 If this option is true, this router may not generate a new address which
19672 specifies delivery to a pipe, either from an Exim filter or from a conventional
19673 forward file. This option is forced to be true if &%one_time%& is set.
19674
19675
19676 .option forbid_sieve_filter redirect boolean false
19677 If this option is set true, only Exim filters are permitted when
19678 &%allow_filter%& is true.
19679
19680
19681 .cindex "SMTP" "error codes"
19682 .option forbid_smtp_code redirect boolean false
19683 If this option is set true, any SMTP error codes that are present at the start
19684 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19685 the default codes (451 and 550, respectively) are always used.
19686
19687
19688
19689
19690 .option hide_child_in_errmsg redirect boolean false
19691 .cindex "bounce message" "redirection details; suppressing"
19692 If this option is true, it prevents Exim from quoting a child address if it
19693 generates a bounce or delay message for it. Instead it says &"an address
19694 generated from <&'the top level address'&>"&. Of course, this applies only to
19695 bounces generated locally. If a message is forwarded to another host, &'its'&
19696 bounce may well quote the generated address.
19697
19698
19699 .option ignore_eacces redirect boolean false
19700 .cindex "EACCES"
19701 If this option is set and an attempt to open a redirection file yields the
19702 EACCES error (permission denied), the &(redirect)& router behaves as if the
19703 file did not exist.
19704
19705
19706 .option ignore_enotdir redirect boolean false
19707 .cindex "ENOTDIR"
19708 If this option is set and an attempt to open a redirection file yields the
19709 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19710 router behaves as if the file did not exist.
19711
19712 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19713 router that has the &%file%& option set discovers that the file does not exist
19714 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19715 against unmounted NFS directories. If the parent can not be statted, delivery
19716 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19717 is set, because that option tells Exim to ignore &"something on the path is not
19718 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19719 that some operating systems give ENOENT where others give ENOTDIR.
19720
19721
19722
19723 .option include_directory redirect string unset
19724 If this option is set, the path names of any &':include:'& items in a
19725 redirection list must start with this directory.
19726
19727
19728 .option modemask redirect "octal integer" 022
19729 This specifies mode bits which must not be set for a file specified by the
19730 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19731
19732
19733 .option one_time redirect boolean false
19734 .cindex "one-time aliasing/forwarding expansion"
19735 .cindex "alias file" "one-time expansion"
19736 .cindex "forward file" "one-time expansion"
19737 .cindex "mailing lists" "one-time expansion"
19738 .cindex "address redirection" "one-time expansion"
19739 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19740 files each time it tries to deliver a message causes a problem when one or more
19741 of the generated addresses fails be delivered at the first attempt. The problem
19742 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19743 but of what happens when the redirection list changes during the time that the
19744 message is on Exim's queue. This is particularly true in the case of mailing
19745 lists, where new subscribers might receive copies of messages that were posted
19746 before they subscribed.
19747
19748 If &%one_time%& is set and any addresses generated by the router fail to
19749 deliver at the first attempt, the failing addresses are added to the message as
19750 &"top level"& addresses, and the parent address that generated them is marked
19751 &"delivered"&. Thus, redirection does not happen again at the next delivery
19752 attempt.
19753
19754 &*Warning 1*&: Any header line addition or removal that is specified by this
19755 router would be lost if delivery did not succeed at the first attempt. For this
19756 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19757 permitted when &%one_time%& is set.
19758
19759 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19760 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19761 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19762
19763 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19764 &%one_time%&.
19765
19766 The original top-level address is remembered with each of the generated
19767 addresses, and is output in any log messages. However, any intermediate parent
19768 addresses are not recorded. This makes a difference to the log only if
19769 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19770 typically be used for mailing lists, where there is normally just one level of
19771 expansion.
19772
19773
19774 .option owners redirect "string list" unset
19775 .cindex "ownership" "alias file"
19776 .cindex "ownership" "forward file"
19777 .cindex "alias file" "ownership"
19778 .cindex "forward file" "ownership"
19779 This specifies a list of permitted owners for the file specified by &%file%&.
19780 This list is in addition to the local user when &%check_local_user%& is set.
19781 See &%check_owner%& above.
19782
19783
19784 .option owngroups redirect "string list" unset
19785 This specifies a list of permitted groups for the file specified by &%file%&.
19786 The list is in addition to the local user's primary group when
19787 &%check_local_user%& is set. See &%check_group%& above.
19788
19789
19790 .option pipe_transport redirect string&!! unset
19791 .vindex "&$address_pipe$&"
19792 A &(redirect)& router sets up a direct delivery to a pipe when a string
19793 starting with a vertical bar character is specified as a new &"address"&. The
19794 transport used is specified by this option, which, after expansion, must be the
19795 name of a configured transport. This should normally be a &(pipe)& transport.
19796 When the transport is run, the pipe command is in &$address_pipe$&.
19797
19798
19799 .option qualify_domain redirect string&!! unset
19800 .vindex "&$qualify_recipient$&"
19801 If this option is set, and an unqualified address (one without a domain) is
19802 generated, and that address would normally be qualified by the global setting
19803 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19804 expanding this string. If the expansion fails, the router declines. If you want
19805 to revert to the default, you can have the expansion generate
19806 &$qualify_recipient$&.
19807
19808 This option applies to all unqualified addresses generated by Exim filters,
19809 but for traditional &_.forward_& files, it applies only to addresses that are
19810 not preceded by a backslash. Sieve filters cannot generate unqualified
19811 addresses.
19812
19813 .option qualify_preserve_domain redirect boolean false
19814 .cindex "domain" "in redirection; preserving"
19815 .cindex "preserving domain in redirection"
19816 .cindex "address redirection" "domain; preserving"
19817 If this option is set, the router's local &%qualify_domain%& option must not be
19818 set (a configuration error occurs if it is). If an unqualified address (one
19819 without a domain) is generated, it is qualified with the domain of the parent
19820 address (the immediately preceding ancestor) instead of the global
19821 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19822 this applies whether or not the address is preceded by a backslash.
19823
19824
19825 .option repeat_use redirect boolean true
19826 If this option is set false, the router is skipped for a child address that has
19827 any ancestor that was routed by this router. This test happens before any of
19828 the other preconditions are tested. Exim's default anti-looping rules skip
19829 only when the ancestor is the same as the current address. See also
19830 &%check_ancestor%& above and the generic &%redirect_router%& option.
19831
19832
19833 .option reply_transport redirect string&!! unset
19834 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19835 &%vacation%& command is used in a filter file. The transport used is specified
19836 by this option, which, after expansion, must be the name of a configured
19837 transport. This should normally be an &(autoreply)& transport. Other transports
19838 are unlikely to do anything sensible or useful.
19839
19840
19841 .option rewrite redirect boolean true
19842 .cindex "address redirection" "disabling rewriting"
19843 If this option is set false, addresses generated by the router are not
19844 subject to address rewriting. Otherwise, they are treated like new addresses
19845 and are rewritten according to the global rewriting rules.
19846
19847
19848 .option sieve_subaddress redirect string&!! unset
19849 The value of this option is passed to a Sieve filter to specify the
19850 :subaddress part of an address.
19851
19852 .option sieve_useraddress redirect string&!! unset
19853 The value of this option is passed to a Sieve filter to specify the :user part
19854 of an address. However, if it is unset, the entire original local part
19855 (including any prefix or suffix) is used for :user.
19856
19857
19858 .option sieve_vacation_directory redirect string&!! unset
19859 .cindex "Sieve filter" "vacation directory"
19860 To enable the &"vacation"& extension for Sieve filters, you must set
19861 &%sieve_vacation_directory%& to the directory where vacation databases are held
19862 (do not put anything else in that directory), and ensure that the
19863 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
19864 needs their own directory; Exim will create it if necessary.
19865
19866
19867
19868 .option skip_syntax_errors redirect boolean false
19869 .cindex "forward file" "broken"
19870 .cindex "address redirection" "broken files"
19871 .cindex "alias file" "broken"
19872 .cindex "broken alias or forward files"
19873 .cindex "ignoring faulty addresses"
19874 .cindex "skipping faulty addresses"
19875 .cindex "error" "skipping bad syntax"
19876 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
19877 non-filter redirection data are skipped, and each failing address is logged. If
19878 &%syntax_errors_to%& is set, a message is sent to the address it defines,
19879 giving details of the failures. If &%syntax_errors_text%& is set, its contents
19880 are expanded and placed at the head of the error message generated by
19881 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
19882 be the same address as the generic &%errors_to%& option. The
19883 &%skip_syntax_errors%& option is often used when handling mailing lists.
19884
19885 If all the addresses in a redirection list are skipped because of syntax
19886 errors, the router declines to handle the original address, and it is passed to
19887 the following routers.
19888
19889 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
19890 error in the filter causes filtering to be abandoned without any action being
19891 taken. The incident is logged, and the router declines to handle the address,
19892 so it is passed to the following routers.
19893
19894 .cindex "Sieve filter" "syntax errors in"
19895 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
19896 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
19897 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
19898
19899 &%skip_syntax_errors%& can be used to specify that errors in users' forward
19900 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
19901 option, used with an address that does not get redirected, can be used to
19902 notify users of these errors, by means of a router like this:
19903 .code
19904 userforward:
19905   driver = redirect
19906   allow_filter
19907   check_local_user
19908   file = $home/.forward
19909   file_transport = address_file
19910   pipe_transport = address_pipe
19911   reply_transport = address_reply
19912   no_verify
19913   skip_syntax_errors
19914   syntax_errors_to = real-$local_part@$domain
19915   syntax_errors_text = \
19916    This is an automatically generated message. An error has\n\
19917    been found in your .forward file. Details of the error are\n\
19918    reported below. While this error persists, you will receive\n\
19919    a copy of this message for every message that is addressed\n\
19920    to you. If your .forward file is a filter file, or if it is\n\
19921    a non-filter file containing no valid forwarding addresses,\n\
19922    a copy of each incoming message will be put in your normal\n\
19923    mailbox. If a non-filter file contains at least one valid\n\
19924    forwarding address, forwarding to the valid addresses will\n\
19925    happen, and those will be the only deliveries that occur.
19926 .endd
19927 You also need a router to ensure that local addresses that are prefixed by
19928 &`real-`& are recognized, but not forwarded or filtered. For example, you could
19929 put this immediately before the &(userforward)& router:
19930 .code
19931 real_localuser:
19932   driver = accept
19933   check_local_user
19934   local_part_prefix = real-
19935   transport = local_delivery
19936 .endd
19937 For security, it would probably be a good idea to restrict the use of this
19938 router to locally-generated messages, using a condition such as this:
19939 .code
19940   condition = ${if match {$sender_host_address}\
19941                          {\N^(|127\.0\.0\.1)$\N}}
19942 .endd
19943
19944
19945 .option syntax_errors_text redirect string&!! unset
19946 See &%skip_syntax_errors%& above.
19947
19948
19949 .option syntax_errors_to redirect string unset
19950 See &%skip_syntax_errors%& above.
19951 .ecindex IIDredrou1
19952 .ecindex IIDredrou2
19953
19954
19955
19956
19957
19958
19959 . ////////////////////////////////////////////////////////////////////////////
19960 . ////////////////////////////////////////////////////////////////////////////
19961
19962 .chapter "Environment for running local transports" "CHAPenvironment" &&&
19963          "Environment for local transports"
19964 .scindex IIDenvlotra1 "local transports" "environment for"
19965 .scindex IIDenvlotra2 "environment for local transports"
19966 .scindex IIDenvlotra3 "transport" "local; environment for"
19967 Local transports handle deliveries to files and pipes. (The &(autoreply)&
19968 transport can be thought of as similar to a pipe.) Exim always runs transports
19969 in subprocesses, under specified uids and gids. Typical deliveries to local
19970 mailboxes run under the uid and gid of the local user.
19971
19972 Exim also sets a specific current directory while running the transport; for
19973 some transports a home directory setting is also relevant. The &(pipe)&
19974 transport is the only one that sets up environment variables; see section
19975 &<<SECTpipeenv>>& for details.
19976
19977 The values used for the uid, gid, and the directories may come from several
19978 different places. In many cases, the router that handles the address associates
19979 settings with that address as a result of its &%check_local_user%&, &%group%&,
19980 or &%user%& options. However, values may also be given in the transport's own
19981 configuration, and these override anything that comes from the router.
19982
19983
19984
19985 .section "Concurrent deliveries" "SECID131"
19986 .cindex "concurrent deliveries"
19987 .cindex "simultaneous deliveries"
19988 If two different messages for the same local recipient arrive more or less
19989 simultaneously, the two delivery processes are likely to run concurrently. When
19990 the &(appendfile)& transport is used to write to a file, Exim applies locking
19991 rules to stop concurrent processes from writing to the same file at the same
19992 time.
19993
19994 However, when you use a &(pipe)& transport, it is up to you to arrange any
19995 locking that is needed. Here is a silly example:
19996 .code
19997 my_transport:
19998   driver = pipe
19999   command = /bin/sh -c 'cat >>/some/file'
20000 .endd
20001 This is supposed to write the message at the end of the file. However, if two
20002 messages arrive at the same time, the file will be scrambled. You can use the
20003 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20004 file using the same algorithm that Exim itself uses.
20005
20006
20007
20008
20009 .section "Uids and gids" "SECTenvuidgid"
20010 .cindex "local transports" "uid and gid"
20011 .cindex "transport" "local; uid and gid"
20012 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20013 overrides any group that the router set in the address, even if &%user%& is not
20014 set for the transport. This makes it possible, for example, to run local mail
20015 delivery under the uid of the recipient (set by the router), but in a special
20016 group (set by the transport). For example:
20017 .code
20018 # Routers ...
20019 # User/group are set by check_local_user in this router
20020 local_users:
20021   driver = accept
20022   check_local_user
20023   transport = group_delivery
20024
20025 # Transports ...
20026 # This transport overrides the group
20027 group_delivery:
20028   driver = appendfile
20029   file = /var/spool/mail/$local_part
20030   group = mail
20031 .endd
20032 If &%user%& is set for a transport, its value overrides what is set in the
20033 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20034 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20035 set.
20036
20037 .oindex "&%initgroups%&"
20038 When the uid is taken from the transport's configuration, the &[initgroups()]&
20039 function is called for the groups associated with that uid if the
20040 &%initgroups%& option is set for the transport. When the uid is not specified
20041 by the transport, but is associated with the address by a router, the option
20042 for calling &[initgroups()]& is taken from the router configuration.
20043
20044 .cindex "&(pipe)& transport" "uid for"
20045 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20046 is set and &%user%& is not set, the uid of the process that called Exim to
20047 receive the message is used, and if &%group%& is not set, the corresponding
20048 original gid is also used.
20049
20050 This is the detailed preference order for obtaining a gid; the first of the
20051 following that is set is used:
20052
20053 .ilist
20054 A &%group%& setting of the transport;
20055 .next
20056 A &%group%& setting of the router;
20057 .next
20058 A gid associated with a user setting of the router, either as a result of
20059 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20060 .next
20061 The group associated with a non-numeric &%user%& setting of the transport;
20062 .next
20063 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20064 the uid is the creator's uid;
20065 .next
20066 The Exim gid if the Exim uid is being used as a default.
20067 .endlist
20068
20069 If, for example, the user is specified numerically on the router and there are
20070 no group settings, no gid is available. In this situation, an error occurs.
20071 This is different for the uid, for which there always is an ultimate default.
20072 The first of the following that is set is used:
20073
20074 .ilist
20075 A &%user%& setting of the transport;
20076 .next
20077 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20078 .next
20079 A &%user%& setting of the router;
20080 .next
20081 A &%check_local_user%& setting of the router;
20082 .next
20083 The Exim uid.
20084 .endlist
20085
20086 Of course, an error will still occur if the uid that is chosen is on the
20087 &%never_users%& list.
20088
20089
20090
20091
20092
20093 .section "Current and home directories" "SECID132"
20094 .cindex "current directory for local transport"
20095 .cindex "home directory" "for local transport"
20096 .cindex "transport" "local; home directory for"
20097 .cindex "transport" "local; current directory for"
20098 Routers may set current and home directories for local transports by means of
20099 the &%transport_current_directory%& and &%transport_home_directory%& options.
20100 However, if the transport's &%current_directory%& or &%home_directory%& options
20101 are set, they override the router's values. In detail, the home directory
20102 for a local transport is taken from the first of these values that is set:
20103
20104 .ilist
20105 The &%home_directory%& option on the transport;
20106 .next
20107 The &%transport_home_directory%& option on the router;
20108 .next
20109 The password data if &%check_local_user%& is set on the router;
20110 .next
20111 The &%router_home_directory%& option on the router.
20112 .endlist
20113
20114 The current directory is taken from the first of these values that is set:
20115
20116 .ilist
20117 The &%current_directory%& option on the transport;
20118 .next
20119 The &%transport_current_directory%& option on the router.
20120 .endlist
20121
20122
20123 If neither the router nor the transport sets a current directory, Exim uses the
20124 value of the home directory, if it is set. Otherwise it sets the current
20125 directory to &_/_& before running a local transport.
20126
20127
20128
20129 .section "Expansion variables derived from the address" "SECID133"
20130 .vindex "&$domain$&"
20131 .vindex "&$local_part$&"
20132 .vindex "&$original_domain$&"
20133 Normally a local delivery is handling a single address, and in that case the
20134 variables such as &$domain$& and &$local_part$& are set during local
20135 deliveries. However, in some circumstances more than one address may be handled
20136 at once (for example, while writing batch SMTP for onward transmission by some
20137 other means). In this case, the variables associated with the local part are
20138 never set, &$domain$& is set only if all the addresses have the same domain,
20139 and &$original_domain$& is never set.
20140 .ecindex IIDenvlotra1
20141 .ecindex IIDenvlotra2
20142 .ecindex IIDenvlotra3
20143
20144
20145
20146
20147
20148
20149
20150 . ////////////////////////////////////////////////////////////////////////////
20151 . ////////////////////////////////////////////////////////////////////////////
20152
20153 .chapter "Generic options for transports" "CHAPtransportgeneric"
20154 .scindex IIDgenoptra1 "generic options" "transport"
20155 .scindex IIDgenoptra2 "options" "generic; for transports"
20156 .scindex IIDgenoptra3 "transport" "generic options for"
20157 The following generic options apply to all transports:
20158
20159
20160 .option body_only transports boolean false
20161 .cindex "transport" "body only"
20162 .cindex "message" "transporting body only"
20163 .cindex "body of message" "transporting"
20164 If this option is set, the message's headers are not transported. It is
20165 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20166 or &(pipe)& transports, the settings of &%message_prefix%& and
20167 &%message_suffix%& should be checked, because this option does not
20168 automatically suppress them.
20169
20170
20171 .option current_directory transports string&!! unset
20172 .cindex "transport" "current directory for"
20173 This specifies the current directory that is to be set while running the
20174 transport, overriding any value that may have been set by the router.
20175 If the expansion fails for any reason, including forced failure, an error is
20176 logged, and delivery is deferred.
20177
20178
20179 .option disable_logging transports boolean false
20180 If this option is set true, nothing is logged for any
20181 deliveries by the transport or for any
20182 transport errors. You should not set this option unless you really, really know
20183 what you are doing.
20184
20185
20186 .option debug_print transports string&!! unset
20187 .cindex "testing" "variables in drivers"
20188 If this option is set and debugging is enabled (see the &%-d%& command line
20189 option), the string is expanded and included in the debugging output when the
20190 transport is run.
20191 If expansion of the string fails, the error message is written to the debugging
20192 output, and Exim carries on processing.
20193 This facility is provided to help with checking out the values of variables and
20194 so on when debugging driver configurations. For example, if a &%headers_add%&
20195 option is not working properly, &%debug_print%& could be used to output the
20196 variables it references. A newline is added to the text if it does not end with
20197 one.
20198 The variables &$transport_name$& and &$router_name$& contain the name of the
20199 transport and the router that called it.
20200
20201 .option delivery_date_add transports boolean false
20202 .cindex "&'Delivery-date:'& header line"
20203 If this option is true, a &'Delivery-date:'& header is added to the message.
20204 This gives the actual time the delivery was made. As this is not a standard
20205 header, Exim has a configuration option (&%delivery_date_remove%&) which
20206 requests its removal from incoming messages, so that delivered messages can
20207 safely be resent to other recipients.
20208
20209
20210 .option driver transports string unset
20211 This specifies which of the available transport drivers is to be used.
20212 There is no default, and this option must be set for every transport.
20213
20214
20215 .option envelope_to_add transports boolean false
20216 .cindex "&'Envelope-to:'& header line"
20217 If this option is true, an &'Envelope-to:'& header is added to the message.
20218 This gives the original address(es) in the incoming envelope that caused this
20219 delivery to happen. More than one address may be present if the transport is
20220 configured to handle several addresses at once, or if more than one original
20221 address was redirected to the same final address. As this is not a standard
20222 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20223 its removal from incoming messages, so that delivered messages can safely be
20224 resent to other recipients.
20225
20226
20227 .option group transports string&!! "Exim group"
20228 .cindex "transport" "group; specifying"
20229 This option specifies a gid for running the transport process, overriding any
20230 value that the router supplies, and also overriding any value associated with
20231 &%user%& (see below).
20232
20233
20234 .option headers_add transports list&!! unset
20235 .cindex "header lines" "adding in transport"
20236 .cindex "transport" "header lines; adding"
20237 This option specifies a list of text headers, newline-separated,
20238 which are (separately) expanded and added to the header
20239 portion of a message as it is transported, as described in section
20240 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20241 routers. If the result of the expansion is an empty string, or if the expansion
20242 is forced to fail, no action is taken. Other expansion failures are treated as
20243 errors and cause the delivery to be deferred.
20244
20245 Unlike most options, &%headers_add%& can be specified multiple times
20246 for a transport; all listed headers are added.
20247
20248
20249 .option headers_only transports boolean false
20250 .cindex "transport" "header lines only"
20251 .cindex "message" "transporting headers only"
20252 .cindex "header lines" "transporting"
20253 If this option is set, the message's body is not transported. It is mutually
20254 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20255 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20256 checked, since this option does not automatically suppress them.
20257
20258
20259 .option headers_remove transports list&!! unset
20260 .cindex "header lines" "removing"
20261 .cindex "transport" "header lines; removing"
20262 This option specifies a list of header names, colon-separated;
20263 these headers are omitted from the message as it is transported, as described
20264 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20265 routers.
20266 Each list item is separately expanded.
20267 If the result of the expansion is an empty string, or if the expansion
20268 is forced to fail, no action is taken. Other expansion failures are treated as
20269 errors and cause the delivery to be deferred.
20270
20271 Unlike most options, &%headers_remove%& can be specified multiple times
20272 for a router; all listed headers are removed.
20273
20274
20275
20276 .option headers_rewrite transports string unset
20277 .cindex "transport" "header lines; rewriting"
20278 .cindex "rewriting" "at transport time"
20279 This option allows addresses in header lines to be rewritten at transport time,
20280 that is, as the message is being copied to its destination. The contents of the
20281 option are a colon-separated list of rewriting rules. Each rule is in exactly
20282 the same form as one of the general rewriting rules that are applied when a
20283 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20284 example,
20285 .code
20286 headers_rewrite = a@b c@d f : \
20287                   x@y w@z
20288 .endd
20289 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20290 &'w@z'& in all address-bearing header lines. The rules are applied to the
20291 header lines just before they are written out at transport time, so they affect
20292 only those copies of the message that pass through the transport. However, only
20293 the message's original header lines, and any that were added by a system
20294 filter, are rewritten. If a router or transport adds header lines, they are not
20295 affected by this option. These rewriting rules are &'not'& applied to the
20296 envelope. You can change the return path using &%return_path%&, but you cannot
20297 change envelope recipients at this time.
20298
20299
20300 .option home_directory transports string&!! unset
20301 .cindex "transport" "home directory for"
20302 .vindex "&$home$&"
20303 This option specifies a home directory setting for a local transport,
20304 overriding any value that may be set by the router. The home directory is
20305 placed in &$home$& while expanding the transport's private options. It is also
20306 used as the current directory if no current directory is set by the
20307 &%current_directory%& option on the transport or the
20308 &%transport_current_directory%& option on the router. If the expansion fails
20309 for any reason, including forced failure, an error is logged, and delivery is
20310 deferred.
20311
20312
20313 .option initgroups transports boolean false
20314 .cindex "additional groups"
20315 .cindex "groups" "additional"
20316 .cindex "transport" "group; additional"
20317 If this option is true and the uid for the delivery process is provided by the
20318 transport, the &[initgroups()]& function is called when running the transport
20319 to ensure that any additional groups associated with the uid are set up.
20320
20321
20322 .option message_size_limit transports string&!! 0
20323 .cindex "limit" "message size per transport"
20324 .cindex "size" "of message, limit"
20325 .cindex "transport" "message size; limiting"
20326 This option controls the size of messages passed through the transport. It is
20327 expanded before use; the result of the expansion must be a sequence of decimal
20328 digits, optionally followed by K or M. If the expansion fails for any reason,
20329 including forced failure, or if the result is not of the required form,
20330 delivery is deferred. If the value is greater than zero and the size of a
20331 message exceeds this limit, the address is failed. If there is any chance that
20332 the resulting bounce message could be routed to the same transport, you should
20333 ensure that &%return_size_limit%& is less than the transport's
20334 &%message_size_limit%&, as otherwise the bounce message will fail to get
20335 delivered.
20336
20337
20338
20339 .option rcpt_include_affixes transports boolean false
20340 .cindex "prefix" "for local part, including in envelope"
20341 .cindex "suffix for local part" "including in envelope"
20342 .cindex "local part" "prefix"
20343 .cindex "local part" "suffix"
20344 When this option is false (the default), and an address that has had any
20345 affixes (prefixes or suffixes) removed from the local part is delivered by any
20346 form of SMTP or LMTP, the affixes are not included. For example, if a router
20347 that contains
20348 .code
20349 local_part_prefix = *-
20350 .endd
20351 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20352 is delivered with
20353 .code
20354 RCPT TO:<xyz@some.domain>
20355 .endd
20356 This is also the case when an ACL-time callout is being used to verify a
20357 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20358 whole local part is included in the RCPT command. This option applies to BSMTP
20359 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20360 &(lmtp)& and &(smtp)& transports.
20361
20362
20363 .option retry_use_local_part transports boolean "see below"
20364 .cindex "hints database" "retry keys"
20365 When a delivery suffers a temporary failure, a retry record is created
20366 in Exim's hints database. For remote deliveries, the key for the retry record
20367 is based on the name and/or IP address of the failing remote host. For local
20368 deliveries, the key is normally the entire address, including both the local
20369 part and the domain. This is suitable for most common cases of local delivery
20370 temporary failure &-- for example, exceeding a mailbox quota should delay only
20371 deliveries to that mailbox, not to the whole domain.
20372
20373 However, in some special cases you may want to treat a temporary local delivery
20374 as a failure associated with the domain, and not with a particular local part.
20375 (For example, if you are storing all mail for some domain in files.) You can do
20376 this by setting &%retry_use_local_part%& false.
20377
20378 For all the local transports, its default value is true. For remote transports,
20379 the default value is false for tidiness, but changing the value has no effect
20380 on a remote transport in the current implementation.
20381
20382
20383 .option return_path transports string&!! unset
20384 .cindex "envelope sender"
20385 .cindex "transport" "return path; changing"
20386 .cindex "return path" "changing in transport"
20387 If this option is set, the string is expanded at transport time and replaces
20388 the existing return path (envelope sender) value in the copy of the message
20389 that is being delivered. An empty return path is permitted. This feature is
20390 designed for remote deliveries, where the value of this option is used in the
20391 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20392 only effect is to change the address that is placed in the &'Return-path:'&
20393 header line, if one is added to the message (see the next option).
20394
20395 &*Note:*& A changed return path is not logged unless you add
20396 &%return_path_on_delivery%& to the log selector.
20397
20398 .vindex "&$return_path$&"
20399 The expansion can refer to the existing value via &$return_path$&. This is
20400 either the message's envelope sender, or an address set by the
20401 &%errors_to%& option on a router. If the expansion is forced to fail, no
20402 replacement occurs; if it fails for another reason, delivery is deferred. This
20403 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20404 section &<<SECTverp>>&.
20405
20406 &*Note*&: If a delivery error is detected locally, including the case when a
20407 remote server rejects a message at SMTP time, the bounce message is not sent to
20408 the value of this option. It is sent to the previously set errors address.
20409 This defaults to the incoming sender address, but can be changed by setting
20410 &%errors_to%& in a router.
20411
20412
20413
20414 .option return_path_add transports boolean false
20415 .cindex "&'Return-path:'& header line"
20416 If this option is true, a &'Return-path:'& header is added to the message.
20417 Although the return path is normally available in the prefix line of BSD
20418 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20419 have easy access to it.
20420
20421 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20422 the delivery SMTP server makes the final delivery"&. This implies that this
20423 header should not be present in incoming messages. Exim has a configuration
20424 option, &%return_path_remove%&, which requests removal of this header from
20425 incoming messages, so that delivered messages can safely be resent to other
20426 recipients.
20427
20428
20429 .option shadow_condition transports string&!! unset
20430 See &%shadow_transport%& below.
20431
20432
20433 .option shadow_transport transports string unset
20434 .cindex "shadow transport"
20435 .cindex "transport" "shadow"
20436 A local transport may set the &%shadow_transport%& option to the name of
20437 another local transport. Shadow remote transports are not supported.
20438
20439 Whenever a delivery to the main transport succeeds, and either
20440 &%shadow_condition%& is unset, or its expansion does not result in the empty
20441 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20442 passed to the shadow transport, with the same delivery address or addresses. If
20443 expansion fails, no action is taken except that non-forced expansion failures
20444 cause a log line to be written.
20445
20446 The result of the shadow transport is discarded and does not affect the
20447 subsequent processing of the message. Only a single level of shadowing is
20448 provided; the &%shadow_transport%& option is ignored on any transport when it
20449 is running as a shadow. Options concerned with output from pipes are also
20450 ignored. The log line for the successful delivery has an item added on the end,
20451 of the form
20452 .code
20453 ST=<shadow transport name>
20454 .endd
20455 If the shadow transport did not succeed, the error message is put in
20456 parentheses afterwards. Shadow transports can be used for a number of different
20457 purposes, including keeping more detailed log information than Exim normally
20458 provides, and implementing automatic acknowledgment policies based on message
20459 headers that some sites insist on.
20460
20461
20462 .option transport_filter transports string&!! unset
20463 .cindex "transport" "filter"
20464 .cindex "filter" "transport filter"
20465 This option sets up a filtering (in the Unix shell sense) process for messages
20466 at transport time. It should not be confused with mail filtering as set up by
20467 individual users or via a system filter.
20468
20469 When the message is about to be written out, the command specified by
20470 &%transport_filter%& is started up in a separate, parallel process, and
20471 the entire message, including the header lines, is passed to it on its standard
20472 input (this in fact is done from a third process, to avoid deadlock). The
20473 command must be specified as an absolute path.
20474
20475 The lines of the message that are written to the transport filter are
20476 terminated by newline (&"\n"&). The message is passed to the filter before any
20477 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20478 lines beginning with a dot, and also before any processing implied by the
20479 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20480 &(pipe)& transports.
20481
20482 The standard error for the filter process is set to the same destination as its
20483 standard output; this is read and written to the message's ultimate
20484 destination. The process that writes the message to the filter, the
20485 filter itself, and the original process that reads the result and delivers it
20486 are all run in parallel, like a shell pipeline.
20487
20488 The filter can perform any transformations it likes, but of course should take
20489 care not to break RFC 2822 syntax. Exim does not check the result, except to
20490 test for a final newline when SMTP is in use. All messages transmitted over
20491 SMTP must end with a newline, so Exim supplies one if it is missing.
20492
20493 .cindex "content scanning" "per user"
20494 A transport filter can be used to provide content-scanning on a per-user basis
20495 at delivery time if the only required effect of the scan is to modify the
20496 message. For example, a content scan could insert a new header line containing
20497 a spam score. This could be interpreted by a filter in the user's MUA. It is
20498 not possible to discard a message at this stage.
20499
20500 .cindex "SMTP" "SIZE"
20501 A problem might arise if the filter increases the size of a message that is
20502 being sent down an SMTP connection. If the receiving SMTP server has indicated
20503 support for the SIZE parameter, Exim will have sent the size of the message
20504 at the start of the SMTP session. If what is actually sent is substantially
20505 more, the server might reject the message. This can be worked round by setting
20506 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20507 additions to the message, or to disable the use of SIZE altogether.
20508
20509 .vindex "&$pipe_addresses$&"
20510 The value of the &%transport_filter%& option is the command string for starting
20511 the filter, which is run directly from Exim, not under a shell. The string is
20512 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20513 Exim breaks it up into arguments and then expands each argument separately (see
20514 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20515 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20516 of arguments, one for each address that applies to this delivery. (This isn't
20517 an ideal name for this feature here, but as it was already implemented for the
20518 &(pipe)& transport, it seemed sensible not to change it.)
20519
20520 .vindex "&$host$&"
20521 .vindex "&$host_address$&"
20522 The expansion variables &$host$& and &$host_address$& are available when the
20523 transport is a remote one. They contain the name and IP address of the host to
20524 which the message is being sent. For example:
20525 .code
20526 transport_filter = /some/directory/transport-filter.pl \
20527   $host $host_address $sender_address $pipe_addresses
20528 .endd
20529
20530 Two problems arise if you want to use more complicated expansion items to
20531 generate transport filter commands, both of which due to the fact that the
20532 command is split up &'before'& expansion.
20533 .ilist
20534 If an expansion item contains white space, you must quote it, so that it is all
20535 part of the same command item. If the entire option setting is one such
20536 expansion item, you have to take care what kind of quoting you use. For
20537 example:
20538 .code
20539 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20540 .endd
20541 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20542 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20543 stripped by Exim when it read the option's value. When the value is used, if
20544 the single quotes were missing, the line would be split into two items,
20545 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20546 Exim tried to expand the first one.
20547 .next
20548 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20549 expansion cannot generate multiple arguments, or a command name followed by
20550 arguments. Consider this example:
20551 .code
20552 transport_filter = ${lookup{$host}lsearch{/a/file}\
20553                     {$value}{/bin/cat}}
20554 .endd
20555 The result of the lookup is interpreted as the name of the command, even
20556 if it contains white space. The simplest way round this is to use a shell:
20557 .code
20558 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20559                                {$value}{/bin/cat}}
20560 .endd
20561 .endlist
20562
20563 The filter process is run under the same uid and gid as the normal delivery.
20564 For remote deliveries this is the Exim uid/gid by default. The command should
20565 normally yield a zero return code. Transport filters are not supposed to fail.
20566 A non-zero code is taken to mean that the transport filter encountered some
20567 serious problem. Delivery of the message is deferred; the message remains on
20568 the queue and is tried again later. It is not possible to cause a message to be
20569 bounced from a transport filter.
20570
20571 If a transport filter is set on an autoreply transport, the original message is
20572 passed through the filter as it is being copied into the newly generated
20573 message, which happens if the &%return_message%& option is set.
20574
20575
20576 .option transport_filter_timeout transports time 5m
20577 .cindex "transport" "filter, timeout"
20578 When Exim is reading the output of a transport filter, it applies a timeout
20579 that can be set by this option. Exceeding the timeout is normally treated as a
20580 temporary delivery failure. However, if a transport filter is used with a
20581 &(pipe)& transport, a timeout in the transport filter is treated in the same
20582 way as a timeout in the pipe command itself. By default, a timeout is a hard
20583 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20584 becomes a temporary error.
20585
20586
20587 .option user transports string&!! "Exim user"
20588 .cindex "uid (user id)" "local delivery"
20589 .cindex "transport" "user, specifying"
20590 This option specifies the user under whose uid the delivery process is to be
20591 run, overriding any uid that may have been set by the router. If the user is
20592 given as a name, the uid is looked up from the password data, and the
20593 associated group is taken as the value of the gid to be used if the &%group%&
20594 option is not set.
20595
20596 For deliveries that use local transports, a user and group are normally
20597 specified explicitly or implicitly (for example, as a result of
20598 &%check_local_user%&) by the router or transport.
20599
20600 .cindex "hints database" "access by remote transport"
20601 For remote transports, you should leave this option unset unless you really are
20602 sure you know what you are doing. When a remote transport is running, it needs
20603 to be able to access Exim's hints databases, because each host may have its own
20604 retry data.
20605 .ecindex IIDgenoptra1
20606 .ecindex IIDgenoptra2
20607 .ecindex IIDgenoptra3
20608
20609
20610
20611
20612
20613
20614 . ////////////////////////////////////////////////////////////////////////////
20615 . ////////////////////////////////////////////////////////////////////////////
20616
20617 .chapter "Address batching in local transports" "CHAPbatching" &&&
20618          "Address batching"
20619 .cindex "transport" "local; address batching in"
20620 The only remote transport (&(smtp)&) is normally configured to handle more than
20621 one address at a time, so that when several addresses are routed to the same
20622 remote host, just one copy of the message is sent. Local transports, however,
20623 normally handle one address at a time. That is, a separate instance of the
20624 transport is run for each address that is routed to the transport. A separate
20625 copy of the message is delivered each time.
20626
20627 .cindex "batched local delivery"
20628 .oindex "&%batch_max%&"
20629 .oindex "&%batch_id%&"
20630 In special cases, it may be desirable to handle several addresses at once in a
20631 local transport, for example:
20632
20633 .ilist
20634 In an &(appendfile)& transport, when storing messages in files for later
20635 delivery by some other means, a single copy of the message with multiple
20636 recipients saves space.
20637 .next
20638 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20639 a single copy saves time, and is the normal way LMTP is expected to work.
20640 .next
20641 In a &(pipe)& transport, when passing the message
20642 to a scanner program or
20643 to some other delivery mechanism such as UUCP, multiple recipients may be
20644 acceptable.
20645 .endlist
20646
20647 These three local transports all have the same options for controlling multiple
20648 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20649 repeating the information for each transport, these options are described here.
20650
20651 The &%batch_max%& option specifies the maximum number of addresses that can be
20652 delivered together in a single run of the transport. Its default value is one
20653 (no batching). When more than one address is routed to a transport that has a
20654 &%batch_max%& value greater than one, the addresses are delivered in a batch
20655 (that is, in a single run of the transport with multiple recipients), subject
20656 to certain conditions:
20657
20658 .ilist
20659 .vindex "&$local_part$&"
20660 If any of the transport's options contain a reference to &$local_part$&, no
20661 batching is possible.
20662 .next
20663 .vindex "&$domain$&"
20664 If any of the transport's options contain a reference to &$domain$&, only
20665 addresses with the same domain are batched.
20666 .next
20667 .cindex "customizing" "batching condition"
20668 If &%batch_id%& is set, it is expanded for each address, and only those
20669 addresses with the same expanded value are batched. This allows you to specify
20670 customized batching conditions. Failure of the expansion for any reason,
20671 including forced failure, disables batching, but it does not stop the delivery
20672 from taking place.
20673 .next
20674 Batched addresses must also have the same errors address (where to send
20675 delivery errors), the same header additions and removals, the same user and
20676 group for the transport, and if a host list is present, the first host must
20677 be the same.
20678 .endlist
20679
20680 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20681 both when the file or pipe command is specified in the transport, and when it
20682 is specified by a &(redirect)& router, but all the batched addresses must of
20683 course be routed to the same file or pipe command. These two transports have an
20684 option called &%use_bsmtp%&, which causes them to deliver the message in
20685 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20686 &%check_string%& and &%escape_string%& options are forced to the values
20687 .code
20688 check_string = "."
20689 escape_string = ".."
20690 .endd
20691 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20692 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20693 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20694
20695 .cindex "&'Envelope-to:'& header line"
20696 If the generic &%envelope_to_add%& option is set for a batching transport, the
20697 &'Envelope-to:'& header that is added to the message contains all the addresses
20698 that are being processed together. If you are using a batching &(appendfile)&
20699 transport without &%use_bsmtp%&, the only way to preserve the recipient
20700 addresses is to set the &%envelope_to_add%& option.
20701
20702 .cindex "&(pipe)& transport" "with multiple addresses"
20703 .vindex "&$pipe_addresses$&"
20704 If you are using a &(pipe)& transport without BSMTP, and setting the
20705 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20706 the command. This is not a true variable; it is a bit of magic that causes each
20707 of the recipient addresses to be inserted into the command as a separate
20708 argument. This provides a way of accessing all the addresses that are being
20709 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20710 are specified by a &(redirect)& router.
20711
20712
20713
20714
20715 . ////////////////////////////////////////////////////////////////////////////
20716 . ////////////////////////////////////////////////////////////////////////////
20717
20718 .chapter "The appendfile transport" "CHAPappendfile"
20719 .scindex IIDapptra1 "&(appendfile)& transport"
20720 .scindex IIDapptra2 "transports" "&(appendfile)&"
20721 .cindex "directory creation"
20722 .cindex "creating directories"
20723 The &(appendfile)& transport delivers a message by appending it to an existing
20724 file, or by creating an entirely new file in a specified directory. Single
20725 files to which messages are appended can be in the traditional Unix mailbox
20726 format, or optionally in the MBX format supported by the Pine MUA and
20727 University of Washington IMAP daemon, &'inter alia'&. When each message is
20728 being delivered as a separate file, &"maildir"& format can optionally be used
20729 to give added protection against failures that happen part-way through the
20730 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20731 supported. For all file formats, Exim attempts to create as many levels of
20732 directory as necessary, provided that &%create_directory%& is set.
20733
20734 The code for the optional formats is not included in the Exim binary by
20735 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20736 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20737 included.
20738
20739 .cindex "quota" "system"
20740 Exim recognizes system quota errors, and generates an appropriate message. Exim
20741 also supports its own quota control within the transport, for use when the
20742 system facility is unavailable or cannot be used for some reason.
20743
20744 If there is an error while appending to a file (for example, quota exceeded or
20745 partition filled), Exim attempts to reset the file's length and last
20746 modification time back to what they were before. If there is an error while
20747 creating an entirely new file, the new file is removed.
20748
20749 Before appending to a file, a number of security checks are made, and the
20750 file is locked. A detailed description is given below, after the list of
20751 private options.
20752
20753 The &(appendfile)& transport is most commonly used for local deliveries to
20754 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20755 putting messages into files for remote delivery by some means other than Exim.
20756 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20757 option).
20758
20759
20760
20761 .section "The file and directory options" "SECTfildiropt"
20762 The &%file%& option specifies a single file, to which the message is appended;
20763 the &%directory%& option specifies a directory, in which a new file containing
20764 the message is created. Only one of these two options can be set, and for
20765 normal deliveries to mailboxes, one of them &'must'& be set.
20766
20767 .vindex "&$address_file$&"
20768 .vindex "&$local_part$&"
20769 However, &(appendfile)& is also used for delivering messages to files or
20770 directories whose names (or parts of names) are obtained from alias,
20771 forwarding, or filtering operations (for example, a &%save%& command in a
20772 user's Exim filter). When such a transport is running, &$local_part$& contains
20773 the local part that was aliased or forwarded, and &$address_file$& contains the
20774 name (or partial name) of the file or directory generated by the redirection
20775 operation. There are two cases:
20776
20777 .ilist
20778 If neither &%file%& nor &%directory%& is set, the redirection operation
20779 must specify an absolute path (one that begins with &`/`&). This is the most
20780 common case when users with local accounts use filtering to sort mail into
20781 different folders. See for example, the &(address_file)& transport in the
20782 default configuration. If the path ends with a slash, it is assumed to be the
20783 name of a directory. A delivery to a directory can also be forced by setting
20784 &%maildir_format%& or &%mailstore_format%&.
20785 .next
20786 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20787 used to determine the file or directory name for the delivery. Normally, the
20788 contents of &$address_file$& are used in some way in the string expansion.
20789 .endlist
20790
20791
20792 .cindex "Sieve filter" "configuring &(appendfile)&"
20793 .cindex "Sieve filter" "relative mailbox path handling"
20794 As an example of the second case, consider an environment where users do not
20795 have home directories. They may be permitted to use Exim filter commands of the
20796 form:
20797 .code
20798 save folder23
20799 .endd
20800 or Sieve filter commands of the form:
20801 .code
20802 require "fileinto";
20803 fileinto "folder23";
20804 .endd
20805 In this situation, the expansion of &%file%& or &%directory%& in the transport
20806 must transform the relative path into an appropriate absolute file name. In the
20807 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20808 is used as a result of a &"keep"& action in the filter. This example shows one
20809 way of handling this requirement:
20810 .code
20811 file = ${if eq{$address_file}{inbox} \
20812             {/var/mail/$local_part} \
20813             {${if eq{${substr_0_1:$address_file}}{/} \
20814                   {$address_file} \
20815                   {$home/mail/$address_file} \
20816             }} \
20817        }
20818 .endd
20819 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20820 location, absolute paths are used without change, and other folders are in the
20821 &_mail_& directory within the home directory.
20822
20823 &*Note 1*&: While processing an Exim filter, a relative path such as
20824 &_folder23_& is turned into an absolute path if a home directory is known to
20825 the router. In particular, this is the case if &%check_local_user%& is set. If
20826 you want to prevent this happening at routing time, you can set
20827 &%router_home_directory%& empty. This forces the router to pass the relative
20828 path to the transport.
20829
20830 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20831 the &%file%& or &%directory%& option is still used if it is set.
20832
20833
20834
20835
20836 .section "Private options for appendfile" "SECID134"
20837 .cindex "options" "&(appendfile)& transport"
20838
20839
20840
20841 .option allow_fifo appendfile boolean false
20842 .cindex "fifo (named pipe)"
20843 .cindex "named pipe (fifo)"
20844 .cindex "pipe" "named (fifo)"
20845 Setting this option permits delivery to named pipes (FIFOs) as well as to
20846 regular files. If no process is reading the named pipe at delivery time, the
20847 delivery is deferred.
20848
20849
20850 .option allow_symlink appendfile boolean false
20851 .cindex "symbolic link" "to mailbox"
20852 .cindex "mailbox" "symbolic link"
20853 By default, &(appendfile)& will not deliver if the path name for the file is
20854 that of a symbolic link. Setting this option relaxes that constraint, but there
20855 are security issues involved in the use of symbolic links. Be sure you know
20856 what you are doing if you set this. Details of exactly what this option affects
20857 are included in the discussion which follows this list of options.
20858
20859
20860 .option batch_id appendfile string&!! unset
20861 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20862 However, batching is automatically disabled for &(appendfile)& deliveries that
20863 happen as a result of forwarding or aliasing or other redirection directly to a
20864 file.
20865
20866
20867 .option batch_max appendfile integer 1
20868 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
20869
20870
20871 .option check_group appendfile boolean false
20872 When this option is set, the group owner of the file defined by the &%file%&
20873 option is checked to see that it is the same as the group under which the
20874 delivery process is running. The default setting is false because the default
20875 file mode is 0600, which means that the group is irrelevant.
20876
20877
20878 .option check_owner appendfile boolean true
20879 When this option is set, the owner of the file defined by the &%file%& option
20880 is checked to ensure that it is the same as the user under which the delivery
20881 process is running.
20882
20883
20884 .option check_string appendfile string "see below"
20885 .cindex "&""From""& line"
20886 As &(appendfile)& writes the message, the start of each line is tested for
20887 matching &%check_string%&, and if it does, the initial matching characters are
20888 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
20889 a literal string, not a regular expression, and the case of any letters it
20890 contains is significant.
20891
20892 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
20893 are forced to &"."& and &".."& respectively, and any settings in the
20894 configuration are ignored. Otherwise, they default to &"From&~"& and
20895 &">From&~"& when the &%file%& option is set, and unset when any of the
20896 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
20897
20898 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
20899 suitable for traditional &"BSD"& mailboxes, where a line beginning with
20900 &"From&~"& indicates the start of a new message. All four options need changing
20901 if another format is used. For example, to deliver to mailboxes in MMDF format:
20902 .cindex "MMDF format mailbox"
20903 .cindex "mailbox" "MMDF format"
20904 .code
20905 check_string = "\1\1\1\1\n"
20906 escape_string = "\1\1\1\1 \n"
20907 message_prefix = "\1\1\1\1\n"
20908 message_suffix = "\1\1\1\1\n"
20909 .endd
20910 .option create_directory appendfile boolean true
20911 .cindex "directory creation"
20912 When this option is true, Exim attempts to create any missing superior
20913 directories for the file that it is about to write. A created directory's mode
20914 is given by the &%directory_mode%& option.
20915
20916 The group ownership of a newly created directory is highly dependent on the
20917 operating system (and possibly the file system) that is being used. For
20918 example, in Solaris, if the parent directory has the setgid bit set, its group
20919 is propagated to the child; if not, the currently set group is used. However,
20920 in FreeBSD, the parent's group is always used.
20921
20922
20923
20924 .option create_file appendfile string anywhere
20925 This option constrains the location of files and directories that are created
20926 by this transport. It applies to files defined by the &%file%& option and
20927 directories defined by the &%directory%& option. In the case of maildir
20928 delivery, it applies to the top level directory, not the maildir directories
20929 beneath.
20930
20931 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
20932 &"belowhome"&. In the second and third cases, a home directory must have been
20933 set for the transport. This option is not useful when an explicit file name is
20934 given for normal mailbox deliveries. It is intended for the case when file
20935 names are generated from users' &_.forward_& files. These are usually handled
20936 by an &(appendfile)& transport called &%address_file%&. See also
20937 &%file_must_exist%&.
20938
20939
20940 .option directory appendfile string&!! unset
20941 This option is mutually exclusive with the &%file%& option, but one of &%file%&
20942 or &%directory%& must be set, unless the delivery is the direct result of a
20943 redirection (see section &<<SECTfildiropt>>&).
20944
20945 When &%directory%& is set, the string is expanded, and the message is delivered
20946 into a new file or files in or below the given directory, instead of being
20947 appended to a single mailbox file. A number of different formats are provided
20948 (see &%maildir_format%& and &%mailstore_format%&), and see section
20949 &<<SECTopdir>>& for further details of this form of delivery.
20950
20951
20952 .option directory_file appendfile string&!! "see below"
20953 .cindex "base62"
20954 .vindex "&$inode$&"
20955 When &%directory%& is set, but neither &%maildir_format%& nor
20956 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
20957 whose name is obtained by expanding this string. The default value is:
20958 .code
20959 q${base62:$tod_epoch}-$inode
20960 .endd
20961 This generates a unique name from the current time, in base 62 form, and the
20962 inode of the file. The variable &$inode$& is available only when expanding this
20963 option.
20964
20965
20966 .option directory_mode appendfile "octal integer" 0700
20967 If &(appendfile)& creates any directories as a result of the
20968 &%create_directory%& option, their mode is specified by this option.
20969
20970
20971 .option escape_string appendfile string "see description"
20972 See &%check_string%& above.
20973
20974
20975 .option file appendfile string&!! unset
20976 This option is mutually exclusive with the &%directory%& option, but one of
20977 &%file%& or &%directory%& must be set, unless the delivery is the direct result
20978 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
20979 specifies a single file, to which the message is appended. One or more of
20980 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
20981 &%file%&.
20982
20983 .cindex "NFS" "lock file"
20984 .cindex "locking files"
20985 .cindex "lock files"
20986 If you are using more than one host to deliver over NFS into the same
20987 mailboxes, you should always use lock files.
20988
20989 The string value is expanded for each delivery, and must yield an absolute
20990 path. The most common settings of this option are variations on one of these
20991 examples:
20992 .code
20993 file = /var/spool/mail/$local_part
20994 file = /home/$local_part/inbox
20995 file = $home/inbox
20996 .endd
20997 .cindex "&""sticky""& bit"
20998 In the first example, all deliveries are done into the same directory. If Exim
20999 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21000 create a file in the directory, so the &"sticky"& bit must be turned on for
21001 deliveries to be possible, or alternatively the &%group%& option can be used to
21002 run the delivery under a group id which has write access to the directory.
21003
21004
21005
21006 .option file_format appendfile string unset
21007 .cindex "file" "mailbox; checking existing format"
21008 This option requests the transport to check the format of an existing file
21009 before adding to it. The check consists of matching a specific string at the
21010 start of the file. The value of the option consists of an even number of
21011 colon-separated strings. The first of each pair is the test string, and the
21012 second is the name of a transport. If the transport associated with a matched
21013 string is not the current transport, control is passed over to the other
21014 transport. For example, suppose the standard &(local_delivery)& transport has
21015 this added to it:
21016 .code
21017 file_format = "From       : local_delivery :\
21018                \1\1\1\1\n : local_mmdf_delivery"
21019 .endd
21020 Mailboxes that begin with &"From"& are still handled by this transport, but if
21021 a mailbox begins with four binary ones followed by a newline, control is passed
21022 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21023 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21024 is assumed to match the current transport. If the start of a mailbox doesn't
21025 match any string, or if the transport named for a given string is not defined,
21026 delivery is deferred.
21027
21028
21029 .option file_must_exist appendfile boolean false
21030 If this option is true, the file specified by the &%file%& option must exist.
21031 A temporary error occurs if it does not, causing delivery to be deferred.
21032 If this option is false, the file is created if it does not exist.
21033
21034
21035 .option lock_fcntl_timeout appendfile time 0s
21036 .cindex "timeout" "mailbox locking"
21037 .cindex "mailbox" "locking, blocking and non-blocking"
21038 .cindex "locking files"
21039 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21040 when locking an open mailbox file. If the call fails, the delivery process
21041 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21042 Non-blocking calls are used so that the file is not kept open during the wait
21043 for the lock; the reason for this is to make it as safe as possible for
21044 deliveries over NFS in the case when processes might be accessing an NFS
21045 mailbox without using a lock file. This should not be done, but
21046 misunderstandings and hence misconfigurations are not unknown.
21047
21048 On a busy system, however, the performance of a non-blocking lock approach is
21049 not as good as using a blocking lock with a timeout. In this case, the waiting
21050 is done inside the system call, and Exim's delivery process acquires the lock
21051 and can proceed as soon as the previous lock holder releases it.
21052
21053 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21054 timeout, are used. There may still be some retrying: the maximum number of
21055 retries is
21056 .code
21057 (lock_retries * lock_interval) / lock_fcntl_timeout
21058 .endd
21059 rounded up to the next whole number. In other words, the total time during
21060 which &(appendfile)& is trying to get a lock is roughly the same, unless
21061 &%lock_fcntl_timeout%& is set very large.
21062
21063 You should consider setting this option if you are getting a lot of delayed
21064 local deliveries because of errors of the form
21065 .code
21066 failed to lock mailbox /some/file (fcntl)
21067 .endd
21068
21069 .option lock_flock_timeout appendfile time 0s
21070 This timeout applies to file locking when using &[flock()]& (see
21071 &%use_flock%&); the timeout operates in a similar manner to
21072 &%lock_fcntl_timeout%&.
21073
21074
21075 .option lock_interval appendfile time 3s
21076 This specifies the time to wait between attempts to lock the file. See below
21077 for details of locking.
21078
21079
21080 .option lock_retries appendfile integer 10
21081 This specifies the maximum number of attempts to lock the file. A value of zero
21082 is treated as 1. See below for details of locking.
21083
21084
21085 .option lockfile_mode appendfile "octal integer" 0600
21086 This specifies the mode of the created lock file, when a lock file is being
21087 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21088
21089
21090 .option lockfile_timeout appendfile time 30m
21091 .cindex "timeout" "mailbox locking"
21092 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21093 exists and is older than this value, it is assumed to have been left behind by
21094 accident, and Exim attempts to remove it.
21095
21096
21097 .option mailbox_filecount appendfile string&!! unset
21098 .cindex "mailbox" "specifying size of"
21099 .cindex "size" "of mailbox"
21100 If this option is set, it is expanded, and the result is taken as the current
21101 number of files in the mailbox. It must be a decimal number, optionally
21102 followed by K or M. This provides a way of obtaining this information from an
21103 external source that maintains the data.
21104
21105
21106 .option mailbox_size appendfile string&!! unset
21107 .cindex "mailbox" "specifying size of"
21108 .cindex "size" "of mailbox"
21109 If this option is set, it is expanded, and the result is taken as the current
21110 size the mailbox. It must be a decimal number, optionally followed by K or M.
21111 This provides a way of obtaining this information from an external source that
21112 maintains the data. This is likely to be helpful for maildir deliveries where
21113 it is computationally expensive to compute the size of a mailbox.
21114
21115
21116
21117 .option maildir_format appendfile boolean false
21118 .cindex "maildir format" "specifying"
21119 If this option is set with the &%directory%& option, the delivery is into a new
21120 file, in the &"maildir"& format that is used by other mail software. When the
21121 transport is activated directly from a &(redirect)& router (for example, the
21122 &(address_file)& transport in the default configuration), setting
21123 &%maildir_format%& causes the path received from the router to be treated as a
21124 directory, whether or not it ends with &`/`&. This option is available only if
21125 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21126 &<<SECTmaildirdelivery>>& below for further details.
21127
21128
21129 .option maildir_quota_directory_regex appendfile string "See below"
21130 .cindex "maildir format" "quota; directories included in"
21131 .cindex "quota" "maildir; directories included in"
21132 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21133 a regular expression for specifying directories, relative to the quota
21134 directory (see &%quota_directory%&), that should be included in the quota
21135 calculation. The default value is:
21136 .code
21137 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21138 .endd
21139 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21140 (directories whose names begin with a dot). If you want to exclude the
21141 &_Trash_&
21142 folder from the count (as some sites do), you need to change this setting to
21143 .code
21144 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21145 .endd
21146 This uses a negative lookahead in the regular expression to exclude the
21147 directory whose name is &_.Trash_&. When a directory is excluded from quota
21148 calculations, quota processing is bypassed for any messages that are delivered
21149 directly into that directory.
21150
21151
21152 .option maildir_retries appendfile integer 10
21153 This option specifies the number of times to retry when writing a file in
21154 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21155
21156
21157 .option maildir_tag appendfile string&!! unset
21158 This option applies only to deliveries in maildir format, and is described in
21159 section &<<SECTmaildirdelivery>>& below.
21160
21161
21162 .option maildir_use_size_file appendfile&!! boolean false
21163 .cindex "maildir format" "&_maildirsize_& file"
21164 The result of string expansion for this option must be a valid boolean value.
21165 If it is true, it enables support for &_maildirsize_& files. Exim
21166 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21167 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21168 value is zero. See &%maildir_quota_directory_regex%& above and section
21169 &<<SECTmaildirdelivery>>& below for further details.
21170
21171 .option maildirfolder_create_regex appendfile string unset
21172 .cindex "maildir format" "&_maildirfolder_& file"
21173 .cindex "&_maildirfolder_&, creating"
21174 The value of this option is a regular expression. If it is unset, it has no
21175 effect. Otherwise, before a maildir delivery takes place, the pattern is
21176 matched against the name of the maildir directory, that is, the directory
21177 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21178 delivery. If there is a match, Exim checks for the existence of a file called
21179 &_maildirfolder_& in the directory, and creates it if it does not exist.
21180 See section &<<SECTmaildirdelivery>>& for more details.
21181
21182
21183 .option mailstore_format appendfile boolean false
21184 .cindex "mailstore format" "specifying"
21185 If this option is set with the &%directory%& option, the delivery is into two
21186 new files in  &"mailstore"& format. The option is available only if
21187 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21188 below for further details.
21189
21190
21191 .option mailstore_prefix appendfile string&!! unset
21192 This option applies only to deliveries in mailstore format, and is described in
21193 section &<<SECTopdir>>& below.
21194
21195
21196 .option mailstore_suffix appendfile string&!! unset
21197 This option applies only to deliveries in mailstore format, and is described in
21198 section &<<SECTopdir>>& below.
21199
21200
21201 .option mbx_format appendfile boolean false
21202 .cindex "locking files"
21203 .cindex "file" "locking"
21204 .cindex "file" "MBX format"
21205 .cindex "MBX format, specifying"
21206 This option is available only if Exim has been compiled with SUPPORT_MBX
21207 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21208 the message is appended to the mailbox file in MBX format instead of
21209 traditional Unix format. This format is supported by Pine4 and its associated
21210 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21211
21212 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21213 automatically changed by the use of &%mbx_format%&. They should normally be set
21214 empty when using MBX format, so this option almost always appears in this
21215 combination:
21216 .code
21217 mbx_format = true
21218 message_prefix =
21219 message_suffix =
21220 .endd
21221 If none of the locking options are mentioned in the configuration,
21222 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21223 is possible to specify the other kinds of locking with &%mbx_format%&, but
21224 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21225 interworks with &'c-client'&, providing for shared access to the mailbox. It
21226 should not be used if any program that does not use this form of locking is
21227 going to access the mailbox, nor should it be used if the mailbox file is NFS
21228 mounted, because it works only when the mailbox is accessed from a single host.
21229
21230 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21231 the standard version of &'c-client'&, because as long as it has a mailbox open
21232 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21233 append messages to it.
21234
21235
21236 .option message_prefix appendfile string&!! "see below"
21237 .cindex "&""From""& line"
21238 The string specified here is expanded and output at the start of every message.
21239 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21240 in which case it is:
21241 .code
21242 message_prefix = "From ${if def:return_path{$return_path}\
21243   {MAILER-DAEMON}} $tod_bsdinbox\n"
21244 .endd
21245 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21246 &`\n`& to &`\r\n`& in &%message_prefix%&.
21247
21248 .option message_suffix appendfile string&!! "see below"
21249 The string specified here is expanded and output at the end of every message.
21250 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21251 in which case it is a single newline character. The suffix can be suppressed by
21252 setting
21253 .code
21254 message_suffix =
21255 .endd
21256 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21257 &`\n`& to &`\r\n`& in &%message_suffix%&.
21258
21259 .option mode appendfile "octal integer" 0600
21260 If the output file is created, it is given this mode. If it already exists and
21261 has wider permissions, they are reduced to this mode. If it has narrower
21262 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21263 if the delivery is the result of a &%save%& command in a filter file specifying
21264 a particular mode, the mode of the output file is always forced to take that
21265 value, and this option is ignored.
21266
21267
21268 .option mode_fail_narrower appendfile boolean true
21269 This option applies in the case when an existing mailbox file has a narrower
21270 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21271 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21272 continues with the delivery attempt, using the existing mode of the file.
21273
21274
21275 .option notify_comsat appendfile boolean false
21276 If this option is true, the &'comsat'& daemon is notified after every
21277 successful delivery to a user mailbox. This is the daemon that notifies logged
21278 on users about incoming mail.
21279
21280
21281 .option quota appendfile string&!! unset
21282 .cindex "quota" "imposed by Exim"
21283 This option imposes a limit on the size of the file to which Exim is appending,
21284 or to the total space used in the directory tree when the &%directory%& option
21285 is set. In the latter case, computation of the space used is expensive, because
21286 all the files in the directory (and any sub-directories) have to be
21287 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21288 &%maildir_use_size_file%& for ways to avoid this in environments where users
21289 have no shell access to their mailboxes).
21290
21291 As there is no interlock against two simultaneous deliveries into a
21292 multi-file mailbox, it is possible for the quota to be overrun in this case.
21293 For single-file mailboxes, of course, an interlock is a necessity.
21294
21295 A file's size is taken as its &'used'& value. Because of blocking effects, this
21296 may be a lot less than the actual amount of disk space allocated to the file.
21297 If the sizes of a number of files are being added up, the rounding effect can
21298 become quite noticeable, especially on systems that have large block sizes.
21299 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21300 the obvious value which users understand most easily.
21301
21302 The value of the option is expanded, and must then be a numerical value
21303 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21304 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21305 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21306 be handled.
21307
21308 &*Note*&: A value of zero is interpreted as &"no quota"&.
21309
21310 The expansion happens while Exim is running as root, before it changes uid for
21311 the delivery. This means that files that are inaccessible to the end user can
21312 be used to hold quota values that are looked up in the expansion. When delivery
21313 fails because this quota is exceeded, the handling of the error is as for
21314 system quota failures.
21315
21316 By default, Exim's quota checking mimics system quotas, and restricts the
21317 mailbox to the specified maximum size, though the value is not accurate to the
21318 last byte, owing to separator lines and additional headers that may get added
21319 during message delivery. When a mailbox is nearly full, large messages may get
21320 refused even though small ones are accepted, because the size of the current
21321 message is added to the quota when the check is made. This behaviour can be
21322 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21323 for exceeding the quota does not include the current message. Thus, deliveries
21324 continue until the quota has been exceeded; thereafter, no further messages are
21325 delivered. See also &%quota_warn_threshold%&.
21326
21327
21328 .option quota_directory appendfile string&!! unset
21329 This option defines the directory to check for quota purposes when delivering
21330 into individual files. The default is the delivery directory, or, if a file
21331 called &_maildirfolder_& exists in a maildir directory, the parent of the
21332 delivery directory.
21333
21334
21335 .option quota_filecount appendfile string&!! 0
21336 This option applies when the &%directory%& option is set. It limits the total
21337 number of files in the directory (compare the inode limit in system quotas). It
21338 can only be used if &%quota%& is also set. The value is expanded; an expansion
21339 failure causes delivery to be deferred. A value of zero is interpreted as
21340 &"no quota"&.
21341
21342
21343 .option quota_is_inclusive appendfile boolean true
21344 See &%quota%& above.
21345
21346
21347 .option quota_size_regex appendfile string unset
21348 This option applies when one of the delivery modes that writes a separate file
21349 for each message is being used. When Exim wants to find the size of one of
21350 these files in order to test the quota, it first checks &%quota_size_regex%&.
21351 If this is set to a regular expression that matches the file name, and it
21352 captures one string, that string is interpreted as a representation of the
21353 file's size. The value of &%quota_size_regex%& is not expanded.
21354
21355 This feature is useful only when users have no shell access to their mailboxes
21356 &-- otherwise they could defeat the quota simply by renaming the files. This
21357 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21358 the file length to the file name. For example:
21359 .code
21360 maildir_tag = ,S=$message_size
21361 quota_size_regex = ,S=(\d+)
21362 .endd
21363 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21364 number of lines in the message.
21365
21366 The regular expression should not assume that the length is at the end of the
21367 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21368 sometimes add other information onto the ends of message file names.
21369
21370 Section &<<SECID136>>& contains further information.
21371
21372
21373 .option quota_warn_message appendfile string&!! "see below"
21374 See below for the use of this option. If it is not set when
21375 &%quota_warn_threshold%& is set, it defaults to
21376 .code
21377 quota_warn_message = "\
21378   To: $local_part@$domain\n\
21379   Subject: Your mailbox\n\n\
21380   This message is automatically created \
21381   by mail delivery software.\n\n\
21382   The size of your mailbox has exceeded \
21383   a warning threshold that is\n\
21384   set by the system administrator.\n"
21385 .endd
21386
21387
21388 .option quota_warn_threshold appendfile string&!! 0
21389 .cindex "quota" "warning threshold"
21390 .cindex "mailbox" "size warning"
21391 .cindex "size" "of mailbox"
21392 This option is expanded in the same way as &%quota%& (see above). If the
21393 resulting value is greater than zero, and delivery of the message causes the
21394 size of the file or total space in the directory tree to cross the given
21395 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21396 may be specified as a percentage of it by following the value with a percent
21397 sign. For example:
21398 .code
21399 quota = 10M
21400 quota_warn_threshold = 75%
21401 .endd
21402 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21403 percent sign is ignored.
21404
21405 The warning message itself is specified by the &%quota_warn_message%& option,
21406 and it must start with a &'To:'& header line containing the recipient(s) of the
21407 warning message. These do not necessarily have to include the recipient(s) of
21408 the original message. A &'Subject:'& line should also normally be supplied. You
21409 can include any other header lines that you want. If you do not include a
21410 &'From:'& line, the default is:
21411 .code
21412 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21413 .endd
21414 .oindex &%errors_reply_to%&
21415 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21416 option.
21417
21418 The &%quota%& option does not have to be set in order to use this option; they
21419 are independent of one another except when the threshold is specified as a
21420 percentage.
21421
21422
21423 .option use_bsmtp appendfile boolean false
21424 .cindex "envelope sender"
21425 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21426 format, with the envelope sender and recipient(s) included as SMTP commands. If
21427 you want to include a leading HELO command with such messages, you can do
21428 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21429 for details of batch SMTP.
21430
21431
21432 .option use_crlf appendfile boolean false
21433 .cindex "carriage return"
21434 .cindex "linefeed"
21435 This option causes lines to be terminated with the two-character CRLF sequence
21436 (carriage return, linefeed) instead of just a linefeed character. In the case
21437 of batched SMTP, the byte sequence written to the file is then an exact image
21438 of what would be sent down a real SMTP connection.
21439
21440 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21441 (which are used to supply the traditional &"From&~"& and blank line separators
21442 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21443 carriage return characters if these are needed. In cases where these options
21444 have non-empty defaults, the values end with a single linefeed, so they must be
21445 changed to end with &`\r\n`& if &%use_crlf%& is set.
21446
21447
21448 .option use_fcntl_lock appendfile boolean "see below"
21449 This option controls the use of the &[fcntl()]& function to lock a file for
21450 exclusive use when a message is being appended. It is set by default unless
21451 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21452 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21453 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21454
21455
21456 .option use_flock_lock appendfile boolean false
21457 This option is provided to support the use of &[flock()]& for file locking, for
21458 the few situations where it is needed. Most modern operating systems support
21459 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21460 each other. Exim uses &[fcntl()]& locking by default.
21461
21462 This option is required only if you are using an operating system where
21463 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21464 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21465 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21466
21467 .cindex "Solaris" "&[flock()]& support"
21468 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21469 have it (and some, I think, provide a not quite right version built on top of
21470 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21471 the ability to use it, and any attempt to do so will cause a configuration
21472 error.
21473
21474 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21475 is just being mapped onto &[fcntl()]& by the OS).
21476
21477
21478 .option use_lockfile appendfile boolean "see below"
21479 If this option is turned off, Exim does not attempt to create a lock file when
21480 appending to a mailbox file. In this situation, the only locking is by
21481 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21482 sure that every MUA that is ever going to look at your users' mailboxes uses
21483 &[fcntl()]& rather than a lock file, and even then only when you are not
21484 delivering over NFS from more than one host.
21485
21486 .cindex "NFS" "lock file"
21487 In order to append to an NFS file safely from more than one host, it is
21488 necessary to take out a lock &'before'& opening the file, and the lock file
21489 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21490 file corruption.
21491
21492 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21493 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21494 except when &%mbx_format%& is set.
21495
21496
21497 .option use_mbx_lock appendfile boolean "see below"
21498 This option is available only if Exim has been compiled with SUPPORT_MBX
21499 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21500 locking rules be used. It is set by default if &%mbx_format%& is set and none
21501 of the locking options are mentioned in the configuration. The locking rules
21502 are the same as are used by the &'c-client'& library that underlies Pine and
21503 the IMAP4 and POP daemons that come with it (see the discussion below). The
21504 rules allow for shared access to the mailbox. However, this kind of locking
21505 does not work when the mailbox is NFS mounted.
21506
21507 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21508 &%use_flock_lock%& to control what kind of locking is used in implementing the
21509 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21510 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21511
21512
21513
21514
21515 .section "Operational details for appending" "SECTopappend"
21516 .cindex "appending to a file"
21517 .cindex "file" "appending"
21518 Before appending to a file, the following preparations are made:
21519
21520 .ilist
21521 If the name of the file is &_/dev/null_&, no action is taken, and a success
21522 return is given.
21523
21524 .next
21525 .cindex "directory creation"
21526 If any directories on the file's path are missing, Exim creates them if the
21527 &%create_directory%& option is set. A created directory's mode is given by the
21528 &%directory_mode%& option.
21529
21530 .next
21531 If &%file_format%& is set, the format of an existing file is checked. If this
21532 indicates that a different transport should be used, control is passed to that
21533 transport.
21534
21535 .next
21536 .cindex "file" "locking"
21537 .cindex "locking files"
21538 .cindex "NFS" "lock file"
21539 If &%use_lockfile%& is set, a lock file is built in a way that will work
21540 reliably over NFS, as follows:
21541
21542 .olist
21543 Create a &"hitching post"& file whose name is that of the lock file with the
21544 current time, primary host name, and process id added, by opening for writing
21545 as a new file. If this fails with an access error, delivery is deferred.
21546 .next
21547 Close the hitching post file, and hard link it to the lock file name.
21548 .next
21549 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21550 Unlink the hitching post name.
21551 .next
21552 Otherwise, use &[stat()]& to get information about the hitching post file, and
21553 then unlink hitching post name. If the number of links is exactly two, creation
21554 of the lock file succeeded but something (for example, an NFS server crash and
21555 restart) caused this fact not to be communicated to the &[link()]& call.
21556 .next
21557 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21558 up to &%lock_retries%& times. However, since any program that writes to a
21559 mailbox should complete its task very quickly, it is reasonable to time out old
21560 lock files that are normally the result of user agent and system crashes. If an
21561 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21562 it before trying again.
21563 .endlist olist
21564
21565 .next
21566 A call is made to &[lstat()]& to discover whether the main file exists, and if
21567 so, what its characteristics are. If &[lstat()]& fails for any reason other
21568 than non-existence, delivery is deferred.
21569
21570 .next
21571 .cindex "symbolic link" "to mailbox"
21572 .cindex "mailbox" "symbolic link"
21573 If the file does exist and is a symbolic link, delivery is deferred, unless the
21574 &%allow_symlink%& option is set, in which case the ownership of the link is
21575 checked, and then &[stat()]& is called to find out about the real file, which
21576 is then subjected to the checks below. The check on the top-level link
21577 ownership prevents one user creating a link for another's mailbox in a sticky
21578 directory, though allowing symbolic links in this case is definitely not a good
21579 idea. If there is a chain of symbolic links, the intermediate ones are not
21580 checked.
21581
21582 .next
21583 If the file already exists but is not a regular file, or if the file's owner
21584 and group (if the group is being checked &-- see &%check_group%& above) are
21585 different from the user and group under which the delivery is running,
21586 delivery is deferred.
21587
21588 .next
21589 If the file's permissions are more generous than specified, they are reduced.
21590 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21591 is set false, in which case the delivery is tried using the existing
21592 permissions.
21593
21594 .next
21595 The file's inode number is saved, and the file is then opened for appending.
21596 If this fails because the file has vanished, &(appendfile)& behaves as if it
21597 hadn't existed (see below). For any other failures, delivery is deferred.
21598
21599 .next
21600 If the file is opened successfully, check that the inode number hasn't
21601 changed, that it is still a regular file, and that the owner and permissions
21602 have not changed. If anything is wrong, defer delivery and freeze the message.
21603
21604 .next
21605 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21606 option is set. Otherwise, check that the file is being created in a permitted
21607 directory if the &%create_file%& option is set (deferring on failure), and then
21608 open for writing as a new file, with the O_EXCL and O_CREAT options,
21609 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21610 set). In this case, which can happen if the link points to a non-existent file,
21611 the file is opened for writing using O_CREAT but not O_EXCL, because
21612 that prevents link following.
21613
21614 .next
21615 .cindex "loop" "while file testing"
21616 If opening fails because the file exists, obey the tests given above for
21617 existing files. However, to avoid looping in a situation where the file is
21618 being continuously created and destroyed, the exists/not-exists loop is broken
21619 after 10 repetitions, and the message is then frozen.
21620
21621 .next
21622 If opening fails with any other error, defer delivery.
21623
21624 .next
21625 .cindex "file" "locking"
21626 .cindex "locking files"
21627 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21628 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21629 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21630 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21631 file, and an exclusive lock on the file whose name is
21632 .code
21633 /tmp/.<device-number>.<inode-number>
21634 .endd
21635 using the device and inode numbers of the open mailbox file, in accordance with
21636 the MBX locking rules. This file is created with a mode that is specified by
21637 the &%lockfile_mode%& option.
21638
21639 If Exim fails to lock the file, there are two possible courses of action,
21640 depending on the value of the locking timeout. This is obtained from
21641 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21642
21643 If the timeout value is zero, the file is closed, Exim waits for
21644 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21645 to lock it again. This happens up to &%lock_retries%& times, after which the
21646 delivery is deferred.
21647
21648 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21649 &[flock()]& are used (with the given timeout), so there has already been some
21650 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21651 immediately. It retries up to
21652 .code
21653 (lock_retries * lock_interval) / <timeout>
21654 .endd
21655 times (rounded up).
21656 .endlist
21657
21658 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21659 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21660
21661
21662 .section "Operational details for delivery to a new file" "SECTopdir"
21663 .cindex "delivery" "to single file"
21664 .cindex "&""From""& line"
21665 When the &%directory%& option is set instead of &%file%&, each message is
21666 delivered into a newly-created file or set of files. When &(appendfile)& is
21667 activated directly from a &(redirect)& router, neither &%file%& nor
21668 &%directory%& is normally set, because the path for delivery is supplied by the
21669 router. (See for example, the &(address_file)& transport in the default
21670 configuration.) In this case, delivery is to a new file if either the path name
21671 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21672
21673 No locking is required while writing the message to a new file, so the various
21674 locking options of the transport are ignored. The &"From"& line that by default
21675 separates messages in a single file is not normally needed, nor is the escaping
21676 of message lines that start with &"From"&, and there is no need to ensure a
21677 newline at the end of each message. Consequently, the default values for
21678 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21679 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21680
21681 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21682 the files in the delivery directory by default. However, you can specify a
21683 different directory by setting &%quota_directory%&. Also, for maildir
21684 deliveries (see below) the &_maildirfolder_& convention is honoured.
21685
21686
21687 .cindex "maildir format"
21688 .cindex "mailstore format"
21689 There are three different ways in which delivery to individual files can be
21690 done, controlled by the settings of the &%maildir_format%& and
21691 &%mailstore_format%& options. Note that code to support maildir or mailstore
21692 formats is not included in the binary unless SUPPORT_MAILDIR or
21693 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21694
21695 .cindex "directory creation"
21696 In all three cases an attempt is made to create the directory and any necessary
21697 sub-directories if they do not exist, provided that the &%create_directory%&
21698 option is set (the default). The location of a created directory can be
21699 constrained by setting &%create_file%&. A created directory's mode is given by
21700 the &%directory_mode%& option. If creation fails, or if the
21701 &%create_directory%& option is not set when creation is required, delivery is
21702 deferred.
21703
21704
21705
21706 .section "Maildir delivery" "SECTmaildirdelivery"
21707 .cindex "maildir format" "description of"
21708 If the &%maildir_format%& option is true, Exim delivers each message by writing
21709 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21710 directory that is defined by the &%directory%& option (the &"delivery
21711 directory"&). If the delivery is successful, the file is renamed into the
21712 &_new_& subdirectory.
21713
21714 In the file name, <&'stime'&> is the current time of day in seconds, and
21715 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21716 Exim checks that the time-of-day clock has moved on by at least one microsecond
21717 before terminating the delivery process. This guarantees uniqueness for the
21718 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21719 opening it. If any response other than ENOENT (does not exist) is given,
21720 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21721
21722 Before Exim carries out a maildir delivery, it ensures that subdirectories
21723 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21724 do not exist, Exim tries to create them and any superior directories in their
21725 path, subject to the &%create_directory%& and &%create_file%& options. If the
21726 &%maildirfolder_create_regex%& option is set, and the regular expression it
21727 contains matches the delivery directory, Exim also ensures that a file called
21728 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21729 &_maildirfolder_& file cannot be created, delivery is deferred.
21730
21731 These features make it possible to use Exim to create all the necessary files
21732 and directories in a maildir mailbox, including subdirectories for maildir++
21733 folders. Consider this example:
21734 .code
21735 maildir_format = true
21736 directory = /var/mail/$local_part\
21737            ${if eq{$local_part_suffix}{}{}\
21738            {/.${substr_1:$local_part_suffix}}}
21739 maildirfolder_create_regex = /\.[^/]+$
21740 .endd
21741 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21742 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21743 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21744 not match this name, so Exim will not look for or create the file
21745 &_/var/mail/pimbo/maildirfolder_&, though it will create
21746 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21747
21748 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21749 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21750 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21751 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21752 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21753
21754 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21755 not inadvertently match the toplevel maildir directory, because a
21756 &_maildirfolder_& file at top level would completely break quota calculations.
21757
21758 .cindex "quota" "in maildir delivery"
21759 .cindex "maildir++"
21760 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21761 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21762 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21763 Exim assumes the directory is a maildir++ folder directory, which is one level
21764 down from the user's top level mailbox directory. This causes it to start at
21765 the parent directory instead of the current directory when calculating the
21766 amount of space used.
21767
21768 One problem with delivering into a multi-file mailbox is that it is
21769 computationally expensive to compute the size of the mailbox for quota
21770 checking. Various approaches have been taken to reduce the amount of work
21771 needed. The next two sections describe two of them. A third alternative is to
21772 use some external process for maintaining the size data, and use the expansion
21773 of the &%mailbox_size%& option as a way of importing it into Exim.
21774
21775
21776
21777
21778 .section "Using tags to record message sizes" "SECID135"
21779 If &%maildir_tag%& is set, the string is expanded for each delivery.
21780 When the maildir file is renamed into the &_new_& sub-directory, the
21781 tag is added to its name. However, if adding the tag takes the length of the
21782 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21783 the tag is dropped and the maildir file is created with no tag.
21784
21785
21786 .vindex "&$message_size$&"
21787 Tags can be used to encode the size of files in their names; see
21788 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21789 happens after the message has been written. The value of the &$message_size$&
21790 variable is set to the number of bytes actually written. If the expansion is
21791 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21792 be deferred. The expanded tag may contain any printing characters except &"/"&.
21793 Non-printing characters in the string are ignored; if the resulting string is
21794 empty, it is ignored. If it starts with an alphanumeric character, a leading
21795 colon is inserted; this default has not proven to be the path that popular
21796 maildir implementations have chosen (but changing it in Exim would break
21797 backwards compatibility).
21798
21799 For one common implementation, you might set:
21800 .code
21801 maildir_tag = ,S=${message_size}
21802 .endd
21803 but you should check the documentation of the other software to be sure.
21804
21805 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21806 as this allows Exim to extract the size from your tag, instead of having to
21807 &[stat()]& each message file.
21808
21809
21810 .section "Using a maildirsize file" "SECID136"
21811 .cindex "quota" "in maildir delivery"
21812 .cindex "maildir format" "&_maildirsize_& file"
21813 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21814 storing quota and message size information in a file called &_maildirsize_&
21815 within the toplevel maildir directory. If this file does not exist, Exim
21816 creates it, setting the quota from the &%quota%& option of the transport. If
21817 the maildir directory itself does not exist, it is created before any attempt
21818 to write a &_maildirsize_& file.
21819
21820 The &_maildirsize_& file is used to hold information about the sizes of
21821 messages in the maildir, thus speeding up quota calculations. The quota value
21822 in the file is just a cache; if the quota is changed in the transport, the new
21823 value overrides the cached value when the next message is delivered. The cache
21824 is maintained for the benefit of other programs that access the maildir and
21825 need to know the quota.
21826
21827 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21828 file is maintained (with a zero quota setting), but no quota is imposed.
21829
21830 A regular expression is available for controlling which directories in the
21831 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21832 See the description of the &%maildir_quota_directory_regex%& option above for
21833 details.
21834
21835
21836 .section "Mailstore delivery" "SECID137"
21837 .cindex "mailstore format" "description of"
21838 If the &%mailstore_format%& option is true, each message is written as two
21839 files in the given directory. A unique base name is constructed from the
21840 message id and the current delivery process, and the files that are written use
21841 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
21842 contains the message's envelope, and the &_.msg_& file contains the message
21843 itself. The base name is placed in the variable &$mailstore_basename$&.
21844
21845 During delivery, the envelope is first written to a file with the suffix
21846 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
21847 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
21848 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
21849 file before accessing either of them. An alternative approach is to wait for
21850 the absence of a &_.tmp_& file.
21851
21852 The envelope file starts with any text defined by the &%mailstore_prefix%&
21853 option, expanded and terminated by a newline if there isn't one. Then follows
21854 the sender address on one line, then all the recipient addresses, one per line.
21855 There can be more than one recipient only if the &%batch_max%& option is set
21856 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
21857 appended to the file, followed by a newline if it does not end with one.
21858
21859 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
21860 failure, it is ignored. Other expansion errors are treated as serious
21861 configuration errors, and delivery is deferred. The variable
21862 &$mailstore_basename$& is available for use during these expansions.
21863
21864
21865 .section "Non-special new file delivery" "SECID138"
21866 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
21867 file is created directly in the named directory. For example, when delivering
21868 messages into files in batched SMTP format for later delivery to some host (see
21869 section &<<SECTbatchSMTP>>&), a setting such as
21870 .code
21871 directory = /var/bsmtp/$host
21872 .endd
21873 might be used. A message is written to a file with a temporary name, which is
21874 then renamed when the delivery is complete. The final name is obtained by
21875 expanding the contents of the &%directory_file%& option.
21876 .ecindex IIDapptra1
21877 .ecindex IIDapptra2
21878
21879
21880
21881
21882
21883
21884 . ////////////////////////////////////////////////////////////////////////////
21885 . ////////////////////////////////////////////////////////////////////////////
21886
21887 .chapter "The autoreply transport" "CHID8"
21888 .scindex IIDauttra1 "transports" "&(autoreply)&"
21889 .scindex IIDauttra2 "&(autoreply)& transport"
21890 The &(autoreply)& transport is not a true transport in that it does not cause
21891 the message to be transmitted. Instead, it generates a new mail message as an
21892 automatic reply to the incoming message. &'References:'& and
21893 &'Auto-Submitted:'& header lines are included. These are constructed according
21894 to the rules in RFCs 2822 and 3834, respectively.
21895
21896 If the router that passes the message to this transport does not have the
21897 &%unseen%& option set, the original message (for the current recipient) is not
21898 delivered anywhere. However, when the &%unseen%& option is set on the router
21899 that passes the message to this transport, routing of the address continues, so
21900 another router can set up a normal message delivery.
21901
21902
21903 The &(autoreply)& transport is usually run as the result of mail filtering, a
21904 &"vacation"& message being the standard example. However, it can also be run
21905 directly from a router like any other transport. To reduce the possibility of
21906 message cascades, messages created by the &(autoreply)& transport always have
21907 empty envelope sender addresses, like bounce messages.
21908
21909 The parameters of the message to be sent can be specified in the configuration
21910 by options described below. However, these are used only when the address
21911 passed to the transport does not contain its own reply information. When the
21912 transport is run as a consequence of a
21913 &%mail%&
21914 or &%vacation%& command in a filter file, the parameters of the message are
21915 supplied by the filter, and passed with the address. The transport's options
21916 that define the message are then ignored (so they are not usually set in this
21917 case). The message is specified entirely by the filter or by the transport; it
21918 is never built from a mixture of options. However, the &%file_optional%&,
21919 &%mode%&, and &%return_message%& options apply in all cases.
21920
21921 &(Autoreply)& is implemented as a local transport. When used as a result of a
21922 command in a user's filter file, &(autoreply)& normally runs under the uid and
21923 gid of the user, and with appropriate current and home directories (see chapter
21924 &<<CHAPenvironment>>&).
21925
21926 There is a subtle difference between routing a message to a &(pipe)& transport
21927 that generates some text to be returned to the sender, and routing it to an
21928 &(autoreply)& transport. This difference is noticeable only if more than one
21929 address from the same message is so handled. In the case of a pipe, the
21930 separate outputs from the different addresses are gathered up and returned to
21931 the sender in a single message, whereas if &(autoreply)& is used, a separate
21932 message is generated for each address that is passed to it.
21933
21934 Non-printing characters are not permitted in the header lines generated for the
21935 message that &(autoreply)& creates, with the exception of newlines that are
21936 immediately followed by white space. If any non-printing characters are found,
21937 the transport defers.
21938 Whether characters with the top bit set count as printing characters or not is
21939 controlled by the &%print_topbitchars%& global option.
21940
21941 If any of the generic options for manipulating headers (for example,
21942 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
21943 of the original message that is included in the generated message when
21944 &%return_message%& is set. They do not apply to the generated message itself.
21945
21946 .vindex "&$sender_address$&"
21947 If the &(autoreply)& transport receives return code 2 from Exim when it submits
21948 the message, indicating that there were no recipients, it does not treat this
21949 as an error. This means that autoreplies sent to &$sender_address$& when this
21950 is empty (because the incoming message is a bounce message) do not cause
21951 problems. They are just discarded.
21952
21953
21954
21955 .section "Private options for autoreply" "SECID139"
21956 .cindex "options" "&(autoreply)& transport"
21957
21958 .option bcc autoreply string&!! unset
21959 This specifies the addresses that are to receive &"blind carbon copies"& of the
21960 message when the message is specified by the transport.
21961
21962
21963 .option cc autoreply string&!! unset
21964 This specifies recipients of the message and the contents of the &'Cc:'& header
21965 when the message is specified by the transport.
21966
21967
21968 .option file autoreply string&!! unset
21969 The contents of the file are sent as the body of the message when the message
21970 is specified by the transport. If both &%file%& and &%text%& are set, the text
21971 string comes first.
21972
21973
21974 .option file_expand autoreply boolean false
21975 If this is set, the contents of the file named by the &%file%& option are
21976 subjected to string expansion as they are added to the message.
21977
21978
21979 .option file_optional autoreply boolean false
21980 If this option is true, no error is generated if the file named by the &%file%&
21981 option or passed with the address does not exist or cannot be read.
21982
21983
21984 .option from autoreply string&!! unset
21985 This specifies the contents of the &'From:'& header when the message is
21986 specified by the transport.
21987
21988
21989 .option headers autoreply string&!! unset
21990 This specifies additional RFC 2822 headers that are to be added to the message
21991 when the message is specified by the transport. Several can be given by using
21992 &"\n"& to separate them. There is no check on the format.
21993
21994
21995 .option log autoreply string&!! unset
21996 This option names a file in which a record of every message sent is logged when
21997 the message is specified by the transport.
21998
21999
22000 .option mode autoreply "octal integer" 0600
22001 If either the log file or the &"once"& file has to be created, this mode is
22002 used.
22003
22004
22005 .option never_mail autoreply "address list&!!" unset
22006 If any run of the transport creates a message with a recipient that matches any
22007 item in the list, that recipient is quietly discarded. If all recipients are
22008 discarded, no message is created. This applies both when the recipients are
22009 generated by a filter and when they are specified in the transport.
22010
22011
22012
22013 .option once autoreply string&!! unset
22014 This option names a file or DBM database in which a record of each &'To:'&
22015 recipient is kept when the message is specified by the transport. &*Note*&:
22016 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22017
22018 If &%once%& is unset, or is set to an empty string, the message is always sent.
22019 By default, if &%once%& is set to a non-empty file name, the message
22020 is not sent if a potential recipient is already listed in the database.
22021 However, if the &%once_repeat%& option specifies a time greater than zero, the
22022 message is sent if that much time has elapsed since a message was last sent to
22023 this recipient. A setting of zero time for &%once_repeat%& (the default)
22024 prevents a message from being sent a second time &-- in this case, zero means
22025 infinity.
22026
22027 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22028 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22029 greater than zero, it changes the way Exim implements the &%once%& option.
22030 Instead of using a DBM file to record every recipient it sends to, it uses a
22031 regular file, whose size will never get larger than the given value.
22032
22033 In the file, Exim keeps a linear list of recipient addresses and the times at
22034 which they were sent messages. If the file is full when a new address needs to
22035 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22036 means that a given recipient may receive multiple messages, but at
22037 unpredictable intervals that depend on the rate of turnover of addresses in the
22038 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22039
22040
22041 .option once_file_size autoreply integer 0
22042 See &%once%& above.
22043
22044
22045 .option once_repeat autoreply time&!! 0s
22046 See &%once%& above.
22047 After expansion, the value of this option must be a valid time value.
22048
22049
22050 .option reply_to autoreply string&!! unset
22051 This specifies the contents of the &'Reply-To:'& header when the message is
22052 specified by the transport.
22053
22054
22055 .option return_message autoreply boolean false
22056 If this is set, a copy of the original message is returned with the new
22057 message, subject to the maximum size set in the &%return_size_limit%& global
22058 configuration option.
22059
22060
22061 .option subject autoreply string&!! unset
22062 This specifies the contents of the &'Subject:'& header when the message is
22063 specified by the transport. It is tempting to quote the original subject in
22064 automatic responses. For example:
22065 .code
22066 subject = Re: $h_subject:
22067 .endd
22068 There is a danger in doing this, however. It may allow a third party to
22069 subscribe your users to an opt-in mailing list, provided that the list accepts
22070 bounce messages as subscription confirmations. Well-managed lists require a
22071 non-bounce message to confirm a subscription, so the danger is relatively
22072 small.
22073
22074
22075
22076 .option text autoreply string&!! unset
22077 This specifies a single string to be used as the body of the message when the
22078 message is specified by the transport. If both &%text%& and &%file%& are set,
22079 the text comes first.
22080
22081
22082 .option to autoreply string&!! unset
22083 This specifies recipients of the message and the contents of the &'To:'& header
22084 when the message is specified by the transport.
22085 .ecindex IIDauttra1
22086 .ecindex IIDauttra2
22087
22088
22089
22090
22091 . ////////////////////////////////////////////////////////////////////////////
22092 . ////////////////////////////////////////////////////////////////////////////
22093
22094 .chapter "The lmtp transport" "CHAPLMTP"
22095 .cindex "transports" "&(lmtp)&"
22096 .cindex "&(lmtp)& transport"
22097 .cindex "LMTP" "over a pipe"
22098 .cindex "LMTP" "over a socket"
22099 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22100 specified command
22101 or by interacting with a Unix domain socket.
22102 This transport is something of a cross between the &(pipe)& and &(smtp)&
22103 transports. Exim also has support for using LMTP over TCP/IP; this is
22104 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22105 to be of minority interest, the default build-time configure in &_src/EDITME_&
22106 has it commented out. You need to ensure that
22107 .code
22108 TRANSPORT_LMTP=yes
22109 .endd
22110 .cindex "options" "&(lmtp)& transport"
22111 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22112 included in the Exim binary. The private options of the &(lmtp)& transport are
22113 as follows:
22114
22115 .option batch_id lmtp string&!! unset
22116 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22117
22118
22119 .option batch_max lmtp integer 1
22120 This limits the number of addresses that can be handled in a single delivery.
22121 Most LMTP servers can handle several addresses at once, so it is normally a
22122 good idea to increase this value. See the description of local delivery
22123 batching in chapter &<<CHAPbatching>>&.
22124
22125
22126 .option command lmtp string&!! unset
22127 This option must be set if &%socket%& is not set. The string is a command which
22128 is run in a separate process. It is split up into a command name and list of
22129 arguments, each of which is separately expanded (so expansion cannot change the
22130 number of arguments). The command is run directly, not via a shell. The message
22131 is passed to the new process using the standard input and output to operate the
22132 LMTP protocol.
22133
22134 .option ignore_quota lmtp boolean false
22135 .cindex "LMTP" "ignoring quota errors"
22136 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22137 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22138 in its response to the LHLO command.
22139
22140 .option socket lmtp string&!! unset
22141 This option must be set if &%command%& is not set. The result of expansion must
22142 be the name of a Unix domain socket. The transport connects to the socket and
22143 delivers the message to it using the LMTP protocol.
22144
22145
22146 .option timeout lmtp time 5m
22147 The transport is aborted if the created process or Unix domain socket does not
22148 respond to LMTP commands or message input within this timeout. Delivery
22149 is deferred, and will be tried again later. Here is an example of a typical
22150 LMTP transport:
22151 .code
22152 lmtp:
22153   driver = lmtp
22154   command = /some/local/lmtp/delivery/program
22155   batch_max = 20
22156   user = exim
22157 .endd
22158 This delivers up to 20 addresses at a time, in a mixture of domains if
22159 necessary, running as the user &'exim'&.
22160
22161
22162
22163 . ////////////////////////////////////////////////////////////////////////////
22164 . ////////////////////////////////////////////////////////////////////////////
22165
22166 .chapter "The pipe transport" "CHAPpipetransport"
22167 .scindex IIDpiptra1 "transports" "&(pipe)&"
22168 .scindex IIDpiptra2 "&(pipe)& transport"
22169 The &(pipe)& transport is used to deliver messages via a pipe to a command
22170 running in another process. One example is the use of &(pipe)& as a
22171 pseudo-remote transport for passing messages to some other delivery mechanism
22172 (such as UUCP). Another is the use by individual users to automatically process
22173 their incoming messages. The &(pipe)& transport can be used in one of the
22174 following ways:
22175
22176 .ilist
22177 .vindex "&$local_part$&"
22178 A router routes one address to a transport in the normal way, and the
22179 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22180 contains the local part of the address (as usual), and the command that is run
22181 is specified by the &%command%& option on the transport.
22182 .next
22183 .vindex "&$pipe_addresses$&"
22184 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22185 transport can handle more than one address in a single run. In this case, when
22186 more than one address is routed to the transport, &$local_part$& is not set
22187 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22188 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22189 that are routed to the transport.
22190 .next
22191 .vindex "&$address_pipe$&"
22192 A router redirects an address directly to a pipe command (for example, from an
22193 alias or forward file). In this case, &$address_pipe$& contains the text of the
22194 pipe command, and the &%command%& option on the transport is ignored unless
22195 &%force_command%& is set. If only one address is being transported
22196 (&%batch_max%& is not greater than one, or only one address was redirected to
22197 this pipe command), &$local_part$& contains the local part that was redirected.
22198 .endlist
22199
22200
22201 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22202 deliver messages over pipes using the LMTP interactive protocol. This is
22203 implemented by the &(lmtp)& transport.
22204
22205 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22206 &_.forward_& file, the command runs under the uid and gid of that user. In
22207 other cases, the uid and gid have to be specified explicitly, either on the
22208 transport or on the router that handles the address. Current and &"home"&
22209 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22210 details of the local delivery environment and chapter &<<CHAPbatching>>&
22211 for a discussion of local delivery batching.
22212
22213
22214 .section "Concurrent delivery" "SECID140"
22215 If two messages arrive at almost the same time, and both are routed to a pipe
22216 delivery, the two pipe transports may be run concurrently. You must ensure that
22217 any pipe commands you set up are robust against this happening. If the commands
22218 write to a file, the &%exim_lock%& utility might be of use.
22219
22220
22221
22222
22223 .section "Returned status and data" "SECID141"
22224 .cindex "&(pipe)& transport" "returned data"
22225 If the command exits with a non-zero return code, the delivery is deemed to
22226 have failed, unless either the &%ignore_status%& option is set (in which case
22227 the return code is treated as zero), or the return code is one of those listed
22228 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22229 later"&. In this case, delivery is deferred. Details of a permanent failure are
22230 logged, but are not included in the bounce message, which merely contains
22231 &"local delivery failed"&.
22232
22233 If the command exits on a signal and the &%freeze_signal%& option is set then
22234 the message will be frozen in the queue. If that option is not set, a bounce
22235 will be sent as normal.
22236
22237 If the return code is greater than 128 and the command being run is a shell
22238 script, it normally means that the script was terminated by a signal whose
22239 value is the return code minus 128. The &%freeze_signal%& option does not
22240 apply in this case.
22241
22242 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22243 return code is set to 127. This is the value that a shell returns if it is
22244 asked to run a non-existent command. The wording for the log line suggests that
22245 a non-existent command may be the problem.
22246
22247 The &%return_output%& option can affect the result of a pipe delivery. If it is
22248 set and the command produces any output on its standard output or standard
22249 error streams, the command is considered to have failed, even if it gave a zero
22250 return code or if &%ignore_status%& is set. The output from the command is
22251 included as part of the bounce message. The &%return_fail_output%& option is
22252 similar, except that output is returned only when the command exits with a
22253 failure return code, that is, a value other than zero or a code that matches
22254 &%temp_errors%&.
22255
22256
22257
22258 .section "How the command is run" "SECThowcommandrun"
22259 .cindex "&(pipe)& transport" "path for command"
22260 The command line is (by default) broken down into a command name and arguments
22261 by the &(pipe)& transport itself. The &%allow_commands%& and
22262 &%restrict_to_path%& options can be used to restrict the commands that may be
22263 run.
22264
22265 .cindex "quoting" "in pipe command"
22266 Unquoted arguments are delimited by white space. If an argument appears in
22267 double quotes, backslash is interpreted as an escape character in the usual
22268 way. If an argument appears in single quotes, no escaping is done.
22269
22270 String expansion is applied to the command line except when it comes from a
22271 traditional &_.forward_& file (commands from a filter file are expanded). The
22272 expansion is applied to each argument in turn rather than to the whole line.
22273 For this reason, any string expansion item that contains white space must be
22274 quoted so as to be contained within a single argument. A setting such as
22275 .code
22276 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22277 .endd
22278 will not work, because the expansion item gets split between several
22279 arguments. You have to write
22280 .code
22281 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22282 .endd
22283 to ensure that it is all in one argument. The expansion is done in this way,
22284 argument by argument, so that the number of arguments cannot be changed as a
22285 result of expansion, and quotes or backslashes in inserted variables do not
22286 interact with external quoting. However, this leads to problems if you want to
22287 generate multiple arguments (or the command name plus arguments) from a single
22288 expansion. In this situation, the simplest solution is to use a shell. For
22289 example:
22290 .code
22291 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22292 .endd
22293
22294 .cindex "transport" "filter"
22295 .cindex "filter" "transport filter"
22296 .vindex "&$pipe_addresses$&"
22297 Special handling takes place when an argument consists of precisely the text
22298 &`$pipe_addresses`&. This is not a general expansion variable; the only
22299 place this string is recognized is when it appears as an argument for a pipe or
22300 transport filter command. It causes each address that is being handled to be
22301 inserted in the argument list at that point &'as a separate argument'&. This
22302 avoids any problems with spaces or shell metacharacters, and is of use when a
22303 &(pipe)& transport is handling groups of addresses in a batch.
22304
22305 If &%force_command%& is enabled on the transport, Special handling takes place
22306 for an argument that consists of precisely the text &`$address_pipe`&.  It
22307 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22308 argument is inserted in the argument list at that point
22309 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22310 the only item in the argument; in fact, if it were then &%force_command%&
22311 should behave as a no-op.  Rather, it should be used to adjust the command
22312 run while preserving the argument vector separation.
22313
22314 After splitting up into arguments and expansion, the resulting command is run
22315 in a subprocess directly from the transport, &'not'& under a shell. The
22316 message that is being delivered is supplied on the standard input, and the
22317 standard output and standard error are both connected to a single pipe that is
22318 read by Exim. The &%max_output%& option controls how much output the command
22319 may produce, and the &%return_output%& and &%return_fail_output%& options
22320 control what is done with it.
22321
22322 Not running the command under a shell (by default) lessens the security risks
22323 in cases when a command from a user's filter file is built out of data that was
22324 taken from an incoming message. If a shell is required, it can of course be
22325 explicitly specified as the command to be run. However, there are circumstances
22326 where existing commands (for example, in &_.forward_& files) expect to be run
22327 under a shell and cannot easily be modified. To allow for these cases, there is
22328 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22329 works. Instead of breaking up the command line as just described, it expands it
22330 as a single string and passes the result to &_/bin/sh_&. The
22331 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22332 with &%use_shell%&, and the whole mechanism is inherently less secure.
22333
22334
22335
22336 .section "Environment variables" "SECTpipeenv"
22337 .cindex "&(pipe)& transport" "environment for command"
22338 .cindex "environment for pipe transport"
22339 The environment variables listed below are set up when the command is invoked.
22340 This list is a compromise for maximum compatibility with other MTAs. Note that
22341 the &%environment%& option can be used to add additional variables to this
22342 environment.
22343 .display
22344 &`DOMAIN            `&   the domain of the address
22345 &`HOME              `&   the home directory, if set
22346 &`HOST              `&   the host name when called from a router (see below)
22347 &`LOCAL_PART        `&   see below
22348 &`LOCAL_PART_PREFIX `&   see below
22349 &`LOCAL_PART_SUFFIX `&   see below
22350 &`LOGNAME           `&   see below
22351 &`MESSAGE_ID        `&   Exim's local ID for the message
22352 &`PATH              `&   as specified by the &%path%& option below
22353 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22354 &`RECIPIENT         `&   the complete recipient address
22355 &`SENDER            `&   the sender of the message (empty if a bounce)
22356 &`SHELL             `&   &`/bin/sh`&
22357 &`TZ                `&   the value of the &%timezone%& option, if set
22358 &`USER              `&   see below
22359 .endd
22360 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22361 router, LOCAL_PART is set to the local part of the address. When it is
22362 called as a result of a forward or alias expansion, LOCAL_PART is set to
22363 the local part of the address that was expanded. In both cases, any affixes are
22364 removed from the local part, and made available in LOCAL_PART_PREFIX and
22365 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22366 same value as LOCAL_PART for compatibility with other MTAs.
22367
22368 .cindex "HOST"
22369 HOST is set only when a &(pipe)& transport is called from a router that
22370 associates hosts with an address, typically when using &(pipe)& as a
22371 pseudo-remote transport. HOST is set to the first host name specified by
22372 the router.
22373
22374 .cindex "HOME"
22375 If the transport's generic &%home_directory%& option is set, its value is used
22376 for the HOME environment variable. Otherwise, a home directory may be set
22377 by the router's &%transport_home_directory%& option, which defaults to the
22378 user's home directory if &%check_local_user%& is set.
22379
22380
22381 .section "Private options for pipe" "SECID142"
22382 .cindex "options" "&(pipe)& transport"
22383
22384
22385
22386 .option allow_commands pipe "string list&!!" unset
22387 .cindex "&(pipe)& transport" "permitted commands"
22388 The string is expanded, and is then interpreted as a colon-separated list of
22389 permitted commands. If &%restrict_to_path%& is not set, the only commands
22390 permitted are those in the &%allow_commands%& list. They need not be absolute
22391 paths; the &%path%& option is still used for relative paths. If
22392 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22393 in the &%allow_commands%& list, or a name without any slashes that is found on
22394 the path. In other words, if neither &%allow_commands%& nor
22395 &%restrict_to_path%& is set, there is no restriction on the command, but
22396 otherwise only commands that are permitted by one or the other are allowed. For
22397 example, if
22398 .code
22399 allow_commands = /usr/bin/vacation
22400 .endd
22401 and &%restrict_to_path%& is not set, the only permitted command is
22402 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22403 &%use_shell%& is set.
22404
22405
22406 .option batch_id pipe string&!! unset
22407 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22408
22409
22410 .option batch_max pipe integer 1
22411 This limits the number of addresses that can be handled in a single delivery.
22412 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22413
22414
22415 .option check_string pipe string unset
22416 As &(pipe)& writes the message, the start of each line is tested for matching
22417 &%check_string%&, and if it does, the initial matching characters are replaced
22418 by the contents of &%escape_string%&, provided both are set. The value of
22419 &%check_string%& is a literal string, not a regular expression, and the case of
22420 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22421 of &%check_string%& and &%escape_string%& are forced to values that implement
22422 the SMTP escaping protocol. Any settings made in the configuration file are
22423 ignored.
22424
22425
22426 .option command pipe string&!! unset
22427 This option need not be set when &(pipe)& is being used to deliver to pipes
22428 obtained directly from address redirections. In other cases, the option must be
22429 set, to provide a command to be run. It need not yield an absolute path (see
22430 the &%path%& option below). The command is split up into separate arguments by
22431 Exim, and each argument is separately expanded, as described in section
22432 &<<SECThowcommandrun>>& above.
22433
22434
22435 .option environment pipe string&!! unset
22436 .cindex "&(pipe)& transport" "environment for command"
22437 .cindex "environment for &(pipe)& transport"
22438 This option is used to add additional variables to the environment in which the
22439 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22440 a string which is expanded, and then interpreted as a colon-separated list of
22441 environment settings of the form <&'name'&>=<&'value'&>.
22442
22443
22444 .option escape_string pipe string unset
22445 See &%check_string%& above.
22446
22447
22448 .option freeze_exec_fail pipe boolean false
22449 .cindex "exec failure"
22450 .cindex "failure of exec"
22451 .cindex "&(pipe)& transport" "failure of exec"
22452 Failure to exec the command in a pipe transport is by default treated like
22453 any other failure while running the command. However, if &%freeze_exec_fail%&
22454 is set, failure to exec is treated specially, and causes the message to be
22455 frozen, whatever the setting of &%ignore_status%&.
22456
22457
22458 .option freeze_signal pipe boolean false
22459 .cindex "signal exit"
22460 .cindex "&(pipe)& transport", "signal exit"
22461 Normally if the process run by a command in a pipe transport exits on a signal,
22462 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22463 frozen in Exim's queue instead.
22464
22465
22466 .option force_command pipe boolean false
22467 .cindex "force command"
22468 .cindex "&(pipe)& transport", "force command"
22469 Normally when a router redirects an address directly to a pipe command
22470 the &%command%& option on the transport is ignored.  If &%force_command%&
22471 is set, the &%command%& option will used. This is especially
22472 useful for forcing a wrapper or additional argument to be added to the
22473 command. For example:
22474 .code
22475 command = /usr/bin/remote_exec myhost -- $address_pipe
22476 force_command
22477 .endd
22478
22479 Note that &$address_pipe$& is handled specially in &%command%& when
22480 &%force_command%& is set, expanding out to the original argument vector as
22481 separate items, similarly to a Unix shell &`"$@"`& construct.
22482
22483 .option ignore_status pipe boolean false
22484 If this option is true, the status returned by the subprocess that is set up to
22485 run the command is ignored, and Exim behaves as if zero had been returned.
22486 Otherwise, a non-zero status or termination by signal causes an error return
22487 from the transport unless the status value is one of those listed in
22488 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22489
22490 &*Note*&: This option does not apply to timeouts, which do not return a status.
22491 See the &%timeout_defer%& option for how timeouts are handled.
22492
22493 .option log_defer_output pipe boolean false
22494 .cindex "&(pipe)& transport" "logging output"
22495 If this option is set, and the status returned by the command is
22496 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22497 and any output was produced, the first line of it is written to the main log.
22498
22499
22500 .option log_fail_output pipe boolean false
22501 If this option is set, and the command returns any output, and also ends with a
22502 return code that is neither zero nor one of the return codes listed in
22503 &%temp_errors%& (that is, the delivery failed), the first line of output is
22504 written to the main log. This option and &%log_output%& are mutually exclusive.
22505 Only one of them may be set.
22506
22507
22508
22509 .option log_output pipe boolean false
22510 If this option is set and the command returns any output, the first line of
22511 output is written to the main log, whatever the return code. This option and
22512 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22513
22514
22515
22516 .option max_output pipe integer 20K
22517 This specifies the maximum amount of output that the command may produce on its
22518 standard output and standard error file combined. If the limit is exceeded, the
22519 process running the command is killed. This is intended as a safety measure to
22520 catch runaway processes. The limit is applied independently of the settings of
22521 the options that control what is done with such output (for example,
22522 &%return_output%&). Because of buffering effects, the amount of output may
22523 exceed the limit by a small amount before Exim notices.
22524
22525
22526 .option message_prefix pipe string&!! "see below"
22527 The string specified here is expanded and output at the start of every message.
22528 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22529 .code
22530 message_prefix = \
22531   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22532   ${tod_bsdinbox}\n
22533 .endd
22534 .cindex "Cyrus"
22535 .cindex "&%tmail%&"
22536 .cindex "&""From""& line"
22537 This is required by the commonly used &_/usr/bin/vacation_& program.
22538 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22539 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22540 setting
22541 .code
22542 message_prefix =
22543 .endd
22544 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22545 &`\n`& to &`\r\n`& in &%message_prefix%&.
22546
22547
22548 .option message_suffix pipe string&!! "see below"
22549 The string specified here is expanded and output at the end of every message.
22550 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22551 The suffix can be suppressed by setting
22552 .code
22553 message_suffix =
22554 .endd
22555 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22556 &`\n`& to &`\r\n`& in &%message_suffix%&.
22557
22558
22559 .option path pipe string "see below"
22560 This option specifies the string that is set up in the PATH environment
22561 variable of the subprocess. The default is:
22562 .code
22563 /bin:/usr/bin
22564 .endd
22565 If the &%command%& option does not yield an absolute path name, the command is
22566 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22567 apply to a command specified as a transport filter.
22568
22569
22570 .option permit_coredump pipe boolean false
22571 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22572 a core-dump of a pipe command, enable this command.  This enables core-dumps
22573 during delivery and affects both the Exim binary and the pipe command run.
22574 It is recommended that this option remain off unless and until you have a need
22575 for it and that this only be enabled when needed, as the risk of excessive
22576 resource consumption can be quite high.  Note also that Exim is typically
22577 installed as a setuid binary and most operating systems will inhibit coredumps
22578 of these by default, so further OS-specific action may be required.
22579
22580
22581 .option pipe_as_creator pipe boolean false
22582 .cindex "uid (user id)" "local delivery"
22583 If the generic &%user%& option is not set and this option is true, the delivery
22584 process is run under the uid that was in force when Exim was originally called
22585 to accept the message. If the group id is not otherwise set (via the generic
22586 &%group%& option), the gid that was in force when Exim was originally called to
22587 accept the message is used.
22588
22589
22590 .option restrict_to_path pipe boolean false
22591 When this option is set, any command name not listed in &%allow_commands%& must
22592 contain no slashes. The command is searched for only in the directories listed
22593 in the &%path%& option. This option is intended for use in the case when a pipe
22594 command has been generated from a user's &_.forward_& file. This is usually
22595 handled by a &(pipe)& transport called &%address_pipe%&.
22596
22597
22598 .option return_fail_output pipe boolean false
22599 If this option is true, and the command produced any output and ended with a
22600 return code other than zero or one of the codes listed in &%temp_errors%& (that
22601 is, the delivery failed), the output is returned in the bounce message.
22602 However, if the message has a null sender (that is, it is itself a bounce
22603 message), output from the command is discarded. This option and
22604 &%return_output%& are mutually exclusive. Only one of them may be set.
22605
22606
22607
22608 .option return_output pipe boolean false
22609 If this option is true, and the command produced any output, the delivery is
22610 deemed to have failed whatever the return code from the command, and the output
22611 is returned in the bounce message. Otherwise, the output is just discarded.
22612 However, if the message has a null sender (that is, it is a bounce message),
22613 output from the command is always discarded, whatever the setting of this
22614 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22615 of them may be set.
22616
22617
22618
22619 .option temp_errors pipe "string list" "see below"
22620 .cindex "&(pipe)& transport" "temporary failure"
22621 This option contains either a colon-separated list of numbers, or a single
22622 asterisk. If &%ignore_status%& is false
22623 and &%return_output%& is not set,
22624 and the command exits with a non-zero return code, the failure is treated as
22625 temporary and the delivery is deferred if the return code matches one of the
22626 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22627 codes are treated as permanent errors. The default setting contains the codes
22628 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22629 compiled on a system that does not define these macros, it assumes values of 75
22630 and 73, respectively.
22631
22632
22633 .option timeout pipe time 1h
22634 If the command fails to complete within this time, it is killed. This normally
22635 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22636 specifies no timeout. In order to ensure that any subprocesses created by the
22637 command are also killed, Exim makes the initial process a process group leader,
22638 and kills the whole process group on a timeout. However, this can be defeated
22639 if one of the processes starts a new process group.
22640
22641 .option timeout_defer pipe boolean false
22642 A timeout in a &(pipe)& transport, either in the command that the transport
22643 runs, or in a transport filter that is associated with it, is by default
22644 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22645 is set true, both kinds of timeout become temporary errors, causing the
22646 delivery to be deferred.
22647
22648 .option umask pipe "octal integer" 022
22649 This specifies the umask setting for the subprocess that runs the command.
22650
22651
22652 .option use_bsmtp pipe boolean false
22653 .cindex "envelope sender"
22654 If this option is set true, the &(pipe)& transport writes messages in &"batch
22655 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22656 commands. If you want to include a leading HELO command with such messages,
22657 you can do so by setting the &%message_prefix%& option. See section
22658 &<<SECTbatchSMTP>>& for details of batch SMTP.
22659
22660 .option use_classresources pipe boolean false
22661 .cindex "class resources (BSD)"
22662 This option is available only when Exim is running on FreeBSD, NetBSD, or
22663 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22664 resource limits when a &(pipe)& transport is run to perform a delivery. The
22665 limits for the uid under which the pipe is to run are obtained from the login
22666 class database.
22667
22668
22669 .option use_crlf pipe boolean false
22670 .cindex "carriage return"
22671 .cindex "linefeed"
22672 This option causes lines to be terminated with the two-character CRLF sequence
22673 (carriage return, linefeed) instead of just a linefeed character. In the case
22674 of batched SMTP, the byte sequence written to the pipe is then an exact image
22675 of what would be sent down a real SMTP connection.
22676
22677 The contents of the &%message_prefix%& and &%message_suffix%& options are
22678 written verbatim, so must contain their own carriage return characters if these
22679 are needed. When &%use_bsmtp%& is not set, the default values for both
22680 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22681 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22682
22683
22684 .option use_shell pipe boolean false
22685 .vindex "&$pipe_addresses$&"
22686 If this option is set, it causes the command to be passed to &_/bin/sh_&
22687 instead of being run directly from the transport, as described in section
22688 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22689 where the command is expected to be run under a shell and cannot easily be
22690 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22691 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22692 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22693 its &%-c%& option.
22694
22695
22696
22697 .section "Using an external local delivery agent" "SECID143"
22698 .cindex "local delivery" "using an external agent"
22699 .cindex "&'procmail'&"
22700 .cindex "external local delivery"
22701 .cindex "delivery" "&'procmail'&"
22702 .cindex "delivery" "by external agent"
22703 The &(pipe)& transport can be used to pass all messages that require local
22704 delivery to a separate local delivery agent such as &%procmail%&. When doing
22705 this, care must be taken to ensure that the pipe is run under an appropriate
22706 uid and gid. In some configurations one wants this to be a uid that is trusted
22707 by the delivery agent to supply the correct sender of the message. It may be
22708 necessary to recompile or reconfigure the delivery agent so that it trusts an
22709 appropriate user. The following is an example transport and router
22710 configuration for &%procmail%&:
22711 .code
22712 # transport
22713 procmail_pipe:
22714   driver = pipe
22715   command = /usr/local/bin/procmail -d $local_part
22716   return_path_add
22717   delivery_date_add
22718   envelope_to_add
22719   check_string = "From "
22720   escape_string = ">From "
22721   umask = 077
22722   user = $local_part
22723   group = mail
22724
22725 # router
22726 procmail:
22727   driver = accept
22728   check_local_user
22729   transport = procmail_pipe
22730 .endd
22731 In this example, the pipe is run as the local user, but with the group set to
22732 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22733 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22734 user to supply a correct sender address. If you do not specify either a
22735 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22736 home directory is the user's home directory by default.
22737
22738 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22739 .code
22740 IFS=" "
22741 .endd
22742 as shown in some &%procmail%& documentation, because Exim does not by default
22743 use a shell to run pipe commands.
22744
22745 .cindex "Cyrus"
22746 The next example shows a transport and a router for a system where local
22747 deliveries are handled by the Cyrus IMAP server.
22748 .code
22749 # transport
22750 local_delivery_cyrus:
22751   driver = pipe
22752   command = /usr/cyrus/bin/deliver \
22753             -m ${substr_1:$local_part_suffix} -- $local_part
22754   user = cyrus
22755   group = mail
22756   return_output
22757   log_output
22758   message_prefix =
22759   message_suffix =
22760
22761 # router
22762 local_user_cyrus:
22763   driver = accept
22764   check_local_user
22765   local_part_suffix = .*
22766   transport = local_delivery_cyrus
22767 .endd
22768 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22769 &%return_output%& to cause any text written by Cyrus to be returned to the
22770 sender.
22771 .ecindex IIDpiptra1
22772 .ecindex IIDpiptra2
22773
22774
22775 . ////////////////////////////////////////////////////////////////////////////
22776 . ////////////////////////////////////////////////////////////////////////////
22777
22778 .chapter "The smtp transport" "CHAPsmtptrans"
22779 .scindex IIDsmttra1 "transports" "&(smtp)&"
22780 .scindex IIDsmttra2 "&(smtp)& transport"
22781 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22782 or LMTP protocol. The list of hosts to try can either be taken from the address
22783 that is being processed (having been set up by the router), or specified
22784 explicitly for the transport. Timeout and retry processing (see chapter
22785 &<<CHAPretry>>&) is applied to each IP address independently.
22786
22787
22788 .section "Multiple messages on a single connection" "SECID144"
22789 The sending of multiple messages over a single TCP/IP connection can arise in
22790 two ways:
22791
22792 .ilist
22793 If a message contains more than &%max_rcpt%& (see below) addresses that are
22794 routed to the same host, more than one copy of the message has to be sent to
22795 that host. In this situation, multiple copies may be sent in a single run of
22796 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22797 does when it has too many addresses to send in one message also depends on the
22798 value of the global &%remote_max_parallel%& option. Details are given in
22799 section &<<SECToutSMTPTCP>>&.)
22800 .next
22801 .cindex "hints database" "remembering routing"
22802 When a message has been successfully delivered over a TCP/IP connection, Exim
22803 looks in its hints database to see if there are any other messages awaiting a
22804 connection to the same host. If there are, a new delivery process is started
22805 for one of them, and the current TCP/IP connection is passed on to it. The new
22806 process may in turn send multiple copies and possibly create yet another
22807 process.
22808 .endlist
22809
22810
22811 For each copy sent over the same TCP/IP connection, a sequence counter is
22812 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22813 no further messages are sent over that connection.
22814
22815
22816
22817 .section "Use of the $host and $host_address variables" "SECID145"
22818 .vindex "&$host$&"
22819 .vindex "&$host_address$&"
22820 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22821 &$host_address$& are the name and IP address of the first host on the host list
22822 passed by the router. However, when the transport is about to connect to a
22823 specific host, and while it is connected to that host, &$host$& and
22824 &$host_address$& are set to the values for that host. These are the values
22825 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22826 &%serialize_hosts%&, and the various TLS options are expanded.
22827
22828
22829 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22830 .vindex &$tls_bits$&
22831 .vindex &$tls_cipher$&
22832 .vindex &$tls_peerdn$&
22833 .vindex &$tls_sni$&
22834 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22835 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22836 are the values that were set when the message was received.
22837 These are the values that are used for options that are expanded before any
22838 SMTP connections are made. Just before each connection is made, these four
22839 variables are emptied. If TLS is subsequently started, they are set to the
22840 appropriate values for the outgoing connection, and these are the values that
22841 are in force when any authenticators are run and when the
22842 &%authenticated_sender%& option is expanded.
22843
22844 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
22845 and will be removed in a future release.
22846
22847
22848 .section "Private options for smtp" "SECID146"
22849 .cindex "options" "&(smtp)& transport"
22850 The private options of the &(smtp)& transport are as follows:
22851
22852
22853 .option address_retry_include_sender smtp boolean true
22854 .cindex "4&'xx'& responses" "retrying after"
22855 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
22856 is the combination of sender and recipient that is delayed in subsequent queue
22857 runs until the retry time is reached. You can delay the recipient without
22858 reference to the sender (which is what earlier versions of Exim did), by
22859 setting &%address_retry_include_sender%& false. However, this can lead to
22860 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
22861
22862 .option allow_localhost smtp boolean false
22863 .cindex "local host" "sending to"
22864 .cindex "fallback" "hosts specified on transport"
22865 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
22866 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
22867 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
22868 the delivery anyway. This should be used only in special cases when the
22869 configuration ensures that no looping will result (for example, a differently
22870 configured Exim is listening on the port to which the message is sent).
22871
22872
22873 .option authenticated_sender smtp string&!! unset
22874 .cindex "Cyrus"
22875 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
22876 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
22877 overriding any existing authenticated sender value. If the string expansion is
22878 forced to fail, the option is ignored. Other expansion failures cause delivery
22879 to be deferred. If the result of expansion is an empty string, that is also
22880 ignored.
22881
22882 The expansion happens after the outgoing connection has been made and TLS
22883 started, if required. This means that the &$host$&, &$host_address$&,
22884 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
22885 particular connection.
22886
22887 If the SMTP session is not authenticated, the expansion of
22888 &%authenticated_sender%& still happens (and can cause the delivery to be
22889 deferred if it fails), but no AUTH= item is added to MAIL commands
22890 unless &%authenticated_sender_force%& is true.
22891
22892 This option allows you to use the &(smtp)& transport in LMTP mode to
22893 deliver mail to Cyrus IMAP and provide the proper local part as the
22894 &"authenticated sender"&, via a setting such as:
22895 .code
22896 authenticated_sender = $local_part
22897 .endd
22898 This removes the need for IMAP subfolders to be assigned special ACLs to
22899 allow direct delivery to those subfolders.
22900
22901 Because of expected uses such as that just described for Cyrus (when no
22902 domain is involved), there is no checking on the syntax of the provided
22903 value.
22904
22905
22906 .option authenticated_sender_force smtp boolean false
22907 If this option is set true, the &%authenticated_sender%& option's value
22908 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
22909 authenticated as a client.
22910
22911
22912 .option command_timeout smtp time 5m
22913 This sets a timeout for receiving a response to an SMTP command that has been
22914 sent out. It is also used when waiting for the initial banner line from the
22915 remote host. Its value must not be zero.
22916
22917
22918 .option connect_timeout smtp time 5m
22919 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
22920 to a remote host. A setting of zero allows the system timeout (typically
22921 several minutes) to act. To have any effect, the value of this option must be
22922 less than the system timeout. However, it has been observed that on some
22923 systems there is no system timeout, which is why the default value for this
22924 option is 5 minutes, a value recommended by RFC 1123.
22925
22926
22927 .option connection_max_messages smtp integer 500
22928 .cindex "SMTP" "passed connection"
22929 .cindex "SMTP" "multiple deliveries"
22930 .cindex "multiple SMTP deliveries"
22931 This controls the maximum number of separate message deliveries that are sent
22932 over a single TCP/IP connection. If the value is zero, there is no limit.
22933 For testing purposes, this value can be overridden by the &%-oB%& command line
22934 option.
22935
22936
22937 .option data_timeout smtp time 5m
22938 This sets a timeout for the transmission of each block in the data portion of
22939 the message. As a result, the overall timeout for a message depends on the size
22940 of the message. Its value must not be zero. See also &%final_timeout%&.
22941
22942
22943 .option delay_after_cutoff smtp boolean true
22944 This option controls what happens when all remote IP addresses for a given
22945 domain have been inaccessible for so long that they have passed their retry
22946 cutoff times.
22947
22948 In the default state, if the next retry time has not been reached for any of
22949 them, the address is bounced without trying any deliveries. In other words,
22950 Exim delays retrying an IP address after the final cutoff time until a new
22951 retry time is reached, and can therefore bounce an address without ever trying
22952 a delivery, when machines have been down for a long time. Some people are
22953 unhappy at this prospect, so...
22954
22955 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
22956 addresses are past their final cutoff time, Exim tries to deliver to those
22957 IP addresses that have not been tried since the message arrived. If there are
22958 none, of if they all fail, the address is bounced. In other words, it does not
22959 delay when a new message arrives, but immediately tries those expired IP
22960 addresses that haven't been tried since the message arrived. If there is a
22961 continuous stream of messages for the dead hosts, unsetting
22962 &%delay_after_cutoff%& means that there will be many more attempts to deliver
22963 to them.
22964
22965
22966 .option dns_qualify_single smtp boolean true
22967 If the &%hosts%& or &%fallback_hosts%& option is being used,
22968 and the &%gethostbyname%& option is false,
22969 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
22970 in chapter &<<CHAPdnslookup>>& for more details.
22971
22972
22973 .option dns_search_parents smtp boolean false
22974 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
22975 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
22976 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
22977 details.
22978
22979
22980 .option dnssec_request_domains smtp "domain list&!!" unset
22981 .cindex "MX record" "security"
22982 .cindex "DNSSEC" "MX lookup"
22983 .cindex "security" "MX lookup"
22984 .cindex "DNS" "DNSSEC"
22985 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22986 the dnssec request bit set.
22987 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
22988
22989
22990
22991 .option dnssec_require_domains smtp "domain list&!!" unset
22992 .cindex "MX record" "security"
22993 .cindex "DNSSEC" "MX lookup"
22994 .cindex "security" "MX lookup"
22995 .cindex "DNS" "DNSSEC"
22996 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
22997 the dnssec request bit set.  Any returns not having the Authenticated Data bit
22998 (AD bit) set wil be ignored and logged as a host-lookup failure.
22999 This applies to all of the SRV, MX A6, AAAA, A lookup sequence.
23000
23001
23002
23003 .option dscp smtp string&!! unset
23004 .cindex "DCSP" "outbound"
23005 This option causes the DSCP value associated with a socket to be set to one
23006 of a number of fixed strings or to numeric value.
23007 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23008 Common values include &`throughput`&, &`mincost`&, and on newer systems
23009 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23010
23011 The outbound packets from Exim will be marked with this value in the header
23012 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23013 that these values will have any effect, not be stripped by networking
23014 equipment, or do much of anything without cooperation with your Network
23015 Engineer and those of all network operators between the source and destination.
23016
23017
23018 .option fallback_hosts smtp "string list" unset
23019 .cindex "fallback" "hosts specified on transport"
23020 String expansion is not applied to this option. The argument must be a
23021 colon-separated list of host names or IP addresses, optionally also including
23022 port numbers, though the separator can be changed, as described in section
23023 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23024 item in a &%route_list%& setting for the &(manualroute)& router, as described
23025 in section &<<SECTformatonehostitem>>&.
23026
23027 Fallback hosts can also be specified on routers, which associate them with the
23028 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23029 &%fallback_hosts%& specified on the transport is used only if the address does
23030 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23031 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23032 However, &%hosts_randomize%& does apply to fallback host lists.
23033
23034 If Exim is unable to deliver to any of the hosts for a particular address, and
23035 the errors are not permanent rejections, the address is put on a separate
23036 transport queue with its host list replaced by the fallback hosts, unless the
23037 address was routed via MX records and the current host was in the original MX
23038 list. In that situation, the fallback host list is not used.
23039
23040 Once normal deliveries are complete, the fallback queue is delivered by
23041 re-running the same transports with the new host lists. If several failing
23042 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23043 copy of the message is sent.
23044
23045 The resolution of the host names on the fallback list is controlled by the
23046 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23047 both to cases when the host list comes with the address and when it is taken
23048 from &%hosts%&. This option provides a &"use a smart host only if delivery
23049 fails"& facility.
23050
23051
23052 .option final_timeout smtp time 10m
23053 This is the timeout that applies while waiting for the response to the final
23054 line containing just &"."& that terminates a message. Its value must not be
23055 zero.
23056
23057 .option gethostbyname smtp boolean false
23058 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23059 being used, names are looked up using &[gethostbyname()]&
23060 (or &[getipnodebyname()]& when available)
23061 instead of using the DNS. Of course, that function may in fact use the DNS, but
23062 it may also consult other sources of information such as &_/etc/hosts_&.
23063
23064 .option gnutls_compat_mode smtp boolean unset
23065 This option controls whether GnuTLS is used in compatibility mode in an Exim
23066 server. This reduces security slightly, but improves interworking with older
23067 implementations of TLS.
23068
23069 .option helo_data smtp string&!! "see below"
23070 .cindex "HELO" "argument, setting"
23071 .cindex "EHLO" "argument, setting"
23072 .cindex "LHLO argument setting"
23073 The value of this option is expanded after a connection to a another host has
23074 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23075 command that starts the outgoing SMTP or LMTP session. The default value of the
23076 option is:
23077 .code
23078 $primary_hostname
23079 .endd
23080 During the expansion, the variables &$host$& and &$host_address$& are set to
23081 the identity of the remote host, and the variables &$sending_ip_address$& and
23082 &$sending_port$& are set to the local IP address and port number that are being
23083 used. These variables can be used to generate different values for different
23084 servers or different local IP addresses. For example, if you want the string
23085 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23086 interface address, you could use this:
23087 .code
23088 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23089   {$primary_hostname}}
23090 .endd
23091 The use of &%helo_data%& applies both to sending messages and when doing
23092 callouts.
23093
23094 .option hosts smtp "string list&!!" unset
23095 Hosts are associated with an address by a router such as &(dnslookup)&, which
23096 finds the hosts by looking up the address domain in the DNS, or by
23097 &(manualroute)&, which has lists of hosts in its configuration. However,
23098 email addresses can be passed to the &(smtp)& transport by any router, and not
23099 all of them can provide an associated list of hosts.
23100
23101 The &%hosts%& option specifies a list of hosts to be used if the address being
23102 processed does not have any hosts associated with it. The hosts specified by
23103 &%hosts%& are also used, whether or not the address has its own hosts, if
23104 &%hosts_override%& is set.
23105
23106 The string is first expanded, before being interpreted as a colon-separated
23107 list of host names or IP addresses, possibly including port numbers. The
23108 separator may be changed to something other than colon, as described in section
23109 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23110 item in a &%route_list%& setting for the &(manualroute)& router, as described
23111 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23112 of the &(manualroute)& router is not available here.
23113
23114 If the expansion fails, delivery is deferred. Unless the failure was caused by
23115 the inability to complete a lookup, the error is logged to the panic log as
23116 well as the main log. Host names are looked up either by searching directly for
23117 address records in the DNS or by calling &[gethostbyname()]& (or
23118 &[getipnodebyname()]& when available), depending on the setting of the
23119 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23120 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23121 address are used.
23122
23123 During delivery, the hosts are tried in order, subject to their retry status,
23124 unless &%hosts_randomize%& is set.
23125
23126
23127 .option hosts_avoid_esmtp smtp "host list&!!" unset
23128 .cindex "ESMTP, avoiding use of"
23129 .cindex "HELO" "forcing use of"
23130 .cindex "EHLO" "avoiding use of"
23131 .cindex "PIPELINING" "avoiding the use of"
23132 This option is for use with broken hosts that announce ESMTP facilities (for
23133 example, PIPELINING) and then fail to implement them properly. When a host
23134 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23135 start of the SMTP session. This means that it cannot use any of the ESMTP
23136 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23137
23138
23139 .option hosts_avoid_pipelining smtp "host list&!!" unset
23140 .cindex "PIPELINING" "avoiding the use of"
23141 Exim will not use the SMTP PIPELINING extension when delivering to any host
23142 that matches this list, even if the server host advertises PIPELINING support.
23143
23144
23145 .option hosts_avoid_tls smtp "host list&!!" unset
23146 .cindex "TLS" "avoiding for certain hosts"
23147 Exim will not try to start a TLS session when delivering to any host that
23148 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23149
23150 .option hosts_verify_avoid_tls smtp "host list&!!" *
23151 .cindex "TLS" "avoiding for certain hosts"
23152 Exim will not try to start a TLS session for a verify callout,
23153 or when delivering in cutthrough mode,
23154 to any host that matches this list.
23155 Note that the default is to not use TLS.
23156
23157
23158 .option hosts_max_try smtp integer 5
23159 .cindex "host" "maximum number to try"
23160 .cindex "limit" "number of hosts tried"
23161 .cindex "limit" "number of MX tried"
23162 .cindex "MX record" "maximum tried"
23163 This option limits the number of IP addresses that are tried for any one
23164 delivery in cases where there are temporary delivery errors. Section
23165 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23166
23167
23168 .option hosts_max_try_hardlimit smtp integer 50
23169 This is an additional check on the maximum number of IP addresses that Exim
23170 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23171 why it exists.
23172
23173
23174
23175 .option hosts_nopass_tls smtp "host list&!!" unset
23176 .cindex "TLS" "passing connection"
23177 .cindex "multiple SMTP deliveries"
23178 .cindex "TLS" "multiple message deliveries"
23179 For any host that matches this list, a connection on which a TLS session has
23180 been started will not be passed to a new delivery process for sending another
23181 message on the same connection. See section &<<SECTmulmessam>>& for an
23182 explanation of when this might be needed.
23183
23184
23185 .option hosts_override smtp boolean false
23186 If this option is set and the &%hosts%& option is also set, any hosts that are
23187 attached to the address are ignored, and instead the hosts specified by the
23188 &%hosts%& option are always used. This option does not apply to
23189 &%fallback_hosts%&.
23190
23191
23192 .option hosts_randomize smtp boolean false
23193 .cindex "randomized host list"
23194 .cindex "host" "list of; randomized"
23195 .cindex "fallback" "randomized hosts"
23196 If this option is set, and either the list of hosts is taken from the
23197 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23198 were not obtained from MX records (this includes fallback hosts from the
23199 router), and were not randomized by the router, the order of trying the hosts
23200 is randomized each time the transport runs. Randomizing the order of a host
23201 list can be used to do crude load sharing.
23202
23203 When &%hosts_randomize%& is true, a host list may be split into groups whose
23204 order is separately randomized. This makes it possible to set up MX-like
23205 behaviour. The boundaries between groups are indicated by an item that is just
23206 &`+`& in the host list. For example:
23207 .code
23208 hosts = host1:host2:host3:+:host4:host5
23209 .endd
23210 The order of the first three hosts and the order of the last two hosts is
23211 randomized for each use, but the first three always end up before the last two.
23212 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23213
23214 .option hosts_require_auth smtp "host list&!!" unset
23215 .cindex "authentication" "required by client"
23216 This option provides a list of servers for which authentication must succeed
23217 before Exim will try to transfer a message. If authentication fails for
23218 servers which are not in this list, Exim tries to send unauthenticated. If
23219 authentication fails for one of these servers, delivery is deferred. This
23220 temporary error is detectable in the retry rules, so it can be turned into a
23221 hard failure if required. See also &%hosts_try_auth%&, and chapter
23222 &<<CHAPSMTPAUTH>>& for details of authentication.
23223
23224
23225 .option hosts_request_ocsp smtp "host list&!!" *
23226 .cindex "TLS" "requiring for certain servers"
23227 Exim will request a Certificate Status on a
23228 TLS session for any host that matches this list.
23229 &%tls_verify_certificates%& should also be set for the transport.
23230
23231 .option hosts_require_ocsp smtp "host list&!!" unset
23232 .cindex "TLS" "requiring for certain servers"
23233 Exim will request, and check for a valid Certificate Status being given, on a
23234 TLS session for any host that matches this list.
23235 &%tls_verify_certificates%& should also be set for the transport.
23236
23237 .option hosts_require_tls smtp "host list&!!" unset
23238 .cindex "TLS" "requiring for certain servers"
23239 Exim will insist on using a TLS session when delivering to any host that
23240 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23241 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23242 incoming messages, use an appropriate ACL.
23243
23244 .option hosts_try_auth smtp "host list&!!" unset
23245 .cindex "authentication" "optional in client"
23246 This option provides a list of servers to which, provided they announce
23247 authentication support, Exim will attempt to authenticate as a client when it
23248 connects. If authentication fails, Exim will try to transfer the message
23249 unauthenticated. See also &%hosts_require_auth%&, and chapter
23250 &<<CHAPSMTPAUTH>>& for details of authentication.
23251
23252 .new
23253 .option hosts_try_prdr smtp "host list&!!" *
23254 .cindex "PRDR" "enabling, optional in client"
23255 This option provides a list of servers to which, provided they announce
23256 PRDR support, Exim will attempt to negotiate PRDR
23257 for multi-recipient messages.
23258 The option can usually be left as default.
23259 .wen
23260
23261 .option interface smtp "string list&!!" unset
23262 .cindex "bind IP address"
23263 .cindex "IP address" "binding"
23264 .vindex "&$host$&"
23265 .vindex "&$host_address$&"
23266 This option specifies which interface to bind to when making an outgoing SMTP
23267 call. The value is an IP address, not an interface name such as
23268 &`eth0`&. Do not confuse this with the interface address that was used when a
23269 message was received, which is in &$received_ip_address$&, formerly known as
23270 &$interface_address$&. The name was changed to minimize confusion with the
23271 outgoing interface address. There is no variable that contains an outgoing
23272 interface address because, unless it is set by this option, its value is
23273 unknown.
23274
23275 During the expansion of the &%interface%& option the variables &$host$& and
23276 &$host_address$& refer to the host to which a connection is about to be made
23277 during the expansion of the string. Forced expansion failure, or an empty
23278 string result causes the option to be ignored. Otherwise, after expansion, the
23279 string must be a list of IP addresses, colon-separated by default, but the
23280 separator can be changed in the usual way. For example:
23281 .code
23282 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23283 .endd
23284 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23285 connection. If none of them are the correct type, the option is ignored. If
23286 &%interface%& is not set, or is ignored, the system's IP functions choose which
23287 interface to use if the host has more than one.
23288
23289
23290 .option keepalive smtp boolean true
23291 .cindex "keepalive" "on outgoing connection"
23292 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23293 connections. When set, it causes the kernel to probe idle connections
23294 periodically, by sending packets with &"old"& sequence numbers. The other end
23295 of the connection should send a acknowledgment if the connection is still okay
23296 or a reset if the connection has been aborted. The reason for doing this is
23297 that it has the beneficial effect of freeing up certain types of connection
23298 that can get stuck when the remote host is disconnected without tidying up the
23299 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23300 unreachable hosts.
23301
23302
23303 .option lmtp_ignore_quota smtp boolean false
23304 .cindex "LMTP" "ignoring quota errors"
23305 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23306 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23307 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23308
23309 .option max_rcpt smtp integer 100
23310 .cindex "RCPT" "maximum number of outgoing"
23311 This option limits the number of RCPT commands that are sent in a single
23312 SMTP message transaction. Each set of addresses is treated independently, and
23313 so can cause parallel connections to the same host if &%remote_max_parallel%&
23314 permits this.
23315
23316
23317 .option multi_domain smtp boolean&!! true
23318 .vindex "&$domain$&"
23319 When this option is set, the &(smtp)& transport can handle a number of
23320 addresses containing a mixture of different domains provided they all resolve
23321 to the same list of hosts. Turning the option off restricts the transport to
23322 handling only one domain at a time. This is useful if you want to use
23323 &$domain$& in an expansion for the transport, because it is set only when there
23324 is a single domain involved in a remote delivery.
23325
23326 .new
23327 It is expanded per-address and can depend on any of
23328 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23329 &$host$&, &$host_address$& and &$host_port$&.
23330 .wen
23331
23332 .option port smtp string&!! "see below"
23333 .cindex "port" "sending TCP/IP"
23334 .cindex "TCP/IP" "setting outgoing port"
23335 This option specifies the TCP/IP port on the server to which Exim connects.
23336 &*Note:*& Do not confuse this with the port that was used when a message was
23337 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23338 The name was changed to minimize confusion with the outgoing port. There is no
23339 variable that contains an outgoing port.
23340
23341 If the value of this option begins with a digit it is taken as a port number;
23342 otherwise it is looked up using &[getservbyname()]&. The default value is
23343 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23344 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23345 is deferred.
23346
23347
23348
23349 .option protocol smtp string smtp
23350 .cindex "LMTP" "over TCP/IP"
23351 .cindex "ssmtp protocol" "outbound"
23352 .cindex "TLS" "SSL-on-connect outbound"
23353 .vindex "&$port$&"
23354 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23355 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23356 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23357 deliveries into closed message stores. Exim also has support for running LMTP
23358 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23359
23360 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23361 changes to &"smtps"&, and the transport initiates TLS immediately after
23362 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23363 The Internet standards bodies strongly discourage use of this mode.
23364
23365
23366 .option retry_include_ip_address smtp boolean&!! true
23367 Exim normally includes both the host name and the IP address in the key it
23368 constructs for indexing retry data after a temporary delivery failure. This
23369 means that when one of several IP addresses for a host is failing, it gets
23370 tried periodically (controlled by the retry rules), but use of the other IP
23371 addresses is not affected.
23372
23373 However, in some dialup environments hosts are assigned a different IP address
23374 each time they connect. In this situation the use of the IP address as part of
23375 the retry key leads to undesirable behaviour. Setting this option false causes
23376 Exim to use only the host name.
23377 .new
23378 Since it is expanded it can be made to depend on the host or domain.
23379 .wen
23380
23381
23382 .option serialize_hosts smtp "host list&!!" unset
23383 .cindex "serializing connections"
23384 .cindex "host" "serializing connections"
23385 Because Exim operates in a distributed manner, if several messages for the same
23386 host arrive at around the same time, more than one simultaneous connection to
23387 the remote host can occur. This is not usually a problem except when there is a
23388 slow link between the hosts. In that situation it may be helpful to restrict
23389 Exim to one connection at a time. This can be done by setting
23390 &%serialize_hosts%& to match the relevant hosts.
23391
23392 .cindex "hints database" "serializing deliveries to a host"
23393 Exim implements serialization by means of a hints database in which a record is
23394 written whenever a process connects to one of the restricted hosts. The record
23395 is deleted when the connection is completed. Obviously there is scope for
23396 records to get left lying around if there is a system or program crash. To
23397 guard against this, Exim ignores any records that are more than six hours old.
23398
23399 If you set up this kind of serialization, you should also arrange to delete the
23400 relevant hints database whenever your system reboots. The names of the files
23401 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23402 may be one or two files, depending on the type of DBM in use. The same files
23403 are used for ETRN serialization.
23404
23405
23406 .option size_addition smtp integer 1024
23407 .cindex "SMTP" "SIZE"
23408 .cindex "message" "size issue for transport filter"
23409 .cindex "size" "of message"
23410 .cindex "transport" "filter"
23411 .cindex "filter" "transport filter"
23412 If a remote SMTP server indicates that it supports the SIZE option of the
23413 MAIL command, Exim uses this to pass over the message size at the start of
23414 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23415 sends, to allow for headers and other text that may be added during delivery by
23416 configuration options or in a transport filter. It may be necessary to increase
23417 this if a lot of text is added to messages.
23418
23419 Alternatively, if the value of &%size_addition%& is set negative, it disables
23420 the use of the SIZE option altogether.
23421
23422
23423 .option tls_certificate smtp string&!! unset
23424 .cindex "TLS" "client certificate, location of"
23425 .cindex "certificate" "client, location of"
23426 .vindex "&$host$&"
23427 .vindex "&$host_address$&"
23428 The value of this option must be the absolute path to a file which contains the
23429 client's certificate, for possible use when sending a message over an encrypted
23430 connection. The values of &$host$& and &$host_address$& are set to the name and
23431 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23432 details of TLS.
23433
23434 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23435 certificate when sending messages as a client. The global option of the same
23436 name specifies the certificate for Exim as a server; it is not automatically
23437 assumed that the same certificate should be used when Exim is operating as a
23438 client.
23439
23440
23441 .option tls_crl smtp string&!! unset
23442 .cindex "TLS" "client certificate revocation list"
23443 .cindex "certificate" "revocation list for client"
23444 This option specifies a certificate revocation list. The expanded value must
23445 be the name of a file that contains a CRL in PEM format.
23446
23447
23448 .option tls_dh_min_bits smtp integer 1024
23449 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23450 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23451 key agreement is negotiated, the server will provide a large prime number
23452 for use.  This option establishes the minimum acceptable size of that number.
23453 If the parameter offered by the server is too small, then the TLS handshake
23454 will fail.
23455
23456 Only supported when using GnuTLS.
23457
23458
23459 .option tls_privatekey smtp string&!! unset
23460 .cindex "TLS" "client private key, location of"
23461 .vindex "&$host$&"
23462 .vindex "&$host_address$&"
23463 The value of this option must be the absolute path to a file which contains the
23464 client's private key. This is used when sending a message over an encrypted
23465 connection using a client certificate. The values of &$host$& and
23466 &$host_address$& are set to the name and address of the server during the
23467 expansion. If this option is unset, or the expansion is forced to fail, or the
23468 result is an empty string, the private key is assumed to be in the same file as
23469 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23470
23471
23472 .option tls_require_ciphers smtp string&!! unset
23473 .cindex "TLS" "requiring specific ciphers"
23474 .cindex "cipher" "requiring specific"
23475 .vindex "&$host$&"
23476 .vindex "&$host_address$&"
23477 The value of this option must be a list of permitted cipher suites, for use
23478 when setting up an outgoing encrypted connection. (There is a global option of
23479 the same name for controlling incoming connections.) The values of &$host$& and
23480 &$host_address$& are set to the name and address of the server during the
23481 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23482 is used in different ways by OpenSSL and GnuTLS (see sections
23483 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23484 ciphers is a preference order.
23485
23486
23487
23488 .option tls_sni smtp string&!! unset
23489 .cindex "TLS" "Server Name Indication"
23490 .vindex "&$tls_sni$&"
23491 If this option is set then it sets the $tls_out_sni variable and causes any
23492 TLS session to pass this value as the Server Name Indication extension to
23493 the remote side, which can be used by the remote side to select an appropriate
23494 certificate and private key for the session.
23495
23496 See &<<SECTtlssni>>& for more information.
23497
23498 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23499 TLS extensions.
23500
23501
23502
23503
23504 .option tls_tempfail_tryclear smtp boolean true
23505 .cindex "4&'xx'& responses" "to STARTTLS"
23506 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23507 setting up a TLS session, this option determines whether or not Exim should try
23508 to deliver the message unencrypted. If it is set false, delivery to the
23509 current host is deferred; if there are other hosts, they are tried. If this
23510 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23511 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23512 TLS negotiation fails, Exim closes the current connection (because it is in an
23513 unknown state), opens a new one to the same host, and then tries the delivery
23514 in clear.
23515
23516
23517 .new
23518 .option tls_try_verify_hosts smtp "host list&!!" *
23519 .wen
23520 .cindex "TLS" "server certificate verification"
23521 .cindex "certificate" "verification of server"
23522 This option gives a list of hosts for which, on encrypted connections,
23523 certificate verification will be tried but need not succeed.
23524 The &%tls_verify_certificates%& option must also be set.
23525 Note that unless the host is in this list
23526 TLS connections will be denied to hosts using self-signed certificates
23527 when &%tls_verify_certificates%& is matched.
23528 The &$tls_out_certificate_verified$& variable is set when
23529 certificate verification succeeds.
23530
23531
23532 .new
23533 .option tls_verify_cert_hostnames smtp "host list&!!" *
23534 .cindex "TLS" "server certificate hostname verification"
23535 .cindex "certificate" "verification of server"
23536 This option give a list of hosts for which,
23537 while verifying the server certificate,
23538 checks will be included on the host name
23539 (note that this will generally be the result of a DNS MX lookup)
23540 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23541 limited to being the initial component of a 3-or-more component FQDN.
23542
23543 There is no equivalent checking on client certificates.
23544 .wen
23545
23546
23547 .new
23548 .option tls_verify_certificates smtp string&!! system
23549 .cindex "TLS" "server certificate verification"
23550 .cindex "certificate" "verification of server"
23551 .vindex "&$host$&"
23552 .vindex "&$host_address$&"
23553 The value of this option must be either the
23554 word "system"
23555 or the absolute path to
23556 a file or directory containing permitted certificates for servers,
23557 for use when setting up an encrypted connection.
23558
23559 The "system" value for the option will use a location compiled into the SSL library.
23560 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23561 is taken as empty and an explicit location
23562 must be specified.
23563
23564 The use of a directory for the option value is not avilable for GnuTLS versions
23565 preceding 3.3.6 and a single file must be used.
23566 .wen
23567
23568 With OpenSSL the certificates specified
23569 explicitly
23570 either by file or directory
23571 are added to those given by the system default location.
23572
23573 The values of &$host$& and
23574 &$host_address$& are set to the name and address of the server during the
23575 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23576
23577 For back-compatability,
23578 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23579 (a single-colon empty list counts as being set)
23580 and certificate verification fails the TLS connection is closed.
23581
23582
23583 .option tls_verify_hosts smtp "host list&!!" unset
23584 .cindex "TLS" "server certificate verification"
23585 .cindex "certificate" "verification of server"
23586 This option gives a list of hosts for which. on encrypted connections,
23587 certificate verification must succeed.
23588 The &%tls_verify_certificates%& option must also be set.
23589 If both this option and &%tls_try_verify_hosts%& are unset
23590 operation is as if this option selected all hosts.
23591
23592
23593
23594
23595 .section "How the limits for the number of hosts to try are used" &&&
23596          "SECTvalhosmax"
23597 .cindex "host" "maximum number to try"
23598 .cindex "limit" "hosts; maximum number tried"
23599 There are two options that are concerned with the number of hosts that are
23600 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23601 &%hosts_max_try_hardlimit%&.
23602
23603
23604 The &%hosts_max_try%& option limits the number of hosts that are tried
23605 for a single delivery. However, despite the term &"host"& in its name, the
23606 option actually applies to each IP address independently. In other words, a
23607 multihomed host is treated as several independent hosts, just as it is for
23608 retrying.
23609
23610 Many of the larger ISPs have multiple MX records which often point to
23611 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23612 created as a result of routing one of these domains.
23613
23614 Trying every single IP address on such a long list does not seem sensible; if
23615 several at the top of the list fail, it is reasonable to assume there is some
23616 problem that is likely to affect all of them. Roughly speaking, the value of
23617 &%hosts_max_try%& is the maximum number that are tried before deferring the
23618 delivery. However, the logic cannot be quite that simple.
23619
23620 Firstly, IP addresses that are skipped because their retry times have not
23621 arrived do not count, and in addition, addresses that are past their retry
23622 limits are also not counted, even when they are tried. This means that when
23623 some IP addresses are past their retry limits, more than the value of
23624 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23625 that all IP addresses are considered before timing out an email address (but
23626 see below for an exception).
23627
23628 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23629 list to see if there is a subsequent host with a different (higher valued) MX.
23630 If there is, that host is considered next, and the current IP address is used
23631 but not counted. This behaviour helps in the case of a domain with a retry rule
23632 that hardly ever delays any hosts, as is now explained:
23633
23634 Consider the case of a long list of hosts with one MX value, and a few with a
23635 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23636 hosts at the top of the list are tried at first. With the default retry rule,
23637 which specifies increasing retry times, the higher MX hosts are eventually
23638 tried when those at the top of the list are skipped because they have not
23639 reached their retry times.
23640
23641 However, it is common practice to put a fixed short retry time on domains for
23642 large ISPs, on the grounds that their servers are rarely down for very long.
23643 Unfortunately, these are exactly the domains that tend to resolve to long lists
23644 of hosts. The short retry time means that the lowest MX hosts are tried every
23645 time. The attempts may be in a different order because of random sorting, but
23646 without the special MX check, the higher MX hosts would never be tried until
23647 all the lower MX hosts had timed out (which might be several days), because
23648 there are always some lower MX hosts that have reached their retry times. With
23649 the special check, Exim considers at least one IP address from each MX value at
23650 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23651 reached.
23652
23653 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23654 particular, Exim normally eventually tries all the IP addresses before timing
23655 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23656 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23657 been set up with hundreds of IP addresses for some domains. It can
23658 take a very long time indeed for an address to time out in these cases.
23659
23660 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23661 Exim never tries more than this number of IP addresses; if it hits this limit
23662 and they are all timed out, the email address is bounced, even though not all
23663 possible IP addresses have been tried.
23664 .ecindex IIDsmttra1
23665 .ecindex IIDsmttra2
23666
23667
23668
23669
23670
23671 . ////////////////////////////////////////////////////////////////////////////
23672 . ////////////////////////////////////////////////////////////////////////////
23673
23674 .chapter "Address rewriting" "CHAPrewrite"
23675 .scindex IIDaddrew "rewriting" "addresses"
23676 There are some circumstances in which Exim automatically rewrites domains in
23677 addresses. The two most common are when an address is given without a domain
23678 (referred to as an &"unqualified address"&) or when an address contains an
23679 abbreviated domain that is expanded by DNS lookup.
23680
23681 Unqualified envelope addresses are accepted only for locally submitted
23682 messages, or for messages that are received from hosts matching
23683 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23684 appropriate. Unqualified addresses in header lines are qualified if they are in
23685 locally submitted messages, or messages from hosts that are permitted to send
23686 unqualified envelope addresses. Otherwise, unqualified addresses in header
23687 lines are neither qualified nor rewritten.
23688
23689 One situation in which Exim does &'not'& automatically rewrite a domain is
23690 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23691 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23692 do this. The new RFCs do not contain this suggestion.
23693
23694
23695 .section "Explicitly configured address rewriting" "SECID147"
23696 This chapter describes the rewriting rules that can be used in the
23697 main rewrite section of the configuration file, and also in the generic
23698 &%headers_rewrite%& option that can be set on any transport.
23699
23700 Some people believe that configured address rewriting is a Mortal Sin.
23701 Others believe that life is not possible without it. Exim provides the
23702 facility; you do not have to use it.
23703
23704 The main rewriting rules that appear in the &"rewrite"& section of the
23705 configuration file are applied to addresses in incoming messages, both envelope
23706 addresses and addresses in header lines. Each rule specifies the types of
23707 address to which it applies.
23708
23709 Whether or not addresses in header lines are rewritten depends on the origin of
23710 the headers and the type of rewriting. Global rewriting, that is, rewriting
23711 rules from the rewrite section of the configuration file, is applied only to
23712 those headers that were received with the message. Header lines that are added
23713 by ACLs or by a system filter or by individual routers or transports (which
23714 are specific to individual recipient addresses) are not rewritten by the global
23715 rules.
23716
23717 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23718 applies all headers except those added by routers and transports. That is, as
23719 well as the headers that were received with the message, it also applies to
23720 headers that were added by an ACL or a system filter.
23721
23722
23723 In general, rewriting addresses from your own system or domain has some
23724 legitimacy. Rewriting other addresses should be done only with great care and
23725 in special circumstances. The author of Exim believes that rewriting should be
23726 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23727 Although it can sometimes be used as a routing tool, this is very strongly
23728 discouraged.
23729
23730 There are two commonly encountered circumstances where rewriting is used, as
23731 illustrated by these examples:
23732
23733 .ilist
23734 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23735 exchange mail with each other behind a firewall, but there is only a single
23736 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23737 &'hitch.fict.example'& when sending mail off-site.
23738 .next
23739 A host rewrites the local parts of its own users so that, for example,
23740 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23741 .endlist
23742
23743
23744
23745 .section "When does rewriting happen?" "SECID148"
23746 .cindex "rewriting" "timing of"
23747 .cindex "&ACL;" "rewriting addresses in"
23748 Configured address rewriting can take place at several different stages of a
23749 message's processing.
23750
23751 .vindex "&$sender_address$&"
23752 At the start of an ACL for MAIL, the sender address may have been rewritten
23753 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23754 ordinary rewrite rules have yet been applied. If, however, the sender address
23755 is verified in the ACL, it is rewritten before verification, and remains
23756 rewritten thereafter. The subsequent value of &$sender_address$& is the
23757 rewritten address. This also applies if sender verification happens in a
23758 RCPT ACL. Otherwise, when the sender address is not verified, it is
23759 rewritten as soon as a message's header lines have been received.
23760
23761 .vindex "&$domain$&"
23762 .vindex "&$local_part$&"
23763 Similarly, at the start of an ACL for RCPT, the current recipient's address
23764 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23765 rewrite rules have yet been applied to it. However, the behaviour is different
23766 from the sender address when a recipient is verified. The address is rewritten
23767 for the verification, but the rewriting is not remembered at this stage. The
23768 value of &$local_part$& and &$domain$& after verification are always the same
23769 as they were before (that is, they contain the unrewritten &-- except for
23770 SMTP-time rewriting &-- address).
23771
23772 As soon as a message's header lines have been received, all the envelope
23773 recipient addresses are permanently rewritten, and rewriting is also applied to
23774 the addresses in the header lines (if configured). This happens before adding
23775 any header lines that were specified in MAIL or RCPT ACLs, and
23776 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23777 before the DATA ACL and &[local_scan()]& functions are run.
23778
23779 When an address is being routed, either for delivery or for verification,
23780 rewriting is applied immediately to child addresses that are generated by
23781 redirection, unless &%no_rewrite%& is set on the router.
23782
23783 .cindex "envelope sender" "rewriting at transport time"
23784 .cindex "rewriting" "at transport time"
23785 .cindex "header lines" "rewriting at transport time"
23786 At transport time, additional rewriting of addresses in header lines can be
23787 specified by setting the generic &%headers_rewrite%& option on a transport.
23788 This option contains rules that are identical in form to those in the rewrite
23789 section of the configuration file. They are applied to the original message
23790 header lines and any that were added by ACLs or a system filter. They are not
23791 applied to header lines that are added by routers or the transport.
23792
23793 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23794 transport option. However, it is not possible to rewrite envelope recipients at
23795 transport time.
23796
23797
23798
23799
23800 .section "Testing the rewriting rules that apply on input" "SECID149"
23801 .cindex "rewriting" "testing"
23802 .cindex "testing" "rewriting"
23803 Exim's input rewriting configuration appears in a part of the run time
23804 configuration file headed by &"begin rewrite"&. It can be tested by the
23805 &%-brw%& command line option. This takes an address (which can be a full RFC
23806 2822 address) as its argument. The output is a list of how the address would be
23807 transformed by the rewriting rules for each of the different places it might
23808 appear in an incoming message, that is, for each different header and for the
23809 envelope sender and recipient fields. For example,
23810 .code
23811 exim -brw ph10@exim.workshop.example
23812 .endd
23813 might produce the output
23814 .code
23815 sender: Philip.Hazel@exim.workshop.example
23816 from: Philip.Hazel@exim.workshop.example
23817 to: ph10@exim.workshop.example
23818 cc: ph10@exim.workshop.example
23819 bcc: ph10@exim.workshop.example
23820 reply-to: Philip.Hazel@exim.workshop.example
23821 env-from: Philip.Hazel@exim.workshop.example
23822 env-to: ph10@exim.workshop.example
23823 .endd
23824 which shows that rewriting has been set up for that address when used in any of
23825 the source fields, but not when it appears as a recipient address. At the
23826 present time, there is no equivalent way of testing rewriting rules that are
23827 set for a particular transport.
23828
23829
23830 .section "Rewriting rules" "SECID150"
23831 .cindex "rewriting" "rules"
23832 The rewrite section of the configuration file consists of lines of rewriting
23833 rules in the form
23834 .display
23835 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23836 .endd
23837 Rewriting rules that are specified for the &%headers_rewrite%& generic
23838 transport option are given as a colon-separated list. Each item in the list
23839 takes the same form as a line in the main rewriting configuration (except that
23840 any colons must be doubled, of course).
23841
23842 The formats of source patterns and replacement strings are described below.
23843 Each is terminated by white space, unless enclosed in double quotes, in which
23844 case normal quoting conventions apply inside the quotes. The flags are single
23845 characters which may appear in any order. Spaces and tabs between them are
23846 ignored.
23847
23848 For each address that could potentially be rewritten, the rules are scanned in
23849 order, and replacements for the address from earlier rules can themselves be
23850 replaced by later rules (but see the &"q"& and &"R"& flags).
23851
23852 The order in which addresses are rewritten is undefined, may change between
23853 releases, and must not be relied on, with one exception: when a message is
23854 received, the envelope sender is always rewritten first, before any header
23855 lines are rewritten. For example, the replacement string for a rewrite of an
23856 address in &'To:'& must not assume that the message's address in &'From:'& has
23857 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
23858 that the envelope sender has already been rewritten.
23859
23860 .vindex "&$domain$&"
23861 .vindex "&$local_part$&"
23862 The variables &$local_part$& and &$domain$& can be used in the replacement
23863 string to refer to the address that is being rewritten. Note that lookup-driven
23864 rewriting can be done by a rule of the form
23865 .code
23866 *@*   ${lookup ...
23867 .endd
23868 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
23869 refer to the address that is being rewritten.
23870
23871
23872 .section "Rewriting patterns" "SECID151"
23873 .cindex "rewriting" "patterns"
23874 .cindex "address list" "in a rewriting pattern"
23875 The source pattern in a rewriting rule is any item which may appear in an
23876 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
23877 single-item address list, which means that it is expanded before being tested
23878 against the address. As always, if you use a regular expression as a pattern,
23879 you must take care to escape dollar and backslash characters, or use the &`\N`&
23880 facility to suppress string expansion within the regular expression.
23881
23882 Domains in patterns should be given in lower case. Local parts in patterns are
23883 case-sensitive. If you want to do case-insensitive matching of local parts, you
23884 can use a regular expression that starts with &`^(?i)`&.
23885
23886 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
23887 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
23888 depending on the type of match which occurred. These can be used in the
23889 replacement string to insert portions of the incoming address. &$0$& always
23890 refers to the complete incoming address. When a regular expression is used, the
23891 numerical variables are set from its capturing subexpressions. For other types
23892 of pattern they are set as follows:
23893
23894 .ilist
23895 If a local part or domain starts with an asterisk, the numerical variables
23896 refer to the character strings matched by asterisks, with &$1$& associated with
23897 the first asterisk, and &$2$& with the second, if present. For example, if the
23898 pattern
23899 .code
23900 *queen@*.fict.example
23901 .endd
23902 is matched against the address &'hearts-queen@wonderland.fict.example'& then
23903 .code
23904 $0 = hearts-queen@wonderland.fict.example
23905 $1 = hearts-
23906 $2 = wonderland
23907 .endd
23908 Note that if the local part does not start with an asterisk, but the domain
23909 does, it is &$1$& that contains the wild part of the domain.
23910
23911 .next
23912 If the domain part of the pattern is a partial lookup, the wild and fixed parts
23913 of the domain are placed in the next available numerical variables. Suppose,
23914 for example, that the address &'foo@bar.baz.example'& is processed by a
23915 rewriting rule of the form
23916 .display
23917 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
23918 .endd
23919 and the key in the file that matches the domain is &`*.baz.example`&. Then
23920 .code
23921 $1 = foo
23922 $2 = bar
23923 $3 = baz.example
23924 .endd
23925 If the address &'foo@baz.example'& is looked up, this matches the same
23926 wildcard file entry, and in this case &$2$& is set to the empty string, but
23927 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
23928 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
23929 whole domain. For non-partial domain lookups, no numerical variables are set.
23930 .endlist
23931
23932
23933 .section "Rewriting replacements" "SECID152"
23934 .cindex "rewriting" "replacements"
23935 If the replacement string for a rule is a single asterisk, addresses that
23936 match the pattern and the flags are &'not'& rewritten, and no subsequent
23937 rewriting rules are scanned. For example,
23938 .code
23939 hatta@lookingglass.fict.example  *  f
23940 .endd
23941 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
23942 &'From:'& headers.
23943
23944 .vindex "&$domain$&"
23945 .vindex "&$local_part$&"
23946 If the replacement string is not a single asterisk, it is expanded, and must
23947 yield a fully qualified address. Within the expansion, the variables
23948 &$local_part$& and &$domain$& refer to the address that is being rewritten.
23949 Any letters they contain retain their original case &-- they are not lower
23950 cased. The numerical variables are set up according to the type of pattern that
23951 matched the address, as described above. If the expansion is forced to fail by
23952 the presence of &"fail"& in a conditional or lookup item, rewriting by the
23953 current rule is abandoned, but subsequent rules may take effect. Any other
23954 expansion failure causes the entire rewriting operation to be abandoned, and an
23955 entry written to the panic log.
23956
23957
23958
23959 .section "Rewriting flags" "SECID153"
23960 There are three different kinds of flag that may appear on rewriting rules:
23961
23962 .ilist
23963 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
23964 c, f, h, r, s, t.
23965 .next
23966 A flag that specifies rewriting at SMTP time: S.
23967 .next
23968 Flags that control the rewriting process: Q, q, R, w.
23969 .endlist
23970
23971 For rules that are part of the &%headers_rewrite%& generic transport option,
23972 E, F, T, and S are not permitted.
23973
23974
23975
23976 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
23977          "SECID154"
23978 .cindex "rewriting" "flags"
23979 If none of the following flag letters, nor the &"S"& flag (see section
23980 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
23981 and to both the sender and recipient fields of the envelope, whereas a
23982 transport-time rewriting rule just applies to all headers. Otherwise, the
23983 rewriting rule is skipped unless the relevant addresses are being processed.
23984 .display
23985 &`E`&       rewrite all envelope fields
23986 &`F`&       rewrite the envelope From field
23987 &`T`&       rewrite the envelope To field
23988 &`b`&       rewrite the &'Bcc:'& header
23989 &`c`&       rewrite the &'Cc:'& header
23990 &`f`&       rewrite the &'From:'& header
23991 &`h`&       rewrite all headers
23992 &`r`&       rewrite the &'Reply-To:'& header
23993 &`s`&       rewrite the &'Sender:'& header
23994 &`t`&       rewrite the &'To:'& header
23995 .endd
23996 "All headers" means all of the headers listed above that can be selected
23997 individually, plus their &'Resent-'& versions. It does not include
23998 other headers such as &'Subject:'& etc.
23999
24000 You should be particularly careful about rewriting &'Sender:'& headers, and
24001 restrict this to special known cases in your own domains.
24002
24003
24004 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24005 .cindex "SMTP" "rewriting malformed addresses"
24006 .cindex "RCPT" "rewriting argument of"
24007 .cindex "MAIL" "rewriting argument of"
24008 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24009 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24010 before any other processing; even before syntax checking. The pattern is
24011 required to be a regular expression, and it is matched against the whole of the
24012 data for the command, including any surrounding angle brackets.
24013
24014 .vindex "&$domain$&"
24015 .vindex "&$local_part$&"
24016 This form of rewrite rule allows for the handling of addresses that are not
24017 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24018 input). Because the input is not required to be a syntactically valid address,
24019 the variables &$local_part$& and &$domain$& are not available during the
24020 expansion of the replacement string. The result of rewriting replaces the
24021 original address in the MAIL or RCPT command.
24022
24023
24024 .section "Flags controlling the rewriting process" "SECID155"
24025 There are four flags which control the way the rewriting process works. These
24026 take effect only when a rule is invoked, that is, when the address is of the
24027 correct type (matches the flags) and matches the pattern:
24028
24029 .ilist
24030 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24031 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24032 absence of &"Q"& the rewritten address must always include a domain.
24033 .next
24034 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24035 even if no rewriting actually takes place because of a &"fail"& in the
24036 expansion. The &"q"& flag is not effective if the address is of the wrong type
24037 (does not match the flags) or does not match the pattern.
24038 .next
24039 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24040 address, up to ten times. It can be combined with the &"q"& flag, to stop
24041 rewriting once it fails to match (after at least one successful rewrite).
24042 .next
24043 .cindex "rewriting" "whole addresses"
24044 When an address in a header is rewritten, the rewriting normally applies only
24045 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24046 left unchanged. For example, rewriting might change
24047 .code
24048 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24049 .endd
24050 into
24051 .code
24052 From: Ford Prefect <prefectf@hitch.fict.example>
24053 .endd
24054 .cindex "RFC 2047"
24055 Sometimes there is a need to replace the whole address item, and this can be
24056 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24057 causes an address in a header line to be rewritten, the entire address is
24058 replaced, not just the working part. The replacement must be a complete RFC
24059 2822 address, including the angle brackets if necessary. If text outside angle
24060 brackets contains a character whose value is greater than 126 or less than 32
24061 (except for tab), the text is encoded according to RFC 2047. The character set
24062 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24063
24064 When the &"w"& flag is set on a rule that causes an envelope address to be
24065 rewritten, all but the working part of the replacement address is discarded.
24066 .endlist
24067
24068
24069 .section "Rewriting examples" "SECID156"
24070 Here is an example of the two common rewriting paradigms:
24071 .code
24072 *@*.hitch.fict.example  $1@hitch.fict.example
24073 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24074                      {$value}fail}@hitch.fict.example bctfrF
24075 .endd
24076 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24077 the string expansion to fail if the lookup does not succeed. In this context it
24078 has the effect of leaving the original address unchanged, but Exim goes on to
24079 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24080 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24081 explicitly, which would cause the rewritten address to be the same as before,
24082 at the cost of a small bit of processing. Not supplying either of these is an
24083 error, since the rewritten address would then contain no local part.
24084
24085 The first example above replaces the domain with a superior, more general
24086 domain. This may not be desirable for certain local parts. If the rule
24087 .code
24088 root@*.hitch.fict.example  *
24089 .endd
24090 were inserted before the first rule, rewriting would be suppressed for the
24091 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24092
24093 Rewriting can be made conditional on a number of tests, by making use of
24094 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24095 messages that originate outside the local host:
24096 .code
24097 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24098                          {$1@hitch.fict.example}fail}"
24099 .endd
24100 The replacement string is quoted in this example because it contains white
24101 space.
24102
24103 .cindex "rewriting" "bang paths"
24104 .cindex "bang paths" "rewriting"
24105 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24106 an address it treats it as an unqualified local part which it qualifies with
24107 the local qualification domain (if the source of the message is local or if the
24108 remote host is permitted to send unqualified addresses). Rewriting can
24109 sometimes be used to handle simple bang paths with a fixed number of
24110 components. For example, the rule
24111 .code
24112 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24113 .endd
24114 rewrites a two-component bang path &'host.name!user'& as the domain address
24115 &'user@host.name'&. However, there is a security implication in using this as
24116 a global rewriting rule for envelope addresses. It can provide a backdoor
24117 method for using your system as a relay, because the incoming addresses appear
24118 to be local. If the bang path addresses are received via SMTP, it is safer to
24119 use the &"S"& flag to rewrite them as they are received, so that relay checking
24120 can be done on the rewritten addresses.
24121 .ecindex IIDaddrew
24122
24123
24124
24125
24126
24127 . ////////////////////////////////////////////////////////////////////////////
24128 . ////////////////////////////////////////////////////////////////////////////
24129
24130 .chapter "Retry configuration" "CHAPretry"
24131 .scindex IIDretconf1 "retry" "configuration, description of"
24132 .scindex IIDregconf2 "configuration file" "retry section"
24133 The &"retry"& section of the runtime configuration file contains a list of
24134 retry rules that control how often Exim tries to deliver messages that cannot
24135 be delivered at the first attempt. If there are no retry rules (the section is
24136 empty or not present), there are no retries. In this situation, temporary
24137 errors are treated as permanent. The default configuration contains a single,
24138 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24139 line option can be used to test which retry rule will be used for a given
24140 address, domain and error.
24141
24142 The most common cause of retries is temporary failure to deliver to a remote
24143 host because the host is down, or inaccessible because of a network problem.
24144 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24145 address) basis, not on a per-message basis. Thus, if one message has recently
24146 been delayed, delivery of a new message to the same host is not immediately
24147 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24148 log selector is set, the message
24149 .cindex "retry" "time not reached"
24150 &"retry time not reached"& is written to the main log whenever a delivery is
24151 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24152 the handling of errors during remote deliveries.
24153
24154 Retry processing applies to routing as well as to delivering, except as covered
24155 in the next paragraph. The retry rules do not distinguish between these
24156 actions. It is not possible, for example, to specify different behaviour for
24157 failures to route the domain &'snark.fict.example'& and failures to deliver to
24158 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24159 added complication, so did not implement it. However, although they share the
24160 same retry rule, the actual retry times for routing and transporting a given
24161 domain are maintained independently.
24162
24163 When a delivery is not part of a queue run (typically an immediate delivery on
24164 receipt of a message), the routers are always run, and local deliveries are
24165 always attempted, even if retry times are set for them. This makes for better
24166 behaviour if one particular message is causing problems (for example, causing
24167 quota overflow, or provoking an error in a filter file). If such a delivery
24168 suffers a temporary failure, the retry data is updated as normal, and
24169 subsequent delivery attempts from queue runs occur only when the retry time for
24170 the local address is reached.
24171
24172 .section "Changing retry rules" "SECID157"
24173 If you change the retry rules in your configuration, you should consider
24174 whether or not to delete the retry data that is stored in Exim's spool area in
24175 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24176 always safe; that is why they are called &"hints"&.
24177
24178 The hints retry data contains suggested retry times based on the previous
24179 rules. In the case of a long-running problem with a remote host, it might
24180 record the fact that the host has timed out. If your new rules increase the
24181 timeout time for such a host, you should definitely remove the old retry data
24182 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24183 messages that it should now be retaining.
24184
24185
24186
24187 .section "Format of retry rules" "SECID158"
24188 .cindex "retry" "rules"
24189 Each retry rule occupies one line and consists of three or four parts,
24190 separated by white space: a pattern, an error name, an optional list of sender
24191 addresses, and a list of retry parameters. The pattern and sender lists must be
24192 enclosed in double quotes if they contain white space. The rules are searched
24193 in order until one is found where the pattern, error name, and sender list (if
24194 present) match the failing host or address, the error that occurred, and the
24195 message's sender, respectively.
24196
24197
24198 The pattern is any single item that may appear in an address list (see section
24199 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24200 which means that it is expanded before being tested against the address that
24201 has been delayed. A negated address list item is permitted. Address
24202 list processing treats a plain domain name as if it were preceded by &"*@"&,
24203 which makes it possible for many retry rules to start with just a domain. For
24204 example,
24205 .code
24206 lookingglass.fict.example        *  F,24h,30m;
24207 .endd
24208 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24209 whereas
24210 .code
24211 alice@lookingglass.fict.example  *  F,24h,30m;
24212 .endd
24213 applies only to temporary failures involving the local part &%alice%&.
24214 In practice, almost all rules start with a domain name pattern without a local
24215 part.
24216
24217 .cindex "regular expressions" "in retry rules"
24218 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24219 must match a complete address, not just a domain, because that is how regular
24220 expressions work in address lists.
24221 .display
24222 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24223 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24224 .endd
24225
24226
24227 .section "Choosing which retry rule to use for address errors" "SECID159"
24228 When Exim is looking for a retry rule after a routing attempt has failed (for
24229 example, after a DNS timeout), each line in the retry configuration is tested
24230 against the complete address only if &%retry_use_local_part%& is set for the
24231 router. Otherwise, only the domain is used, except when matching against a
24232 regular expression, when the local part of the address is replaced with &"*"&.
24233 A domain on its own can match a domain pattern, or a pattern that starts with
24234 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24235 &%check_local_user%& is true, and false for other routers.
24236
24237 Similarly, when Exim is looking for a retry rule after a local delivery has
24238 failed (for example, after a mailbox full error), each line in the retry
24239 configuration is tested against the complete address only if
24240 &%retry_use_local_part%& is set for the transport (it defaults true for all
24241 local transports).
24242
24243 .cindex "4&'xx'& responses" "retry rules for"
24244 However, when Exim is looking for a retry rule after a remote delivery attempt
24245 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24246 whole address is always used as the key when searching the retry rules. The
24247 rule that is found is used to create a retry time for the combination of the
24248 failing address and the message's sender. It is the combination of sender and
24249 recipient that is delayed in subsequent queue runs until its retry time is
24250 reached. You can delay the recipient without regard to the sender by setting
24251 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24252 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24253 commands.
24254
24255
24256
24257 .section "Choosing which retry rule to use for host and message errors" &&&
24258          "SECID160"
24259 For a temporary error that is not related to an individual address (for
24260 example, a connection timeout), each line in the retry configuration is checked
24261 twice. First, the name of the remote host is used as a domain name (preceded by
24262 &"*@"& when matching a regular expression). If this does not match the line,
24263 the domain from the email address is tried in a similar fashion. For example,
24264 suppose the MX records for &'a.b.c.example'& are
24265 .code
24266 a.b.c.example  MX  5  x.y.z.example
24267                MX  6  p.q.r.example
24268                MX  7  m.n.o.example
24269 .endd
24270 and the retry rules are
24271 .code
24272 p.q.r.example    *      F,24h,30m;
24273 a.b.c.example    *      F,4d,45m;
24274 .endd
24275 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24276 first rule matches neither the host nor the domain, so Exim looks at the second
24277 rule. This does not match the host, but it does match the domain, so it is used
24278 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24279 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24280 first retry rule is used, because it matches the host.
24281
24282 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24283 first rule to determine retry times, but for all the other hosts for the domain
24284 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24285 routing to &'a.b.c.example'& suffers a temporary failure.
24286
24287 &*Note*&: The host name is used when matching the patterns, not its IP address.
24288 However, if a message is routed directly to an IP address without the use of a
24289 host name, for example, if a &(manualroute)& router contains a setting such as:
24290 .code
24291 route_list = *.a.example  192.168.34.23
24292 .endd
24293 then the &"host name"& that is used when searching for a retry rule is the
24294 textual form of the IP address.
24295
24296 .section "Retry rules for specific errors" "SECID161"
24297 .cindex "retry" "specific errors; specifying"
24298 The second field in a retry rule is the name of a particular error, or an
24299 asterisk, which matches any error. The errors that can be tested for are:
24300
24301 .vlist
24302 .vitem &%auth_failed%&
24303 Authentication failed when trying to send to a host in the
24304 &%hosts_require_auth%& list in an &(smtp)& transport.
24305
24306 .vitem &%data_4xx%&
24307 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24308 after the command, or after sending the message's data.
24309
24310 .vitem &%mail_4xx%&
24311 A 4&'xx'& error was received for an outgoing MAIL command.
24312
24313 .vitem &%rcpt_4xx%&
24314 A 4&'xx'& error was received for an outgoing RCPT command.
24315 .endlist
24316
24317 For the three 4&'xx'& errors, either the first or both of the x's can be given
24318 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24319 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24320 and have retries every ten minutes with a one-hour timeout, you could set up a
24321 retry rule of this form:
24322 .code
24323 the.domain.name  rcpt_452   F,1h,10m
24324 .endd
24325 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24326 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24327
24328 .vlist
24329 .vitem &%lost_connection%&
24330 A server unexpectedly closed the SMTP connection. There may, of course,
24331 legitimate reasons for this (host died, network died), but if it repeats a lot
24332 for the same host, it indicates something odd.
24333
24334 .vitem &%refused_MX%&
24335 A connection to a host obtained from an MX record was refused.
24336
24337 .vitem &%refused_A%&
24338 A connection to a host not obtained from an MX record was refused.
24339
24340 .vitem &%refused%&
24341 A connection was refused.
24342
24343 .vitem &%timeout_connect_MX%&
24344 A connection attempt to a host obtained from an MX record timed out.
24345
24346 .vitem &%timeout_connect_A%&
24347 A connection attempt to a host not obtained from an MX record timed out.
24348
24349 .vitem &%timeout_connect%&
24350 A connection attempt timed out.
24351
24352 .vitem &%timeout_MX%&
24353 There was a timeout while connecting or during an SMTP session with a host
24354 obtained from an MX record.
24355
24356 .vitem &%timeout_A%&
24357 There was a timeout while connecting or during an SMTP session with a host not
24358 obtained from an MX record.
24359
24360 .vitem &%timeout%&
24361 There was a timeout while connecting or during an SMTP session.
24362
24363 .vitem &%tls_required%&
24364 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24365 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24366 to STARTTLS, or there was a problem setting up the TLS connection.
24367
24368 .vitem &%quota%&
24369 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24370 transport.
24371
24372 .vitem &%quota_%&<&'time'&>
24373 .cindex "quota" "error testing in retry rule"
24374 .cindex "retry" "quota error testing"
24375 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24376 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24377 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24378 for four days.
24379 .endlist
24380
24381 .cindex "mailbox" "time of last read"
24382 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24383 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24384 it should be based on the last time that the user accessed the mailbox.
24385 However, it is not always possible to determine this. Exim uses the following
24386 heuristic rules:
24387
24388 .ilist
24389 If the mailbox is a single file, the time of last access (the &"atime"&) is
24390 used. As no new messages are being delivered (because the mailbox is over
24391 quota), Exim does not access the file, so this is the time of last user access.
24392 .next
24393 .cindex "maildir format" "time of last read"
24394 For a maildir delivery, the time of last modification of the &_new_&
24395 subdirectory is used. As the mailbox is over quota, no new files are created in
24396 the &_new_& subdirectory, because no new messages are being delivered. Any
24397 change to the &_new_& subdirectory is therefore assumed to be the result of an
24398 MUA moving a new message to the &_cur_& directory when it is first read. The
24399 time that is used is therefore the last time that the user read a new message.
24400 .next
24401 For other kinds of multi-file mailbox, the time of last access cannot be
24402 obtained, so a retry rule that uses this type of error field is never matched.
24403 .endlist
24404
24405 The quota errors apply both to system-enforced quotas and to Exim's own quota
24406 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24407 when a local delivery is deferred because a partition is full (the ENOSPC
24408 error).
24409
24410
24411
24412 .section "Retry rules for specified senders" "SECID162"
24413 .cindex "retry" "rules; sender-specific"
24414 You can specify retry rules that apply only when the failing message has a
24415 specific sender. In particular, this can be used to define retry rules that
24416 apply only to bounce messages. The third item in a retry rule can be of this
24417 form:
24418 .display
24419 &`senders=`&<&'address list'&>
24420 .endd
24421 The retry timings themselves are then the fourth item. For example:
24422 .code
24423 *   rcpt_4xx   senders=:   F,1h,30m
24424 .endd
24425 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24426 host. If the address list contains white space, it must be enclosed in quotes.
24427 For example:
24428 .code
24429 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24430 .endd
24431 &*Warning*&: This facility can be unhelpful if it is used for host errors
24432 (which do not depend on the recipient). The reason is that the sender is used
24433 only to match the retry rule. Once the rule has been found for a host error,
24434 its contents are used to set a retry time for the host, and this will apply to
24435 all messages, not just those with specific senders.
24436
24437 When testing retry rules using &%-brt%&, you can supply a sender using the
24438 &%-f%& command line option, like this:
24439 .code
24440 exim -f "" -brt user@dom.ain
24441 .endd
24442 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24443 list is never matched.
24444
24445
24446
24447
24448
24449 .section "Retry parameters" "SECID163"
24450 .cindex "retry" "parameters in rules"
24451 The third (or fourth, if a senders list is present) field in a retry rule is a
24452 sequence of retry parameter sets, separated by semicolons. Each set consists of
24453 .display
24454 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24455 .endd
24456 The letter identifies the algorithm for computing a new retry time; the cutoff
24457 time is the time beyond which this algorithm no longer applies, and the
24458 arguments vary the algorithm's action. The cutoff time is measured from the
24459 time that the first failure for the domain (combined with the local part if
24460 relevant) was detected, not from the time the message was received.
24461
24462 .cindex "retry" "algorithms"
24463 .cindex "retry" "fixed intervals"
24464 .cindex "retry" "increasing intervals"
24465 .cindex "retry" "random intervals"
24466 The available algorithms are:
24467
24468 .ilist
24469 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24470 the interval.
24471 .next
24472 &'G'&: retry at geometrically increasing intervals. The first argument
24473 specifies a starting value for the interval, and the second a multiplier, which
24474 is used to increase the size of the interval at each retry.
24475 .next
24476 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24477 retry, the previous interval is multiplied by the factor in order to get a
24478 maximum for the next interval. The minimum interval is the first argument of
24479 the parameter, and an actual interval is chosen randomly between them. Such a
24480 rule has been found to be helpful in cluster configurations when all the
24481 members of the cluster restart at once, and may therefore synchronize their
24482 queue processing times.
24483 .endlist
24484
24485 When computing the next retry time, the algorithm definitions are scanned in
24486 order until one whose cutoff time has not yet passed is reached. This is then
24487 used to compute a new retry time that is later than the current time. In the
24488 case of fixed interval retries, this simply means adding the interval to the
24489 current time. For geometrically increasing intervals, retry intervals are
24490 computed from the rule's parameters until one that is greater than the previous
24491 interval is found. The main configuration variable
24492 .cindex "limit" "retry interval"
24493 .cindex "retry" "interval, maximum"
24494 .oindex "&%retry_interval_max%&"
24495 &%retry_interval_max%& limits the maximum interval between retries. It
24496 cannot be set greater than &`24h`&, which is its default value.
24497
24498 A single remote domain may have a number of hosts associated with it, and each
24499 host may have more than one IP address. Retry algorithms are selected on the
24500 basis of the domain name, but are applied to each IP address independently. If,
24501 for example, a host has two IP addresses and one is unusable, Exim will
24502 generate retry times for it and will not try to use it until its next retry
24503 time comes. Thus the good IP address is likely to be tried first most of the
24504 time.
24505
24506 .cindex "hints database" "use for retrying"
24507 Retry times are hints rather than promises. Exim does not make any attempt to
24508 run deliveries exactly at the computed times. Instead, a queue runner process
24509 starts delivery processes for delayed messages periodically, and these attempt
24510 new deliveries only for those addresses that have passed their next retry time.
24511 If a new message arrives for a deferred address, an immediate delivery attempt
24512 occurs only if the address has passed its retry time. In the absence of new
24513 messages, the minimum time between retries is the interval between queue runner
24514 processes. There is not much point in setting retry times of five minutes if
24515 your queue runners happen only once an hour, unless there are a significant
24516 number of incoming messages (which might be the case on a system that is
24517 sending everything to a smart host, for example).
24518
24519 The data in the retry hints database can be inspected by using the
24520 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24521 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24522 &'exinext'& utility script can be used to find out what the next retry times
24523 are for the hosts associated with a particular mail domain, and also for local
24524 deliveries that have been deferred.
24525
24526
24527 .section "Retry rule examples" "SECID164"
24528 Here are some example retry rules:
24529 .code
24530 alice@wonderland.fict.example quota_5d  F,7d,3h
24531 wonderland.fict.example       quota_5d
24532 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24533 lookingglass.fict.example     *         F,24h,30m;
24534 *                 refused_A   F,2h,20m;
24535 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24536 .endd
24537 The first rule sets up special handling for mail to
24538 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24539 mailbox has not been read for at least 5 days. Retries continue every three
24540 hours for 7 days. The second rule handles over-quota errors for all other local
24541 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24542 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24543 fail are bounced immediately if the mailbox has not been read for at least 5
24544 days.
24545
24546 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24547 happen every 15 minutes for an hour, then with geometrically increasing
24548 intervals until two days have passed since a delivery first failed. After the
24549 first hour there is a delay of one hour, then two hours, then four hours, and
24550 so on (this is a rather extreme example).
24551
24552 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24553 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24554 all other domains, with special action for connection refusal from hosts that
24555 were not obtained from an MX record.
24556
24557 The final rule in a retry configuration should always have asterisks in the
24558 first two fields so as to provide a general catch-all for any addresses that do
24559 not have their own special handling. This example tries every 15 minutes for 2
24560 hours, then with intervals starting at one hour and increasing by a factor of
24561 1.5 up to 16 hours, then every 8 hours up to 5 days.
24562
24563
24564
24565 .section "Timeout of retry data" "SECID165"
24566 .cindex "timeout" "of retry data"
24567 .oindex "&%retry_data_expire%&"
24568 .cindex "hints database" "data expiry"
24569 .cindex "retry" "timeout of data"
24570 Exim timestamps the data that it writes to its retry hints database. When it
24571 consults the data during a delivery it ignores any that is older than the value
24572 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24573 been tried for 7 days, Exim will try to deliver to it immediately a message
24574 arrives, and if that fails, it will calculate a retry time as if it were
24575 failing for the first time.
24576
24577 This improves the behaviour for messages routed to rarely-used hosts such as MX
24578 backups. If such a host was down at one time, and happens to be down again when
24579 Exim tries a month later, using the old retry data would imply that it had been
24580 down all the time, which is not a justified assumption.
24581
24582 If a host really is permanently dead, this behaviour causes a burst of retries
24583 every now and again, but only if messages routed to it are rare. If there is a
24584 message at least once every 7 days the retry data never expires.
24585
24586
24587
24588
24589 .section "Long-term failures" "SECID166"
24590 .cindex "delivery failure, long-term"
24591 .cindex "retry" "after long-term failure"
24592 Special processing happens when an email address has been failing for so long
24593 that the cutoff time for the last algorithm is reached. For example, using the
24594 default retry rule:
24595 .code
24596 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24597 .endd
24598 the cutoff time is four days. Reaching the retry cutoff is independent of how
24599 long any specific message has been failing; it is the length of continuous
24600 failure for the recipient address that counts.
24601
24602 When the cutoff time is reached for a local delivery, or for all the IP
24603 addresses associated with a remote delivery, a subsequent delivery failure
24604 causes Exim to give up on the address, and a bounce message is generated.
24605 In order to cater for new messages that use the failing address, a next retry
24606 time is still computed from the final algorithm, and is used as follows:
24607
24608 For local deliveries, one delivery attempt is always made for any subsequent
24609 messages. If this delivery fails, the address fails immediately. The
24610 post-cutoff retry time is not used.
24611
24612 If the delivery is remote, there are two possibilities, controlled by the
24613 .oindex "&%delay_after_cutoff%&"
24614 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24615 default. Until the post-cutoff retry time for one of the IP addresses is
24616 reached, the failing email address is bounced immediately, without a delivery
24617 attempt taking place. After that time, one new delivery attempt is made to
24618 those IP addresses that are past their retry times, and if that still fails,
24619 the address is bounced and new retry times are computed.
24620
24621 In other words, when all the hosts for a given email address have been failing
24622 for a long time, Exim bounces rather then defers until one of the hosts' retry
24623 times is reached. Then it tries once, and bounces if that attempt fails. This
24624 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24625 to a broken destination, but if the host does recover, Exim will eventually
24626 notice.
24627
24628 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24629 addresses are past their final cutoff time, Exim tries to deliver to those IP
24630 addresses that have not been tried since the message arrived. If there are
24631 no suitable IP addresses, or if they all fail, the address is bounced. In other
24632 words, it does not delay when a new message arrives, but tries the expired
24633 addresses immediately, unless they have been tried since the message arrived.
24634 If there is a continuous stream of messages for the failing domains, setting
24635 &%delay_after_cutoff%& false means that there will be many more attempts to
24636 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24637 true.
24638
24639 .section "Deliveries that work intermittently" "SECID167"
24640 .cindex "retry" "intermittently working deliveries"
24641 Some additional logic is needed to cope with cases where a host is
24642 intermittently available, or when a message has some attribute that prevents
24643 its delivery when others to the same address get through. In this situation,
24644 because some messages are successfully delivered, the &"retry clock"& for the
24645 host or address keeps getting reset by the successful deliveries, and so
24646 failing messages remain on the queue for ever because the cutoff time is never
24647 reached.
24648
24649 Two exceptional actions are applied to prevent this happening. The first
24650 applies to errors that are related to a message rather than a remote host.
24651 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24652 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24653 commands, and quota failures. For this type of error, if a message's arrival
24654 time is earlier than the &"first failed"& time for the error, the earlier time
24655 is used when scanning the retry rules to decide when to try next and when to
24656 time out the address.
24657
24658 The exceptional second action applies in all cases. If a message has been on
24659 the queue for longer than the cutoff time of any applicable retry rule for a
24660 given address, a delivery is attempted for that address, even if it is not yet
24661 time, and if this delivery fails, the address is timed out. A new retry time is
24662 not computed in this case, so that other messages for the same address are
24663 considered immediately.
24664 .ecindex IIDretconf1
24665 .ecindex IIDregconf2
24666
24667
24668
24669
24670
24671
24672 . ////////////////////////////////////////////////////////////////////////////
24673 . ////////////////////////////////////////////////////////////////////////////
24674
24675 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24676 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24677 .scindex IIDauthconf2 "authentication"
24678 The &"authenticators"& section of Exim's run time configuration is concerned
24679 with SMTP authentication. This facility is an extension to the SMTP protocol,
24680 described in RFC 2554, which allows a client SMTP host to authenticate itself
24681 to a server. This is a common way for a server to recognize clients that are
24682 permitted to use it as a relay. SMTP authentication is not of relevance to the
24683 transfer of mail between servers that have no managerial connection with each
24684 other.
24685
24686 .cindex "AUTH" "description of"
24687 Very briefly, the way SMTP authentication works is as follows:
24688
24689 .ilist
24690 The server advertises a number of authentication &'mechanisms'& in response to
24691 the client's EHLO command.
24692 .next
24693 The client issues an AUTH command, naming a specific mechanism. The command
24694 may, optionally, contain some authentication data.
24695 .next
24696 The server may issue one or more &'challenges'&, to which the client must send
24697 appropriate responses. In simple authentication mechanisms, the challenges are
24698 just prompts for user names and passwords. The server does not have to issue
24699 any challenges &-- in some mechanisms the relevant data may all be transmitted
24700 with the AUTH command.
24701 .next
24702 The server either accepts or denies authentication.
24703 .next
24704 If authentication succeeds, the client may optionally make use of the AUTH
24705 option on the MAIL command to pass an authenticated sender in subsequent
24706 mail transactions. Authentication lasts for the remainder of the SMTP
24707 connection.
24708 .next
24709 If authentication fails, the client may give up, or it may try a different
24710 authentication mechanism, or it may try transferring mail over the
24711 unauthenticated connection.
24712 .endlist
24713
24714 If you are setting up a client, and want to know which authentication
24715 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24716 SMTP port) on the server, and issue an EHLO command. The response to this
24717 includes the list of supported mechanisms. For example:
24718 .display
24719 &`$ `&&*&`telnet server.example 25`&*&
24720 &`Trying 192.168.34.25...`&
24721 &`Connected to server.example.`&
24722 &`Escape character is &#x0027;^]&#x0027;.`&
24723 &`220 server.example ESMTP Exim 4.20 ...`&
24724 &*&`ehlo client.example`&*&
24725 &`250-server.example Hello client.example [10.8.4.5]`&
24726 &`250-SIZE 52428800`&
24727 &`250-PIPELINING`&
24728 &`250-AUTH PLAIN`&
24729 &`250 HELP`&
24730 .endd
24731 The second-last line of this example output shows that the server supports
24732 authentication using the PLAIN mechanism. In Exim, the different authentication
24733 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24734 routers and transports, which authenticators are included in the binary is
24735 controlled by build-time definitions. The following are currently available,
24736 included by setting
24737 .code
24738 AUTH_CRAM_MD5=yes
24739 AUTH_CYRUS_SASL=yes
24740 AUTH_DOVECOT=yes
24741 AUTH_GSASL=yes
24742 AUTH_HEIMDAL_GSSAPI=yes
24743 AUTH_PLAINTEXT=yes
24744 AUTH_SPA=yes
24745 .endd
24746 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24747 authentication mechanism (RFC 2195), and the second provides an interface to
24748 the Cyrus SASL authentication library.
24749 The third is an interface to Dovecot's authentication system, delegating the
24750 work via a socket interface.
24751 The fourth provides an interface to the GNU SASL authentication library, which
24752 provides mechanisms but typically not data sources.
24753 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24754 supporting setting a server keytab.
24755 The sixth can be configured to support
24756 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24757 not formally documented, but used by several MUAs. The seventh authenticator
24758 supports Microsoft's &'Secure Password Authentication'& mechanism.
24759
24760 The authenticators are configured using the same syntax as other drivers (see
24761 section &<<SECTfordricon>>&). If no authenticators are required, no
24762 authentication section need be present in the configuration file. Each
24763 authenticator can in principle have both server and client functions. When Exim
24764 is receiving SMTP mail, it is acting as a server; when it is sending out
24765 messages over SMTP, it is acting as a client. Authenticator configuration
24766 options are provided for use in both these circumstances.
24767
24768 To make it clear which options apply to which situation, the prefixes
24769 &%server_%& and &%client_%& are used on option names that are specific to
24770 either the server or the client function, respectively. Server and client
24771 functions are disabled if none of their options are set. If an authenticator is
24772 to be used for both server and client functions, a single definition, using
24773 both sets of options, is required. For example:
24774 .code
24775 cram:
24776   driver = cram_md5
24777   public_name = CRAM-MD5
24778   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24779   client_name = ph10
24780   client_secret = secret2
24781 .endd
24782 The &%server_%& option is used when Exim is acting as a server, and the
24783 &%client_%& options when it is acting as a client.
24784
24785 Descriptions of the individual authenticators are given in subsequent chapters.
24786 The remainder of this chapter covers the generic options for the
24787 authenticators, followed by general discussion of the way authentication works
24788 in Exim.
24789
24790 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24791 per-mechanism basis.  Please read carefully to determine which variables hold
24792 account labels such as usercodes and which hold passwords or other
24793 authenticating data.
24794
24795 Note that some mechanisms support two different identifiers for accounts: the
24796 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24797 and &'authz'& are commonly encountered.  The American spelling is standard here.
24798 Conceptually, authentication data such as passwords are tied to the identifier
24799 used to authenticate; servers may have rules to permit one user to act as a
24800 second user, so that after login the session is treated as though that second
24801 user had logged in.  That second user is the &'authorization id'&.  A robust
24802 configuration might confirm that the &'authz'& field is empty or matches the
24803 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24804 as verified data, the &'authz'& as an unverified request which the server might
24805 choose to honour.
24806
24807 A &'realm'& is a text string, typically a domain name, presented by a server
24808 to a client to help it select an account and credentials to use.  In some
24809 mechanisms, the client and server provably agree on the realm, but clients
24810 typically can not treat the realm as secure data to be blindly trusted.
24811
24812
24813
24814 .section "Generic options for authenticators" "SECID168"
24815 .cindex "authentication" "generic options"
24816 .cindex "options" "generic; for authenticators"
24817
24818 .option client_condition authenticators string&!! unset
24819 When Exim is authenticating as a client, it skips any authenticator whose
24820 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24821 used, for example, to skip plain text authenticators when the connection is not
24822 encrypted by a setting such as:
24823 .code
24824 client_condition = ${if !eq{$tls_out_cipher}{}}
24825 .endd
24826
24827
24828 .option client_set_id authenticators string&!! unset
24829 When client authentication succeeds, this condition is expanded; the
24830 result is used in the log lines for outbound messasges.
24831 Typically it will be the user name used for authentication.
24832
24833
24834 .option driver authenticators string unset
24835 This option must always be set. It specifies which of the available
24836 authenticators is to be used.
24837
24838
24839 .option public_name authenticators string unset
24840 This option specifies the name of the authentication mechanism that the driver
24841 implements, and by which it is known to the outside world. These names should
24842 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
24843 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
24844 defaults to the driver's instance name.
24845
24846
24847 .option server_advertise_condition authenticators string&!! unset
24848 When a server is about to advertise an authentication mechanism, the condition
24849 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
24850 mechanism is not advertised.
24851 If the expansion fails, the mechanism is not advertised. If the failure was not
24852 forced, and was not caused by a lookup defer, the incident is logged.
24853 See section &<<SECTauthexiser>>& below for further discussion.
24854
24855
24856 .option server_condition authenticators string&!! unset
24857 This option must be set for a &%plaintext%& server authenticator, where it
24858 is used directly to control authentication. See section &<<SECTplainserver>>&
24859 for details.
24860
24861 For the &(gsasl)& authenticator, this option is required for various
24862 mechanisms; see chapter &<<CHAPgsasl>>& for details.
24863
24864 For the other authenticators, &%server_condition%& can be used as an additional
24865 authentication or authorization mechanism that is applied after the other
24866 authenticator conditions succeed. If it is set, it is expanded when the
24867 authenticator would otherwise return a success code. If the expansion is forced
24868 to fail, authentication fails. Any other expansion failure causes a temporary
24869 error code to be returned. If the result of a successful expansion is an empty
24870 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
24871 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
24872 other result, a temporary error code is returned, with the expanded string as
24873 the error text.
24874
24875
24876 .option server_debug_print authenticators string&!! unset
24877 If this option is set and authentication debugging is enabled (see the &%-d%&
24878 command line option), the string is expanded and included in the debugging
24879 output when the authenticator is run as a server. This can help with checking
24880 out the values of variables.
24881 If expansion of the string fails, the error message is written to the debugging
24882 output, and Exim carries on processing.
24883
24884
24885 .option server_set_id authenticators string&!! unset
24886 .vindex "&$authenticated_id$&"
24887 When an Exim server successfully authenticates a client, this string is
24888 expanded using data from the authentication, and preserved for any incoming
24889 messages in the variable &$authenticated_id$&. It is also included in the log
24890 lines for incoming messages. For example, a user/password authenticator
24891 configuration might preserve the user name that was used to authenticate, and
24892 refer to it subsequently during delivery of the message.
24893 If expansion fails, the option is ignored.
24894
24895
24896 .option server_mail_auth_condition authenticators string&!! unset
24897 This option allows a server to discard authenticated sender addresses supplied
24898 as part of MAIL commands in SMTP connections that are authenticated by the
24899 driver on which &%server_mail_auth_condition%& is set. The option is not used
24900 as part of the authentication process; instead its (unexpanded) value is
24901 remembered for later use.
24902 How it is used is described in the following section.
24903
24904
24905
24906
24907
24908 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
24909 .cindex "authentication" "sender; authenticated"
24910 .cindex "AUTH" "on MAIL command"
24911 When a client supplied an AUTH= item on a MAIL command, Exim applies
24912 the following checks before accepting it as the authenticated sender of the
24913 message:
24914
24915 .ilist
24916 If the connection is not using extended SMTP (that is, HELO was used rather
24917 than EHLO), the use of AUTH= is a syntax error.
24918 .next
24919 If the value of the AUTH= parameter is &"<>"&, it is ignored.
24920 .next
24921 .vindex "&$authenticated_sender$&"
24922 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
24923 running, the value of &$authenticated_sender$& is set to the value obtained
24924 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
24925 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
24926 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
24927 given for the MAIL command.
24928 .next
24929 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
24930 is accepted and placed in &$authenticated_sender$& only if the client has
24931 authenticated.
24932 .next
24933 If the AUTH= value was accepted by either of the two previous rules, and
24934 the client has authenticated, and the authenticator has a setting for the
24935 &%server_mail_auth_condition%&, the condition is checked at this point. The
24936 valued that was saved from the authenticator is expanded. If the expansion
24937 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
24938 &$authenticated_sender$& is deleted. If the expansion yields any other value,
24939 the value of &$authenticated_sender$& is retained and passed on with the
24940 message.
24941 .endlist
24942
24943
24944 When &$authenticated_sender$& is set for a message, it is passed on to other
24945 hosts to which Exim authenticates as a client. Do not confuse this value with
24946 &$authenticated_id$&, which is a string obtained from the authentication
24947 process, and which is not usually a complete email address.
24948
24949 .vindex "&$sender_address$&"
24950 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
24951 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
24952 therefore make use of &$authenticated_sender$&. The converse is not true: the
24953 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
24954 ACL is run.
24955
24956
24957
24958 .section "Authentication on an Exim server" "SECTauthexiser"
24959 .cindex "authentication" "on an Exim server"
24960 When Exim receives an EHLO command, it advertises the public names of those
24961 authenticators that are configured as servers, subject to the following
24962 conditions:
24963
24964 .ilist
24965 The client host must match &%auth_advertise_hosts%& (default *).
24966 .next
24967 It the &%server_advertise_condition%& option is set, its expansion must not
24968 yield the empty string, &"0"&, &"no"&, or &"false"&.
24969 .endlist
24970
24971 The order in which the authenticators are defined controls the order in which
24972 the mechanisms are advertised.
24973
24974 Some mail clients (for example, some versions of Netscape) require the user to
24975 provide a name and password for authentication whenever AUTH is advertised,
24976 even though authentication may not in fact be needed (for example, Exim may be
24977 set up to allow unconditional relaying from the client by an IP address check).
24978 You can make such clients more friendly by not advertising AUTH to them.
24979 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
24980 that runs for RCPT) to relay without authentication, you should set
24981 .code
24982 auth_advertise_hosts = ! 10.9.8.0/24
24983 .endd
24984 so that no authentication mechanisms are advertised to them.
24985
24986 The &%server_advertise_condition%& controls the advertisement of individual
24987 authentication mechanisms. For example, it can be used to restrict the
24988 advertisement of a particular mechanism to encrypted connections, by a setting
24989 such as:
24990 .code
24991 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
24992 .endd
24993 .vindex "&$tls_in_cipher$&"
24994 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
24995 yields &"yes"&, which allows the advertisement to happen.
24996
24997 When an Exim server receives an AUTH command from a client, it rejects it
24998 immediately if AUTH was not advertised in response to an earlier EHLO
24999 command. This is the case if
25000
25001 .ilist
25002 The client host does not match &%auth_advertise_hosts%&; or
25003 .next
25004 No authenticators are configured with server options; or
25005 .next
25006 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25007 server authenticators.
25008 .endlist
25009
25010
25011 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25012 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25013 AUTH is accepted from any client host.
25014
25015 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25016 server authentication mechanism that was advertised in response to EHLO and
25017 that matches the one named in the AUTH command. If it finds one, it runs
25018 the appropriate authentication protocol, and authentication either succeeds or
25019 fails. If there is no matching advertised mechanism, the AUTH command is
25020 rejected with a 504 error.
25021
25022 .vindex "&$received_protocol$&"
25023 .vindex "&$sender_host_authenticated$&"
25024 When a message is received from an authenticated host, the value of
25025 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25026 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25027 public name) of the authenticator driver that successfully authenticated the
25028 client from which the message was received. This variable is empty if there was
25029 no successful authentication.
25030
25031
25032
25033
25034 .section "Testing server authentication" "SECID169"
25035 .cindex "authentication" "testing a server"
25036 .cindex "AUTH" "testing a server"
25037 .cindex "base64 encoding" "creating authentication test data"
25038 Exim's &%-bh%& option can be useful for testing server authentication
25039 configurations. The data for the AUTH command has to be sent using base64
25040 encoding. A quick way to produce such data for testing is the following Perl
25041 script:
25042 .code
25043 use MIME::Base64;
25044 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25045 .endd
25046 .cindex "binary zero" "in authentication data"
25047 This interprets its argument as a Perl string, and then encodes it. The
25048 interpretation as a Perl string allows binary zeros, which are required for
25049 some kinds of authentication, to be included in the data. For example, a
25050 command line to run this script on such data might be
25051 .code
25052 encode '\0user\0password'
25053 .endd
25054 Note the use of single quotes to prevent the shell interpreting the
25055 backslashes, so that they can be interpreted by Perl to specify characters
25056 whose code value is zero.
25057
25058 &*Warning 1*&: If either of the user or password strings starts with an octal
25059 digit, you must use three zeros instead of one after the leading backslash. If
25060 you do not, the octal digit that starts your string will be incorrectly
25061 interpreted as part of the code for the first character.
25062
25063 &*Warning 2*&: If there are characters in the strings that Perl interprets
25064 specially, you must use a Perl escape to prevent them being misinterpreted. For
25065 example, a command such as
25066 .code
25067 encode '\0user@domain.com\0pas$$word'
25068 .endd
25069 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25070
25071 If you have the &%mimencode%& command installed, another way to do produce
25072 base64-encoded strings is to run the command
25073 .code
25074 echo -e -n `\0user\0password' | mimencode
25075 .endd
25076 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25077 in the argument, and the &%-n%& option specifies no newline at the end of its
25078 output. However, not all versions of &%echo%& recognize these options, so you
25079 should check your version before relying on this suggestion.
25080
25081
25082
25083 .section "Authentication by an Exim client" "SECID170"
25084 .cindex "authentication" "on an Exim client"
25085 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25086 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25087 announces support for authentication, and the host matches an entry in either
25088 of these options, Exim (as a client) tries to authenticate as follows:
25089
25090 .ilist
25091 For each authenticator that is configured as a client, in the order in which
25092 they are defined in the configuration, it searches the authentication
25093 mechanisms announced by the server for one whose name matches the public name
25094 of the authenticator.
25095 .next
25096 .vindex "&$host$&"
25097 .vindex "&$host_address$&"
25098 When it finds one that matches, it runs the authenticator's client code. The
25099 variables &$host$& and &$host_address$& are available for any string expansions
25100 that the client might do. They are set to the server's name and IP address. If
25101 any expansion is forced to fail, the authentication attempt is abandoned, and
25102 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25103 delivery to be deferred.
25104 .next
25105 If the result of the authentication attempt is a temporary error or a timeout,
25106 Exim abandons trying to send the message to the host for the moment. It will
25107 try again later. If there are any backup hosts available, they are tried in the
25108 usual way.
25109 .next
25110 If the response to authentication is a permanent error (5&'xx'& code), Exim
25111 carries on searching the list of authenticators and tries another one if
25112 possible. If all authentication attempts give permanent errors, or if there are
25113 no attempts because no mechanisms match (or option expansions force failure),
25114 what happens depends on whether the host matches &%hosts_require_auth%& or
25115 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25116 delivery is deferred. The error can be detected in the retry rules, and thereby
25117 turned into a permanent error if you wish. In the second case, Exim tries to
25118 deliver the message unauthenticated.
25119 .endlist
25120
25121 .cindex "AUTH" "on MAIL command"
25122 When Exim has authenticated itself to a remote server, it adds the AUTH
25123 parameter to the MAIL commands it sends, if it has an authenticated sender for
25124 the message. If the message came from a remote host, the authenticated sender
25125 is the one that was receiving on an incoming MAIL command, provided that the
25126 incoming connection was authenticated and the &%server_mail_auth%& condition
25127 allowed the authenticated sender to be retained. If a local process calls Exim
25128 to send a message, the sender address that is built from the login name and
25129 &%qualify_domain%& is treated as authenticated. However, if the
25130 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25131 the authenticated sender that was received with the message.
25132 .ecindex IIDauthconf1
25133 .ecindex IIDauthconf2
25134
25135
25136
25137
25138
25139
25140 . ////////////////////////////////////////////////////////////////////////////
25141 . ////////////////////////////////////////////////////////////////////////////
25142
25143 .chapter "The plaintext authenticator" "CHAPplaintext"
25144 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25145 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25146 The &(plaintext)& authenticator can be configured to support the PLAIN and
25147 LOGIN authentication mechanisms, both of which transfer authentication data as
25148 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25149 security risk; you are strongly advised to insist on the use of SMTP encryption
25150 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25151 use unencrypted plain text, you should not use the same passwords for SMTP
25152 connections as you do for login accounts.
25153
25154 .section "Plaintext options" "SECID171"
25155 .cindex "options" "&(plaintext)& authenticator (server)"
25156 When configured as a server, &(plaintext)& uses the following options:
25157
25158 .option server_condition authenticators string&!! unset
25159 This is actually a global authentication option, but it must be set in order to
25160 configure the &(plaintext)& driver as a server. Its use is described below.
25161
25162 .option server_prompts plaintext string&!! unset
25163 The contents of this option, after expansion, must be a colon-separated list of
25164 prompt strings. If expansion fails, a temporary authentication rejection is
25165 given.
25166
25167 .section "Using plaintext in a server" "SECTplainserver"
25168 .cindex "AUTH" "in &(plaintext)& authenticator"
25169 .cindex "binary zero" "in &(plaintext)& authenticator"
25170 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25171         "in &(plaintext)& authenticator"
25172 .vindex "&$auth1$&, &$auth2$&, etc"
25173 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25174
25175 When running as a server, &(plaintext)& performs the authentication test by
25176 expanding a string. The data sent by the client with the AUTH command, or in
25177 response to subsequent prompts, is base64 encoded, and so may contain any byte
25178 values when decoded. If any data is supplied with the command, it is treated as
25179 a list of strings, separated by NULs (binary zeros), the first three of which
25180 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25181 (neither LOGIN nor PLAIN uses more than three strings).
25182
25183 For compatibility with previous releases of Exim, the values are also placed in
25184 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25185 variables for this purpose is now deprecated, as it can lead to confusion in
25186 string expansions that also use them for other things.
25187
25188 If there are more strings in &%server_prompts%& than the number of strings
25189 supplied with the AUTH command, the remaining prompts are used to obtain more
25190 data. Each response from the client may be a list of NUL-separated strings.
25191
25192 .vindex "&$authenticated_id$&"
25193 Once a sufficient number of data strings have been received,
25194 &%server_condition%& is expanded. If the expansion is forced to fail,
25195 authentication fails. Any other expansion failure causes a temporary error code
25196 to be returned. If the result of a successful expansion is an empty string,
25197 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25198 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25199 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25200 For any other result, a temporary error code is returned, with the expanded
25201 string as the error text
25202
25203 &*Warning*&: If you use a lookup in the expansion to find the user's
25204 password, be sure to make the authentication fail if the user is unknown.
25205 There are good and bad examples at the end of the next section.
25206
25207
25208
25209 .section "The PLAIN authentication mechanism" "SECID172"
25210 .cindex "PLAIN authentication mechanism"
25211 .cindex "authentication" "PLAIN mechanism"
25212 .cindex "binary zero" "in &(plaintext)& authenticator"
25213 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25214 sent as one item of data (that is, one combined string containing two NUL
25215 separators). The data is sent either as part of the AUTH command, or
25216 subsequently in response to an empty prompt from the server.
25217
25218 The second and third strings are a user name and a corresponding password.
25219 Using a single fixed user name and password as an example, this could be
25220 configured as follows:
25221 .code
25222 fixed_plain:
25223   driver = plaintext
25224   public_name = PLAIN
25225   server_prompts = :
25226   server_condition = \
25227     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25228   server_set_id = $auth2
25229 .endd
25230 Note that the default result strings from &%if%& (&"true"& or an empty string)
25231 are exactly what we want here, so they need not be specified. Obviously, if the
25232 password contains expansion-significant characters such as dollar, backslash,
25233 or closing brace, they have to be escaped.
25234
25235 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25236 the end of a string list are ignored). If all the data comes as part of the
25237 AUTH command, as is commonly the case, the prompt is not used. This
25238 authenticator is advertised in the response to EHLO as
25239 .code
25240 250-AUTH PLAIN
25241 .endd
25242 and a client host can authenticate itself by sending the command
25243 .code
25244 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25245 .endd
25246 As this contains three strings (more than the number of prompts), no further
25247 data is required from the client. Alternatively, the client may just send
25248 .code
25249 AUTH PLAIN
25250 .endd
25251 to initiate authentication, in which case the server replies with an empty
25252 prompt. The client must respond with the combined data string.
25253
25254 The data string is base64 encoded, as required by the RFC. This example,
25255 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25256 represents a zero byte. This is split up into three strings, the first of which
25257 is empty. The &%server_condition%& option in the authenticator checks that the
25258 second two are &`username`& and &`mysecret`& respectively.
25259
25260 Having just one fixed user name and password, as in this example, is not very
25261 realistic, though for a small organization with only a handful of
25262 authenticating clients it could make sense.
25263
25264 A more sophisticated instance of this authenticator could use the user name in
25265 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25266 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25267 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25268 This is an incorrect example:
25269 .code
25270 server_condition = \
25271   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25272 .endd
25273 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25274 which it then compares to the supplied password (&$auth3$&). Why is this example
25275 incorrect? It works fine for existing users, but consider what happens if a
25276 non-existent user name is given. The lookup fails, but as no success/failure
25277 strings are given for the lookup, it yields an empty string. Thus, to defeat
25278 the authentication, all a client has to do is to supply a non-existent user
25279 name and an empty password. The correct way of writing this test is:
25280 .code
25281 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25282   {${if eq{$value}{$auth3}}} {false}}
25283 .endd
25284 In this case, if the lookup succeeds, the result is checked; if the lookup
25285 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25286 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25287 always fails if its second argument is empty. However, the second way of
25288 writing the test makes the logic clearer.
25289
25290
25291 .section "The LOGIN authentication mechanism" "SECID173"
25292 .cindex "LOGIN authentication mechanism"
25293 .cindex "authentication" "LOGIN mechanism"
25294 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25295 in a number of programs. No data is sent with the AUTH command. Instead, a
25296 user name and password are supplied separately, in response to prompts. The
25297 plaintext authenticator can be configured to support this as in this example:
25298 .code
25299 fixed_login:
25300   driver = plaintext
25301   public_name = LOGIN
25302   server_prompts = User Name : Password
25303   server_condition = \
25304     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25305   server_set_id = $auth1
25306 .endd
25307 Because of the way plaintext operates, this authenticator accepts data supplied
25308 with the AUTH command (in contravention of the specification of LOGIN), but
25309 if the client does not supply it (as is the case for LOGIN clients), the prompt
25310 strings are used to obtain two data items.
25311
25312 Some clients are very particular about the precise text of the prompts. For
25313 example, Outlook Express is reported to recognize only &"Username:"& and
25314 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25315 strings. It uses the &%ldapauth%& expansion condition to check the user
25316 name and password by binding to an LDAP server:
25317 .code
25318 login:
25319   driver = plaintext
25320   public_name = LOGIN
25321   server_prompts = Username:: : Password::
25322   server_condition = ${if and{{ \
25323     !eq{}{$auth1} }{ \
25324     ldapauth{\
25325       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25326       pass=${quote:$auth2} \
25327       ldap://ldap.example.org/} }} }
25328   server_set_id = uid=$auth1,ou=people,o=example.org
25329 .endd
25330 We have to check that the username is not empty before using it, because LDAP
25331 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25332 operator to correctly quote the DN for authentication. However, the basic
25333 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25334 correct one to use for the password, because quoting is needed only to make
25335 the password conform to the Exim syntax. At the LDAP level, the password is an
25336 uninterpreted string.
25337
25338
25339 .section "Support for different kinds of authentication" "SECID174"
25340 A number of string expansion features are provided for the purpose of
25341 interfacing to different ways of user authentication. These include checking
25342 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25343 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25344 &<<SECTexpcond>>&.
25345
25346
25347
25348
25349 .section "Using plaintext in a client" "SECID175"
25350 .cindex "options" "&(plaintext)& authenticator (client)"
25351 The &(plaintext)& authenticator has two client options:
25352
25353 .option client_ignore_invalid_base64 plaintext boolean false
25354 If the client receives a server prompt that is not a valid base64 string,
25355 authentication is abandoned by default. However, if this option is set true,
25356 the error in the challenge is ignored and the client sends the response as
25357 usual.
25358
25359 .option client_send plaintext string&!! unset
25360 The string is a colon-separated list of authentication data strings. Each
25361 string is independently expanded before being sent to the server. The first
25362 string is sent with the AUTH command; any more strings are sent in response
25363 to prompts from the server. Before each string is expanded, the value of the
25364 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25365 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25366 way. Thus, the prompt that is received in response to sending the first string
25367 (with the AUTH command) can be used in the expansion of the second string, and
25368 so on. If an invalid base64 string is received when
25369 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25370 &$auth$&<&'n'&> variable.
25371
25372 &*Note*&: You cannot use expansion to create multiple strings, because
25373 splitting takes priority and happens first.
25374
25375 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25376 the data, further processing is applied to each string before it is sent. If
25377 there are any single circumflex characters in the string, they are converted to
25378 NULs. Should an actual circumflex be required as data, it must be doubled in
25379 the string.
25380
25381 This is an example of a client configuration that implements the PLAIN
25382 authentication mechanism with a fixed user name and password:
25383 .code
25384 fixed_plain:
25385   driver = plaintext
25386   public_name = PLAIN
25387   client_send = ^username^mysecret
25388 .endd
25389 The lack of colons means that the entire text is sent with the AUTH
25390 command, with the circumflex characters converted to NULs. A similar example
25391 that uses the LOGIN mechanism is:
25392 .code
25393 fixed_login:
25394   driver = plaintext
25395   public_name = LOGIN
25396   client_send = : username : mysecret
25397 .endd
25398 The initial colon means that the first string is empty, so no data is sent with
25399 the AUTH command itself. The remaining strings are sent in response to
25400 prompts.
25401 .ecindex IIDplaiauth1
25402 .ecindex IIDplaiauth2
25403
25404
25405
25406
25407 . ////////////////////////////////////////////////////////////////////////////
25408 . ////////////////////////////////////////////////////////////////////////////
25409
25410 .chapter "The cram_md5 authenticator" "CHID9"
25411 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25412 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25413 .cindex "CRAM-MD5 authentication mechanism"
25414 .cindex "authentication" "CRAM-MD5 mechanism"
25415 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25416 sends a challenge string to the client, and the response consists of a user
25417 name and the CRAM-MD5 digest of the challenge string combined with a secret
25418 string (password) which is known to both server and client. Thus, the secret
25419 is not sent over the network as plain text, which makes this authenticator more
25420 secure than &(plaintext)&. However, the downside is that the secret has to be
25421 available in plain text at either end.
25422
25423
25424 .section "Using cram_md5 as a server" "SECID176"
25425 .cindex "options" "&(cram_md5)& authenticator (server)"
25426 This authenticator has one server option, which must be set to configure the
25427 authenticator as a server:
25428
25429 .option server_secret cram_md5 string&!! unset
25430 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25431 When the server receives the client's response, the user name is placed in
25432 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25433 obtain the password for that user. The server then computes the CRAM-MD5 digest
25434 that the client should have sent, and checks that it received the correct
25435 string. If the expansion of &%server_secret%& is forced to fail, authentication
25436 fails. If the expansion fails for some other reason, a temporary error code is
25437 returned to the client.
25438
25439 For compatibility with previous releases of Exim, the user name is also placed
25440 in &$1$&. However, the use of this variables for this purpose is now
25441 deprecated, as it can lead to confusion in string expansions that also use
25442 numeric variables for other things.
25443
25444 For example, the following authenticator checks that the user name given by the
25445 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25446 user name, authentication fails.
25447 .code
25448 fixed_cram:
25449   driver = cram_md5
25450   public_name = CRAM-MD5
25451   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25452   server_set_id = $auth1
25453 .endd
25454 .vindex "&$authenticated_id$&"
25455 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25456 name in &$authenticated_id$&. A more typical configuration might look up the
25457 secret string in a file, using the user name as the key. For example:
25458 .code
25459 lookup_cram:
25460   driver = cram_md5
25461   public_name = CRAM-MD5
25462   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25463                   {$value}fail}
25464   server_set_id = $auth1
25465 .endd
25466 Note that this expansion explicitly forces failure if the lookup fails
25467 because &$auth1$& contains an unknown user name.
25468
25469 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25470 using the relevant libraries, you need to know the realm to specify in the
25471 lookup and then ask for the &"userPassword"& attribute for that user in that
25472 realm, with:
25473 .code
25474 cyrusless_crammd5:
25475   driver = cram_md5
25476   public_name = CRAM-MD5
25477   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25478                   dbmjz{/etc/sasldb2}}
25479   server_set_id = $auth1
25480 .endd
25481
25482 .section "Using cram_md5 as a client" "SECID177"
25483 .cindex "options" "&(cram_md5)& authenticator (client)"
25484 When used as a client, the &(cram_md5)& authenticator has two options:
25485
25486
25487
25488 .option client_name cram_md5 string&!! "the primary host name"
25489 This string is expanded, and the result used as the user name data when
25490 computing the response to the server's challenge.
25491
25492
25493 .option client_secret cram_md5 string&!! unset
25494 This option must be set for the authenticator to work as a client. Its value is
25495 expanded and the result used as the secret string when computing the response.
25496
25497
25498 .vindex "&$host$&"
25499 .vindex "&$host_address$&"
25500 Different user names and secrets can be used for different servers by referring
25501 to &$host$& or &$host_address$& in the options. Forced failure of either
25502 expansion string is treated as an indication that this authenticator is not
25503 prepared to handle this case. Exim moves on to the next configured client
25504 authenticator. Any other expansion failure causes Exim to give up trying to
25505 send the message to the current server.
25506
25507 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25508 strings, is:
25509 .code
25510 fixed_cram:
25511   driver = cram_md5
25512   public_name = CRAM-MD5
25513   client_name = ph10
25514   client_secret = secret
25515 .endd
25516 .ecindex IIDcramauth1
25517 .ecindex IIDcramauth2
25518
25519
25520
25521 . ////////////////////////////////////////////////////////////////////////////
25522 . ////////////////////////////////////////////////////////////////////////////
25523
25524 .chapter "The cyrus_sasl authenticator" "CHID10"
25525 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25526 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25527 .cindex "Cyrus" "SASL library"
25528 .cindex "Kerberos"
25529 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25530 Digital Ltd (&url(http://www.aldigital.co.uk)).
25531
25532 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25533 library implementation of the RFC 2222 (&"Simple Authentication and Security
25534 Layer"&). This library supports a number of authentication mechanisms,
25535 including PLAIN and LOGIN, but also several others that Exim does not support
25536 directly. In particular, there is support for Kerberos authentication.
25537
25538 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25539 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25540 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25541 name of the driver to determine which mechanism to support.
25542
25543 Where access to some kind of secret file is required, for example in GSSAPI
25544 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25545 user, and that the Cyrus SASL library has no way of escalating privileges
25546 by default. You may also find you need to set environment variables,
25547 depending on the driver you are using.
25548
25549 The application name provided by Exim is &"exim"&, so various SASL options may
25550 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25551 Kerberos, note that because of limitations in the GSSAPI interface,
25552 changing the server keytab might need to be communicated down to the Kerberos
25553 layer independently. The mechanism for doing so is dependent upon the Kerberos
25554 implementation.
25555
25556 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25557 may be set to point to an alternative keytab file. Exim will pass this
25558 variable through from its own inherited environment when started as root or the
25559 Exim user. The keytab file needs to be readable by the Exim user.
25560 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25561 environment variable.  In practice, for those releases, the Cyrus authenticator
25562 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25563 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25564
25565
25566 .section "Using cyrus_sasl as a server" "SECID178"
25567 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25568 (on a successful authentication) into &$auth1$&. For compatibility with
25569 previous releases of Exim, the username is also placed in &$1$&. However, the
25570 use of this variable for this purpose is now deprecated, as it can lead to
25571 confusion in string expansions that also use numeric variables for other
25572 things.
25573
25574
25575 .option server_hostname cyrus_sasl string&!! "see below"
25576 This option selects the hostname that is used when communicating with the
25577 library. The default value is &`$primary_hostname`&. It is up to the underlying
25578 SASL plug-in what it does with this data.
25579
25580
25581 .option server_mech cyrus_sasl string "see below"
25582 This option selects the authentication mechanism this driver should use. The
25583 default is the value of the generic &%public_name%& option. This option allows
25584 you to use a different underlying mechanism from the advertised name. For
25585 example:
25586 .code
25587 sasl:
25588   driver = cyrus_sasl
25589   public_name = X-ANYTHING
25590   server_mech = CRAM-MD5
25591   server_set_id = $auth1
25592 .endd
25593
25594 .option server_realm cyrus_sasl string&!! unset
25595 This specifies the SASL realm that the server claims to be in.
25596
25597
25598 .option server_service cyrus_sasl string &`smtp`&
25599 This is the SASL service that the server claims to implement.
25600
25601
25602 For straightforward cases, you do not need to set any of the authenticator's
25603 private options. All you need to do is to specify an appropriate mechanism as
25604 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25605 PLAIN, you could have two authenticators as follows:
25606 .code
25607 sasl_cram_md5:
25608   driver = cyrus_sasl
25609   public_name = CRAM-MD5
25610   server_set_id = $auth1
25611
25612 sasl_plain:
25613   driver = cyrus_sasl
25614   public_name = PLAIN
25615   server_set_id = $auth2
25616 .endd
25617 Cyrus SASL does implement the LOGIN authentication method, even though it is
25618 not a standard method. It is disabled by default in the source distribution,
25619 but it is present in many binary distributions.
25620 .ecindex IIDcyrauth1
25621 .ecindex IIDcyrauth2
25622
25623
25624
25625
25626 . ////////////////////////////////////////////////////////////////////////////
25627 . ////////////////////////////////////////////////////////////////////////////
25628 .chapter "The dovecot authenticator" "CHAPdovecot"
25629 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25630 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25631 This authenticator is an interface to the authentication facility of the
25632 Dovecot POP/IMAP server, which can support a number of authentication methods.
25633 Note that Dovecot must be configured to use auth-client not auth-userdb.
25634 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25635 to use the same mechanisms for SMTP authentication. This is a server
25636 authenticator only. There is only one option:
25637
25638 .option server_socket dovecot string unset
25639
25640 This option must specify the socket that is the interface to Dovecot
25641 authentication. The &%public_name%& option must specify an authentication
25642 mechanism that Dovecot is configured to support. You can have several
25643 authenticators for different mechanisms. For example:
25644 .code
25645 dovecot_plain:
25646   driver = dovecot
25647   public_name = PLAIN
25648   server_socket = /var/run/dovecot/auth-client
25649   server_set_id = $auth1
25650
25651 dovecot_ntlm:
25652   driver = dovecot
25653   public_name = NTLM
25654   server_socket = /var/run/dovecot/auth-client
25655   server_set_id = $auth1
25656 .endd
25657 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25658 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25659 option is passed in the Dovecot authentication command. If, for a TLS
25660 connection, a client certificate has been verified, the &"valid-client-cert"&
25661 option is passed. When authentication succeeds, the identity of the user
25662 who authenticated is placed in &$auth1$&.
25663 .ecindex IIDdcotauth1
25664 .ecindex IIDdcotauth2
25665
25666
25667 . ////////////////////////////////////////////////////////////////////////////
25668 . ////////////////////////////////////////////////////////////////////////////
25669 .chapter "The gsasl authenticator" "CHAPgsasl"
25670 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25671 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25672 .cindex "authentication" "GNU SASL"
25673 .cindex "authentication" "SASL"
25674 .cindex "authentication" "EXTERNAL"
25675 .cindex "authentication" "ANONYMOUS"
25676 .cindex "authentication" "PLAIN"
25677 .cindex "authentication" "LOGIN"
25678 .cindex "authentication" "DIGEST-MD5"
25679 .cindex "authentication" "CRAM-MD5"
25680 .cindex "authentication" "SCRAM-SHA-1"
25681 The &(gsasl)& authenticator provides server integration for the GNU SASL
25682 library and the mechanisms it provides.  This is new as of the 4.80 release
25683 and there are a few areas where the library does not let Exim smoothly
25684 scale to handle future authentication mechanisms, so no guarantee can be
25685 made that any particular new authentication mechanism will be supported
25686 without code changes in Exim.
25687
25688
25689 .option server_channelbinding gsasl boolean false
25690 Some authentication mechanisms are able to use external context at both ends
25691 of the session to bind the authentication to that context, and fail the
25692 authentication process if that context differs.  Specifically, some TLS
25693 ciphersuites can provide identifying information about the cryptographic
25694 context.
25695
25696 This means that certificate identity and verification becomes a non-issue,
25697 as a man-in-the-middle attack will cause the correct client and server to
25698 see different identifiers and authentication will fail.
25699
25700 This is currently only supported when using the GnuTLS library.  This is
25701 only usable by mechanisms which support "channel binding"; at time of
25702 writing, that's the SCRAM family.
25703
25704 This defaults off to ensure smooth upgrade across Exim releases, in case
25705 this option causes some clients to start failing.  Some future release
25706 of Exim may switch the default to be true.
25707
25708
25709 .option server_hostname gsasl string&!! "see below"
25710 This option selects the hostname that is used when communicating with the
25711 library. The default value is &`$primary_hostname`&.
25712 Some mechanisms will use this data.
25713
25714
25715 .option server_mech gsasl string "see below"
25716 This option selects the authentication mechanism this driver should use. The
25717 default is the value of the generic &%public_name%& option. This option allows
25718 you to use a different underlying mechanism from the advertised name. For
25719 example:
25720 .code
25721 sasl:
25722   driver = gsasl
25723   public_name = X-ANYTHING
25724   server_mech = CRAM-MD5
25725   server_set_id = $auth1
25726 .endd
25727
25728
25729 .option server_password gsasl string&!! unset
25730 Various mechanisms need access to the cleartext password on the server, so
25731 that proof-of-possession can be demonstrated on the wire, without sending
25732 the password itself.
25733
25734 The data available for lookup varies per mechanism.
25735 In all cases, &$auth1$& is set to the &'authentication id'&.
25736 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25737 if available, else the empty string.
25738 The &$auth3$& variable will always be the &'realm'& if available,
25739 else the empty string.
25740
25741 A forced failure will cause authentication to defer.
25742
25743 If using this option, it may make sense to set the &%server_condition%&
25744 option to be simply "true".
25745
25746
25747 .option server_realm gsasl string&!! unset
25748 This specifies the SASL realm that the server claims to be in.
25749 Some mechanisms will use this data.
25750
25751
25752 .option server_scram_iter gsasl string&!! unset
25753 This option provides data for the SCRAM family of mechanisms.
25754 &$auth1$& is not available at evaluation time.
25755 (This may change, as we receive feedback on use)
25756
25757
25758 .option server_scram_salt gsasl string&!! unset
25759 This option provides data for the SCRAM family of mechanisms.
25760 &$auth1$& is not available at evaluation time.
25761 (This may change, as we receive feedback on use)
25762
25763
25764 .option server_service gsasl string &`smtp`&
25765 This is the SASL service that the server claims to implement.
25766 Some mechanisms will use this data.
25767
25768
25769 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25770 .vindex "&$auth1$&, &$auth2$&, etc"
25771 These may be set when evaluating specific options, as detailed above.
25772 They will also be set when evaluating &%server_condition%&.
25773
25774 Unless otherwise stated below, the &(gsasl)& integration will use the following
25775 meanings for these variables:
25776
25777 .ilist
25778 .vindex "&$auth1$&"
25779 &$auth1$&: the &'authentication id'&
25780 .next
25781 .vindex "&$auth2$&"
25782 &$auth2$&: the &'authorization id'&
25783 .next
25784 .vindex "&$auth3$&"
25785 &$auth3$&: the &'realm'&
25786 .endlist
25787
25788 On a per-mechanism basis:
25789
25790 .ilist
25791 .cindex "authentication" "EXTERNAL"
25792 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25793 the &%server_condition%& option must be present.
25794 .next
25795 .cindex "authentication" "ANONYMOUS"
25796 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25797 the &%server_condition%& option must be present.
25798 .next
25799 .cindex "authentication" "GSSAPI"
25800 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25801 &$auth2$& will be set to the &'authorization id'&,
25802 the &%server_condition%& option must be present.
25803 .endlist
25804
25805 An &'anonymous token'& is something passed along as an unauthenticated
25806 identifier; this is analogous to FTP anonymous authentication passing an
25807 email address, or software-identifier@, as the "password".
25808
25809
25810 An example showing the password having the realm specified in the callback
25811 and demonstrating a Cyrus SASL to GSASL migration approach is:
25812 .code
25813 gsasl_cyrusless_crammd5:
25814   driver = gsasl
25815   public_name = CRAM-MD5
25816   server_realm = imap.example.org
25817   server_password = ${lookup{$auth1:$auth3:userPassword}\
25818                     dbmjz{/etc/sasldb2}{$value}fail}
25819   server_set_id = ${quote:$auth1}
25820   server_condition = yes
25821 .endd
25822
25823
25824 . ////////////////////////////////////////////////////////////////////////////
25825 . ////////////////////////////////////////////////////////////////////////////
25826
25827 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25828 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25829 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
25830 .cindex "authentication" "GSSAPI"
25831 .cindex "authentication" "Kerberos"
25832 The &(heimdal_gssapi)& authenticator provides server integration for the
25833 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
25834 reliably.
25835
25836 .option server_hostname heimdal_gssapi string&!! "see below"
25837 This option selects the hostname that is used, with &%server_service%&,
25838 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
25839 identifier.  The default value is &`$primary_hostname`&.
25840
25841 .option server_keytab heimdal_gssapi string&!! unset
25842 If set, then Heimdal will not use the system default keytab (typically
25843 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
25844 The value should be a pathname, with no &"file:"& prefix.
25845
25846 .option server_service heimdal_gssapi string&!! "smtp"
25847 This option specifies the service identifier used, in conjunction with
25848 &%server_hostname%&, for building the identifer for finding credentials
25849 from the keytab.
25850
25851
25852 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
25853 Beware that these variables will typically include a realm, thus will appear
25854 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
25855 not verified, so a malicious client can set it to anything.
25856
25857 The &$auth1$& field should be safely trustable as a value from the Key
25858 Distribution Center.  Note that these are not quite email addresses.
25859 Each identifier is for a role, and so the left-hand-side may include a
25860 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
25861
25862 .vindex "&$auth1$&, &$auth2$&, etc"
25863 .ilist
25864 .vindex "&$auth1$&"
25865 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
25866 .next
25867 .vindex "&$auth2$&"
25868 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
25869 authentication.  If that was empty, this will also be set to the
25870 GSS Display Name.
25871 .endlist
25872
25873
25874 . ////////////////////////////////////////////////////////////////////////////
25875 . ////////////////////////////////////////////////////////////////////////////
25876
25877 .chapter "The spa authenticator" "CHAPspa"
25878 .scindex IIDspaauth1 "&(spa)& authenticator"
25879 .scindex IIDspaauth2 "authenticators" "&(spa)&"
25880 .cindex "authentication" "Microsoft Secure Password"
25881 .cindex "authentication" "NTLM"
25882 .cindex "Microsoft Secure Password Authentication"
25883 .cindex "NTLM authentication"
25884 The &(spa)& authenticator provides client support for Microsoft's &'Secure
25885 Password Authentication'& mechanism,
25886 which is also sometimes known as NTLM (NT LanMan). The code for client side of
25887 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
25888 taken from the Samba project (&url(http://www.samba.org)). The code for the
25889 server side was subsequently contributed by Tom Kistner. The mechanism works as
25890 follows:
25891
25892 .ilist
25893 After the AUTH command has been accepted, the client sends an SPA
25894 authentication request based on the user name and optional domain.
25895 .next
25896 The server sends back a challenge.
25897 .next
25898 The client builds a challenge response which makes use of the user's password
25899 and sends it to the server, which then accepts or rejects it.
25900 .endlist
25901
25902 Encryption is used to protect the password in transit.
25903
25904
25905
25906 .section "Using spa as a server" "SECID179"
25907 .cindex "options" "&(spa)& authenticator (server)"
25908 The &(spa)& authenticator has just one server option:
25909
25910 .option server_password spa string&!! unset
25911 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
25912 This option is expanded, and the result must be the cleartext password for the
25913 authenticating user, whose name is at this point in &$auth1$&. For
25914 compatibility with previous releases of Exim, the user name is also placed in
25915 &$1$&. However, the use of this variable for this purpose is now deprecated, as
25916 it can lead to confusion in string expansions that also use numeric variables
25917 for other things. For example:
25918 .code
25919 spa:
25920   driver = spa
25921   public_name = NTLM
25922   server_password = \
25923     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
25924 .endd
25925 If the expansion is forced to fail, authentication fails. Any other expansion
25926 failure causes a temporary error code to be returned.
25927
25928
25929
25930
25931
25932 .section "Using spa as a client" "SECID180"
25933 .cindex "options" "&(spa)& authenticator (client)"
25934 The &(spa)& authenticator has the following client options:
25935
25936
25937
25938 .option client_domain spa string&!! unset
25939 This option specifies an optional domain for the authentication.
25940
25941
25942 .option client_password spa string&!! unset
25943 This option specifies the user's password, and must be set.
25944
25945
25946 .option client_username spa string&!! unset
25947 This option specifies the user name, and must be set. Here is an example of a
25948 configuration of this authenticator for use with the mail servers at
25949 &'msn.com'&:
25950 .code
25951 msn:
25952   driver = spa
25953   public_name = MSN
25954   client_username = msn/msn_username
25955   client_password = msn_plaintext_password
25956   client_domain = DOMAIN_OR_UNSET
25957 .endd
25958 .ecindex IIDspaauth1
25959 .ecindex IIDspaauth2
25960
25961
25962
25963
25964
25965 . ////////////////////////////////////////////////////////////////////////////
25966 . ////////////////////////////////////////////////////////////////////////////
25967
25968 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
25969          "Encrypted SMTP connections"
25970 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
25971 .scindex IIDencsmtp2 "SMTP" "encryption"
25972 .cindex "TLS" "on SMTP connection"
25973 .cindex "OpenSSL"
25974 .cindex "GnuTLS"
25975 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
25976 Sockets Layer), is implemented by making use of the OpenSSL library or the
25977 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
25978 cryptographic code in the Exim distribution itself for implementing TLS. In
25979 order to use this feature you must install OpenSSL or GnuTLS, and then build a
25980 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
25981 You also need to understand the basic concepts of encryption at a managerial
25982 level, and in particular, the way that public keys, private keys, and
25983 certificates are used.
25984
25985 RFC 3207 defines how SMTP connections can make use of encryption. Once a
25986 connection is established, the client issues a STARTTLS command. If the
25987 server accepts this, the client and the server negotiate an encryption
25988 mechanism. If the negotiation succeeds, the data that subsequently passes
25989 between them is encrypted.
25990
25991 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
25992 and if so, what cipher suite is in use, whether the client supplied a
25993 certificate, and whether or not that certificate was verified. This makes it
25994 possible for an Exim server to deny or accept certain commands based on the
25995 encryption state.
25996
25997 &*Warning*&: Certain types of firewall and certain anti-virus products can
25998 disrupt TLS connections. You need to turn off SMTP scanning for these products
25999 in order to get TLS to work.
26000
26001
26002
26003 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26004          "SECID284"
26005 .cindex "ssmtp protocol"
26006 .cindex "smtps protocol"
26007 .cindex "SMTP" "ssmtp protocol"
26008 .cindex "SMTP" "smtps protocol"
26009 Early implementations of encrypted SMTP used a different TCP port from normal
26010 SMTP, and expected an encryption negotiation to start immediately, instead of
26011 waiting for a STARTTLS command from the client using the standard SMTP
26012 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26013 allocated for this purpose.
26014
26015 This approach was abandoned when encrypted SMTP was standardized, but there are
26016 still some legacy clients that use it. Exim supports these clients by means of
26017 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26018 numbers; the most common use is expected to be:
26019 .code
26020 tls_on_connect_ports = 465
26021 .endd
26022 The port numbers specified by this option apply to all SMTP connections, both
26023 via the daemon and via &'inetd'&. You still need to specify all the ports that
26024 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26025 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26026 an extra port &-- rather, it specifies different behaviour on a port that is
26027 defined elsewhere.
26028
26029 There is also a &%-tls-on-connect%& command line option. This overrides
26030 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26031
26032
26033
26034
26035
26036
26037 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26038 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26039 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26040 followed later, when the first versions of GnuTLS were released. To build Exim
26041 to use GnuTLS, you need to set
26042 .code
26043 USE_GNUTLS=yes
26044 .endd
26045 in Local/Makefile, in addition to
26046 .code
26047 SUPPORT_TLS=yes
26048 .endd
26049 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26050 include files and libraries for GnuTLS can be found.
26051
26052 There are some differences in usage when using GnuTLS instead of OpenSSL:
26053
26054 .ilist
26055 The &%tls_verify_certificates%& option
26056 cannot be the path of a directory
26057 for GnuTLS versions before 3.3.6
26058 (for later versions, or OpenSSL, it can be either).
26059 .next
26060 The default value for &%tls_dhparam%& differs for historical reasons.
26061 .next
26062 .vindex "&$tls_in_peerdn$&"
26063 .vindex "&$tls_out_peerdn$&"
26064 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26065 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26066 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26067 .next
26068 OpenSSL identifies cipher suites using hyphens as separators, for example:
26069 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26070 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26071 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26072 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26073 to handle its own older variants) when processing lists of cipher suites in the
26074 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26075 option).
26076 .next
26077 The &%tls_require_ciphers%& options operate differently, as described in the
26078 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26079 .next
26080 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26081 When using OpenSSL, this option is ignored.
26082 (If an API is found to let OpenSSL be configured in this way,
26083 let the Exim Maintainers know and we'll likely use it).
26084 .next
26085 Some other recently added features may only be available in one or the other.
26086 This should be documented with the feature.  If the documentation does not
26087 explicitly state that the feature is infeasible in the other TLS
26088 implementation, then patches are welcome.
26089 .endlist
26090
26091
26092 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26093 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26094 an explicit path; if the latter, then the text about generation still applies,
26095 but not the chosen filename.
26096 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26097 See the documentation of &%tls_dhparam%& for more information.
26098
26099 GnuTLS uses D-H parameters that may take a substantial amount of time
26100 to compute. It is unreasonable to re-compute them for every TLS session.
26101 Therefore, Exim keeps this data in a file in its spool directory, called
26102 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26103 of bits requested.
26104 The file is owned by the Exim user and is readable only by
26105 its owner. Every Exim process that start up GnuTLS reads the D-H
26106 parameters from this file. If the file does not exist, the first Exim process
26107 that needs it computes the data and writes it to a temporary file which is
26108 renamed once it is complete. It does not matter if several Exim processes do
26109 this simultaneously (apart from wasting a few resources). Once a file is in
26110 place, new Exim processes immediately start using it.
26111
26112 For maximum security, the parameters that are stored in this file should be
26113 recalculated periodically, the frequency depending on your paranoia level.
26114 If you are avoiding using the fixed D-H primes published in RFCs, then you
26115 are concerned about some advanced attacks and will wish to do this; if you do
26116 not regenerate then you might as well stick to the standard primes.
26117
26118 Arranging this is easy in principle; just delete the file when you want new
26119 values to be computed. However, there may be a problem. The calculation of new
26120 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26121 If the system is not very active, &_/dev/random_& may delay returning data
26122 until enough randomness (entropy) is available. This may cause Exim to hang for
26123 a substantial amount of time, causing timeouts on incoming connections.
26124
26125 The solution is to generate the parameters externally to Exim. They are stored
26126 in &_gnutls-params-N_& in PEM format, which means that they can be
26127 generated externally using the &(certtool)& command that is part of GnuTLS.
26128
26129 To replace the parameters with new ones, instead of deleting the file
26130 and letting Exim re-create it, you can generate new parameters using
26131 &(certtool)& and, when this has been done, replace Exim's cache file by
26132 renaming. The relevant commands are something like this:
26133 .code
26134 # ls
26135 [ look for file; assume gnutls-params-2236 is the most recent ]
26136 # rm -f new-params
26137 # touch new-params
26138 # chown exim:exim new-params
26139 # chmod 0600 new-params
26140 # certtool --generate-dh-params --bits 2236 >>new-params
26141 # openssl dhparam -noout -text -in new-params | head
26142 [ check the first line, make sure it's not more than 2236;
26143   if it is, then go back to the start ("rm") and repeat
26144   until the size generated is at most the size requested ]
26145 # chmod 0400 new-params
26146 # mv new-params gnutls-params-2236
26147 .endd
26148 If Exim never has to generate the parameters itself, the possibility of
26149 stalling is removed.
26150
26151 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26152 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26153 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26154 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26155 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26156 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26157 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26158 which applies to all D-H usage, client or server.  If the value returned by
26159 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26160 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26161 limit, which is still much higher than Exim historically used.
26162
26163 The filename and bits used will change as the GnuTLS maintainers change the
26164 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26165 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26166 2432 bits, while NSS is limited to 2236 bits.
26167
26168 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26169 increase the chance of the generated prime actually being within acceptable
26170 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26171 procedure above.  There is no sane procedure available to Exim to double-check
26172 the size of the generated prime, so it might still be too large.
26173
26174
26175 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26176 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26177 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26178 There is a function in the OpenSSL library that can be passed a list of cipher
26179 suites before the cipher negotiation takes place. This specifies which ciphers
26180 are acceptable. The list is colon separated and may contain names like
26181 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26182 directly to this function call.
26183 Many systems will install the OpenSSL manual-pages, so you may have
26184 &'ciphers(1)'& available to you.
26185 The following quotation from the OpenSSL
26186 documentation specifies what forms of item are allowed in the cipher string:
26187
26188 .ilist
26189 It can consist of a single cipher suite such as RC4-SHA.
26190 .next
26191 It can represent a list of cipher suites containing a certain algorithm,
26192 or cipher suites of a certain type. For example SHA1 represents all
26193 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26194 SSL v3 algorithms.
26195 .next
26196 Lists of cipher suites can be combined in a single cipher string using
26197 the + character. This is used as a logical and operation. For example
26198 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26199 algorithms.
26200 .endlist
26201
26202 Each cipher string can be optionally preceded by one of the characters &`!`&,
26203 &`-`& or &`+`&.
26204 .ilist
26205 If &`!`& is used, the ciphers are permanently deleted from the list. The
26206 ciphers deleted can never reappear in the list even if they are explicitly
26207 stated.
26208 .next
26209 If &`-`& is used, the ciphers are deleted from the list, but some or all
26210 of the ciphers can be added again by later options.
26211 .next
26212 If &`+`& is used, the ciphers are moved to the end of the list. This
26213 option does not add any new ciphers; it just moves matching existing ones.
26214 .endlist
26215
26216 If none of these characters is present, the string is interpreted as
26217 a list of ciphers to be appended to the current preference list. If the list
26218 includes any ciphers already present they will be ignored: that is, they will
26219 not be moved to the end of the list.
26220 .endlist
26221
26222 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26223 string:
26224 .code
26225 # note single-quotes to get ! past any shell history expansion
26226 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26227 .endd
26228
26229 This example will let the library defaults be permitted on the MX port, where
26230 there's probably no identity verification anyway, but ups the ante on the
26231 submission ports where the administrator might have some influence on the
26232 choice of clients used:
26233 .code
26234 # OpenSSL variant; see man ciphers(1)
26235 tls_require_ciphers = ${if =={$received_port}{25}\
26236                            {DEFAULT}\
26237                            {HIGH:!MD5:!SHA1}}
26238 .endd
26239
26240
26241
26242 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26243          "SECTreqciphgnu"
26244 .cindex "GnuTLS" "specifying parameters for"
26245 .cindex "TLS" "specifying ciphers (GnuTLS)"
26246 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26247 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26248 .cindex "TLS" "specifying protocols (GnuTLS)"
26249 .cindex "TLS" "specifying priority string (GnuTLS)"
26250 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26251 The GnuTLS library allows the caller to provide a "priority string", documented
26252 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26253 ciphersuite specification in OpenSSL.
26254
26255 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26256 and controls both protocols and ciphers.
26257
26258 The &%tls_require_ciphers%& option is available both as an global option,
26259 controlling how Exim behaves as a server, and also as an option of the
26260 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26261 the value is string expanded.  The resulting string is not an Exim list and
26262 the string is given to the GnuTLS library, so that Exim does not need to be
26263 aware of future feature enhancements of GnuTLS.
26264
26265 Documentation of the strings accepted may be found in the GnuTLS manual, under
26266 "Priority strings".  This is online as
26267 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26268 but beware that this relates to GnuTLS 3, which may be newer than the version
26269 installed on your system.  If you are using GnuTLS 3,
26270 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26271 on that site can be used to test a given string.
26272
26273 For example:
26274 .code
26275 # Disable older versions of protocols
26276 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26277 .endd
26278
26279 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26280 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26281 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26282
26283 This example will let the library defaults be permitted on the MX port, where
26284 there's probably no identity verification anyway, and lowers security further
26285 by increasing compatibility; but this ups the ante on the submission ports
26286 where the administrator might have some influence on the choice of clients
26287 used:
26288 .code
26289 # GnuTLS variant
26290 tls_require_ciphers = ${if =={$received_port}{25}\
26291                            {NORMAL:%COMPAT}\
26292                            {SECURE128}}
26293 .endd
26294
26295
26296 .section "Configuring an Exim server to use TLS" "SECID182"
26297 .cindex "TLS" "configuring an Exim server"
26298 When Exim has been built with TLS support, it advertises the availability of
26299 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26300 but not to any others. The default value of this option is unset, which means
26301 that STARTTLS is not advertised at all. This default is chosen because you
26302 need to set some other options in order to make TLS available, and also it is
26303 sensible for systems that want to use TLS only as a client.
26304
26305 If a client issues a STARTTLS command and there is some configuration
26306 problem in the server, the command is rejected with a 454 error. If the client
26307 persists in trying to issue SMTP commands, all except QUIT are rejected
26308 with the error
26309 .code
26310 554 Security failure
26311 .endd
26312 If a STARTTLS command is issued within an existing TLS session, it is
26313 rejected with a 554 error code.
26314
26315 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26316 match some hosts. You can, of course, set it to * to match all hosts.
26317 However, this is not all you need to do. TLS sessions to a server won't work
26318 without some further configuration at the server end.
26319
26320 It is rumoured that all existing clients that support TLS/SSL use RSA
26321 encryption. To make this work you need to set, in the server,
26322 .code
26323 tls_certificate = /some/file/name
26324 tls_privatekey = /some/file/name
26325 .endd
26326 These options are, in fact, expanded strings, so you can make them depend on
26327 the identity of the client that is connected if you wish. The first file
26328 contains the server's X509 certificate, and the second contains the private key
26329 that goes with it. These files need to be
26330 PEM format and readable by the Exim user, and must
26331 always be given as full path names.
26332 The key must not be password-protected.
26333 They can be the same file if both the
26334 certificate and the key are contained within it. If &%tls_privatekey%& is not
26335 set, or if its expansion is forced to fail or results in an empty string, this
26336 is assumed to be the case. The certificate file may also contain intermediate
26337 certificates that need to be sent to the client to enable it to authenticate
26338 the server's certificate.
26339
26340 If you do not understand about certificates and keys, please try to find a
26341 source of this background information, which is not Exim-specific. (There are a
26342 few comments below in section &<<SECTcerandall>>&.)
26343
26344 &*Note*&: These options do not apply when Exim is operating as a client &--
26345 they apply only in the case of a server. If you need to use a certificate in an
26346 Exim client, you must set the options of the same names in an &(smtp)&
26347 transport.
26348
26349 With just these options, an Exim server will be able to use TLS. It does not
26350 require the client to have a certificate (but see below for how to insist on
26351 this). There is one other option that may be needed in other situations. If
26352 .code
26353 tls_dhparam = /some/file/name
26354 .endd
26355 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26356 with the parameters contained in the file.
26357 Set this to &`none`& to disable use of DH entirely, by making no prime
26358 available:
26359 .code
26360 tls_dhparam = none
26361 .endd
26362 This may also be set to a string identifying a standard prime to be used for
26363 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26364 used is &`ike23`&.  There are a few standard primes available, see the
26365 documentation for &%tls_dhparam%& for the complete list.
26366
26367 See the command
26368 .code
26369 openssl dhparam
26370 .endd
26371 for a way of generating file data.
26372
26373 The strings supplied for these three options are expanded every time a client
26374 host connects. It is therefore possible to use different certificates and keys
26375 for different hosts, if you so wish, by making use of the client's IP address
26376 in &$sender_host_address$& to control the expansion. If a string expansion is
26377 forced to fail, Exim behaves as if the option is not set.
26378
26379 .cindex "cipher" "logging"
26380 .cindex "log" "TLS cipher"
26381 .vindex "&$tls_in_cipher$&"
26382 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26383 an incoming TLS connection. It is included in the &'Received:'& header of an
26384 incoming message (by default &-- you can, of course, change this), and it is
26385 also included in the log line that records a message's arrival, keyed by
26386 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26387 condition can be used to test for specific cipher suites in ACLs.
26388
26389 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26390 can check the name of the cipher suite and vary their actions accordingly. The
26391 cipher suite names vary, depending on which TLS library is being used. For
26392 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26393 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26394 documentation for more details.
26395
26396 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26397 (again depending on the &%tls_cipher%& log selector).
26398
26399
26400 .section "Requesting and verifying client certificates" "SECID183"
26401 .cindex "certificate" "verification of client"
26402 .cindex "TLS" "client certificate verification"
26403 If you want an Exim server to request a certificate when negotiating a TLS
26404 session with a client, you must set either &%tls_verify_hosts%& or
26405 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26406 apply to all TLS connections. For any host that matches one of these options,
26407 Exim requests a certificate as part of the setup of the TLS session. The
26408 contents of the certificate are verified by comparing it with a list of
26409 expected certificates.
26410 .new
26411 These may be the system default set (depending on library version),
26412 .wen
26413 an explicit file or,
26414 depending on library version, a directory, identified by
26415 &%tls_verify_certificates%&.
26416
26417 A file can contain multiple certificates, concatenated end to end. If a
26418 directory is used
26419 (OpenSSL only),
26420 each certificate must be in a separate file, with a name (or a symbolic link)
26421 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26422 certificate. You can compute the relevant hash by running the command
26423 .code
26424 openssl x509 -hash -noout -in /cert/file
26425 .endd
26426 where &_/cert/file_& contains a single certificate.
26427
26428 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26429 what happens if the client does not supply a certificate, or if the certificate
26430 does not match any of the certificates in the collection named by
26431 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26432 attempt to set up a TLS session is aborted, and the incoming connection is
26433 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26434 session continues. ACLs that run for subsequent SMTP commands can detect the
26435 fact that no certificate was verified, and vary their actions accordingly. For
26436 example, you can insist on a certificate before accepting a message for
26437 relaying, but not when the message is destined for local delivery.
26438
26439 .vindex "&$tls_in_peerdn$&"
26440 When a client supplies a certificate (whether it verifies or not), the value of
26441 the Distinguished Name of the certificate is made available in the variable
26442 &$tls_in_peerdn$& during subsequent processing of the message.
26443
26444 .cindex "log" "distinguished name"
26445 Because it is often a long text string, it is not included in the log line or
26446 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26447 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26448 &%received_header_text%& to change the &'Received:'& header. When no
26449 certificate is supplied, &$tls_in_peerdn$& is empty.
26450
26451
26452 .section "Revoked certificates" "SECID184"
26453 .cindex "TLS" "revoked certificates"
26454 .cindex "revocation list"
26455 .cindex "certificate" "revocation list"
26456 .cindex "OCSP" "stapling"
26457 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26458 certificates are revoked. If you have such a list, you can pass it to an Exim
26459 server using the global option called &%tls_crl%& and to an Exim client using
26460 an identically named option for the &(smtp)& transport. In each case, the value
26461 of the option is expanded and must then be the name of a file that contains a
26462 CRL in PEM format.
26463 The downside is that clients have to periodically re-download a potentially huge
26464 file from every certificate authority they know of.
26465
26466 The way with most moving parts at query time is Online Certificate
26467 Status Protocol (OCSP), where the client verifies the certificate
26468 against an OCSP server run by the CA.  This lets the CA track all
26469 usage of the certs.  It requires running software with access to the
26470 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26471 is based on HTTP and can be proxied accordingly.
26472
26473 The only widespread OCSP server implementation (known to this writer)
26474 comes as part of OpenSSL and aborts on an invalid request, such as
26475 connecting to the port and then disconnecting.  This requires
26476 re-entering the passphrase each time some random client does this.
26477
26478 The third way is OCSP Stapling; in this, the server using a certificate
26479 issued by the CA periodically requests an OCSP proof of validity from
26480 the OCSP server, then serves it up inline as part of the TLS
26481 negotiation.   This approach adds no extra round trips, does not let the
26482 CA track users, scales well with number of certs issued by the CA and is
26483 resilient to temporary OCSP server failures, as long as the server
26484 starts retrying to fetch an OCSP proof some time before its current
26485 proof expires.  The downside is that it requires server support.
26486
26487 Unless Exim is built with the support disabled,
26488 or with GnuTLS earlier than version 3.1.3,
26489 support for OCSP stapling is included.
26490
26491 There is a global option called &%tls_ocsp_file%&.
26492 The file specified therein is expected to be in DER format, and contain
26493 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26494 option will be re-expanded for SNI, if the &%tls_certificate%& option
26495 contains &`tls_in_sni`&, as per other TLS options.
26496
26497 Exim does not at this time implement any support for fetching a new OCSP
26498 proof.  The burden is on the administrator to handle this, outside of
26499 Exim.  The file specified should be replaced atomically, so that the
26500 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26501 on each connection, so a new file will be handled transparently on the
26502 next connection.
26503
26504 When built with OpenSSL Exim will check for a valid next update timestamp
26505 in the OCSP proof; if not present, or if the proof has expired, it will be
26506 ignored.
26507
26508 For the client to be able to verify the stapled OCSP the server must
26509 also supply, in its stapled information, any intermediate
26510 certificates for the chain leading to the OCSP proof from the signer
26511 of the server certificate.  There may be zero or one such. These
26512 intermediate certificates should be added to the server OCSP stapling
26513 file named by &%tls_ocsp_file%&.
26514
26515 Note that the proof only covers the terminal server certificate,
26516 not any of the chain from CA to it.
26517
26518 There is no current way to staple a proof for a client certificate.
26519
26520 .code
26521   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26522   OCSP server is supplied.  The server URL may be included in the
26523   server certificate, if the CA is helpful.
26524
26525   One failure mode seen was the OCSP Signer cert expiring before the end
26526   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26527   noted this as invalid overall, but the re-fetch script did not.
26528 .endd
26529
26530
26531
26532
26533 .section "Configuring an Exim client to use TLS" "SECID185"
26534 .cindex "cipher" "logging"
26535 .cindex "log" "TLS cipher"
26536 .cindex "log" "distinguished name"
26537 .cindex "TLS" "configuring an Exim client"
26538 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26539 deliveries as well as to incoming, the latter one causing logging of the
26540 server certificate's DN. The remaining client configuration for TLS is all
26541 within the &(smtp)& transport.
26542
26543 It is not necessary to set any options to have TLS work in the &(smtp)&
26544 transport. If Exim is built with TLS support, and TLS is advertised by a
26545 server, the &(smtp)& transport always tries to start a TLS session. However,
26546 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26547 transport) to a list of server hosts for which TLS should not be used.
26548
26549 If you do not want Exim to attempt to send messages unencrypted when an attempt
26550 to set up an encrypted connection fails in any way, you can set
26551 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26552 those hosts, delivery is always deferred if an encrypted connection cannot be
26553 set up. If there are any other hosts for the address, they are tried in the
26554 usual way.
26555
26556 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26557 the message unencrypted. It always does this if the response to STARTTLS is
26558 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26559 session after a success response code, what happens is controlled by the
26560 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26561 delivery to this host is deferred, and other hosts (if available) are tried. If
26562 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26563 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26564 negotiation fails, Exim closes the current connection (because it is in an
26565 unknown state), opens a new one to the same host, and then tries the delivery
26566 unencrypted.
26567
26568 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26569 transport provide the client with a certificate, which is passed to the server
26570 if it requests it. If the server is Exim, it will request a certificate only if
26571 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26572
26573 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26574 specifies a collection of expected server certificates.
26575 .new
26576 These may be the system default set (depending on library version),
26577 .wen
26578 a file or,
26579 depnding on liibrary version, a directory,
26580 must name a file or,
26581 for OpenSSL only (not GnuTLS), a directory.
26582 The client verifies the server's certificate
26583 against this collection, taking into account any revoked certificates that are
26584 in the list defined by &%tls_crl%&.
26585 Failure to verify fails the TLS connection unless either of the
26586 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26587
26588 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26589 certificate verification to the listed servers.  Verification either must
26590 or need not succeed respectively.
26591
26592 The &(smtp)& transport has two OCSP-related options:
26593 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26594 is requested and required for the connection to proceed.  The default
26595 value is empty.
26596 &%hosts_request_ocsp%&; a host-list for which (additionally)
26597 a Certificate Status is requested (but not necessarily verified).  The default
26598 value is "*" meaning that requests are made unless configured
26599 otherwise.
26600
26601 The host(s) should also be in &%hosts_require_tls%&, and
26602 &%tls_verify_certificates%& configured for the transport,
26603 for OCSP to be relevant.
26604
26605 If
26606 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26607 list of permitted cipher suites. If either of these checks fails, delivery to
26608 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26609 alternative hosts, if any.
26610
26611  &*Note*&:
26612 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26613 is operating as a client. Exim does not assume that a server certificate (set
26614 by the global options of the same name) should also be used when operating as a
26615 client.
26616
26617 .vindex "&$host$&"
26618 .vindex "&$host_address$&"
26619 All the TLS options in the &(smtp)& transport are expanded before use, with
26620 &$host$& and &$host_address$& containing the name and address of the server to
26621 which the client is connected. Forced failure of an expansion causes Exim to
26622 behave as if the relevant option were unset.
26623
26624 .vindex &$tls_out_bits$&
26625 .vindex &$tls_out_cipher$&
26626 .vindex &$tls_out_peerdn$&
26627 .vindex &$tls_out_sni$&
26628 Before an SMTP connection is established, the
26629 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26630 variables are emptied. (Until the first connection, they contain the values
26631 that were set when the message was received.) If STARTTLS is subsequently
26632 successfully obeyed, these variables are set to the relevant values for the
26633 outgoing connection.
26634
26635
26636
26637 .section "Use of TLS Server Name Indication" "SECTtlssni"
26638 .cindex "TLS" "Server Name Indication"
26639 .vindex "&$tls_in_sni$&"
26640 .oindex "&%tls_in_sni%&"
26641 With TLS1.0 or above, there is an extension mechanism by which extra
26642 information can be included at various points in the protocol.  One of these
26643 extensions, documented in RFC 6066 (and before that RFC 4366) is
26644 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26645 client in the initial handshake, so that the server can examine the servername
26646 within and possibly choose to use different certificates and keys (and more)
26647 for this session.
26648
26649 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26650 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26651 address.
26652
26653 With SMTP to MX, there are the same problems here as in choosing the identity
26654 against which to validate a certificate: you can't rely on insecure DNS to
26655 provide the identity which you then cryptographically verify.  So this will
26656 be of limited use in that environment.
26657
26658 With SMTP to Submission, there is a well-defined hostname which clients are
26659 connecting to and can validate certificates against.  Thus clients &*can*&
26660 choose to include this information in the TLS negotiation.  If this becomes
26661 wide-spread, then hosters can choose to present different certificates to
26662 different clients.  Or even negotiate different cipher suites.
26663
26664 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26665 if not empty, will be sent on a TLS session as part of the handshake.  There's
26666 nothing more to it.  Choosing a sensible value not derived insecurely is the
26667 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26668 for the lifetime of the client connection (including during authentication).
26669
26670 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26671 received from a client.
26672 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26673
26674 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26675 option (prior to expansion) then the following options will be re-expanded
26676 during TLS session handshake, to permit alternative values to be chosen:
26677
26678 .ilist
26679 .vindex "&%tls_certificate%&"
26680 &%tls_certificate%&
26681 .next
26682 .vindex "&%tls_crl%&"
26683 &%tls_crl%&
26684 .next
26685 .vindex "&%tls_privatekey%&"
26686 &%tls_privatekey%&
26687 .next
26688 .vindex "&%tls_verify_certificates%&"
26689 &%tls_verify_certificates%&
26690 .next
26691 .vindex "&%tls_ocsp_file%&"
26692 &%tls_ocsp_file%&
26693 .endlist
26694
26695 Great care should be taken to deal with matters of case, various injection
26696 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26697 can always be referenced; it is important to remember that &$tls_sni$& is
26698 arbitrary unverified data provided prior to authentication.
26699
26700 The Exim developers are proceeding cautiously and so far no other TLS options
26701 are re-expanded.
26702
26703 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26704 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26705 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26706 see &`-servername`& in the output, then OpenSSL has support.
26707
26708 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26709 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26710 built, then you have SNI support).
26711
26712
26713
26714 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26715          "SECTmulmessam"
26716 .cindex "multiple SMTP deliveries with TLS"
26717 .cindex "TLS" "multiple message deliveries"
26718 Exim sends multiple messages down the same TCP/IP connection by starting up
26719 an entirely new delivery process for each message, passing the socket from
26720 one process to the next. This implementation does not fit well with the use
26721 of TLS, because there is quite a lot of state information associated with a TLS
26722 connection, not just a socket identification. Passing all the state information
26723 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26724 session before passing the socket to a new process. The new process may then
26725 try to start a new TLS session, and if successful, may try to re-authenticate
26726 if AUTH is in use, before sending the next message.
26727
26728 The RFC is not clear as to whether or not an SMTP session continues in clear
26729 after TLS has been shut down, or whether TLS may be restarted again later, as
26730 just described. However, if the server is Exim, this shutdown and
26731 reinitialization works. It is not known which (if any) other servers operate
26732 successfully if the client closes a TLS session and continues with unencrypted
26733 SMTP, but there are certainly some that do not work. For such servers, Exim
26734 should not pass the socket to another process, because the failure of the
26735 subsequent attempt to use it would cause Exim to record a temporary host error,
26736 and delay other deliveries to that host.
26737
26738 To test for this case, Exim sends an EHLO command to the server after
26739 closing down the TLS session. If this fails in any way, the connection is
26740 closed instead of being passed to a new delivery process, but no retry
26741 information is recorded.
26742
26743 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26744 &(smtp)& transport to match those hosts for which Exim should not pass
26745 connections to new processes if TLS has been used.
26746
26747
26748
26749
26750 .section "Certificates and all that" "SECTcerandall"
26751 .cindex "certificate" "references to discussion"
26752 In order to understand fully how TLS works, you need to know about
26753 certificates, certificate signing, and certificate authorities. This is not the
26754 place to give a tutorial, especially as I do not know very much about it
26755 myself. Some helpful introduction can be found in the FAQ for the SSL addition
26756 to Apache, currently at
26757 .display
26758 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
26759 .endd
26760 Other parts of the &'modssl'& documentation are also helpful, and have
26761 links to further files.
26762 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
26763 0-201-61598-3), contains both introductory and more in-depth descriptions.
26764 Some sample programs taken from the book are available from
26765 .display
26766 &url(http://www.rtfm.com/openssl-examples/)
26767 .endd
26768
26769
26770 .section "Certificate chains" "SECID186"
26771 The file named by &%tls_certificate%& may contain more than one
26772 certificate. This is useful in the case where the certificate that is being
26773 sent is validated by an intermediate certificate which the other end does
26774 not have. Multiple certificates must be in the correct order in the file.
26775 First the host's certificate itself, then the first intermediate
26776 certificate to validate the issuer of the host certificate, then the next
26777 intermediate certificate to validate the issuer of the first intermediate
26778 certificate, and so on, until finally (optionally) the root certificate.
26779 The root certificate must already be trusted by the recipient for
26780 validation to succeed, of course, but if it's not preinstalled, sending the
26781 root certificate along with the rest makes it available for the user to
26782 install if the receiving end is a client MUA that can interact with a user.
26783
26784 Note that certificates using MD5 are unlikely to work on today's Internet;
26785 even if your libraries allow loading them for use in Exim when acting as a
26786 server, increasingly clients will not accept such certificates.  The error
26787 diagnostics in such a case can be frustratingly vague.
26788
26789
26790
26791 .section "Self-signed certificates" "SECID187"
26792 .cindex "certificate" "self-signed"
26793 You can create a self-signed certificate using the &'req'& command provided
26794 with OpenSSL, like this:
26795 . ==== Do not shorten the duration here without reading and considering
26796 . ==== the text below.  Please leave it at 9999 days.
26797 .code
26798 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
26799             -days 9999 -nodes
26800 .endd
26801 &_file1_& and &_file2_& can be the same file; the key and the certificate are
26802 delimited and so can be identified independently. The &%-days%& option
26803 specifies a period for which the certificate is valid. The &%-nodes%& option is
26804 important: if you do not set it, the key is encrypted with a passphrase
26805 that you are prompted for, and any use that is made of the key causes more
26806 prompting for the passphrase. This is not helpful if you are going to use
26807 this certificate and key in an MTA, where prompting is not possible.
26808
26809 . ==== I expect to still be working 26 years from now.  The less technical
26810 . ==== debt I create, in terms of storing up trouble for my later years, the
26811 . ==== happier I will be then.  We really have reached the point where we
26812 . ==== should start, at the very least, provoking thought and making folks
26813 . ==== pause before proceeding, instead of leaving all the fixes until two
26814 . ==== years before 2^31 seconds after the 1970 Unix epoch.
26815 . ==== -pdp, 2012
26816 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
26817 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
26818 the above command might produce a date in the past.  Think carefully about
26819 the lifetime of the systems you're deploying, and either reduce the duration
26820 of the certificate or reconsider your platform deployment.  (At time of
26821 writing, reducing the duration is the most likely choice, but the inexorable
26822 progression of time takes us steadily towards an era where this will not
26823 be a sensible resolution).
26824
26825 A self-signed certificate made in this way is sufficient for testing, and
26826 may be adequate for all your requirements if you are mainly interested in
26827 encrypting transfers, and not in secure identification.
26828
26829 However, many clients require that the certificate presented by the server be a
26830 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
26831 certificate. In this situation, the self-signed certificate described above
26832 must be installed on the client host as a trusted root &'certification
26833 authority'& (CA), and the certificate used by Exim must be a user certificate
26834 signed with that self-signed certificate.
26835
26836 For information on creating self-signed CA certificates and using them to sign
26837 user certificates, see the &'General implementation overview'& chapter of the
26838 Open-source PKI book, available online at
26839 &url(http://ospkibook.sourceforge.net/).
26840 .ecindex IIDencsmtp1
26841 .ecindex IIDencsmtp2
26842
26843
26844
26845 . ////////////////////////////////////////////////////////////////////////////
26846 . ////////////////////////////////////////////////////////////////////////////
26847
26848 .chapter "Access control lists" "CHAPACL"
26849 .scindex IIDacl "&ACL;" "description"
26850 .cindex "control of incoming mail"
26851 .cindex "message" "controlling incoming"
26852 .cindex "policy control" "access control lists"
26853 Access Control Lists (ACLs) are defined in a separate section of the run time
26854 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
26855 name, terminated by a colon. Here is a complete ACL section that contains just
26856 one very small ACL:
26857 .code
26858 begin acl
26859 small_acl:
26860   accept   hosts = one.host.only
26861 .endd
26862 You can have as many lists as you like in the ACL section, and the order in
26863 which they appear does not matter. The lists are self-terminating.
26864
26865 The majority of ACLs are used to control Exim's behaviour when it receives
26866 certain SMTP commands. This applies both to incoming TCP/IP connections, and
26867 when a local process submits a message using SMTP by specifying the &%-bs%&
26868 option. The most common use is for controlling which recipients are accepted
26869 in incoming messages. In addition, you can define an ACL that is used to check
26870 local non-SMTP messages. The default configuration file contains an example of
26871 a realistic ACL for checking RCPT commands. This is discussed in chapter
26872 &<<CHAPdefconfil>>&.
26873
26874
26875 .section "Testing ACLs" "SECID188"
26876 The &%-bh%& command line option provides a way of testing your ACL
26877 configuration locally by running a fake SMTP session with which you interact.
26878 The host &'relay-test.mail-abuse.org'& provides a service for checking your
26879 relaying configuration (see section &<<SECTcheralcon>>& for more details).
26880
26881
26882
26883 .section "Specifying when ACLs are used" "SECID189"
26884 .cindex "&ACL;" "options for specifying"
26885 In order to cause an ACL to be used, you have to name it in one of the relevant
26886 options in the main part of the configuration. These options are:
26887 .cindex "AUTH" "ACL for"
26888 .cindex "DATA" "ACLs for"
26889 .cindex "ETRN" "ACL for"
26890 .cindex "EXPN" "ACL for"
26891 .cindex "HELO" "ACL for"
26892 .cindex "EHLO" "ACL for"
26893 .cindex "MAIL" "ACL for"
26894 .cindex "QUIT, ACL for"
26895 .cindex "RCPT" "ACL for"
26896 .cindex "STARTTLS, ACL for"
26897 .cindex "VRFY" "ACL for"
26898 .cindex "SMTP" "connection, ACL for"
26899 .cindex "non-SMTP messages" "ACLs for"
26900 .cindex "MIME content scanning" "ACL for"
26901 .cindex "PRDR" "ACL for"
26902
26903 .table2 140pt
26904 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
26905 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
26906 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
26907 .irow &%acl_smtp_auth%&        "ACL for AUTH"
26908 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
26909 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
26910 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
26911 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
26912 .irow &%acl_smtp_expn%&        "ACL for EXPN"
26913 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
26914 .irow &%acl_smtp_mail%&        "ACL for MAIL"
26915 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
26916 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
26917 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
26918 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
26919 .irow &%acl_smtp_quit%&        "ACL for QUIT"
26920 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
26921 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
26922 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
26923 .endtable
26924
26925 For example, if you set
26926 .code
26927 acl_smtp_rcpt = small_acl
26928 .endd
26929 the little ACL defined above is used whenever Exim receives a RCPT command
26930 in an SMTP dialogue. The majority of policy tests on incoming messages can be
26931 done when RCPT commands arrive. A rejection of RCPT should cause the
26932 sending MTA to give up on the recipient address contained in the RCPT
26933 command, whereas rejection at other times may cause the client MTA to keep on
26934 trying to deliver the message. It is therefore recommended that you do as much
26935 testing as possible at RCPT time.
26936
26937
26938 .section "The non-SMTP ACLs" "SECID190"
26939 .cindex "non-SMTP messages" "ACLs for"
26940 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
26941 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
26942 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
26943 the state of the SMTP connection such as encryption and authentication) are not
26944 relevant and are forbidden in these ACLs. However, the sender and recipients
26945 are known, so the &%senders%& and &%sender_domains%& conditions and the
26946 &$sender_address$& and &$recipients$& variables can be used. Variables such as
26947 &$authenticated_sender$& are also available. You can specify added header lines
26948 in any of these ACLs.
26949
26950 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
26951 non-SMTP message, before any of the message has been read. (This is the
26952 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
26953 batched SMTP input, it runs after the DATA command has been reached. The
26954 result of this ACL is ignored; it cannot be used to reject a message. If you
26955 really need to, you could set a value in an ACL variable here and reject based
26956 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
26957 controls, and in particular, it can be used to set
26958 .code
26959 control = suppress_local_fixups
26960 .endd
26961 This cannot be used in the other non-SMTP ACLs because by the time they are
26962 run, it is too late.
26963
26964 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
26965 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
26966
26967 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
26968 kind of rejection is treated as permanent, because there is no way of sending a
26969 temporary error for these kinds of message.
26970
26971
26972 .section "The SMTP connect ACL" "SECID191"
26973 .cindex "SMTP" "connection, ACL for"
26974 .oindex &%smtp_banner%&
26975 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
26976 session, after the test specified by &%host_reject_connection%& (which is now
26977 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
26978 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
26979 the message override the banner message that is otherwise specified by the
26980 &%smtp_banner%& option.
26981
26982
26983 .section "The EHLO/HELO ACL" "SECID192"
26984 .cindex "EHLO" "ACL for"
26985 .cindex "HELO" "ACL for"
26986 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
26987 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
26988 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
26989 Note that a client may issue more than one EHLO or HELO command in an SMTP
26990 session, and indeed is required to issue a new EHLO or HELO after successfully
26991 setting up encryption following a STARTTLS command.
26992
26993 If the command is accepted by an &%accept%& verb that has a &%message%&
26994 modifier, the message may not contain more than one line (it will be truncated
26995 at the first newline and a panic logged if it does). Such a message cannot
26996 affect the EHLO options that are listed on the second and subsequent lines of
26997 an EHLO response.
26998
26999
27000 .section "The DATA ACLs" "SECID193"
27001 .cindex "DATA" "ACLs for"
27002 Two ACLs are associated with the DATA command, because it is two-stage
27003 command, with two responses being sent to the client.
27004 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27005 is obeyed. This gives you control after all the RCPT commands, but before
27006 the message itself is received. It offers the opportunity to give a negative
27007 response to the DATA command before the data is transmitted. Header lines
27008 added by MAIL or RCPT ACLs are not visible at this time, but any that
27009 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27010
27011 You cannot test the contents of the message, for example, to verify addresses
27012 in the headers, at RCPT time or when the DATA command is received. Such
27013 tests have to appear in the ACL that is run after the message itself has been
27014 received, before the final response to the DATA command is sent. This is
27015 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27016 associated with the DATA command.
27017
27018 For both of these ACLs, it is not possible to reject individual recipients. An
27019 error response rejects the entire message. Unfortunately, it is known that some
27020 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27021 before or after the data) correctly &-- they keep the message on their queues
27022 and try again later, but that is their problem, though it does waste some of
27023 your resources.
27024
27025 The &%acl_smtp_data%& ACL is run after
27026 the &%acl_smtp_data_prdr%&,
27027 the &%acl_smtp_dkim%&
27028 and the &%acl_smtp_mime%& ACLs.
27029
27030 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27031 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27032 enabled (which is the default).
27033
27034 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27035 received, and is executed for each DKIM signature found in a message.  If not
27036 otherwise specified, the default action is to accept.
27037
27038 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27039
27040 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27041
27042
27043 .section "The SMTP MIME ACL" "SECID194"
27044 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27045 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27046
27047 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27048
27049
27050 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27051 .cindex "PRDR" "ACL for"
27052 .oindex "&%prdr_enable%&"
27053 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27054 with PRDR support enabled (which is the default).
27055 It becomes active only when the PRDR feature is negotiated between
27056 client and server for a message, and more than one recipient
27057 has been accepted.
27058
27059 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27060 has been recieved, and is executed once for each recipient of the message
27061 with &$local_part$& and &$domain$& valid.
27062 The test may accept, defer or deny for inividual recipients.
27063 The &%acl_smtp_data%& will still be called after this ACL and
27064 can reject the message overall, even if this ACL has accepted it
27065 for some or all recipients.
27066
27067 PRDR may be used to support per-user content filtering.  Without it
27068 one must defer any recipient after the first that has a different
27069 content-filter configuration.  With PRDR, the RCPT-time check
27070 for this can be disabled when the MAIL-time $smtp_command included
27071 "PRDR".  Any required difference in behaviour of the main DATA-time
27072 ACL should however depend on the PRDR-time ACL having run, as Exim
27073 will avoid doing so in some situations (eg.  single-recipient mails).
27074
27075 See also the &%prdr_enable%& global option
27076 and the &%hosts_try_prdr%& smtp transport option.
27077
27078 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27079 If the ACL is not defined, processing completes as if
27080 the feature was not requested by the client.
27081
27082 .section "The QUIT ACL" "SECTQUITACL"
27083 .cindex "QUIT, ACL for"
27084 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27085 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27086 does not in fact control any access. For this reason, the only verbs that are
27087 permitted are &%accept%& and &%warn%&.
27088
27089 This ACL can be used for tasks such as custom logging at the end of an SMTP
27090 session. For example, you can use ACL variables in other ACLs to count
27091 messages, recipients, etc., and log the totals at QUIT time using one or
27092 more &%logwrite%& modifiers on a &%warn%& verb.
27093
27094 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27095 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27096
27097 You do not need to have a final &%accept%&, but if you do, you can use a
27098 &%message%& modifier to specify custom text that is sent as part of the 221
27099 response to QUIT.
27100
27101 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27102 failure (for example, failure to open a log file, or when Exim is bombing out
27103 because it has detected an unrecoverable error), all SMTP commands from the
27104 client are given temporary error responses until QUIT is received or the
27105 connection is closed. In these special cases, the QUIT ACL does not run.
27106
27107
27108 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27109 .vindex &$acl_smtp_notquit$&
27110 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27111 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27112 trouble, such as being unable to write to its log files, this ACL is not run,
27113 because it might try to do things (such as write to log files) that make the
27114 situation even worse.
27115
27116 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27117 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27118 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27119 and &%warn%&.
27120
27121 .vindex &$smtp_notquit_reason$&
27122 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27123 to a string that indicates the reason for the termination of the SMTP
27124 connection. The possible values are:
27125 .table2
27126 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27127 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27128 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27129 .irow &`connection-lost`&          "The SMTP connection has been lost"
27130 .irow &`data-timeout`&             "Timeout while reading message data"
27131 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27132 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27133 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27134 .irow &`synchronization-error`&    "SMTP synchronization error"
27135 .irow &`tls-failed`&               "TLS failed to start"
27136 .endtable
27137 In most cases when an SMTP connection is closed without having received QUIT,
27138 Exim sends an SMTP response message before actually closing the connection.
27139 With the exception of the &`acl-drop`& case, the default message can be
27140 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27141 &%drop%& verb in another ACL, it is the message from the other ACL that is
27142 used.
27143
27144
27145 .section "Finding an ACL to use" "SECID195"
27146 .cindex "&ACL;" "finding which to use"
27147 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27148 you can use different ACLs in different circumstances. For example,
27149 .code
27150 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27151                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27152 .endd
27153 In the default configuration file there are some example settings for
27154 providing an RFC 4409 message submission service on port 587 and a
27155 non-standard &"smtps"& service on port 465. You can use a string
27156 expansion like this to choose an ACL for MUAs on these ports which is
27157 more appropriate for this purpose than the default ACL on port 25.
27158
27159 The expanded string does not have to be the name of an ACL in the
27160 configuration file; there are other possibilities. Having expanded the
27161 string, Exim searches for an ACL as follows:
27162
27163 .ilist
27164 If the string begins with a slash, Exim uses it as a file name, and reads its
27165 contents as an ACL. The lines are processed in the same way as lines in the
27166 Exim configuration file. In particular, continuation lines are supported, blank
27167 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27168 If the file does not exist or cannot be read, an error occurs (typically
27169 causing a temporary failure of whatever caused the ACL to be run). For example:
27170 .code
27171 acl_smtp_data = /etc/acls/\
27172   ${lookup{$sender_host_address}lsearch\
27173   {/etc/acllist}{$value}{default}}
27174 .endd
27175 This looks up an ACL file to use on the basis of the host's IP address, falling
27176 back to a default if the lookup fails. If an ACL is successfully read from a
27177 file, it is retained in memory for the duration of the Exim process, so that it
27178 can be re-used without having to re-read the file.
27179 .next
27180 If the string does not start with a slash, and does not contain any spaces,
27181 Exim searches the ACL section of the configuration for an ACL whose name
27182 matches the string.
27183 .next
27184 If no named ACL is found, or if the string contains spaces, Exim parses
27185 the string as an inline ACL. This can save typing in cases where you just
27186 want to have something like
27187 .code
27188 acl_smtp_vrfy = accept
27189 .endd
27190 in order to allow free use of the VRFY command. Such a string may contain
27191 newlines; it is processed in the same way as an ACL that is read from a file.
27192 .endlist
27193
27194
27195
27196
27197 .section "ACL return codes" "SECID196"
27198 .cindex "&ACL;" "return codes"
27199 Except for the QUIT ACL, which does not affect the SMTP return code (see
27200 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27201 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27202 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27203 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27204 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27205 This also causes a 4&'xx'& return code.
27206
27207 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27208 &"deny"&, because there is no mechanism for passing temporary errors to the
27209 submitters of non-SMTP messages.
27210
27211
27212 ACLs that are relevant to message reception may also return &"discard"&. This
27213 has the effect of &"accept"&, but causes either the entire message or an
27214 individual recipient address to be discarded. In other words, it is a
27215 blackholing facility. Use it with care.
27216
27217 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27218 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27219 RCPT ACL is to discard just the one recipient address. If there are no
27220 recipients left when the message's data is received, the DATA ACL is not
27221 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27222 remaining recipients. The &"discard"& return is not permitted for the
27223 &%acl_smtp_predata%& ACL.
27224
27225
27226 .cindex "&[local_scan()]& function" "when all recipients discarded"
27227 The &[local_scan()]& function is always run, even if there are no remaining
27228 recipients; it may create new recipients.
27229
27230
27231
27232 .section "Unset ACL options" "SECID197"
27233 .cindex "&ACL;" "unset options"
27234 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27235 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27236 not defined at all. For any defined ACL, the default action when control
27237 reaches the end of the ACL statements is &"deny"&.
27238
27239 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27240 these two are ACLs that are used only for their side effects. They cannot be
27241 used to accept or reject anything.
27242
27243 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27244 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27245 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27246 when the ACL is not defined is &"accept"&.
27247
27248 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27249 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27250 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27251 messages over an SMTP connection. For an example, see the ACL in the default
27252 configuration file.
27253
27254
27255
27256
27257 .section "Data for message ACLs" "SECID198"
27258 .cindex "&ACL;" "data for message ACL"
27259 .vindex &$domain$&
27260 .vindex &$local_part$&
27261 .vindex &$sender_address$&
27262 .vindex &$sender_host_address$&
27263 .vindex &$smtp_command$&
27264 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27265 that contain information about the host and the message's sender (for example,
27266 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27267 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27268 &$local_part$& are set from the argument address. The entire SMTP command
27269 is available in &$smtp_command$&.
27270
27271 When an ACL for the AUTH parameter of MAIL is running, the variables that
27272 contain information about the host are set, but &$sender_address$& is not yet
27273 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27274 how it is used.
27275
27276 .vindex "&$message_size$&"
27277 The &$message_size$& variable is set to the value of the SIZE parameter on
27278 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27279 that parameter is not given. The value is updated to the true message size by
27280 the time the final DATA ACL is run (after the message data has been
27281 received).
27282
27283 .vindex "&$rcpt_count$&"
27284 .vindex "&$recipients_count$&"
27285 The &$rcpt_count$& variable increases by one for each RCPT command received.
27286 The &$recipients_count$& variable increases by one each time a RCPT command is
27287 accepted, so while an ACL for RCPT is being processed, it contains the number
27288 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27289 &$rcpt_count$& contains the total number of RCPT commands, and
27290 &$recipients_count$& contains the total number of accepted recipients.
27291
27292
27293
27294
27295
27296 .section "Data for non-message ACLs" "SECTdatfornon"
27297 .cindex "&ACL;" "data for non-message ACL"
27298 .vindex &$smtp_command_argument$&
27299 .vindex &$smtp_command$&
27300 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27301 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27302 and the entire SMTP command is available in &$smtp_command$&.
27303 These variables can be tested using a &%condition%& condition. For example,
27304 here is an ACL for use with AUTH, which insists that either the session is
27305 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27306 does not permit authentication methods that use cleartext passwords on
27307 unencrypted connections.
27308 .code
27309 acl_check_auth:
27310   accept encrypted = *
27311   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27312                      {CRAM-MD5}}
27313   deny   message   = TLS encryption or CRAM-MD5 required
27314 .endd
27315 (Another way of applying this restriction is to arrange for the authenticators
27316 that use cleartext passwords not to be advertised when the connection is not
27317 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27318 option to do this.)
27319
27320
27321
27322 .section "Format of an ACL" "SECID199"
27323 .cindex "&ACL;" "format of"
27324 .cindex "&ACL;" "verbs, definition of"
27325 An individual ACL consists of a number of statements. Each statement starts
27326 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27327 Modifiers can change the way the verb operates, define error and log messages,
27328 set variables, insert delays, and vary the processing of accepted messages.
27329
27330 If all the conditions are met, the verb is obeyed. The same condition may be
27331 used (with different arguments) more than once in the same statement. This
27332 provides a means of specifying an &"and"& conjunction between conditions. For
27333 example:
27334 .code
27335 deny  dnslists = list1.example
27336 dnslists = list2.example
27337 .endd
27338 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27339 the conditions and modifiers when it reaches a condition that fails. What
27340 happens then depends on the verb (and in one case, on a special modifier). Not
27341 all the conditions make sense at every testing point. For example, you cannot
27342 test a sender address in the ACL that is run for a VRFY command.
27343
27344
27345 .section "ACL verbs" "SECID200"
27346 The ACL verbs are as follows:
27347
27348 .ilist
27349 .cindex "&%accept%& ACL verb"
27350 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27351 of the conditions are not met, what happens depends on whether &%endpass%&
27352 appears among the conditions (for syntax see below). If the failing condition
27353 is before &%endpass%&, control is passed to the next ACL statement; if it is
27354 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27355 check a RCPT command:
27356 .code
27357 accept domains = +local_domains
27358 endpass
27359 verify = recipient
27360 .endd
27361 If the recipient domain does not match the &%domains%& condition, control
27362 passes to the next statement. If it does match, the recipient is verified, and
27363 the command is accepted if verification succeeds. However, if verification
27364 fails, the ACL yields &"deny"&, because the failing condition is after
27365 &%endpass%&.
27366
27367 The &%endpass%& feature has turned out to be confusing to many people, so its
27368 use is not recommended nowadays. It is always possible to rewrite an ACL so
27369 that &%endpass%& is not needed, and it is no longer used in the default
27370 configuration.
27371
27372 .cindex "&%message%& ACL modifier" "with &%accept%&"
27373 If a &%message%& modifier appears on an &%accept%& statement, its action
27374 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27375 (when an &%accept%& verb either accepts or passes control to the next
27376 statement), &%message%& can be used to vary the message that is sent when an
27377 SMTP command is accepted. For example, in a RCPT ACL you could have:
27378 .display
27379 &`accept  `&<&'some conditions'&>
27380 &`        message = OK, I will allow you through today`&
27381 .endd
27382 You can specify an SMTP response code, optionally followed by an &"extended
27383 response code"& at the start of the message, but the first digit must be the
27384 same as would be sent by default, which is 2 for an &%accept%& verb.
27385
27386 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27387 an error message that is used when access is denied. This behaviour is retained
27388 for backward compatibility, but current &"best practice"& is to avoid the use
27389 of &%endpass%&.
27390
27391
27392 .next
27393 .cindex "&%defer%& ACL verb"
27394 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27395 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27396 &%defer%& is the same as &%deny%&, because there is no way of sending a
27397 temporary error. For a RCPT command, &%defer%& is much the same as using a
27398 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27399 be used in any ACL, and even for a recipient it might be a simpler approach.
27400
27401
27402 .next
27403 .cindex "&%deny%& ACL verb"
27404 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27405 the conditions are not met, control is passed to the next ACL statement. For
27406 example,
27407 .code
27408 deny dnslists = blackholes.mail-abuse.org
27409 .endd
27410 rejects commands from hosts that are on a DNS black list.
27411
27412
27413 .next
27414 .cindex "&%discard%& ACL verb"
27415 &%discard%&: This verb behaves like &%accept%&, except that it returns
27416 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27417 that are concerned with receiving messages. When all the conditions are true,
27418 the sending entity receives a &"success"& response. However, &%discard%& causes
27419 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27420 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27421 message's recipients are discarded. Recipients that are discarded before DATA
27422 do not appear in the log line when the &%received_recipients%& log selector is set.
27423
27424 If the &%log_message%& modifier is set when &%discard%& operates,
27425 its contents are added to the line that is automatically written to the log.
27426 The &%message%& modifier operates exactly as it does for &%accept%&.
27427
27428
27429 .next
27430 .cindex "&%drop%& ACL verb"
27431 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27432 forcibly closed after the 5&'xx'& error message has been sent. For example:
27433 .code
27434 drop   message   = I don't take more than 20 RCPTs
27435        condition = ${if > {$rcpt_count}{20}}
27436 .endd
27437 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27438 The connection is always dropped after sending a 550 response.
27439
27440 .next
27441 .cindex "&%require%& ACL verb"
27442 &%require%&: If all the conditions are met, control is passed to the next ACL
27443 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27444 example, when checking a RCPT command,
27445 .code
27446 require message = Sender did not verify
27447         verify  = sender
27448 .endd
27449 passes control to subsequent statements only if the message's sender can be
27450 verified. Otherwise, it rejects the command. Note the positioning of the
27451 &%message%& modifier, before the &%verify%& condition. The reason for this is
27452 discussed in section &<<SECTcondmodproc>>&.
27453
27454 .next
27455 .cindex "&%warn%& ACL verb"
27456 &%warn%&: If all the conditions are true, a line specified by the
27457 &%log_message%& modifier is written to Exim's main log. Control always passes
27458 to the next ACL statement. If any condition is false, the log line is not
27459 written. If an identical log line is requested several times in the same
27460 message, only one copy is actually written to the log. If you want to force
27461 duplicates to be written, use the &%logwrite%& modifier instead.
27462
27463 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27464 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27465 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27466 first failing condition. There is more about adding header lines in section
27467 &<<SECTaddheadacl>>&.
27468
27469 If any condition on a &%warn%& statement cannot be completed (that is, there is
27470 some sort of defer), the log line specified by &%log_message%& is not written.
27471 This does not include the case of a forced failure from a lookup, which
27472 is considered to be a successful completion. After a defer, no further
27473 conditions or modifiers in the &%warn%& statement are processed. The incident
27474 is logged, and the ACL continues to be processed, from the next statement
27475 onwards.
27476
27477
27478 .vindex "&$acl_verify_message$&"
27479 When one of the &%warn%& conditions is an address verification that fails, the
27480 text of the verification failure message is in &$acl_verify_message$&. If you
27481 want this logged, you must set it up explicitly. For example:
27482 .code
27483 warn   !verify = sender
27484        log_message = sender verify failed: $acl_verify_message
27485 .endd
27486 .endlist
27487
27488 At the end of each ACL there is an implicit unconditional &%deny%&.
27489
27490 As you can see from the examples above, the conditions and modifiers are
27491 written one to a line, with the first one on the same line as the verb, and
27492 subsequent ones on following lines. If you have a very long condition, you can
27493 continue it onto several physical lines by the usual backslash continuation
27494 mechanism. It is conventional to align the conditions vertically.
27495
27496
27497
27498 .section "ACL variables" "SECTaclvariables"
27499 .cindex "&ACL;" "variables"
27500 There are some special variables that can be set during ACL processing. They
27501 can be used to pass information between different ACLs, different invocations
27502 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27503 transports, and filters that are used to deliver a message. The names of these
27504 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27505 an underscore, but the remainder of the name can be any sequence of
27506 alphanumeric characters and underscores that you choose. There is no limit on
27507 the number of ACL variables. The two sets act as follows:
27508 .ilist
27509 The values of those variables whose names begin with &$acl_c$& persist
27510 throughout an SMTP connection. They are never reset. Thus, a value that is set
27511 while receiving one message is still available when receiving the next message
27512 on the same SMTP connection.
27513 .next
27514 The values of those variables whose names begin with &$acl_m$& persist only
27515 while a message is being received. They are reset afterwards. They are also
27516 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27517 .endlist
27518
27519 When a message is accepted, the current values of all the ACL variables are
27520 preserved with the message and are subsequently made available at delivery
27521 time. The ACL variables are set by a modifier called &%set%&. For example:
27522 .code
27523 accept hosts = whatever
27524        set acl_m4 = some value
27525 accept authenticated = *
27526        set acl_c_auth = yes
27527 .endd
27528 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27529 be set. If you want to set a variable without taking any action, you can use a
27530 &%warn%& verb without any other modifiers or conditions.
27531
27532 .oindex &%strict_acl_vars%&
27533 What happens if a syntactically valid but undefined ACL variable is
27534 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27535 false (the default), an empty string is substituted; if it is true, an
27536 error is generated.
27537
27538 Versions of Exim before 4.64 have a limited set of numbered variables, but
27539 their names are compatible, so there is no problem with upgrading.
27540
27541
27542 .section "Condition and modifier processing" "SECTcondmodproc"
27543 .cindex "&ACL;" "conditions; processing"
27544 .cindex "&ACL;" "modifiers; processing"
27545 An exclamation mark preceding a condition negates its result. For example:
27546 .code
27547 deny   domains = *.dom.example
27548       !verify  = recipient
27549 .endd
27550 causes the ACL to return &"deny"& if the recipient domain ends in
27551 &'dom.example'& and the recipient address cannot be verified. Sometimes
27552 negation can be used on the right-hand side of a condition. For example, these
27553 two statements are equivalent:
27554 .code
27555 deny  hosts = !192.168.3.4
27556 deny !hosts =  192.168.3.4
27557 .endd
27558 However, for many conditions (&%verify%& being a good example), only left-hand
27559 side negation of the whole condition is possible.
27560
27561 The arguments of conditions and modifiers are expanded. A forced failure
27562 of an expansion causes a condition to be ignored, that is, it behaves as if the
27563 condition is true. Consider these two statements:
27564 .code
27565 accept  senders = ${lookup{$host_name}lsearch\
27566                   {/some/file}{$value}fail}
27567 accept  senders = ${lookup{$host_name}lsearch\
27568                   {/some/file}{$value}{}}
27569 .endd
27570 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27571 the returned list is searched, but if the lookup fails the behaviour is
27572 different in the two cases. The &%fail%& in the first statement causes the
27573 condition to be ignored, leaving no further conditions. The &%accept%& verb
27574 therefore succeeds. The second statement, however, generates an empty list when
27575 the lookup fails. No sender can match an empty list, so the condition fails,
27576 and therefore the &%accept%& also fails.
27577
27578 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27579 specify actions that are taken as the conditions for a statement are checked;
27580 others specify text for messages that are used when access is denied or a
27581 warning is generated. The &%control%& modifier affects the way an incoming
27582 message is handled.
27583
27584 The positioning of the modifiers in an ACL statement is important, because the
27585 processing of a verb ceases as soon as its outcome is known. Only those
27586 modifiers that have already been encountered will take effect. For example,
27587 consider this use of the &%message%& modifier:
27588 .code
27589 require message = Can't verify sender
27590         verify  = sender
27591         message = Can't verify recipient
27592         verify  = recipient
27593         message = This message cannot be used
27594 .endd
27595 If sender verification fails, Exim knows that the result of the statement is
27596 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27597 so its text is used as the error message. If sender verification succeeds, but
27598 recipient verification fails, the second message is used. If recipient
27599 verification succeeds, the third message becomes &"current"&, but is never used
27600 because there are no more conditions to cause failure.
27601
27602 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27603 modifier that is used, because all the conditions must be true for rejection to
27604 happen. Specifying more than one &%message%& modifier does not make sense, and
27605 the message can even be specified after all the conditions. For example:
27606 .code
27607 deny   hosts = ...
27608       !senders = *@my.domain.example
27609        message = Invalid sender from client host
27610 .endd
27611 The &"deny"& result does not happen until the end of the statement is reached,
27612 by which time Exim has set up the message.
27613
27614
27615
27616 .section "ACL modifiers" "SECTACLmodi"
27617 .cindex "&ACL;" "modifiers; list of"
27618 The ACL modifiers are as follows:
27619
27620 .vlist
27621 .vitem &*add_header*&&~=&~<&'text'&>
27622 This modifier specifies one or more header lines that are to be added to an
27623 incoming message, assuming, of course, that the message is ultimately
27624 accepted. For details, see section &<<SECTaddheadacl>>&.
27625
27626 .vitem &*continue*&&~=&~<&'text'&>
27627 .cindex "&%continue%& ACL modifier"
27628 .cindex "database" "updating in ACL"
27629 This modifier does nothing of itself, and processing of the ACL always
27630 continues with the next condition or modifier. The value of &%continue%& is in
27631 the side effects of expanding its argument. Typically this could be used to
27632 update a database. It is really just a syntactic tidiness, to avoid having to
27633 write rather ugly lines like this:
27634 .display
27635 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27636 .endd
27637 Instead, all you need is
27638 .display
27639 &`continue = `&<&'some expansion'&>
27640 .endd
27641
27642 .vitem &*control*&&~=&~<&'text'&>
27643 .cindex "&%control%& ACL modifier"
27644 This modifier affects the subsequent processing of the SMTP connection or of an
27645 incoming message that is accepted. The effect of the first type of control
27646 lasts for the duration of the connection, whereas the effect of the second type
27647 lasts only until the current message has been received. The message-specific
27648 controls always apply to the whole message, not to individual recipients,
27649 even if the &%control%& modifier appears in a RCPT ACL.
27650
27651 As there are now quite a few controls that can be applied, they are described
27652 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27653 in several different ways. For example:
27654
27655 . ==== As this is a nested list, any displays it contains must be indented
27656 . ==== as otherwise they are too far to the left. That comment applies only
27657 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27658 . ==== way.
27659
27660 .ilist
27661 It can be at the end of an &%accept%& statement:
27662 .code
27663     accept  ...some conditions
27664             control = queue_only
27665 .endd
27666 In this case, the control is applied when this statement yields &"accept"&, in
27667 other words, when the conditions are all true.
27668
27669 .next
27670 It can be in the middle of an &%accept%& statement:
27671 .code
27672     accept  ...some conditions...
27673             control = queue_only
27674             ...some more conditions...
27675 .endd
27676 If the first set of conditions are true, the control is applied, even if the
27677 statement does not accept because one of the second set of conditions is false.
27678 In this case, some subsequent statement must yield &"accept"& for the control
27679 to be relevant.
27680
27681 .next
27682 It can be used with &%warn%& to apply the control, leaving the
27683 decision about accepting or denying to a subsequent verb. For
27684 example:
27685 .code
27686     warn    ...some conditions...
27687             control = freeze
27688     accept  ...
27689 .endd
27690 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27691 &%logwrite%&, so it does not add anything to the message and does not write a
27692 log entry.
27693
27694 .next
27695 If you want to apply a control unconditionally, you can use it with a
27696 &%require%& verb. For example:
27697 .code
27698     require  control = no_multiline_responses
27699 .endd
27700 .endlist
27701
27702 .vitem &*delay*&&~=&~<&'time'&>
27703 .cindex "&%delay%& ACL modifier"
27704 .oindex "&%-bh%&"
27705 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27706 the time interval before proceeding. However, when testing Exim using the
27707 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27708 output instead). The time is given in the usual Exim notation, and the delay
27709 happens as soon as the modifier is processed. In an SMTP session, pending
27710 output is flushed before the delay is imposed.
27711
27712 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27713 example:
27714 .code
27715 deny    ...some conditions...
27716         delay = 30s
27717 .endd
27718 The delay happens if all the conditions are true, before the statement returns
27719 &"deny"&. Compare this with:
27720 .code
27721 deny    delay = 30s
27722         ...some conditions...
27723 .endd
27724 which waits for 30s before processing the conditions. The &%delay%& modifier
27725 can also be used with &%warn%& and together with &%control%&:
27726 .code
27727 warn    ...some conditions...
27728         delay = 2m
27729         control = freeze
27730 accept  ...
27731 .endd
27732
27733 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27734 responses to several commands are no longer buffered and sent in one packet (as
27735 they would normally be) because all output is flushed before imposing the
27736 delay. This optimization is disabled so that a number of small delays do not
27737 appear to the client as one large aggregated delay that might provoke an
27738 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27739 using a &%control%& modifier to set &%no_delay_flush%&.
27740
27741
27742 .vitem &*endpass*&
27743 .cindex "&%endpass%& ACL modifier"
27744 This modifier, which has no argument, is recognized only in &%accept%& and
27745 &%discard%& statements. It marks the boundary between the conditions whose
27746 failure causes control to pass to the next statement, and the conditions whose
27747 failure causes the ACL to return &"deny"&. This concept has proved to be
27748 confusing to some people, so the use of &%endpass%& is no longer recommended as
27749 &"best practice"&. See the description of &%accept%& above for more details.
27750
27751
27752 .vitem &*log_message*&&~=&~<&'text'&>
27753 .cindex "&%log_message%& ACL modifier"
27754 This modifier sets up a message that is used as part of the log message if the
27755 ACL denies access or a &%warn%& statement's conditions are true. For example:
27756 .code
27757 require log_message = wrong cipher suite $tls_in_cipher
27758         encrypted   = DES-CBC3-SHA
27759 .endd
27760 &%log_message%& is also used when recipients are discarded by &%discard%&. For
27761 example:
27762 .display
27763 &`discard `&<&'some conditions'&>
27764 &`        log_message = Discarded $local_part@$domain because...`&
27765 .endd
27766 When access is denied, &%log_message%& adds to any underlying error message
27767 that may exist because of a condition failure. For example, while verifying a
27768 recipient address, a &':fail:'& redirection might have already set up a
27769 message.
27770
27771 The message may be defined before the conditions to which it applies, because
27772 the string expansion does not happen until Exim decides that access is to be
27773 denied. This means that any variables that are set by the condition are
27774 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
27775 variables are set after a DNS black list lookup succeeds. If the expansion of
27776 &%log_message%& fails, or if the result is an empty string, the modifier is
27777 ignored.
27778
27779 .vindex "&$acl_verify_message$&"
27780 If you want to use a &%warn%& statement to log the result of an address
27781 verification, you can use &$acl_verify_message$& to include the verification
27782 error message.
27783
27784 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
27785 the start of the logged message. If the same warning log message is requested
27786 more than once while receiving  a single email message, only one copy is
27787 actually logged. If you want to log multiple copies, use &%logwrite%& instead
27788 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
27789 is logged for a successful &%warn%& statement.
27790
27791 If &%log_message%& is not present and there is no underlying error message (for
27792 example, from the failure of address verification), but &%message%& is present,
27793 the &%message%& text is used for logging rejections. However, if any text for
27794 logging contains newlines, only the first line is logged. In the absence of
27795 both &%log_message%& and &%message%&, a default built-in message is used for
27796 logging rejections.
27797
27798
27799 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
27800 .cindex "&%log_reject_target%& ACL modifier"
27801 .cindex "logging in ACL" "specifying which log"
27802 This modifier makes it possible to specify which logs are used for messages
27803 about ACL rejections. Its argument is a colon-separated list of words that can
27804 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
27805 may be empty, in which case a rejection is not logged at all. For example, this
27806 ACL fragment writes no logging information when access is denied:
27807 .display
27808 &`deny `&<&'some conditions'&>
27809 &`     log_reject_target =`&
27810 .endd
27811 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
27812 permanent and temporary rejections. Its effect lasts for the rest of the
27813 current ACL.
27814
27815
27816 .vitem &*logwrite*&&~=&~<&'text'&>
27817 .cindex "&%logwrite%& ACL modifier"
27818 .cindex "logging in ACL" "immediate"
27819 This modifier writes a message to a log file as soon as it is encountered when
27820 processing an ACL. (Compare &%log_message%&, which, except in the case of
27821 &%warn%& and &%discard%&, is used only if the ACL statement denies
27822 access.) The &%logwrite%& modifier can be used to log special incidents in
27823 ACLs. For example:
27824 .display
27825 &`accept `&<&'some special conditions'&>
27826 &`       control  = freeze`&
27827 &`       logwrite = froze message because ...`&
27828 .endd
27829 By default, the message is written to the main log. However, it may begin
27830 with a colon, followed by a comma-separated list of log names, and then
27831 another colon, to specify exactly which logs are to be written. For
27832 example:
27833 .code
27834 logwrite = :main,reject: text for main and reject logs
27835 logwrite = :panic: text for panic log only
27836 .endd
27837
27838
27839 .vitem &*message*&&~=&~<&'text'&>
27840 .cindex "&%message%& ACL modifier"
27841 This modifier sets up a text string that is expanded and used as a response
27842 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
27843 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
27844 there is some complication if &%endpass%& is involved; see the description of
27845 &%accept%& for details.)
27846
27847 The expansion of the message happens at the time Exim decides that the ACL is
27848 to end, not at the time it processes &%message%&. If the expansion fails, or
27849 generates an empty string, the modifier is ignored. Here is an example where
27850 &%message%& must be specified first, because the ACL ends with a rejection if
27851 the &%hosts%& condition fails:
27852 .code
27853 require  message = Host not recognized
27854          hosts = 10.0.0.0/8
27855 .endd
27856 (Once a condition has failed, no further conditions or modifiers are
27857 processed.)
27858
27859 .cindex "SMTP" "error codes"
27860 .oindex "&%smtp_banner%&
27861 For ACLs that are triggered by SMTP commands, the message is returned as part
27862 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
27863 is meaningful only for SMTP, as no message is returned when a non-SMTP message
27864 is accepted. In the case of the connect ACL, accepting with a message modifier
27865 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
27866 accept message may not contain more than one line (otherwise it will be
27867 truncated at the first newline and a panic logged), and it cannot affect the
27868 EHLO options.
27869
27870 When SMTP is involved, the message may begin with an overriding response code,
27871 consisting of three digits optionally followed by an &"extended response code"&
27872 of the form &'n.n.n'&, each code being followed by a space. For example:
27873 .code
27874 deny  message = 599 1.2.3 Host not welcome
27875       hosts = 192.168.34.0/24
27876 .endd
27877 The first digit of the supplied response code must be the same as would be sent
27878 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
27879 access, but for the predata ACL, note that the default success code is 354, not
27880 2&'xx'&.
27881
27882 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
27883 the message modifier cannot override the 221 response code.
27884
27885 The text in a &%message%& modifier is literal; any quotes are taken as
27886 literals, but because the string is expanded, backslash escapes are processed
27887 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
27888 response.
27889
27890 .vindex "&$acl_verify_message$&"
27891 For ACLs that are called by an &%acl =%& ACL condition, the message is
27892 stored in &$acl_verify_message$&, from which the calling ACL may use it.
27893
27894 If &%message%& is used on a statement that verifies an address, the message
27895 specified overrides any message that is generated by the verification process.
27896 However, the original message is available in the variable
27897 &$acl_verify_message$&, so you can incorporate it into your message if you
27898 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
27899 routers to be passed back as part of the SMTP response, you should either not
27900 use a &%message%& modifier, or make use of &$acl_verify_message$&.
27901
27902 For compatibility with previous releases of Exim, a &%message%& modifier that
27903 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
27904 modifier, but this usage is now deprecated. However, &%message%& acts only when
27905 all the conditions are true, wherever it appears in an ACL command, whereas
27906 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
27907 &%warn%& in an ACL that is not concerned with receiving a message, it has no
27908 effect.
27909
27910
27911 .vitem &*remove_header*&&~=&~<&'text'&>
27912 This modifier specifies one or more header names in a colon-separated list
27913  that are to be removed from an incoming message, assuming, of course, that
27914 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
27915
27916
27917 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
27918 .cindex "&%set%& ACL modifier"
27919 This modifier puts a value into one of the ACL variables (see section
27920 &<<SECTaclvariables>>&).
27921
27922
27923 .vitem &*udpsend*&&~=&~<&'parameters'&>
27924 This modifier sends a UDP packet, for purposes such as statistics
27925 collection or behaviour monitoring. The parameters are expanded, and
27926 the result of the expansion must be a colon-separated list consisting
27927 of a destination server, port number, and the packet contents. The
27928 server can be specified as a host name or IPv4 or IPv6 address. The
27929 separator can be changed with the usual angle bracket syntax. For
27930 example, you might want to collect information on which hosts connect
27931 when:
27932 .code
27933 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
27934              $tod_zulu $sender_host_address
27935 .endd
27936 .endlist
27937
27938
27939
27940
27941 .section "Use of the control modifier" "SECTcontrols"
27942 .cindex "&%control%& ACL modifier"
27943 The &%control%& modifier supports the following settings:
27944
27945 .vlist
27946 .vitem &*control&~=&~allow_auth_unadvertised*&
27947 This modifier allows a client host to use the SMTP AUTH command even when it
27948 has not been advertised in response to EHLO. Furthermore, because there are
27949 apparently some really broken clients that do this, Exim will accept AUTH after
27950 HELO (rather than EHLO) when this control is set. It should be used only if you
27951 really need it, and you should limit its use to those broken clients that do
27952 not work without it. For example:
27953 .code
27954 warn hosts   = 192.168.34.25
27955      control = allow_auth_unadvertised
27956 .endd
27957 Normally, when an Exim server receives an AUTH command, it checks the name of
27958 the authentication mechanism that is given in the command to ensure that it
27959 matches an advertised mechanism. When this control is set, the check that a
27960 mechanism has been advertised is bypassed. Any configured mechanism can be used
27961 by the client. This control is permitted only in the connection and HELO ACLs.
27962
27963
27964 .vitem &*control&~=&~caseful_local_part*& &&&
27965        &*control&~=&~caselower_local_part*&
27966 .cindex "&ACL;" "case of local part in"
27967 .cindex "case of local parts"
27968 .vindex "&$local_part$&"
27969 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
27970 (that is, during RCPT processing). By default, the contents of &$local_part$&
27971 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
27972 any uppercase letters in the original local part are restored in &$local_part$&
27973 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
27974 is encountered.
27975
27976 These controls affect only the current recipient. Moreover, they apply only to
27977 local part handling that takes place directly in the ACL (for example, as a key
27978 in lookups). If a test to verify the recipient is obeyed, the case-related
27979 handling of the local part during the verification is controlled by the router
27980 configuration (see the &%caseful_local_part%& generic router option).
27981
27982 This facility could be used, for example, to add a spam score to local parts
27983 containing upper case letters. For example, using &$acl_m4$& to accumulate the
27984 spam score:
27985 .code
27986 warn  control = caseful_local_part
27987       set acl_m4 = ${eval:\
27988                      $acl_m4 + \
27989                      ${if match{$local_part}{[A-Z]}{1}{0}}\
27990                     }
27991       control = caselower_local_part
27992 .endd
27993 Notice that we put back the lower cased version afterwards, assuming that
27994 is what is wanted for subsequent tests.
27995
27996
27997 .vitem &*control&~=&~cutthrough_delivery*&
27998 .cindex "&ACL;" "cutthrough routing"
27999 .cindex "cutthrough" "requesting"
28000 This option requests delivery be attempted while the item is being received.
28001
28002 The option usable in the RCPT ACL.
28003 If enabled for a message recieved via smtp and routed to an smtp transport,
28004 and the message has only one recipient,
28005 then the delivery connection is made while the receiving connection is open
28006 and data is copied from one to the other.
28007
28008 If a recipient-verify callout connection is subsequently
28009 requested in the same ACL it is held open and used for the data,
28010 otherwise one is made after the initial RCPT ACL completes.
28011
28012 Note that routers are used in verify mode,
28013 and cannot depend on content of received headers.
28014 Note also that headers cannot be
28015 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28016 Headers may be modified by routers (subject to the above) and transports.
28017
28018 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28019 of outgoing messages is done, because it sends data to the ultimate destination
28020 before the entire message has been received from the source.
28021
28022 Should the ultimate destination system positively accept or reject the mail,
28023 a corresponding indication is given to the source system and nothing is queued.
28024 If there is a temporary error the item is queued for later delivery in the
28025 usual fashion. If the item is successfully delivered in cutthrough mode
28026 the log line is tagged with ">>" rather than "=>" and appears
28027 before the acceptance "<=" line.
28028
28029 Delivery in this mode avoids the generation of a bounce mail to a
28030 (possibly faked)
28031 sender when the destination system is doing content-scan based rejection.
28032
28033
28034 .vitem &*control&~=&~debug/*&<&'options'&>
28035 .cindex "&ACL;" "enabling debug logging"
28036 .cindex "debugging" "enabling from an ACL"
28037 This control turns on debug logging, almost as though Exim had been invoked
28038 with &`-d`&, with the output going to a new logfile, by default called
28039 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28040 may access any variables already defined.  The logging may be adjusted with
28041 the &'opts'& option, which takes the same values as the &`-d`& command-line
28042 option.  Some examples (which depend on variables that don't exist in all
28043 contexts):
28044 .code
28045       control = debug
28046       control = debug/tag=.$sender_host_address
28047       control = debug/opts=+expand+acl
28048       control = debug/tag=.$message_exim_id/opts=+expand
28049 .endd
28050
28051
28052 .vitem &*control&~=&~dkim_disable_verify*&
28053 .cindex "disable DKIM verify"
28054 .cindex "DKIM" "disable verify"
28055 This control turns off DKIM verification processing entirely.  For details on
28056 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28057
28058
28059 .vitem &*control&~=&~dscp/*&<&'value'&>
28060 .cindex "&ACL;" "setting DSCP value"
28061 .cindex "DSCP" "inbound"
28062 This option causes the DSCP value associated with the socket for the inbound
28063 connection to be adjusted to a given value, given as one of a number of fixed
28064 strings or to numeric value.
28065 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28066 Common values include &`throughput`&, &`mincost`&, and on newer systems
28067 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28068
28069 The outbound packets from Exim will be marked with this value in the header
28070 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28071 that these values will have any effect, not be stripped by networking
28072 equipment, or do much of anything without cooperation with your Network
28073 Engineer and those of all network operators between the source and destination.
28074
28075
28076 .vitem &*control&~=&~enforce_sync*& &&&
28077        &*control&~=&~no_enforce_sync*&
28078 .cindex "SMTP" "synchronization checking"
28079 .cindex "synchronization checking in SMTP"
28080 These controls make it possible to be selective about when SMTP synchronization
28081 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28082 state of the switch (it is true by default). See the description of this option
28083 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28084
28085 The effect of these two controls lasts for the remainder of the SMTP
28086 connection. They can appear in any ACL except the one for the non-SMTP
28087 messages. The most straightforward place to put them is in the ACL defined by
28088 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28089 before the first synchronization check. The expected use is to turn off the
28090 synchronization checks for badly-behaved hosts that you nevertheless need to
28091 work with.
28092
28093
28094 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28095 .cindex "fake defer"
28096 .cindex "defer, fake"
28097 This control works in exactly the same way as &%fakereject%& (described below)
28098 except that it causes an SMTP 450 response after the message data instead of a
28099 550 response. You must take care when using &%fakedefer%& because it causes the
28100 messages to be duplicated when the sender retries. Therefore, you should not
28101 use &%fakedefer%& if the message is to be delivered normally.
28102
28103 .vitem &*control&~=&~fakereject/*&<&'message'&>
28104 .cindex "fake rejection"
28105 .cindex "rejection, fake"
28106 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28107 words, only when an SMTP message is being received. If Exim accepts the
28108 message, instead the final 250 response, a 550 rejection message is sent.
28109 However, Exim proceeds to deliver the message as normal. The control applies
28110 only to the current message, not to any subsequent ones that may be received in
28111 the same SMTP connection.
28112
28113 The text for the 550 response is taken from the &%control%& modifier. If no
28114 message is supplied, the following is used:
28115 .code
28116 550-Your message has been rejected but is being
28117 550-kept for evaluation.
28118 550-If it was a legitimate message, it may still be
28119 550 delivered to the target recipient(s).
28120 .endd
28121 This facility should be used with extreme caution.
28122
28123 .vitem &*control&~=&~freeze*&
28124 .cindex "frozen messages" "forcing in ACL"
28125 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28126 other words, only when a message is being received. If the message is accepted,
28127 it is placed on Exim's queue and frozen. The control applies only to the
28128 current message, not to any subsequent ones that may be received in the same
28129 SMTP connection.
28130
28131 This modifier can optionally be followed by &`/no_tell`&. If the global option
28132 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28133 is told about the freezing), provided all the &*control=freeze*& modifiers that
28134 are obeyed for the current message have the &`/no_tell`& option.
28135
28136 .vitem &*control&~=&~no_delay_flush*&
28137 .cindex "SMTP" "output flushing, disabling for delay"
28138 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28139 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28140 use. This control, as long as it is encountered before the &%delay%& modifier,
28141 disables such output flushing.
28142
28143 .vitem &*control&~=&~no_callout_flush*&
28144 .cindex "SMTP" "output flushing, disabling for callout"
28145 Exim normally flushes SMTP output before performing a callout in an ACL, to
28146 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28147 use. This control, as long as it is encountered before the &%verify%& condition
28148 that causes the callout, disables such output flushing.
28149
28150 .vitem &*control&~=&~no_mbox_unspool*&
28151 This control is available when Exim is compiled with the content scanning
28152 extension. Content scanning may require a copy of the current message, or parts
28153 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28154 or spam scanner. Normally, such copies are deleted when they are no longer
28155 needed. If this control is set, the copies are not deleted. The control applies
28156 only to the current message, not to any subsequent ones that may be received in
28157 the same SMTP connection. It is provided for debugging purposes and is unlikely
28158 to be useful in production.
28159
28160 .vitem &*control&~=&~no_multiline_responses*&
28161 .cindex "multiline responses, suppressing"
28162 This control is permitted for any ACL except the one for non-SMTP messages.
28163 It seems that there are broken clients in use that cannot handle multiline
28164 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28165
28166 If this control is set, multiline SMTP responses from ACL rejections are
28167 suppressed. One way of doing this would have been to put out these responses as
28168 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28169 (&"use multiline responses for more"& it says &-- ha!), and some of the
28170 responses might get close to that. So this facility, which is after all only a
28171 sop to broken clients, is implemented by doing two very easy things:
28172
28173 .ilist
28174 Extra information that is normally output as part of a rejection caused by
28175 sender verification failure is omitted. Only the final line (typically &"sender
28176 verification failed"&) is sent.
28177 .next
28178 If a &%message%& modifier supplies a multiline response, only the first
28179 line is output.
28180 .endlist
28181
28182 The setting of the switch can, of course, be made conditional on the
28183 calling host. Its effect lasts until the end of the SMTP connection.
28184
28185 .vitem &*control&~=&~no_pipelining*&
28186 .cindex "PIPELINING" "suppressing advertising"
28187 This control turns off the advertising of the PIPELINING extension to SMTP in
28188 the current session. To be useful, it must be obeyed before Exim sends its
28189 response to an EHLO command. Therefore, it should normally appear in an ACL
28190 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28191 &%pipelining_advertise_hosts%&.
28192
28193 .vitem &*control&~=&~queue_only*&
28194 .oindex "&%queue_only%&"
28195 .cindex "queueing incoming messages"
28196 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28197 other words, only when a message is being received. If the message is accepted,
28198 it is placed on Exim's queue and left there for delivery by a subsequent queue
28199 runner. No immediate delivery process is started. In other words, it has the
28200 effect as the &%queue_only%& global option. However, the control applies only
28201 to the current message, not to any subsequent ones that may be received in the
28202 same SMTP connection.
28203
28204 .vitem &*control&~=&~submission/*&<&'options'&>
28205 .cindex "message" "submission"
28206 .cindex "submission mode"
28207 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28208 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28209 the current message is a submission from a local MUA. In this case, Exim
28210 operates in &"submission mode"&, and applies certain fixups to the message if
28211 necessary. For example, it adds a &'Date:'& header line if one is not present.
28212 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28213 late (the message has already been created).
28214
28215 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28216 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28217 submission mode; the available options for this control are described there.
28218 The control applies only to the current message, not to any subsequent ones
28219 that may be received in the same SMTP connection.
28220
28221 .vitem &*control&~=&~suppress_local_fixups*&
28222 .cindex "submission fixups, suppressing"
28223 This control applies to locally submitted (non TCP/IP) messages, and is the
28224 complement of &`control = submission`&. It disables the fixups that are
28225 normally applied to locally-submitted messages. Specifically:
28226
28227 .ilist
28228 Any &'Sender:'& header line is left alone (in this respect, it is a
28229 dynamic version of &%local_sender_retain%&).
28230 .next
28231 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28232 .next
28233 There is no check that &'From:'& corresponds to the actual sender.
28234 .endlist ilist
28235
28236 This control may be useful when a remotely-originated message is accepted,
28237 passed to some scanning program, and then re-submitted for delivery. It can be
28238 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28239 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28240 data is read.
28241
28242 &*Note:*& This control applies only to the current message, not to any others
28243 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28244 .endlist vlist
28245
28246
28247 .section "Summary of message fixup control" "SECTsummesfix"
28248 All four possibilities for message fixups can be specified:
28249
28250 .ilist
28251 Locally submitted, fixups applied: the default.
28252 .next
28253 Locally submitted, no fixups applied: use
28254 &`control = suppress_local_fixups`&.
28255 .next
28256 Remotely submitted, no fixups applied: the default.
28257 .next
28258 Remotely submitted, fixups applied: use &`control = submission`&.
28259 .endlist
28260
28261
28262
28263 .section "Adding header lines in ACLs" "SECTaddheadacl"
28264 .cindex "header lines" "adding in an ACL"
28265 .cindex "header lines" "position of added lines"
28266 .cindex "&%add_header%& ACL modifier"
28267 The &%add_header%& modifier can be used to add one or more extra header lines
28268 to an incoming message, as in this example:
28269 .code
28270 warn dnslists = sbl.spamhaus.org : \
28271                 dialup.mail-abuse.org
28272      add_header = X-blacklisted-at: $dnslist_domain
28273 .endd
28274 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28275 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28276 receiving a message). The message must ultimately be accepted for
28277 &%add_header%& to have any significant effect. You can use &%add_header%& with
28278 any ACL verb, including &%deny%& (though this is potentially useful only in a
28279 RCPT ACL).
28280
28281 Headers will not be added to the message if the modifier is used in
28282 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28283
28284 Leading and trailing newlines are removed from
28285 the data for the &%add_header%& modifier; if it then
28286 contains one or more newlines that
28287 are not followed by a space or a tab, it is assumed to contain multiple header
28288 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28289 front of any line that is not a valid header line.
28290
28291 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28292 They are added to the message before processing the DATA and MIME ACLs.
28293 However, if an identical header line is requested more than once, only one copy
28294 is actually added to the message. Further header lines may be accumulated
28295 during the DATA and MIME ACLs, after which they are added to the message, again
28296 with duplicates suppressed. Thus, it is possible to add two identical header
28297 lines to an SMTP message, but only if one is added before DATA and one after.
28298 In the case of non-SMTP messages, new headers are accumulated during the
28299 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28300 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28301 are included in the entry that is written to the reject log.
28302
28303 .cindex "header lines" "added; visibility of"
28304 Header lines are not visible in string expansions
28305 of message headers
28306 until they are added to the
28307 message. It follows that header lines defined in the MAIL, RCPT, and predata
28308 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28309 header lines that are added by the DATA or MIME ACLs are not visible in those
28310 ACLs. Because of this restriction, you cannot use header lines as a way of
28311 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28312 this, you can use ACL variables, as described in section
28313 &<<SECTaclvariables>>&.
28314
28315 The list of headers yet to be added is given by the &%$headers_added%& variable.
28316
28317 The &%add_header%& modifier acts immediately as it is encountered during the
28318 processing of an ACL. Notice the difference between these two cases:
28319 .display
28320 &`accept add_header = ADDED: some text`&
28321 &`       `&<&'some condition'&>
28322
28323 &`accept `&<&'some condition'&>
28324 &`       add_header = ADDED: some text`&
28325 .endd
28326 In the first case, the header line is always added, whether or not the
28327 condition is true. In the second case, the header line is added only if the
28328 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28329 ACL statement. All those that are encountered before a condition fails are
28330 honoured.
28331
28332 .cindex "&%warn%& ACL verb"
28333 For compatibility with previous versions of Exim, a &%message%& modifier for a
28334 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28335 effect only if all the conditions are true, even if it appears before some of
28336 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28337 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28338 are present on a &%warn%& verb, both are processed according to their
28339 specifications.
28340
28341 By default, new header lines are added to a message at the end of the existing
28342 header lines. However, you can specify that any particular header line should
28343 be added right at the start (before all the &'Received:'& lines), immediately
28344 after the first block of &'Received:'& lines, or immediately before any line
28345 that is not a &'Received:'& or &'Resent-something:'& header.
28346
28347 This is done by specifying &":at_start:"&, &":after_received:"&, or
28348 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28349 header line, respectively. (Header text cannot start with a colon, as there has
28350 to be a header name first.) For example:
28351 .code
28352 warn add_header = \
28353        :after_received:X-My-Header: something or other...
28354 .endd
28355 If more than one header line is supplied in a single &%add_header%& modifier,
28356 each one is treated independently and can therefore be placed differently. If
28357 you add more than one line at the start, or after the Received: block, they end
28358 up in reverse order.
28359
28360 &*Warning*&: This facility currently applies only to header lines that are
28361 added in an ACL. It does NOT work for header lines that are added in a
28362 system filter or in a router or transport.
28363
28364
28365
28366 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28367 .cindex "header lines" "removing in an ACL"
28368 .cindex "header lines" "position of removed lines"
28369 .cindex "&%remove_header%& ACL modifier"
28370 The &%remove_header%& modifier can be used to remove one or more header lines
28371 from an incoming message, as in this example:
28372 .code
28373 warn   message        = Remove internal headers
28374        remove_header  = x-route-mail1 : x-route-mail2
28375 .endd
28376 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28377 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28378 receiving a message). The message must ultimately be accepted for
28379 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28380 with any ACL verb, including &%deny%&, though this is really not useful for
28381 any verb that doesn't result in a delivered message.
28382
28383 Headers will not be removed to the message if the modifier is used in
28384 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28385
28386 More than one header can be removed at the same time by using a colon separated
28387 list of header names. The header matching is case insensitive. Wildcards are
28388 not permitted, nor is list expansion performed, so you cannot use hostlists to
28389 create a list of headers, however both connection and message variable expansion
28390 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28391 .code
28392 warn   hosts           = +internal_hosts
28393        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28394 warn   message         = Remove internal headers
28395        remove_header   = $acl_c_ihdrs
28396 .endd
28397 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28398 They are removed from the message before processing the DATA and MIME ACLs.
28399 There is no harm in attempting to remove the same header twice nor is removing
28400 a non-existent header. Further header lines to be removed may be accumulated
28401 during the DATA and MIME ACLs, after which they are removed from the message,
28402 if present. In the case of non-SMTP messages, headers to be removed are
28403 accumulated during the non-SMTP ACLs, and are removed from the message after
28404 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28405 ACL, there really is no effect because there is no logging of what headers
28406 would have been removed.
28407
28408 .cindex "header lines" "removed; visibility of"
28409 Header lines are not visible in string expansions until the DATA phase when it
28410 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28411 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28412 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28413 this restriction, you cannot use header lines as a way of controlling data
28414 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28415 you should instead use ACL variables, as described in section
28416 &<<SECTaclvariables>>&.
28417
28418 The &%remove_header%& modifier acts immediately as it is encountered during the
28419 processing of an ACL. Notice the difference between these two cases:
28420 .display
28421 &`accept remove_header = X-Internal`&
28422 &`       `&<&'some condition'&>
28423
28424 &`accept `&<&'some condition'&>
28425 &`       remove_header = X-Internal`&
28426 .endd
28427 In the first case, the header line is always removed, whether or not the
28428 condition is true. In the second case, the header line is removed only if the
28429 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28430 same ACL statement. All those that are encountered before a condition fails
28431 are honoured.
28432
28433 &*Warning*&: This facility currently applies only to header lines that are
28434 present during ACL processing. It does NOT remove header lines that are added
28435 in a system filter or in a router or transport.
28436
28437
28438
28439
28440 .section "ACL conditions" "SECTaclconditions"
28441 .cindex "&ACL;" "conditions; list of"
28442 Some of the conditions listed in this section are available only when Exim is
28443 compiled with the content-scanning extension. They are included here briefly
28444 for completeness. More detailed descriptions can be found in the discussion on
28445 content scanning in chapter &<<CHAPexiscan>>&.
28446
28447 Not all conditions are relevant in all circumstances. For example, testing
28448 senders and recipients does not make sense in an ACL that is being run as the
28449 result of the arrival of an ETRN command, and checks on message headers can be
28450 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28451 can use the same condition (with different parameters) more than once in the
28452 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28453 The conditions are as follows:
28454
28455
28456 .vlist
28457 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28458 .cindex "&ACL;" "nested"
28459 .cindex "&ACL;" "indirect"
28460 .cindex "&ACL;" "arguments"
28461 .cindex "&%acl%& ACL condition"
28462 The possible values of the argument are the same as for the
28463 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28464 &"accept"& the condition is true; if it returns &"deny"& the condition is
28465 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28466 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28467 condition false. This means that further processing of the &%warn%& verb
28468 ceases, but processing of the ACL continues.
28469
28470 If the argument is a named ACL, up to nine space-separated optional values
28471 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28472 and $acl_narg is set to the count of values.
28473 Previous values of these variables are restored after the call returns.
28474 The name and values are expanded separately.
28475 Note that spaces in complex expansions which are used as arguments
28476 will act as argument separators.
28477
28478 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28479 the connection is dropped. If it returns &"discard"&, the verb must be
28480 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28481 conditions are tested.
28482
28483 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28484 loops. This condition allows you to use different ACLs in different
28485 circumstances. For example, different ACLs can be used to handle RCPT commands
28486 for different local users or different local domains.
28487
28488 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28489 .cindex "&%authenticated%& ACL condition"
28490 .cindex "authentication" "ACL checking"
28491 .cindex "&ACL;" "testing for authentication"
28492 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28493 the name of the authenticator is tested against the list. To test for
28494 authentication by any authenticator, you can set
28495 .code
28496 authenticated = *
28497 .endd
28498
28499 .vitem &*condition&~=&~*&<&'string'&>
28500 .cindex "&%condition%& ACL condition"
28501 .cindex "customizing" "ACL condition"
28502 .cindex "&ACL;" "customized test"
28503 .cindex "&ACL;" "testing, customized"
28504 This feature allows you to make up custom conditions. If the result of
28505 expanding the string is an empty string, the number zero, or one of the strings
28506 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28507 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28508 any other value, some error is assumed to have occurred, and the ACL returns
28509 &"defer"&. However, if the expansion is forced to fail, the condition is
28510 ignored. The effect is to treat it as true, whether it is positive or
28511 negative.
28512
28513 .vitem &*decode&~=&~*&<&'location'&>
28514 .cindex "&%decode%& ACL condition"
28515 This condition is available only when Exim is compiled with the
28516 content-scanning extension, and it is allowed only in the ACL defined by
28517 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28518 If all goes well, the condition is true. It is false only if there are
28519 problems such as a syntax error or a memory shortage. For more details, see
28520 chapter &<<CHAPexiscan>>&.
28521
28522 .vitem &*demime&~=&~*&<&'extension&~list'&>
28523 .cindex "&%demime%& ACL condition"
28524 This condition is available only when Exim is compiled with the
28525 content-scanning extension. Its use is described in section
28526 &<<SECTdemimecond>>&.
28527
28528 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28529 .cindex "&%dnslists%& ACL condition"
28530 .cindex "DNS list" "in ACL"
28531 .cindex "black list (DNS)"
28532 .cindex "&ACL;" "testing a DNS list"
28533 This condition checks for entries in DNS black lists. These are also known as
28534 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28535 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28536 different variants of this condition to describe briefly here. See sections
28537 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28538
28539 .vitem &*domains&~=&~*&<&'domain&~list'&>
28540 .cindex "&%domains%& ACL condition"
28541 .cindex "domain" "ACL checking"
28542 .cindex "&ACL;" "testing a recipient domain"
28543 .vindex "&$domain_data$&"
28544 This condition is relevant only after a RCPT command. It checks that the domain
28545 of the recipient address is in the domain list. If percent-hack processing is
28546 enabled, it is done before this test is done. If the check succeeds with a
28547 lookup, the result of the lookup is placed in &$domain_data$& until the next
28548 &%domains%& test.
28549
28550 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28551 use &%domains%& in a DATA ACL.
28552
28553
28554 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28555 .cindex "&%encrypted%& ACL condition"
28556 .cindex "encryption" "checking in an ACL"
28557 .cindex "&ACL;" "testing for encryption"
28558 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28559 name of the cipher suite in use is tested against the list. To test for
28560 encryption without testing for any specific cipher suite(s), set
28561 .code
28562 encrypted = *
28563 .endd
28564
28565
28566 .vitem &*hosts&~=&~*&<&'host&~list'&>
28567 .cindex "&%hosts%& ACL condition"
28568 .cindex "host" "ACL checking"
28569 .cindex "&ACL;" "testing the client host"
28570 This condition tests that the calling host matches the host list. If you have
28571 name lookups or wildcarded host names and IP addresses in the same host list,
28572 you should normally put the IP addresses first. For example, you could have:
28573 .code
28574 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28575 .endd
28576 The lookup in this example uses the host name for its key. This is implied by
28577 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28578 and it wouldn't matter which way round you had these two items.)
28579
28580 The reason for the problem with host names lies in the left-to-right way that
28581 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28582 but when it reaches an item that requires a host name, it fails if it cannot
28583 find a host name to compare with the pattern. If the above list is given in the
28584 opposite order, the &%accept%& statement fails for a host whose name cannot be
28585 found, even if its IP address is 10.9.8.7.
28586
28587 If you really do want to do the name check first, and still recognize the IP
28588 address even if the name lookup fails, you can rewrite the ACL like this:
28589 .code
28590 accept hosts = dbm;/etc/friendly/hosts
28591 accept hosts = 10.9.8.7
28592 .endd
28593 The default action on failing to find the host name is to assume that the host
28594 is not in the list, so the first &%accept%& statement fails. The second
28595 statement can then check the IP address.
28596
28597 .vindex "&$host_data$&"
28598 If a &%hosts%& condition is satisfied by means of a lookup, the result
28599 of the lookup is made available in the &$host_data$& variable. This
28600 allows you, for example, to set up a statement like this:
28601 .code
28602 deny  hosts = net-lsearch;/some/file
28603 message = $host_data
28604 .endd
28605 which gives a custom error message for each denied host.
28606
28607 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28608 .cindex "&%local_parts%& ACL condition"
28609 .cindex "local part" "ACL checking"
28610 .cindex "&ACL;" "testing a local part"
28611 .vindex "&$local_part_data$&"
28612 This condition is relevant only after a RCPT command. It checks that the local
28613 part of the recipient address is in the list. If percent-hack processing is
28614 enabled, it is done before this test. If the check succeeds with a lookup, the
28615 result of the lookup is placed in &$local_part_data$&, which remains set until
28616 the next &%local_parts%& test.
28617
28618 .vitem &*malware&~=&~*&<&'option'&>
28619 .cindex "&%malware%& ACL condition"
28620 .cindex "&ACL;" "virus scanning"
28621 .cindex "&ACL;" "scanning for viruses"
28622 This condition is available only when Exim is compiled with the
28623 content-scanning extension. It causes the incoming message to be scanned for
28624 viruses. For details, see chapter &<<CHAPexiscan>>&.
28625
28626 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28627 .cindex "&%mime_regex%& ACL condition"
28628 .cindex "&ACL;" "testing by regex matching"
28629 This condition is available only when Exim is compiled with the
28630 content-scanning extension, and it is allowed only in the ACL defined by
28631 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28632 with any of the regular expressions. For details, see chapter
28633 &<<CHAPexiscan>>&.
28634
28635 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28636 .cindex "rate limiting"
28637 This condition can be used to limit the rate at which a user or host submits
28638 messages. Details are given in section &<<SECTratelimiting>>&.
28639
28640 .vitem &*recipients&~=&~*&<&'address&~list'&>
28641 .cindex "&%recipients%& ACL condition"
28642 .cindex "recipient" "ACL checking"
28643 .cindex "&ACL;" "testing a recipient"
28644 This condition is relevant only after a RCPT command. It checks the entire
28645 recipient address against a list of recipients.
28646
28647 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28648 .cindex "&%regex%& ACL condition"
28649 .cindex "&ACL;" "testing by regex matching"
28650 This condition is available only when Exim is compiled with the
28651 content-scanning extension, and is available only in the DATA, MIME, and
28652 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28653 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28654
28655 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28656 .cindex "&%sender_domains%& ACL condition"
28657 .cindex "sender" "ACL checking"
28658 .cindex "&ACL;" "testing a sender domain"
28659 .vindex "&$domain$&"
28660 .vindex "&$sender_address_domain$&"
28661 This condition tests the domain of the sender of the message against the given
28662 domain list. &*Note*&: The domain of the sender address is in
28663 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28664 of this condition. This is an exception to the general rule for testing domain
28665 lists. It is done this way so that, if this condition is used in an ACL for a
28666 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28667 influence the sender checking.
28668
28669 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28670 relaying, because sender addresses are easily, and commonly, forged.
28671
28672 .vitem &*senders&~=&~*&<&'address&~list'&>
28673 .cindex "&%senders%& ACL condition"
28674 .cindex "sender" "ACL checking"
28675 .cindex "&ACL;" "testing a sender"
28676 This condition tests the sender of the message against the given list. To test
28677 for a bounce message, which has an empty sender, set
28678 .code
28679 senders = :
28680 .endd
28681 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28682 relaying, because sender addresses are easily, and commonly, forged.
28683
28684 .vitem &*spam&~=&~*&<&'username'&>
28685 .cindex "&%spam%& ACL condition"
28686 .cindex "&ACL;" "scanning for spam"
28687 This condition is available only when Exim is compiled with the
28688 content-scanning extension. It causes the incoming message to be scanned by
28689 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28690
28691 .vitem &*verify&~=&~certificate*&
28692 .cindex "&%verify%& ACL condition"
28693 .cindex "TLS" "client certificate verification"
28694 .cindex "certificate" "verification of client"
28695 .cindex "&ACL;" "certificate verification"
28696 .cindex "&ACL;" "testing a TLS certificate"
28697 This condition is true in an SMTP session if the session is encrypted, and a
28698 certificate was received from the client, and the certificate was verified. The
28699 server requests a certificate only if the client matches &%tls_verify_hosts%&
28700 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28701
28702 .vitem &*verify&~=&~csa*&
28703 .cindex "CSA verification"
28704 This condition checks whether the sending host (the client) is authorized to
28705 send email. Details of how this works are given in section
28706 &<<SECTverifyCSA>>&.
28707
28708 .vitem &*verify&~=&~header_names_ascii*&
28709 .cindex "&%verify%& ACL condition"
28710 .cindex "&ACL;" "verifying header names only ASCII"
28711 .cindex "header lines" "verifying header names only ASCII"
28712 .cindex "verifying" "header names only ASCII"
28713 This condition is relevant only in an ACL that is run after a message has been
28714 received, that is, in an ACL specified by &%acl_smtp_data%& or
28715 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28716 there are no non-ASCII characters, also excluding control characters.  The
28717 allowable characters are decimal ASCII values 33 through 126.
28718
28719 Exim itself will handle headers with non-ASCII characters, but it can cause
28720 problems for downstream applications, so this option will allow their
28721 detection and rejection in the DATA ACL's.
28722
28723 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28724 .cindex "&%verify%& ACL condition"
28725 .cindex "&ACL;" "verifying sender in the header"
28726 .cindex "header lines" "verifying the sender in"
28727 .cindex "sender" "verifying in header"
28728 .cindex "verifying" "sender in header"
28729 This condition is relevant only in an ACL that is run after a message has been
28730 received, that is, in an ACL specified by &%acl_smtp_data%& or
28731 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28732 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28733 is loosely thought of as a &"sender"& address (hence the name of the test).
28734 However, an address that appears in one of these headers need not be an address
28735 that accepts bounce messages; only sender addresses in envelopes are required
28736 to accept bounces. Therefore, if you use the callout option on this check, you
28737 might want to arrange for a non-empty address in the MAIL command.
28738
28739 Details of address verification and the options are given later, starting at
28740 section &<<SECTaddressverification>>& (callouts are described in section
28741 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28742 condition to restrict it to bounce messages only:
28743 .code
28744 deny    senders = :
28745         message = A valid sender header is required for bounces
28746        !verify  = header_sender
28747 .endd
28748
28749 .vitem &*verify&~=&~header_syntax*&
28750 .cindex "&%verify%& ACL condition"
28751 .cindex "&ACL;" "verifying header syntax"
28752 .cindex "header lines" "verifying syntax"
28753 .cindex "verifying" "header syntax"
28754 This condition is relevant only in an ACL that is run after a message has been
28755 received, that is, in an ACL specified by &%acl_smtp_data%& or
28756 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
28757 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
28758 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
28759 permitted only in locally generated messages and from hosts that match
28760 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
28761 appropriate.
28762
28763 Note that this condition is a syntax check only. However, a common spamming
28764 ploy used to be to send syntactically invalid headers such as
28765 .code
28766 To: @
28767 .endd
28768 and this condition can be used to reject such messages, though they are not as
28769 common as they used to be.
28770
28771 .vitem &*verify&~=&~helo*&
28772 .cindex "&%verify%& ACL condition"
28773 .cindex "&ACL;" "verifying HELO/EHLO"
28774 .cindex "HELO" "verifying"
28775 .cindex "EHLO" "verifying"
28776 .cindex "verifying" "EHLO"
28777 .cindex "verifying" "HELO"
28778 This condition is true if a HELO or EHLO command has been received from the
28779 client host, and its contents have been verified. If there has been no previous
28780 attempt to verify the HELO/EHLO contents, it is carried out when this
28781 condition is encountered. See the description of the &%helo_verify_hosts%& and
28782 &%helo_try_verify_hosts%& options for details of how to request verification
28783 independently of this condition.
28784
28785 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
28786 option), this condition is always true.
28787
28788
28789 .vitem &*verify&~=&~not_blind*&
28790 .cindex "verifying" "not blind"
28791 .cindex "bcc recipients, verifying none"
28792 This condition checks that there are no blind (bcc) recipients in the message.
28793 Every envelope recipient must appear either in a &'To:'& header line or in a
28794 &'Cc:'& header line for this condition to be true. Local parts are checked
28795 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
28796 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
28797 used only in a DATA or non-SMTP ACL.
28798
28799 There are, of course, many legitimate messages that make use of blind (bcc)
28800 recipients. This check should not be used on its own for blocking messages.
28801
28802
28803 .vitem &*verify&~=&~recipient/*&<&'options'&>
28804 .cindex "&%verify%& ACL condition"
28805 .cindex "&ACL;" "verifying recipient"
28806 .cindex "recipient" "verifying"
28807 .cindex "verifying" "recipient"
28808 .vindex "&$address_data$&"
28809 This condition is relevant only after a RCPT command. It verifies the current
28810 recipient. Details of address verification are given later, starting at section
28811 &<<SECTaddressverification>>&. After a recipient has been verified, the value
28812 of &$address_data$& is the last value that was set while routing the address.
28813 This applies even if the verification fails. When an address that is being
28814 verified is redirected to a single address, verification continues with the new
28815 address, and in that case, the subsequent value of &$address_data$& is the
28816 value for the child address.
28817
28818 .vitem &*verify&~=&~reverse_host_lookup*&
28819 .cindex "&%verify%& ACL condition"
28820 .cindex "&ACL;" "verifying host reverse lookup"
28821 .cindex "host" "verifying reverse lookup"
28822 This condition ensures that a verified host name has been looked up from the IP
28823 address of the client host. (This may have happened already if the host name
28824 was needed for checking a host list, or if the host matched &%host_lookup%&.)
28825 Verification ensures that the host name obtained from a reverse DNS lookup, or
28826 one of its aliases, does, when it is itself looked up in the DNS, yield the
28827 original IP address.
28828
28829 If this condition is used for a locally generated message (that is, when there
28830 is no client host involved), it always succeeds.
28831
28832 .vitem &*verify&~=&~sender/*&<&'options'&>
28833 .cindex "&%verify%& ACL condition"
28834 .cindex "&ACL;" "verifying sender"
28835 .cindex "sender" "verifying"
28836 .cindex "verifying" "sender"
28837 This condition is relevant only after a MAIL or RCPT command, or after a
28838 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
28839 the message's sender is empty (that is, this is a bounce message), the
28840 condition is true. Otherwise, the sender address is verified.
28841
28842 .vindex "&$address_data$&"
28843 .vindex "&$sender_address_data$&"
28844 If there is data in the &$address_data$& variable at the end of routing, its
28845 value is placed in &$sender_address_data$& at the end of verification. This
28846 value can be used in subsequent conditions and modifiers in the same ACL
28847 statement. It does not persist after the end of the current statement. If you
28848 want to preserve the value for longer, you can save it in an ACL variable.
28849
28850 Details of verification are given later, starting at section
28851 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
28852 to avoid doing it more than once per message.
28853
28854 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
28855 .cindex "&%verify%& ACL condition"
28856 This is a variation of the previous option, in which a modified address is
28857 verified as a sender.
28858 .endlist
28859
28860
28861
28862 .section "Using DNS lists" "SECTmorednslists"
28863 .cindex "DNS list" "in ACL"
28864 .cindex "black list (DNS)"
28865 .cindex "&ACL;" "testing a DNS list"
28866 In its simplest form, the &%dnslists%& condition tests whether the calling host
28867 is on at least one of a number of DNS lists by looking up the inverted IP
28868 address in one or more DNS domains. (Note that DNS list domains are not mail
28869 domains, so the &`+`& syntax for named lists doesn't work - it is used for
28870 special options instead.) For example, if the calling host's IP
28871 address is 192.168.62.43, and the ACL statement is
28872 .code
28873 deny dnslists = blackholes.mail-abuse.org : \
28874                 dialups.mail-abuse.org
28875 .endd
28876 the following records are looked up:
28877 .code
28878 43.62.168.192.blackholes.mail-abuse.org
28879 43.62.168.192.dialups.mail-abuse.org
28880 .endd
28881 As soon as Exim finds an existing DNS record, processing of the list stops.
28882 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
28883 to test that a host is on more than one list (an &"and"& conjunction), you can
28884 use two separate conditions:
28885 .code
28886 deny dnslists = blackholes.mail-abuse.org
28887      dnslists = dialups.mail-abuse.org
28888 .endd
28889 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
28890 behaves as if the host does not match the list item, that is, as if the DNS
28891 record does not exist. If there are further items in the DNS list, they are
28892 processed.
28893
28894 This is usually the required action when &%dnslists%& is used with &%deny%&
28895 (which is the most common usage), because it prevents a DNS failure from
28896 blocking mail. However, you can change this behaviour by putting one of the
28897 following special items in the list:
28898 .display
28899 &`+include_unknown `&   behave as if the item is on the list
28900 &`+exclude_unknown `&   behave as if the item is not on the list (default)
28901 &`+defer_unknown   `&   give a temporary error
28902 .endd
28903 .cindex "&`+include_unknown`&"
28904 .cindex "&`+exclude_unknown`&"
28905 .cindex "&`+defer_unknown`&"
28906 Each of these applies to any subsequent items on the list. For example:
28907 .code
28908 deny dnslists = +defer_unknown : foo.bar.example
28909 .endd
28910 Testing the list of domains stops as soon as a match is found. If you want to
28911 warn for one list and block for another, you can use two different statements:
28912 .code
28913 deny  dnslists = blackholes.mail-abuse.org
28914 warn  message  = X-Warn: sending host is on dialups list
28915       dnslists = dialups.mail-abuse.org
28916 .endd
28917 DNS list lookups are cached by Exim for the duration of the SMTP session,
28918 so a lookup based on the IP address is done at most once for any incoming
28919 connection. Exim does not share information between multiple incoming
28920 connections (but your local name server cache should be active).
28921
28922
28923
28924 .section "Specifying the IP address for a DNS list lookup" "SECID201"
28925 .cindex "DNS list" "keyed by explicit IP address"
28926 By default, the IP address that is used in a DNS list lookup is the IP address
28927 of the calling host. However, you can specify another IP address by listing it
28928 after the domain name, introduced by a slash. For example:
28929 .code
28930 deny dnslists = black.list.tld/192.168.1.2
28931 .endd
28932 This feature is not very helpful with explicit IP addresses; it is intended for
28933 use with IP addresses that are looked up, for example, the IP addresses of the
28934 MX hosts or nameservers of an email sender address. For an example, see section
28935 &<<SECTmulkeyfor>>& below.
28936
28937
28938
28939
28940 .section "DNS lists keyed on domain names" "SECID202"
28941 .cindex "DNS list" "keyed by domain name"
28942 There are some lists that are keyed on domain names rather than inverted IP
28943 addresses (see for example the &'domain based zones'& link at
28944 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
28945 with these lists. You can change the name that is looked up in a DNS list by
28946 listing it after the domain name, introduced by a slash. For example,
28947 .code
28948 deny  message  = Sender's domain is listed at $dnslist_domain
28949       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
28950 .endd
28951 This particular example is useful only in ACLs that are obeyed after the
28952 RCPT or DATA commands, when a sender address is available. If (for
28953 example) the message's sender is &'user@tld.example'& the name that is looked
28954 up by this example is
28955 .code
28956 tld.example.dsn.rfc-ignorant.org
28957 .endd
28958 A single &%dnslists%& condition can contain entries for both names and IP
28959 addresses. For example:
28960 .code
28961 deny dnslists = sbl.spamhaus.org : \
28962                 dsn.rfc-ignorant.org/$sender_address_domain
28963 .endd
28964 The first item checks the sending host's IP address; the second checks a domain
28965 name. The whole condition is true if either of the DNS lookups succeeds.
28966
28967
28968
28969
28970 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
28971 .cindex "DNS list" "multiple keys for"
28972 The syntax described above for looking up explicitly-defined values (either
28973 names or IP addresses) in a DNS blacklist is a simplification. After the domain
28974 name for the DNS list, what follows the slash can in fact be a list of items.
28975 As with all lists in Exim, the default separator is a colon. However, because
28976 this is a sublist within the list of DNS blacklist domains, it is necessary
28977 either to double the separators like this:
28978 .code
28979 dnslists = black.list.tld/name.1::name.2
28980 .endd
28981 or to change the separator character, like this:
28982 .code
28983 dnslists = black.list.tld/<;name.1;name.2
28984 .endd
28985 If an item in the list is an IP address, it is inverted before the DNS
28986 blacklist domain is appended. If it is not an IP address, no inversion
28987 occurs. Consider this condition:
28988 .code
28989 dnslists = black.list.tld/<;192.168.1.2;a.domain
28990 .endd
28991 The DNS lookups that occur are:
28992 .code
28993 2.1.168.192.black.list.tld
28994 a.domain.black.list.tld
28995 .endd
28996 Once a DNS record has been found (that matches a specific IP return
28997 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
28998 are done. If there is a temporary DNS error, the rest of the sublist of domains
28999 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29000 only if no other DNS lookup in this sublist succeeds. In other words, a
29001 successful lookup for any of the items in the sublist overrides a temporary
29002 error for a previous item.
29003
29004 The ability to supply a list of items after the slash is in some sense just a
29005 syntactic convenience. These two examples have the same effect:
29006 .code
29007 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29008 dnslists = black.list.tld/a.domain::b.domain
29009 .endd
29010 However, when the data for the list is obtained from a lookup, the second form
29011 is usually much more convenient. Consider this example:
29012 .code
29013 deny message  = The mail servers for the domain \
29014                 $sender_address_domain \
29015                 are listed at $dnslist_domain ($dnslist_value); \
29016                 see $dnslist_text.
29017      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29018                                    ${lookup dnsdb {>|mxh=\
29019                                    $sender_address_domain} }} }
29020 .endd
29021 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29022 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29023 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29024 of expanding the condition might be something like this:
29025 .code
29026 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29027 .endd
29028 Thus, this example checks whether or not the IP addresses of the sender
29029 domain's mail servers are on the Spamhaus black list.
29030
29031 The key that was used for a successful DNS list lookup is put into the variable
29032 &$dnslist_matched$& (see section &<<SECID204>>&).
29033
29034
29035
29036
29037 .section "Data returned by DNS lists" "SECID203"
29038 .cindex "DNS list" "data returned from"
29039 DNS lists are constructed using address records in the DNS. The original RBL
29040 just used the address 127.0.0.1 on the right hand side of each record, but the
29041 RBL+ list and some other lists use a number of values with different meanings.
29042 The values used on the RBL+ list are:
29043 .display
29044 127.1.0.1  RBL
29045 127.1.0.2  DUL
29046 127.1.0.3  DUL and RBL
29047 127.1.0.4  RSS
29048 127.1.0.5  RSS and RBL
29049 127.1.0.6  RSS and DUL
29050 127.1.0.7  RSS and DUL and RBL
29051 .endd
29052 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29053 different values. Some DNS lists may return more than one address record;
29054 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29055
29056
29057 .section "Variables set from DNS lists" "SECID204"
29058 .cindex "expansion" "variables, set from DNS list"
29059 .cindex "DNS list" "variables set from"
29060 .vindex "&$dnslist_domain$&"
29061 .vindex "&$dnslist_matched$&"
29062 .vindex "&$dnslist_text$&"
29063 .vindex "&$dnslist_value$&"
29064 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29065 the name of the overall domain that matched (for example,
29066 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29067 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29068 the DNS record. When the key is an IP address, it is not reversed in
29069 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29070 cases, for example:
29071 .code
29072 deny dnslists = spamhaus.example
29073 .endd
29074 the key is also available in another variable (in this case,
29075 &$sender_host_address$&). In more complicated cases, however, this is not true.
29076 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29077 might generate a dnslists lookup like this:
29078 .code
29079 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29080 .endd
29081 If this condition succeeds, the value in &$dnslist_matched$& might be
29082 &`192.168.6.7`& (for example).
29083
29084 If more than one address record is returned by the DNS lookup, all the IP
29085 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29086 The variable &$dnslist_text$& contains the contents of any associated TXT
29087 record. For lists such as RBL+ the TXT record for a merged entry is often not
29088 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29089 information.
29090
29091 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29092 &-- although these appear before the condition in the ACL, they are not
29093 expanded until after it has failed. For example:
29094 .code
29095 deny    hosts = !+local_networks
29096         message = $sender_host_address is listed \
29097                   at $dnslist_domain
29098         dnslists = rbl-plus.mail-abuse.example
29099 .endd
29100
29101
29102
29103 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29104 .cindex "DNS list" "matching specific returned data"
29105 You can add an equals sign and an IP address after a &%dnslists%& domain name
29106 in order to restrict its action to DNS records with a matching right hand side.
29107 For example,
29108 .code
29109 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29110 .endd
29111 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29112 any address record is considered to be a match. For the moment, we assume
29113 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29114 describes how multiple records are handled.
29115
29116 More than one IP address may be given for checking, using a comma as a
29117 separator. These are alternatives &-- if any one of them matches, the
29118 &%dnslists%& condition is true. For example:
29119 .code
29120 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29121 .endd
29122 If you want to specify a constraining address list and also specify names or IP
29123 addresses to be looked up, the constraining address list must be specified
29124 first. For example:
29125 .code
29126 deny dnslists = dsn.rfc-ignorant.org\
29127                 =127.0.0.2/$sender_address_domain
29128 .endd
29129
29130 If the character &`&&`& is used instead of &`=`&, the comparison for each
29131 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29132 In other words, the listed addresses are used as bit masks. The comparison is
29133 true if all the bits in the mask are present in the address that is being
29134 tested. For example:
29135 .code
29136 dnslists = a.b.c&0.0.0.3
29137 .endd
29138 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29139 want to test whether one bit or another bit is present (as opposed to both
29140 being present), you must use multiple values. For example:
29141 .code
29142 dnslists = a.b.c&0.0.0.1,0.0.0.2
29143 .endd
29144 matches if the final component of the address is an odd number or two times
29145 an odd number.
29146
29147
29148
29149 .section "Negated DNS matching conditions" "SECID205"
29150 You can supply a negative list of IP addresses as part of a &%dnslists%&
29151 condition. Whereas
29152 .code
29153 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29154 .endd
29155 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29156 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29157 .code
29158 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29159 .endd
29160 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29161 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29162 words, the result of the test is inverted if an exclamation mark appears before
29163 the &`=`& (or the &`&&`&) sign.
29164
29165 &*Note*&: This kind of negation is not the same as negation in a domain,
29166 host, or address list (which is why the syntax is different).
29167
29168 If you are using just one list, the negation syntax does not gain you much. The
29169 previous example is precisely equivalent to
29170 .code
29171 deny  dnslists = a.b.c
29172      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29173 .endd
29174 However, if you are using multiple lists, the negation syntax is clearer.
29175 Consider this example:
29176 .code
29177 deny  dnslists = sbl.spamhaus.org : \
29178                  list.dsbl.org : \
29179                  dnsbl.njabl.org!=127.0.0.3 : \
29180                  relays.ordb.org
29181 .endd
29182 Using only positive lists, this would have to be:
29183 .code
29184 deny  dnslists = sbl.spamhaus.org : \
29185                  list.dsbl.org
29186 deny  dnslists = dnsbl.njabl.org
29187      !dnslists = dnsbl.njabl.org=127.0.0.3
29188 deny  dnslists = relays.ordb.org
29189 .endd
29190 which is less clear, and harder to maintain.
29191
29192
29193
29194
29195 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29196 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29197 thereby providing more than one IP address. When an item in a &%dnslists%& list
29198 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29199 the match to specific results from the DNS lookup, there are two ways in which
29200 the checking can be handled. For example, consider the condition:
29201 .code
29202 dnslists = a.b.c=127.0.0.1
29203 .endd
29204 What happens if the DNS lookup for the incoming IP address yields both
29205 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29206 condition true because at least one given value was found, or is it false
29207 because at least one of the found values was not listed? And how does this
29208 affect negated conditions? Both possibilities are provided for with the help of
29209 additional separators &`==`& and &`=&&`&.
29210
29211 .ilist
29212 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29213 IP addresses matches one of the listed addresses. For the example above, the
29214 condition is true because 127.0.0.1 matches.
29215 .next
29216 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29217 looked up IP addresses matches one of the listed addresses. If the condition is
29218 changed to:
29219 .code
29220 dnslists = a.b.c==127.0.0.1
29221 .endd
29222 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29223 false because 127.0.0.2 is not listed. You would need to have:
29224 .code
29225 dnslists = a.b.c==127.0.0.1,127.0.0.2
29226 .endd
29227 for the condition to be true.
29228 .endlist
29229
29230 When &`!`& is used to negate IP address matching, it inverts the result, giving
29231 the precise opposite of the behaviour above. Thus:
29232 .ilist
29233 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29234 addresses matches one of the listed addresses. Consider:
29235 .code
29236 dnslists = a.b.c!&0.0.0.1
29237 .endd
29238 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29239 false because 127.0.0.1 matches.
29240 .next
29241 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29242 looked up IP address that does not match. Consider:
29243 .code
29244 dnslists = a.b.c!=&0.0.0.1
29245 .endd
29246 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29247 true, because 127.0.0.2 does not match. You would need to have:
29248 .code
29249 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29250 .endd
29251 for the condition to be false.
29252 .endlist
29253 When the DNS lookup yields only a single IP address, there is no difference
29254 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29255
29256
29257
29258
29259 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29260 .cindex "DNS list" "information from merged"
29261 When the facility for restricting the matching IP values in a DNS list is used,
29262 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29263 the true reason for rejection. This happens when lists are merged and the IP
29264 address in the A record is used to distinguish them; unfortunately there is
29265 only one TXT record. One way round this is not to use merged lists, but that
29266 can be inefficient because it requires multiple DNS lookups where one would do
29267 in the vast majority of cases when the host of interest is not on any of the
29268 lists.
29269
29270 A less inefficient way of solving this problem is available. If
29271 two domain names, comma-separated, are given, the second is used first to
29272 do an initial check, making use of any IP value restrictions that are set.
29273 If there is a match, the first domain is used, without any IP value
29274 restrictions, to get the TXT record. As a byproduct of this, there is also
29275 a check that the IP being tested is indeed on the first list. The first
29276 domain is the one that is put in &$dnslist_domain$&. For example:
29277 .code
29278 reject message  = \
29279          rejected because $sender_host_address is blacklisted \
29280          at $dnslist_domain\n$dnslist_text
29281        dnslists = \
29282          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29283          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29284 .endd
29285 For the first blacklist item, this starts by doing a lookup in
29286 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29287 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29288 value, and as long as something is found, it looks for the corresponding TXT
29289 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29290 The second blacklist item is processed similarly.
29291
29292 If you are interested in more than one merged list, the same list must be
29293 given several times, but because the results of the DNS lookups are cached,
29294 the DNS calls themselves are not repeated. For example:
29295 .code
29296 reject dnslists = \
29297          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29298          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29299          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29300          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29301 .endd
29302 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29303 values matches (or if no record is found), this is the only lookup that is
29304 done. Only if there is a match is one of the more specific lists consulted.
29305
29306
29307
29308 .section "DNS lists and IPv6" "SECTmorednslistslast"
29309 .cindex "IPv6" "DNS black lists"
29310 .cindex "DNS list" "IPv6 usage"
29311 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29312 nibble by nibble. For example, if the calling host's IP address is
29313 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29314 .code
29315 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29316   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29317 .endd
29318 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29319 lists contain wildcard records, intended for IPv4, that interact badly with
29320 IPv6. For example, the DNS entry
29321 .code
29322 *.3.some.list.example.    A    127.0.0.1
29323 .endd
29324 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29325 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29326
29327 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29328 &%condition%& condition, as in this example:
29329 .code
29330 deny   condition = ${if isip4{$sender_host_address}}
29331        dnslists  = some.list.example
29332 .endd
29333
29334 If an explicit key is being used for a DNS lookup and it may be an IPv6
29335 address you should specify alternate list separators for both the outer
29336 (DNS list name) list and inner (lookup keys) list:
29337 .code
29338        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29339 .endd
29340
29341 .section "Rate limiting incoming messages" "SECTratelimiting"
29342 .cindex "rate limiting" "client sending"
29343 .cindex "limiting client sending rates"
29344 .oindex "&%smtp_ratelimit_*%&"
29345 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29346 which clients can send email. This is more powerful than the
29347 &%smtp_ratelimit_*%& options, because those options control the rate of
29348 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29349 works across all connections (concurrent and sequential) from the same client
29350 host. The syntax of the &%ratelimit%& condition is:
29351 .display
29352 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29353 .endd
29354 If the average client sending rate is less than &'m'& messages per time
29355 period &'p'& then the condition is false; otherwise it is true.
29356
29357 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29358 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29359 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29360 of &'p'&.
29361
29362 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29363 time interval, for example, &`8h`& for eight hours. A larger time constant
29364 means that it takes Exim longer to forget a client's past behaviour. The
29365 parameter &'m'& is the maximum number of messages that a client is permitted to
29366 send in each time interval. It also specifies the number of messages permitted
29367 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29368 constant, you can allow a client to send more messages in a burst without
29369 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29370 both small, messages must be sent at an even rate.
29371
29372 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29373 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29374 when deploying the &%ratelimit%& ACL condition. The script prints usage
29375 instructions when it is run with no arguments.
29376
29377 The key is used to look up the data for calculating the client's average
29378 sending rate. This data is stored in Exim's spool directory, alongside the
29379 retry and other hints databases. The default key is &$sender_host_address$&,
29380 which means Exim computes the sending rate of each client host IP address.
29381 By changing the key you can change how Exim identifies clients for the purpose
29382 of ratelimiting. For example, to limit the sending rate of each authenticated
29383 user, independent of the computer they are sending from, set the key to
29384 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29385 example, &$authenticated_id$& is only meaningful if the client has
29386 authenticated (which you can check with the &%authenticated%& ACL condition).
29387
29388 The lookup key does not have to identify clients: If you want to limit the
29389 rate at which a recipient receives messages, you can use the key
29390 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29391 ACL.
29392
29393 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29394 specifies what Exim measures the rate of, for example messages or recipients
29395 or bytes. You can adjust the measurement using the &%unique=%& and/or
29396 &%count=%& options. You can also control when Exim updates the recorded rate
29397 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29398 separated by a slash, like the other parameters. They may appear in any order.
29399
29400 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29401 any options that alter the meaning of the stored data. The limit &'m'& is not
29402 stored, so you can alter the configured maximum rate and Exim will still
29403 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29404 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29405 behaviour. The lookup key is not affected by changes to the update mode and
29406 the &%count=%& option.
29407
29408
29409 .section "Ratelimit options for what is being measured" "ratoptmea"
29410 .cindex "rate limiting" "per_* options"
29411 The &%per_conn%& option limits the client's connection rate. It is not
29412 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29413 &%acl_not_smtp_start%& ACLs.
29414
29415 The &%per_mail%& option limits the client's rate of sending messages. This is
29416 the default if none of the &%per_*%& options is specified. It can be used in
29417 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29418 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29419
29420 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29421 the same ACLs as the &%per_mail%& option, though it is best to use this option
29422 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29423 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29424 in its MAIL command, which may be inaccurate or completely missing. You can
29425 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29426 in kilobytes, megabytes, or gigabytes, respectively.
29427
29428 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29429 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29430 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29431 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29432 ACLs the rate is updated with the total recipient count in one go. Note that
29433 in either case the rate limiting engine will see a message with many
29434 recipients as a large high-speed burst.
29435
29436 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29437 number of different recipients that the client has sent messages to in the
29438 last time period. That is, if the client repeatedly sends messages to the same
29439 recipient, its measured rate is not increased. This option can only be used in
29440 &%acl_smtp_rcpt%&.
29441
29442 The &%per_cmd%& option causes Exim to recompute the rate every time the
29443 condition is processed. This can be used to limit the rate of any SMTP
29444 command. If it is used in multiple ACLs it can limit the aggregate rate of
29445 multiple different commands.
29446
29447 The &%count=%& option can be used to alter how much Exim adds to the client's
29448 measured rate. For example, the &%per_byte%& option is equivalent to
29449 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29450 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29451 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29452
29453 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29454
29455
29456 .section "Ratelimit update modes" "ratoptupd"
29457 .cindex "rate limiting" "reading data without updating"
29458 You can specify one of three options with the &%ratelimit%& condition to
29459 control when its database is updated. This section describes the &%readonly%&
29460 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29461
29462 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29463 previously-computed rate to check against the limit.
29464
29465 For example, you can test the client's sending rate and deny it access (when
29466 it is too fast) in the connect ACL. If the client passes this check then it
29467 can go on to send a message, in which case its recorded rate will be updated
29468 in the MAIL ACL. Subsequent connections from the same client will check this
29469 new rate.
29470 .code
29471 acl_check_connect:
29472  deny ratelimit = 100 / 5m / readonly
29473     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29474                   (max $sender_rate_limit)
29475 # ...
29476 acl_check_mail:
29477  warn ratelimit = 100 / 5m / strict
29478     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29479                   (max $sender_rate_limit)
29480 .endd
29481
29482 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29483 processing a message then it may increase the client's measured rate more than
29484 it should. For example, this will happen if you check the &%per_rcpt%& option
29485 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29486 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29487 multiple update problems by using the &%readonly%& option on later ratelimit
29488 checks.
29489
29490 The &%per_*%& options described above do not make sense in some ACLs. If you
29491 use a &%per_*%& option in an ACL where it is not normally permitted then the
29492 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29493 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29494 next section) so you must specify the &%readonly%& option explicitly.
29495
29496
29497 .section "Ratelimit options for handling fast clients" "ratoptfast"
29498 .cindex "rate limiting" "strict and leaky modes"
29499 If a client's average rate is greater than the maximum, the rate limiting
29500 engine can react in two possible ways, depending on the presence of the
29501 &%strict%& or &%leaky%& update modes. This is independent of the other
29502 counter-measures (such as rejecting the message) that may be specified by the
29503 rest of the ACL.
29504
29505 The &%leaky%& (default) option means that the client's recorded rate is not
29506 updated if it is above the limit. The effect of this is that Exim measures the
29507 client's average rate of successfully sent email, which cannot be greater than
29508 the maximum allowed. If the client is over the limit it may suffer some
29509 counter-measures (as specified in the ACL), but it will still be able to send
29510 email at the configured maximum rate, whatever the rate of its attempts. This
29511 is generally the better choice if you have clients that retry automatically.
29512 For example, it does not prevent a sender with an over-aggressive retry rate
29513 from getting any email through.
29514
29515 The &%strict%& option means that the client's recorded rate is always
29516 updated. The effect of this is that Exim measures the client's average rate
29517 of attempts to send email, which can be much higher than the maximum it is
29518 actually allowed. If the client is over the limit it may be subjected to
29519 counter-measures by the ACL. It must slow down and allow sufficient time to
29520 pass that its computed rate falls below the maximum before it can send email
29521 again. The time (the number of smoothing periods) it must wait and not
29522 attempt to send mail can be calculated with this formula:
29523 .code
29524         ln(peakrate/maxrate)
29525 .endd
29526
29527
29528 .section "Limiting the rate of different events" "ratoptuniq"
29529 .cindex "rate limiting" "counting unique events"
29530 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29531 rate of different events. For example, the &%per_addr%& option uses this
29532 mechanism to count the number of different recipients that the client has
29533 sent messages to in the last time period; it is equivalent to
29534 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29535 measure the rate that a client uses different sender addresses with the
29536 options &`per_mail/unique=$sender_address`&.
29537
29538 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29539 has seen for that key. The whole set is thrown away when it is older than the
29540 rate smoothing period &'p'&, so each different event is counted at most once
29541 per period. In the &%leaky%& update mode, an event that causes the client to
29542 go over the limit is not added to the set, in the same way that the client's
29543 recorded rate is not updated in the same situation.
29544
29545 When you combine the &%unique=%& and &%readonly%& options, the specific
29546 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29547 rate.
29548
29549 The &%unique=%& mechanism needs more space in the ratelimit database than the
29550 other &%ratelimit%& options in order to store the event set. The number of
29551 unique values is potentially as large as the rate limit, so the extra space
29552 required increases with larger limits.
29553
29554 The uniqueification is not perfect: there is a small probability that Exim
29555 will think a new event has happened before. If the sender's rate is less than
29556 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29557 the measured rate can go above the limit, in which case Exim may under-count
29558 events by a significant margin. Fortunately, if the rate is high enough (2.7
29559 times the limit) that the false positive rate goes above 9%, then Exim will
29560 throw away the over-full event set before the measured rate falls below the
29561 limit. Therefore the only harm should be that exceptionally high sending rates
29562 are logged incorrectly; any countermeasures you configure will be as effective
29563 as intended.
29564
29565
29566 .section "Using rate limiting" "useratlim"
29567 Exim's other ACL facilities are used to define what counter-measures are taken
29568 when the rate limit is exceeded. This might be anything from logging a warning
29569 (for example, while measuring existing sending rates in order to define
29570 policy), through time delays to slow down fast senders, up to rejecting the
29571 message. For example:
29572 .code
29573 # Log all senders' rates
29574 warn ratelimit = 0 / 1h / strict
29575      log_message = Sender rate $sender_rate / $sender_rate_period
29576
29577 # Slow down fast senders; note the need to truncate $sender_rate
29578 # at the decimal point.
29579 warn ratelimit = 100 / 1h / per_rcpt / strict
29580      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29581                    $sender_rate_limit }s
29582
29583 # Keep authenticated users under control
29584 deny authenticated = *
29585      ratelimit = 100 / 1d / strict / $authenticated_id
29586
29587 # System-wide rate limit
29588 defer message = Sorry, too busy. Try again later.
29589      ratelimit = 10 / 1s / $primary_hostname
29590
29591 # Restrict incoming rate from each host, with a default
29592 # set using a macro and special cases looked up in a table.
29593 defer message = Sender rate exceeds $sender_rate_limit \
29594                messages per $sender_rate_period
29595      ratelimit = ${lookup {$sender_host_address} \
29596                    cdb {DB/ratelimits.cdb} \
29597                    {$value} {RATELIMIT} }
29598 .endd
29599 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29600 especially with the &%per_rcpt%& option, you may suffer from a performance
29601 bottleneck caused by locking on the ratelimit hints database. Apart from
29602 making your ACLs less complicated, you can reduce the problem by using a
29603 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29604 this means that Exim will lose its hints data after a reboot (including retry
29605 hints, the callout cache, and ratelimit data).
29606
29607
29608
29609 .section "Address verification" "SECTaddressverification"
29610 .cindex "verifying address" "options for"
29611 .cindex "policy control" "address verification"
29612 Several of the &%verify%& conditions described in section
29613 &<<SECTaclconditions>>& cause addresses to be verified. Section
29614 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29615 The verification conditions can be followed by options that modify the
29616 verification process. The options are separated from the keyword and from each
29617 other by slashes, and some of them contain parameters. For example:
29618 .code
29619 verify = sender/callout
29620 verify = recipient/defer_ok/callout=10s,defer_ok
29621 .endd
29622 The first stage of address verification, which always happens, is to run the
29623 address through the routers, in &"verify mode"&. Routers can detect the
29624 difference between verification and routing for delivery, and their actions can
29625 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29626 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29627 The available options are as follows:
29628
29629 .ilist
29630 If the &%callout%& option is specified, successful routing to one or more
29631 remote hosts is followed by a &"callout"& to those hosts as an additional
29632 check. Callouts and their sub-options are discussed in the next section.
29633 .next
29634 If there is a defer error while doing verification routing, the ACL
29635 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29636 options, the condition is forced to be true instead. Note that this is a main
29637 verification option as well as a suboption for callouts.
29638 .next
29639 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29640 discusses the reporting of sender address verification failures.
29641 .next
29642 The &%success_on_redirect%& option causes verification always to succeed
29643 immediately after a successful redirection. By default, if a redirection
29644 generates just one address, that address is also verified. See further
29645 discussion in section &<<SECTredirwhilveri>>&.
29646 .endlist
29647
29648 .cindex "verifying address" "differentiating failures"
29649 .vindex "&$recipient_verify_failure$&"
29650 .vindex "&$sender_verify_failure$&"
29651 .vindex "&$acl_verify_message$&"
29652 After an address verification failure, &$acl_verify_message$& contains the
29653 error message that is associated with the failure. It can be preserved by
29654 coding like this:
29655 .code
29656 warn  !verify = sender
29657        set acl_m0 = $acl_verify_message
29658 .endd
29659 If you are writing your own custom rejection message or log message when
29660 denying access, you can use this variable to include information about the
29661 verification failure.
29662
29663 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29664 appropriate) contains one of the following words:
29665
29666 .ilist
29667 &%qualify%&: The address was unqualified (no domain), and the message
29668 was neither local nor came from an exempted host.
29669 .next
29670 &%route%&: Routing failed.
29671 .next
29672 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29673 occurred at or before the MAIL command (that is, on initial
29674 connection, HELO, or MAIL).
29675 .next
29676 &%recipient%&: The RCPT command in a callout was rejected.
29677 .next
29678 &%postmaster%&: The postmaster check in a callout was rejected.
29679 .endlist
29680
29681 The main use of these variables is expected to be to distinguish between
29682 rejections of MAIL and rejections of RCPT in callouts.
29683
29684
29685
29686
29687 .section "Callout verification" "SECTcallver"
29688 .cindex "verifying address" "by callout"
29689 .cindex "callout" "verification"
29690 .cindex "SMTP" "callout verification"
29691 For non-local addresses, routing verifies the domain, but is unable to do any
29692 checking of the local part. There are situations where some means of verifying
29693 the local part is desirable. One way this can be done is to make an SMTP
29694 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29695 a subsequent host for a recipient address, to see if the host accepts the
29696 address. We use the term &'callout'& to cover both cases. Note that for a
29697 sender address, the callback is not to the client host that is trying to
29698 deliver the message, but to one of the hosts that accepts incoming mail for the
29699 sender's domain.
29700
29701 Exim does not do callouts by default. If you want them to happen, you must
29702 request them by setting appropriate options on the &%verify%& condition, as
29703 described below. This facility should be used with care, because it can add a
29704 lot of resource usage to the cost of verifying an address. However, Exim does
29705 cache the results of callouts, which helps to reduce the cost. Details of
29706 caching are in section &<<SECTcallvercache>>&.
29707
29708 Recipient callouts are usually used only between hosts that are controlled by
29709 the same administration. For example, a corporate gateway host could use
29710 callouts to check for valid recipients on an internal mailserver. A successful
29711 callout does not guarantee that a real delivery to the address would succeed;
29712 on the other hand, a failing callout does guarantee that a delivery would fail.
29713
29714 If the &%callout%& option is present on a condition that verifies an address, a
29715 second stage of verification occurs if the address is successfully routed to
29716 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29717 &(manualroute)& router, where the router specifies the hosts. However, if a
29718 router that does not set up hosts routes to an &(smtp)& transport with a
29719 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29720 &%hosts_override%& set, its hosts are always used, whether or not the router
29721 supplies a host list.
29722 Callouts are only supported on &(smtp)& transports.
29723
29724 The port that is used is taken from the transport, if it is specified and is a
29725 remote transport. (For routers that do verification only, no transport need be
29726 specified.) Otherwise, the default SMTP port is used. If a remote transport
29727 specifies an outgoing interface, this is used; otherwise the interface is not
29728 specified. Likewise, the text that is used for the HELO command is taken from
29729 the transport's &%helo_data%& option; if there is no transport, the value of
29730 &$smtp_active_hostname$& is used.
29731
29732 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29733 test whether a bounce message could be delivered to the sender address. The
29734 following SMTP commands are sent:
29735 .display
29736 &`HELO `&<&'local host name'&>
29737 &`MAIL FROM:<>`&
29738 &`RCPT TO:`&<&'the address to be tested'&>
29739 &`QUIT`&
29740 .endd
29741 LHLO is used instead of HELO if the transport's &%protocol%& option is
29742 set to &"lmtp"&.
29743
29744 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
29745 settings.
29746
29747 A recipient callout check is similar. By default, it also uses an empty address
29748 for the sender. This default is chosen because most hosts do not make use of
29749 the sender address when verifying a recipient. Using the same address means
29750 that a single cache entry can be used for each recipient. Some sites, however,
29751 do make use of the sender address when verifying. These are catered for by the
29752 &%use_sender%& and &%use_postmaster%& options, described in the next section.
29753
29754 If the response to the RCPT command is a 2&'xx'& code, the verification
29755 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
29756 Exim tries the next host, if any. If there is a problem with all the remote
29757 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
29758 &%callout%& option is given, in which case the condition is forced to succeed.
29759
29760 .cindex "SMTP" "output flushing, disabling for callout"
29761 A callout may take a little time. For this reason, Exim normally flushes SMTP
29762 output before performing a callout in an ACL, to avoid unexpected timeouts in
29763 clients when the SMTP PIPELINING extension is in use. The flushing can be
29764 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
29765
29766
29767
29768
29769 .section "Additional parameters for callouts" "CALLaddparcall"
29770 .cindex "callout" "additional parameters for"
29771 The &%callout%& option can be followed by an equals sign and a number of
29772 optional parameters, separated by commas. For example:
29773 .code
29774 verify = recipient/callout=10s,defer_ok
29775 .endd
29776 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
29777 separate verify options, is retained for backwards compatibility, but is now
29778 deprecated. The additional parameters for &%callout%& are as follows:
29779
29780
29781 .vlist
29782 .vitem <&'a&~time&~interval'&>
29783 .cindex "callout" "timeout, specifying"
29784 This specifies the timeout that applies for the callout attempt to each host.
29785 For example:
29786 .code
29787 verify = sender/callout=5s
29788 .endd
29789 The default is 30 seconds. The timeout is used for each response from the
29790 remote host. It is also used for the initial connection, unless overridden by
29791 the &%connect%& parameter.
29792
29793
29794 .vitem &*connect&~=&~*&<&'time&~interval'&>
29795 .cindex "callout" "connection timeout, specifying"
29796 This parameter makes it possible to set a different (usually smaller) timeout
29797 for making the SMTP connection. For example:
29798 .code
29799 verify = sender/callout=5s,connect=1s
29800 .endd
29801 If not specified, this timeout defaults to the general timeout value.
29802
29803 .vitem &*defer_ok*&
29804 .cindex "callout" "defer, action on"
29805 When this parameter is present, failure to contact any host, or any other kind
29806 of temporary error, is treated as success by the ACL. However, the cache is not
29807 updated in this circumstance.
29808
29809 .vitem &*fullpostmaster*&
29810 .cindex "callout" "full postmaster check"
29811 This operates like the &%postmaster%& option (see below), but if the check for
29812 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
29813 accordance with the specification in RFC 2821. The RFC states that the
29814 unqualified address &'postmaster'& should be accepted.
29815
29816
29817 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
29818 .cindex "callout" "sender when verifying header"
29819 When verifying addresses in header lines using the &%header_sender%&
29820 verification option, Exim behaves by default as if the addresses are envelope
29821 sender addresses from a message. Callout verification therefore tests to see
29822 whether a bounce message could be delivered, by using an empty address in the
29823 MAIL command. However, it is arguable that these addresses might never be used
29824 as envelope senders, and could therefore justifiably reject bounce messages
29825 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
29826 address to use in the MAIL command. For example:
29827 .code
29828 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
29829 .endd
29830 This parameter is available only for the &%header_sender%& verification option.
29831
29832
29833 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
29834 .cindex "callout" "overall timeout, specifying"
29835 This parameter sets an overall timeout for performing a callout verification.
29836 For example:
29837 .code
29838 verify = sender/callout=5s,maxwait=30s
29839 .endd
29840 This timeout defaults to four times the callout timeout for individual SMTP
29841 commands. The overall timeout applies when there is more than one host that can
29842 be tried. The timeout is checked before trying the next host. This prevents
29843 very long delays if there are a large number of hosts and all are timing out
29844 (for example, when network connections are timing out).
29845
29846
29847 .vitem &*no_cache*&
29848 .cindex "callout" "cache, suppressing"
29849 .cindex "caching callout, suppressing"
29850 When this parameter is given, the callout cache is neither read nor updated.
29851
29852 .vitem &*postmaster*&
29853 .cindex "callout" "postmaster; checking"
29854 When this parameter is set, a successful callout check is followed by a similar
29855 check for the local part &'postmaster'& at the same domain. If this address is
29856 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
29857 the postmaster check is recorded in a cache record; if it is a failure, this is
29858 used to fail subsequent callouts for the domain without a connection being
29859 made, until the cache record expires.
29860
29861 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
29862 The postmaster check uses an empty sender in the MAIL command by default.
29863 You can use this parameter to do a postmaster check using a different address.
29864 For example:
29865 .code
29866 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
29867 .endd
29868 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
29869 one overrides. The &%postmaster%& parameter is equivalent to this example:
29870 .code
29871 require  verify = sender/callout=postmaster_mailfrom=
29872 .endd
29873 &*Warning*&: The caching arrangements for postmaster checking do not take
29874 account of the sender address. It is assumed that either the empty address or
29875 a fixed non-empty address will be used. All that Exim remembers is that the
29876 postmaster check for the domain succeeded or failed.
29877
29878
29879 .vitem &*random*&
29880 .cindex "callout" "&""random""& check"
29881 When this parameter is set, before doing the normal callout check, Exim does a
29882 check for a &"random"& local part at the same domain. The local part is not
29883 really random &-- it is defined by the expansion of the option
29884 &%callout_random_local_part%&, which defaults to
29885 .code
29886 $primary_hostname-$tod_epoch-testing
29887 .endd
29888 The idea here is to try to determine whether the remote host accepts all local
29889 parts without checking. If it does, there is no point in doing callouts for
29890 specific local parts. If the &"random"& check succeeds, the result is saved in
29891 a cache record, and used to force the current and subsequent callout checks to
29892 succeed without a connection being made, until the cache record expires.
29893
29894 .vitem &*use_postmaster*&
29895 .cindex "callout" "sender for recipient check"
29896 This parameter applies to recipient callouts only. For example:
29897 .code
29898 deny  !verify = recipient/callout=use_postmaster
29899 .endd
29900 .vindex "&$qualify_domain$&"
29901 It causes a non-empty postmaster address to be used in the MAIL command when
29902 performing the callout for the recipient, and also for a &"random"& check if
29903 that is configured. The local part of the address is &`postmaster`& and the
29904 domain is the contents of &$qualify_domain$&.
29905
29906 .vitem &*use_sender*&
29907 This option applies to recipient callouts only. For example:
29908 .code
29909 require  verify = recipient/callout=use_sender
29910 .endd
29911 It causes the message's actual sender address to be used in the MAIL
29912 command when performing the callout, instead of an empty address. There is no
29913 need to use this option unless you know that the called hosts make use of the
29914 sender when checking recipients. If used indiscriminately, it reduces the
29915 usefulness of callout caching.
29916 .endlist
29917
29918 If you use any of the parameters that set a non-empty sender for the MAIL
29919 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
29920 &%use_sender%&), you should think about possible loops. Recipient checking is
29921 usually done between two hosts that are under the same management, and the host
29922 that receives the callouts is not normally configured to do callouts itself.
29923 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
29924 these circumstances.
29925
29926 However, if you use a non-empty sender address for a callout to an arbitrary
29927 host, there is the likelihood that the remote host will itself initiate a
29928 callout check back to your host. As it is checking what appears to be a message
29929 sender, it is likely to use an empty address in MAIL, thus avoiding a
29930 callout loop. However, to be on the safe side it would be best to set up your
29931 own ACLs so that they do not do sender verification checks when the recipient
29932 is the address you use for header sender or postmaster callout checking.
29933
29934 Another issue to think about when using non-empty senders for callouts is
29935 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
29936 by the sender/recipient combination; thus, for any given recipient, many more
29937 actual callouts are performed than when an empty sender or postmaster is used.
29938
29939
29940
29941
29942 .section "Callout caching" "SECTcallvercache"
29943 .cindex "hints database" "callout cache"
29944 .cindex "callout" "cache, description of"
29945 .cindex "caching" "callout"
29946 Exim caches the results of callouts in order to reduce the amount of resources
29947 used, unless you specify the &%no_cache%& parameter with the &%callout%&
29948 option. A hints database called &"callout"& is used for the cache. Two
29949 different record types are used: one records the result of a callout check for
29950 a specific address, and the other records information that applies to the
29951 entire domain (for example, that it accepts the local part &'postmaster'&).
29952
29953 When an original callout fails, a detailed SMTP error message is given about
29954 the failure. However, for subsequent failures use the cache data, this message
29955 is not available.
29956
29957 The expiry times for negative and positive address cache records are
29958 independent, and can be set by the global options &%callout_negative_expire%&
29959 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
29960
29961 If a host gives a negative response to an SMTP connection, or rejects any
29962 commands up to and including
29963 .code
29964 MAIL FROM:<>
29965 .endd
29966 (but not including the MAIL command with a non-empty address),
29967 any callout attempt is bound to fail. Exim remembers such failures in a
29968 domain cache record, which it uses to fail callouts for the domain without
29969 making new connections, until the domain record times out. There are two
29970 separate expiry times for domain cache records:
29971 &%callout_domain_negative_expire%& (default 3h) and
29972 &%callout_domain_positive_expire%& (default 7d).
29973
29974 Domain records expire when the negative expiry time is reached if callouts
29975 cannot be made for the domain, or if the postmaster check failed.
29976 Otherwise, they expire when the positive expiry time is reached. This
29977 ensures that, for example, a host that stops accepting &"random"& local parts
29978 will eventually be noticed.
29979
29980 The callout caching mechanism is based on the domain of the address that is
29981 being tested. If the domain routes to several hosts, it is assumed that their
29982 behaviour will be the same.
29983
29984
29985
29986 .section "Sender address verification reporting" "SECTsenaddver"
29987 .cindex "verifying" "suppressing error details"
29988 See section &<<SECTaddressverification>>& for a general discussion of
29989 verification. When sender verification fails in an ACL, the details of the
29990 failure are given as additional output lines before the 550 response to the
29991 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
29992 you might see:
29993 .code
29994 MAIL FROM:<xyz@abc.example>
29995 250 OK
29996 RCPT TO:<pqr@def.example>
29997 550-Verification failed for <xyz@abc.example>
29998 550-Called:   192.168.34.43
29999 550-Sent:     RCPT TO:<xyz@abc.example>
30000 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30001 550 Sender verification failed
30002 .endd
30003 If more than one RCPT command fails in the same way, the details are given
30004 only for the first of them. However, some administrators do not want to send
30005 out this much information. You can suppress the details by adding
30006 &`/no_details`& to the ACL statement that requests sender verification. For
30007 example:
30008 .code
30009 verify = sender/no_details
30010 .endd
30011
30012 .section "Redirection while verifying" "SECTredirwhilveri"
30013 .cindex "verifying" "redirection while"
30014 .cindex "address redirection" "while verifying"
30015 A dilemma arises when a local address is redirected by aliasing or forwarding
30016 during verification: should the generated addresses themselves be verified,
30017 or should the successful expansion of the original address be enough to verify
30018 it? By default, Exim takes the following pragmatic approach:
30019
30020 .ilist
30021 When an incoming address is redirected to just one child address, verification
30022 continues with the child address, and if that fails to verify, the original
30023 verification also fails.
30024 .next
30025 When an incoming address is redirected to more than one child address,
30026 verification does not continue. A success result is returned.
30027 .endlist
30028
30029 This seems the most reasonable behaviour for the common use of aliasing as a
30030 way of redirecting different local parts to the same mailbox. It means, for
30031 example, that a pair of alias entries of the form
30032 .code
30033 A.Wol:   aw123
30034 aw123:   :fail: Gone away, no forwarding address
30035 .endd
30036 work as expected, with both local parts causing verification failure. When a
30037 redirection generates more than one address, the behaviour is more like a
30038 mailing list, where the existence of the alias itself is sufficient for
30039 verification to succeed.
30040
30041 It is possible, however, to change the default behaviour so that all successful
30042 redirections count as successful verifications, however many new addresses are
30043 generated. This is specified by the &%success_on_redirect%& verification
30044 option. For example:
30045 .code
30046 require verify = recipient/success_on_redirect/callout=10s
30047 .endd
30048 In this example, verification succeeds if a router generates a new address, and
30049 the callout does not occur, because no address was routed to a remote host.
30050
30051 When verification is being tested via the &%-bv%& option, the treatment of
30052 redirections is as just described, unless the &%-v%& or any debugging option is
30053 also specified. In that case, full verification is done for every generated
30054 address and a report is output for each of them.
30055
30056
30057
30058 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30059 .cindex "CSA" "verifying"
30060 Client SMTP Authorization is a system that allows a site to advertise
30061 which machines are and are not permitted to send email. This is done by placing
30062 special SRV records in the DNS; these are looked up using the client's HELO
30063 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30064 Authorization checks in Exim are performed by the ACL condition:
30065 .code
30066 verify = csa
30067 .endd
30068 This fails if the client is not authorized. If there is a DNS problem, or if no
30069 valid CSA SRV record is found, or if the client is authorized, the condition
30070 succeeds. These three cases can be distinguished using the expansion variable
30071 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30072 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30073 be likely to cause problems for legitimate email.
30074
30075 The error messages produced by the CSA code include slightly more
30076 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30077 looking up the CSA SRV record, or problems looking up the CSA target
30078 address record. There are four reasons for &$csa_status$& being &"fail"&:
30079
30080 .ilist
30081 The client's host name is explicitly not authorized.
30082 .next
30083 The client's IP address does not match any of the CSA target IP addresses.
30084 .next
30085 The client's host name is authorized but it has no valid target IP addresses
30086 (for example, the target's addresses are IPv6 and the client is using IPv4).
30087 .next
30088 The client's host name has no CSA SRV record but a parent domain has asserted
30089 that all subdomains must be explicitly authorized.
30090 .endlist
30091
30092 The &%csa%& verification condition can take an argument which is the domain to
30093 use for the DNS query. The default is:
30094 .code
30095 verify = csa/$sender_helo_name
30096 .endd
30097 This implementation includes an extension to CSA. If the query domain
30098 is an address literal such as [192.0.2.95], or if it is a bare IP
30099 address, Exim searches for CSA SRV records in the reverse DNS as if
30100 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30101 meaningful to say:
30102 .code
30103 verify = csa/$sender_host_address
30104 .endd
30105 In fact, this is the check that Exim performs if the client does not say HELO.
30106 This extension can be turned off by setting the main configuration option
30107 &%dns_csa_use_reverse%& to be false.
30108
30109 If a CSA SRV record is not found for the domain itself, a search
30110 is performed through its parent domains for a record which might be
30111 making assertions about subdomains. The maximum depth of this search is limited
30112 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30113 default. Exim does not look for CSA SRV records in a top level domain, so the
30114 default settings handle HELO domains as long as seven
30115 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30116 of legitimate HELO domains.
30117
30118 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30119 direct SRV lookups, this is not sufficient because of the extra parent domain
30120 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30121 addresses into lookups in the reverse DNS space. The result of a successful
30122 lookup such as:
30123 .code
30124 ${lookup dnsdb {csa=$sender_helo_name}}
30125 .endd
30126 has two space-separated fields: an authorization code and a target host name.
30127 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30128 authorization required but absent, or &"?"& for unknown.
30129
30130
30131
30132
30133 .section "Bounce address tag validation" "SECTverifyPRVS"
30134 .cindex "BATV, verifying"
30135 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30136 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30137 Genuine incoming bounce messages should therefore always be addressed to
30138 recipients that have a valid tag. This scheme is a way of detecting unwanted
30139 bounce messages caused by sender address forgeries (often called &"collateral
30140 spam"&), because the recipients of such messages do not include valid tags.
30141
30142 There are two expansion items to help with the implementation of the BATV
30143 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30144 the original envelope sender address by using a simple key to add a hash of the
30145 address and some time-based randomizing information. The &%prvs%& expansion
30146 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30147 The syntax of these expansion items is described in section
30148 &<<SECTexpansionitems>>&.
30149
30150 As an example, suppose the secret per-address keys are stored in an MySQL
30151 database. A query to look up the key for an address could be defined as a macro
30152 like this:
30153 .code
30154 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30155                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30156                 }{$value}}
30157 .endd
30158 Suppose also that the senders who make use of BATV are defined by an address
30159 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30160 use this:
30161 .code
30162 # Bounces: drop unsigned addresses for BATV senders
30163 deny message = This address does not send an unsigned reverse path
30164      senders = :
30165      recipients = +batv_senders
30166
30167 # Bounces: In case of prvs-signed address, check signature.
30168 deny message = Invalid reverse path signature.
30169      senders = :
30170      condition  = ${prvscheck {$local_part@$domain}\
30171                   {PRVSCHECK_SQL}{1}}
30172      !condition = $prvscheck_result
30173 .endd
30174 The first statement rejects recipients for bounce messages that are addressed
30175 to plain BATV sender addresses, because it is known that BATV senders do not
30176 send out messages with plain sender addresses. The second statement rejects
30177 recipients that are prvs-signed, but with invalid signatures (either because
30178 the key is wrong, or the signature has timed out).
30179
30180 A non-prvs-signed address is not rejected by the second statement, because the
30181 &%prvscheck%& expansion yields an empty string if its first argument is not a
30182 prvs-signed address, thus causing the &%condition%& condition to be false. If
30183 the first argument is a syntactically valid prvs-signed address, the yield is
30184 the third string (in this case &"1"&), whether or not the cryptographic and
30185 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30186 of the checks (empty for failure, &"1"& for success).
30187
30188 There is one more issue you must consider when implementing prvs-signing:
30189 you have to ensure that the routers accept prvs-signed addresses and
30190 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30191 router to remove the signature with a configuration along these lines:
30192 .code
30193 batv_redirect:
30194   driver = redirect
30195   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30196 .endd
30197 This works because, if the third argument of &%prvscheck%& is empty, the result
30198 of the expansion of a prvs-signed address is the decoded value of the original
30199 address. This router should probably be the first of your routers that handles
30200 local addresses.
30201
30202 To create BATV-signed addresses in the first place, a transport of this form
30203 can be used:
30204 .code
30205 external_smtp_batv:
30206   driver = smtp
30207   return_path = ${prvs {$return_path} \
30208                        {${lookup mysql{SELECT \
30209                        secret FROM batv_prvs WHERE \
30210                        sender='${quote_mysql:$sender_address}'} \
30211                        {$value}fail}}}
30212 .endd
30213 If no key can be found for the existing return path, no signing takes place.
30214
30215
30216
30217 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30218 .cindex "&ACL;" "relay control"
30219 .cindex "relaying" "control by ACL"
30220 .cindex "policy control" "relay control"
30221 An MTA is said to &'relay'& a message if it receives it from some host and
30222 delivers it directly to another host as a result of a remote address contained
30223 within it. Redirecting a local address via an alias or forward file and then
30224 passing the message on to another host is not relaying,
30225 .cindex "&""percent hack""&"
30226 but a redirection as a result of the &"percent hack"& is.
30227
30228 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30229 A host which is acting as a gateway or an MX backup is concerned with incoming
30230 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30231 a host which is acting as a smart host for a number of clients is concerned
30232 with outgoing relaying from those clients to the Internet at large. Often the
30233 same host is fulfilling both functions,
30234 . ///
30235 . as illustrated in the diagram below,
30236 . ///
30237 but in principle these two kinds of relaying are entirely independent. What is
30238 not wanted is the transmission of mail from arbitrary remote hosts through your
30239 system to arbitrary domains.
30240
30241
30242 You can implement relay control by means of suitable statements in the ACL that
30243 runs for each RCPT command. For convenience, it is often easiest to use
30244 Exim's named list facility to define the domains and hosts involved. For
30245 example, suppose you want to do the following:
30246
30247 .ilist
30248 Deliver a number of domains to mailboxes on the local host (or process them
30249 locally in some other way). Let's say these are &'my.dom1.example'& and
30250 &'my.dom2.example'&.
30251 .next
30252 Relay mail for a number of other domains for which you are the secondary MX.
30253 These might be &'friend1.example'& and &'friend2.example'&.
30254 .next
30255 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30256 Suppose your LAN is 192.168.45.0/24.
30257 .endlist
30258
30259
30260 In the main part of the configuration, you put the following definitions:
30261 .code
30262 domainlist local_domains    = my.dom1.example : my.dom2.example
30263 domainlist relay_to_domains = friend1.example : friend2.example
30264 hostlist   relay_from_hosts = 192.168.45.0/24
30265 .endd
30266 Now you can use these definitions in the ACL that is run for every RCPT
30267 command:
30268 .code
30269 acl_check_rcpt:
30270   accept domains = +local_domains : +relay_to_domains
30271   accept hosts   = +relay_from_hosts
30272 .endd
30273 The first statement accepts any RCPT command that contains an address in
30274 the local or relay domains. For any other domain, control passes to the second
30275 statement, which accepts the command only if it comes from one of the relay
30276 hosts. In practice, you will probably want to make your ACL more sophisticated
30277 than this, for example, by including sender and recipient verification. The
30278 default configuration includes a more comprehensive example, which is described
30279 in chapter &<<CHAPdefconfil>>&.
30280
30281
30282
30283 .section "Checking a relay configuration" "SECTcheralcon"
30284 .cindex "relaying" "checking control of"
30285 You can check the relay characteristics of your configuration in the same way
30286 that you can test any ACL behaviour for an incoming SMTP connection, by using
30287 the &%-bh%& option to run a fake SMTP session with which you interact.
30288
30289 For specifically testing for unwanted relaying, the host
30290 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30291 host from the host on which Exim is running, using the normal telnet port, you
30292 will see a normal telnet connection message and then quite a long delay. Be
30293 patient. The remote host is making an SMTP connection back to your host, and
30294 trying a number of common probes to test for open relay vulnerability. The
30295 results of the tests will eventually appear on your terminal.
30296 .ecindex IIDacl
30297
30298
30299
30300 . ////////////////////////////////////////////////////////////////////////////
30301 . ////////////////////////////////////////////////////////////////////////////
30302
30303 .chapter "Content scanning at ACL time" "CHAPexiscan"
30304 .scindex IIDcosca "content scanning" "at ACL time"
30305 The extension of Exim to include content scanning at ACL time, formerly known
30306 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30307 was integrated into the main source for Exim release 4.50, and Tom continues to
30308 maintain it. Most of the wording of this chapter is taken from Tom's
30309 specification.
30310
30311 It is also possible to scan the content of messages at other times. The
30312 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30313 scanning after all the ACLs have run. A transport filter can be used to scan
30314 messages at delivery time (see the &%transport_filter%& option, described in
30315 chapter &<<CHAPtransportgeneric>>&).
30316
30317 If you want to include the ACL-time content-scanning features when you compile
30318 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30319 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30320
30321 .ilist
30322 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30323 for all MIME parts for SMTP and non-SMTP messages, respectively.
30324 .next
30325 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30326 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30327 run at the end of message reception (the &%acl_smtp_data%& ACL).
30328 .next
30329 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30330 of messages, or parts of messages, for debugging purposes.
30331 .next
30332 Additional expansion variables that are set in the new ACL and by the new
30333 conditions.
30334 .next
30335 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30336 .endlist
30337
30338 There is another content-scanning configuration option for &_Local/Makefile_&,
30339 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30340 condition is compiled, in addition to all the other content-scanning features.
30341
30342 Content-scanning is continually evolving, and new features are still being
30343 added. While such features are still unstable and liable to incompatible
30344 changes, they are made available in Exim by setting options whose names begin
30345 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30346 this manual. You can find out about them by reading the file called
30347 &_doc/experimental.txt_&.
30348
30349 All the content-scanning facilities work on a MBOX copy of the message that is
30350 temporarily created in a file called:
30351 .display
30352 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30353 .endd
30354 The &_.eml_& extension is a friendly hint to virus scanners that they can
30355 expect an MBOX-like structure inside that file. The file is created when the
30356 first content scanning facility is called. Subsequent calls to content
30357 scanning conditions open the same file again. The directory is recursively
30358 removed when the &%acl_smtp_data%& ACL has finished running, unless
30359 .code
30360 control = no_mbox_unspool
30361 .endd
30362 has been encountered. When the MIME ACL decodes files, they are put into the
30363 same directory by default.
30364
30365
30366
30367 .section "Scanning for viruses" "SECTscanvirus"
30368 .cindex "virus scanning"
30369 .cindex "content scanning" "for viruses"
30370 .cindex "content scanning" "the &%malware%& condition"
30371 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30372 It supports a &"generic"& interface to scanners called via the shell, and
30373 specialized interfaces for &"daemon"& type virus scanners, which are resident
30374 in memory and thus are much faster.
30375
30376 .new
30377 A timeout of 2 minutes is applied to a scanner call (by default);
30378 if it expires then a defer action is taken.
30379 .wen
30380
30381 .oindex "&%av_scanner%&"
30382 You can set the &%av_scanner%& option in the main part of the configuration
30383 to specify which scanner to use, together with any additional options that
30384 are needed. The basic syntax is as follows:
30385 .display
30386 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30387 .endd
30388 If you do not set &%av_scanner%&, it defaults to
30389 .code
30390 av_scanner = sophie:/var/run/sophie
30391 .endd
30392 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30393 before use.
30394 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30395 The following scanner types are supported in this release:
30396
30397 .vlist
30398 .new
30399 .vitem &%avast%&
30400 .cindex "virus scanners" "avast"
30401 This is the scanner daemon of Avast. It has been tested with Avast Core
30402 Security (currenty at version 1.1.7).
30403 You can get a trial version at &url(http://www.avast.com) or for Linux
30404 at &url(http://www.avast.com/linux-server-antivirus).
30405 This scanner type takes one option,
30406 which can be either a full path to a UNIX socket,
30407 or host and port specifiers separated by white space.
30408 The host may be a name or an IP address; the port is either a
30409 single number or a pair of numbers with a dash between.
30410 Any further options are given, on separate lines,
30411 to the daemon as options before the main scan command.
30412 For example:
30413 .code
30414 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30415 av_scanner = avast:192.168.2.22 5036
30416 .endd
30417 If you omit the argument, the default path
30418 &_/var/run/avast/scan.sock_&
30419 is used.
30420 If you use a remote host,
30421 you need to make Exim's spool directory available to it,
30422 as the scanner is passed a file path, not file contents.
30423 For information about available commands and their options you may use 
30424 .code
30425 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30426     FLAGS
30427     SENSITIVITY
30428     PACK
30429 .endd
30430 .wen
30431
30432
30433 .vitem &%aveserver%&
30434 .cindex "virus scanners" "Kaspersky"
30435 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30436 at &url(http://www.kaspersky.com). This scanner type takes one option,
30437 which is the path to the daemon's UNIX socket. The default is shown in this
30438 example:
30439 .code
30440 av_scanner = aveserver:/var/run/aveserver
30441 .endd
30442
30443
30444 .vitem &%clamd%&
30445 .cindex "virus scanners" "clamd"
30446 This daemon-type scanner is GPL and free. You can get it at
30447 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30448 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30449 in the MIME ACL. This no longer believed to be necessary. One option is
30450 required: either the path and name of a UNIX socket file, or a hostname or IP
30451 number, and a port, separated by space, as in the second of these examples:
30452 .code
30453 av_scanner = clamd:/opt/clamd/socket
30454 av_scanner = clamd:192.0.2.3 1234
30455 av_scanner = clamd:192.0.2.3 1234:local
30456 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30457 .endd
30458 If the value of av_scanner points to a UNIX socket file or contains the local
30459 keyword, then the ClamAV interface will pass a filename containing the data
30460 to be scanned, which will should normally result in less I/O happening and be
30461 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30462 Exim does not assume that there is a common filesystem with the remote host.
30463 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30464 you be running a version of ClamAV prior to 0.95.
30465
30466 The final example shows that multiple TCP targets can be specified.  Exim will
30467 randomly use one for each incoming email (i.e. it load balances them).  Note
30468 that only TCP targets may be used if specifying a list of scanners; a UNIX
30469 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30470 unavailable, Exim will try the remaining one(s) until it finds one that works.
30471 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30472 not keep track of scanner state between multiple messages, and the scanner
30473 selection is random, so the message will get logged in the mainlog for each
30474 email that the down scanner gets chosen first (message wrapped to be readable):
30475 .code
30476 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30477    clamd: connection to localhost, port 3310 failed
30478    (Connection refused)
30479 .endd
30480
30481 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30482 contributing the code for this scanner.
30483
30484 .vitem &%cmdline%&
30485 .cindex "virus scanners" "command line interface"
30486 This is the keyword for the generic command line scanner interface. It can be
30487 used to attach virus scanners that are invoked from the shell. This scanner
30488 type takes 3 mandatory options:
30489
30490 .olist
30491 The full path and name of the scanner binary, with all command line options,
30492 and a placeholder (&`%s`&) for the directory to scan.
30493
30494 .next
30495 A regular expression to match against the STDOUT and STDERR output of the
30496 virus scanner. If the expression matches, a virus was found. You must make
30497 absolutely sure that this expression matches on &"virus found"&. This is called
30498 the &"trigger"& expression.
30499
30500 .next
30501 Another regular expression, containing exactly one pair of parentheses, to
30502 match the name of the virus found in the scanners output. This is called the
30503 &"name"& expression.
30504 .endlist olist
30505
30506 For example, Sophos Sweep reports a virus on a line like this:
30507 .code
30508 Virus 'W32/Magistr-B' found in file ./those.bat
30509 .endd
30510 For the trigger expression, we can match the phrase &"found in file"&. For the
30511 name expression, we want to extract the W32/Magistr-B string, so we can match
30512 for the single quotes left and right of it. Altogether, this makes the
30513 configuration setting:
30514 .code
30515 av_scanner = cmdline:\
30516              /path/to/sweep -ss -all -rec -archive %s:\
30517              found in file:'(.+)'
30518 .endd
30519 .vitem &%drweb%&
30520 .cindex "virus scanners" "DrWeb"
30521 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30522 takes one option,
30523 either a full path to a UNIX socket,
30524 or host and port specifiers separated by white space.
30525 The host may be a name or an IP address; the port is either a
30526 single number or a pair of numbers with a dash between.
30527 For example:
30528 .code
30529 av_scanner = drweb:/var/run/drwebd.sock
30530 av_scanner = drweb:192.168.2.20 31337
30531 .endd
30532 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30533 is used. Thanks to Alex Miller for contributing the code for this scanner.
30534
30535 .vitem &%f-protd%&
30536 .cindex "virus scanners" "f-protd"
30537 The f-protd scanner is accessed via HTTP over TCP.
30538 One argument is taken, being a space-separated hostname and port number
30539 (or port-range).
30540 For example:
30541 .code
30542 av_scanner = f-protd:localhost 10200-10204
30543 .endd
30544 If you omit the argument, the default values show above are used.
30545
30546 .vitem &%fsecure%&
30547 .cindex "virus scanners" "F-Secure"
30548 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30549 argument which is the path to a UNIX socket. For example:
30550 .code
30551 av_scanner = fsecure:/path/to/.fsav
30552 .endd
30553 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30554 Thelmen for contributing the code for this scanner.
30555
30556 .vitem &%kavdaemon%&
30557 .cindex "virus scanners" "Kaspersky"
30558 This is the scanner daemon of Kaspersky Version 4. This version of the
30559 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30560 scanner type takes one option, which is the path to the daemon's UNIX socket.
30561 For example:
30562 .code
30563 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30564 .endd
30565 The default path is &_/var/run/AvpCtl_&.
30566
30567 .vitem &%mksd%&
30568 .cindex "virus scanners" "mksd"
30569 This is a daemon type scanner that is aimed mainly at Polish users, though some
30570 parts of documentation are now available in English. You can get it at
30571 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30572 the maximum number of processes used simultaneously to scan the attachments,
30573 provided that the demime facility is employed and also provided that mksd has
30574 been run with at least the same number of child processes. For example:
30575 .code
30576 av_scanner = mksd:2
30577 .endd
30578 You can safely omit this option (the default value is 1).
30579
30580 .vitem &%sock%&
30581 .cindex "virus scanners" "simple socket-connected"
30582 This is a general-purpose way of talking to simple scanner daemons
30583 running on the local machine.
30584 There are four options:
30585 an address (which may be an IP addres and port, or the path of a Unix socket),
30586 a commandline to send (may include a single %s which will be replaced with
30587 the path to the mail file to be scanned),
30588 an RE to trigger on from the returned data,
30589 an RE to extract malware_name from the returned data.
30590 For example:
30591 .code
30592 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30593 .endd
30594 Default for the socket specifier is &_/tmp/malware.sock_&.
30595 Default for the commandline is &_%s\n_&.
30596 Both regular-expressions are required.
30597
30598 .vitem &%sophie%&
30599 .cindex "virus scanners" "Sophos and Sophie"
30600 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30601 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30602 for this scanner type is the path to the UNIX socket that Sophie uses for
30603 client communication. For example:
30604 .code
30605 av_scanner = sophie:/tmp/sophie
30606 .endd
30607 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30608 the option.
30609 .endlist
30610
30611 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30612 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30613 ACL.
30614
30615 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30616 makes it possible to use different scanners. See further below for an example.
30617 The &%malware%& condition caches its results, so when you use it multiple times
30618 for the same message, the actual scanning process is only carried out once.
30619 However, using expandable items in &%av_scanner%& disables this caching, in
30620 which case each use of the &%malware%& condition causes a new scan of the
30621 message.
30622
30623 The &%malware%& condition takes a right-hand argument that is expanded before
30624 .new
30625 use and taken as a list, slash-separated by default.
30626 .wen
30627 The first element can then be one of
30628
30629 .ilist
30630 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30631 The condition succeeds if a virus was found, and fail otherwise. This is the
30632 recommended usage.
30633 .next
30634 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30635 the condition fails immediately.
30636 .next
30637 A regular expression, in which case the message is scanned for viruses. The
30638 condition succeeds if a virus is found and its name matches the regular
30639 expression. This allows you to take special actions on certain types of virus.
30640 .new
30641 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30642 unless the separator is changed (in the usual way).
30643 .wen
30644 .endlist
30645
30646 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30647 messages even if there is a problem with the virus scanner.
30648 Otherwise, such a problem causes the ACL to defer.
30649
30650 .new
30651 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30652 specify a non-default timeout.  The default is two minutes.
30653 For example:
30654 .code
30655 malware = * / defer_ok / tmo=10s
30656 .endd
30657 A timeout causes the ACL to defer.
30658 .wen
30659
30660 .vindex "&$malware_name$&"
30661 When a virus is found, the condition sets up an expansion variable called
30662 &$malware_name$& that contains the name of the virus. You can use it in a
30663 &%message%& modifier that specifies the error returned to the sender, and/or in
30664 logging data.
30665
30666 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30667 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30668 &%malware%& condition.
30669
30670 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30671 imposed by your anti-virus scanner.
30672
30673 Here is a very simple scanning example:
30674 .code
30675 deny message = This message contains malware ($malware_name)
30676      demime = *
30677      malware = *
30678 .endd
30679 The next example accepts messages when there is a problem with the scanner:
30680 .code
30681 deny message = This message contains malware ($malware_name)
30682      demime = *
30683      malware = */defer_ok
30684 .endd
30685 The next example shows how to use an ACL variable to scan with both sophie and
30686 aveserver. It assumes you have set:
30687 .code
30688 av_scanner = $acl_m0
30689 .endd
30690 in the main Exim configuration.
30691 .code
30692 deny message = This message contains malware ($malware_name)
30693      set acl_m0 = sophie
30694      malware = *
30695
30696 deny message = This message contains malware ($malware_name)
30697      set acl_m0 = aveserver
30698      malware = *
30699 .endd
30700
30701
30702 .section "Scanning with SpamAssassin" "SECTscanspamass"
30703 .cindex "content scanning" "for spam"
30704 .cindex "spam scanning"
30705 .cindex "SpamAssassin"
30706 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30707 score and a report for the message. You can get SpamAssassin at
30708 &url(http://www.spamassassin.org), or, if you have a working Perl
30709 installation, you can use CPAN by running:
30710 .code
30711 perl -MCPAN -e 'install Mail::SpamAssassin'
30712 .endd
30713 SpamAssassin has its own set of configuration files. Please review its
30714 documentation to see how you can tweak it. The default installation should work
30715 nicely, however.
30716
30717 .oindex "&%spamd_address%&"
30718 After having installed and configured SpamAssassin, start the &%spamd%& daemon.
30719 By default, it listens on 127.0.0.1, TCP port 783. If you use another host or
30720 port for &%spamd%&, you must set the &%spamd_address%& option in the global
30721 part of the Exim configuration as follows (example):
30722 .code
30723 spamd_address = 192.168.99.45 387
30724 .endd
30725 You do not need to set this option if you use the default. As of version 2.60,
30726 &%spamd%& also supports communication over UNIX sockets. If you want to use
30727 these, supply &%spamd_address%& with an absolute file name instead of a
30728 address/port pair:
30729 .code
30730 spamd_address = /var/run/spamd_socket
30731 .endd
30732 You can have multiple &%spamd%& servers to improve scalability. These can
30733 reside on other hardware reachable over the network. To specify multiple
30734 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
30735 option, separated with colons:
30736 .code
30737 spamd_address = 192.168.2.10 783 : \
30738                 192.168.2.11 783 : \
30739                 192.168.2.12 783
30740 .endd
30741 Up to 32 &%spamd%& servers are supported. The servers are queried in a random
30742 fashion. When a server fails to respond to the connection attempt, all other
30743 servers are tried until one succeeds. If no server responds, the &%spam%&
30744 condition defers.
30745
30746 &*Warning*&: It is not possible to use the UNIX socket connection method with
30747 multiple &%spamd%& servers.
30748
30749 The &%spamd_address%& variable is expanded before use if it starts with
30750 a dollar sign. In this case, the expansion may return a string that is
30751 used as the list so that multiple spamd servers can be the result of an
30752 expansion.
30753
30754 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
30755 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
30756 .code
30757 deny message = This message was classified as SPAM
30758      spam = joe
30759 .endd
30760 The right-hand side of the &%spam%& condition specifies a name. This is
30761 relevant if you have set up multiple SpamAssassin profiles. If you do not want
30762 to scan using a specific profile, but rather use the SpamAssassin system-wide
30763 default profile, you can scan for an unknown name, or simply use &"nobody"&.
30764 However, you must put something on the right-hand side.
30765
30766 The name allows you to use per-domain or per-user antispam profiles in
30767 principle, but this is not straightforward in practice, because a message may
30768 have multiple recipients, not necessarily all in the same domain. Because the
30769 &%spam%& condition has to be called from a DATA ACL in order to be able to
30770 read the contents of the message, the variables &$local_part$& and &$domain$&
30771 are not set.
30772
30773 The right-hand side of the &%spam%& condition is expanded before being used, so
30774 you can put lookups or conditions there. When the right-hand side evaluates to
30775 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
30776
30777
30778 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
30779 large ones may cause significant performance degradation. As most spam messages
30780 are quite small, it is recommended that you do not scan the big ones. For
30781 example:
30782 .code
30783 deny message = This message was classified as SPAM
30784      condition = ${if < {$message_size}{10K}}
30785      spam = nobody
30786 .endd
30787
30788 The &%spam%& condition returns true if the threshold specified in the user's
30789 SpamAssassin profile has been matched or exceeded. If you want to use the
30790 &%spam%& condition for its side effects (see the variables below), you can make
30791 it always return &"true"& by appending &`:true`& to the username.
30792
30793 .cindex "spam scanning" "returned variables"
30794 When the &%spam%& condition is run, it sets up a number of expansion
30795 variables. These variables are saved with the received message, thus they are
30796 available for use at delivery time.
30797
30798 .vlist
30799 .vitem &$spam_score$&
30800 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
30801 for inclusion in log or reject messages.
30802
30803 .vitem &$spam_score_int$&
30804 The spam score of the message, multiplied by ten, as an integer value. For
30805 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
30806 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
30807 The integer value is useful for numeric comparisons in conditions.
30808
30809 .vitem &$spam_bar$&
30810 A string consisting of a number of &"+"& or &"-"& characters, representing the
30811 integer part of the spam score value. A spam score of 4.4 would have a
30812 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
30813 headers, since MUAs can match on such strings.
30814
30815 .vitem &$spam_report$&
30816 A multiline text table, containing the full SpamAssassin report for the
30817 message. Useful for inclusion in headers or reject messages.
30818 .endlist
30819
30820 The &%spam%& condition caches its results unless expansion in
30821 spamd_address was used. If you call it again with the same user name, it
30822 does not scan again, but rather returns the same values as before.
30823
30824 The &%spam%& condition returns DEFER if there is any error while running
30825 the message through SpamAssassin or if the expansion of spamd_address
30826 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
30827 statement block), append &`/defer_ok`& to the right-hand side of the
30828 spam condition, like this:
30829 .code
30830 deny message = This message was classified as SPAM
30831      spam    = joe/defer_ok
30832 .endd
30833 This causes messages to be accepted even if there is a problem with &%spamd%&.
30834
30835 Here is a longer, commented example of the use of the &%spam%&
30836 condition:
30837 .code
30838 # put headers in all messages (no matter if spam or not)
30839 warn  spam = nobody:true
30840       add_header = X-Spam-Score: $spam_score ($spam_bar)
30841       add_header = X-Spam-Report: $spam_report
30842
30843 # add second subject line with *SPAM* marker when message
30844 # is over threshold
30845 warn  spam = nobody
30846       add_header = Subject: *SPAM* $h_Subject:
30847
30848 # reject spam at high scores (> 12)
30849 deny  message = This message scored $spam_score spam points.
30850       spam = nobody:true
30851       condition = ${if >{$spam_score_int}{120}{1}{0}}
30852 .endd
30853
30854
30855
30856 .section "Scanning MIME parts" "SECTscanmimepart"
30857 .cindex "content scanning" "MIME parts"
30858 .cindex "MIME content scanning"
30859 .oindex "&%acl_smtp_mime%&"
30860 .oindex "&%acl_not_smtp_mime%&"
30861 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
30862 each MIME part of an SMTP message, including multipart types, in the sequence
30863 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
30864 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
30865 options may both refer to the same ACL if you want the same processing in both
30866 cases.
30867
30868 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
30869 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
30870 the case of a non-SMTP message. However, a MIME ACL is called only if the
30871 message contains a &'Content-Type:'& header line. When a call to a MIME
30872 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
30873 result code is sent to the client. In the case of an SMTP message, the
30874 &%acl_smtp_data%& ACL is not called when this happens.
30875
30876 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
30877 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
30878 condition to match against the raw MIME part. You can also use the
30879 &%mime_regex%& condition to match against the decoded MIME part (see section
30880 &<<SECTscanregex>>&).
30881
30882 At the start of a MIME ACL, a number of variables are set from the header
30883 information for the relevant MIME part. These are described below. The contents
30884 of the MIME part are not by default decoded into a disk file except for MIME
30885 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
30886 part into a disk file, you can use the &%decode%& condition. The general
30887 syntax is:
30888 .display
30889 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
30890 .endd
30891 The right hand side is expanded before use. After expansion,
30892 the value can be:
30893
30894 .olist
30895 &"0"& or &"false"&, in which case no decoding is done.
30896 .next
30897 The string &"default"&. In that case, the file is put in the temporary
30898 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
30899 a sequential file name consisting of the message id and a sequence number. The
30900 full path and name is available in &$mime_decoded_filename$& after decoding.
30901 .next
30902 A full path name starting with a slash. If the full name is an existing
30903 directory, it is used as a replacement for the default directory. The filename
30904 is then sequentially assigned. If the path does not exist, it is used as
30905 the full path and file name.
30906 .next
30907 If the string does not start with a slash, it is used as the
30908 filename, and the default path is then used.
30909 .endlist
30910 The &%decode%& condition normally succeeds. It is only false for syntax
30911 errors or unusual circumstances such as memory shortages. You can easily decode
30912 a file with its original, proposed filename using
30913 .code
30914 decode = $mime_filename
30915 .endd
30916 However, you should keep in mind that &$mime_filename$& might contain
30917 anything. If you place files outside of the default path, they are not
30918 automatically unlinked.
30919
30920 For RFC822 attachments (these are messages attached to messages, with a
30921 content-type of &"message/rfc822"&), the ACL is called again in the same manner
30922 as for the primary message, only that the &$mime_is_rfc822$& expansion
30923 variable is set (see below). Attached messages are always decoded to disk
30924 before being checked, and the files are unlinked once the check is done.
30925
30926 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
30927 used to match regular expressions against raw and decoded MIME parts,
30928 respectively. They are described in section &<<SECTscanregex>>&.
30929
30930 .cindex "MIME content scanning" "returned variables"
30931 The following list describes all expansion variables that are
30932 available in the MIME ACL:
30933
30934 .vlist
30935 .vitem &$mime_boundary$&
30936 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
30937 have a boundary string, which is stored in this variable. If the current part
30938 has no boundary parameter in the &'Content-Type:'& header, this variable
30939 contains the empty string.
30940
30941 .vitem &$mime_charset$&
30942 This variable contains the character set identifier, if one was found in the
30943 &'Content-Type:'& header. Examples for charset identifiers are:
30944 .code
30945 us-ascii
30946 gb2312 (Chinese)
30947 iso-8859-1
30948 .endd
30949 Please note that this value is not normalized, so you should do matches
30950 case-insensitively.
30951
30952 .vitem &$mime_content_description$&
30953 This variable contains the normalized content of the &'Content-Description:'&
30954 header. It can contain a human-readable description of the parts content. Some
30955 implementations repeat the filename for attachments here, but they are usually
30956 only used for display purposes.
30957
30958 .vitem &$mime_content_disposition$&
30959 This variable contains the normalized content of the &'Content-Disposition:'&
30960 header. You can expect strings like &"attachment"& or &"inline"& here.
30961
30962 .vitem &$mime_content_id$&
30963 This variable contains the normalized content of the &'Content-ID:'& header.
30964 This is a unique ID that can be used to reference a part from another part.
30965
30966 .vitem &$mime_content_size$&
30967 This variable is set only after the &%decode%& modifier (see above) has been
30968 successfully run. It contains the size of the decoded part in kilobytes. The
30969 size is always rounded up to full kilobytes, so only a completely empty part
30970 has a &$mime_content_size$& of zero.
30971
30972 .vitem &$mime_content_transfer_encoding$&
30973 This variable contains the normalized content of the
30974 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
30975 type. Typical values are &"base64"& and &"quoted-printable"&.
30976
30977 .vitem &$mime_content_type$&
30978 If the MIME part has a &'Content-Type:'& header, this variable contains its
30979 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
30980 are some examples of popular MIME types, as they may appear in this variable:
30981 .code
30982 text/plain
30983 text/html
30984 application/octet-stream
30985 image/jpeg
30986 audio/midi
30987 .endd
30988 If the MIME part has no &'Content-Type:'& header, this variable contains the
30989 empty string.
30990
30991 .vitem &$mime_decoded_filename$&
30992 This variable is set only after the &%decode%& modifier (see above) has been
30993 successfully run. It contains the full path and file name of the file
30994 containing the decoded data.
30995 .endlist
30996
30997 .cindex "RFC 2047"
30998 .vlist
30999 .vitem &$mime_filename$&
31000 This is perhaps the most important of the MIME variables. It contains a
31001 proposed filename for an attachment, if one was found in either the
31002 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31003 RFC2047 decoded, but no additional sanity checks are done. If no filename was
31004 found, this variable contains the empty string.
31005
31006 .vitem &$mime_is_coverletter$&
31007 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31008 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31009 content in the cover letter, while not restricting attachments at all.
31010
31011 The variable contains 1 (true) for a MIME part believed to be part of the
31012 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31013 follows:
31014
31015 .olist
31016 The outermost MIME part of a message is always a cover letter.
31017
31018 .next
31019 If a multipart/alternative or multipart/related MIME part is a cover letter,
31020 so are all MIME subparts within that multipart.
31021
31022 .next
31023 If any other multipart is a cover letter, the first subpart is a cover letter,
31024 and the rest are attachments.
31025
31026 .next
31027 All parts contained within an attachment multipart are attachments.
31028 .endlist olist
31029
31030 As an example, the following will ban &"HTML mail"& (including that sent with
31031 alternative plain text), while allowing HTML files to be attached. HTML
31032 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31033 .code
31034 deny message = HTML mail is not accepted here
31035 !condition = $mime_is_rfc822
31036 condition = $mime_is_coverletter
31037 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31038 .endd
31039 .vitem &$mime_is_multipart$&
31040 This variable has the value 1 (true) when the current part has the main type
31041 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31042 Since multipart entities only serve as containers for other parts, you may not
31043 want to carry out specific actions on them.
31044
31045 .vitem &$mime_is_rfc822$&
31046 This variable has the value 1 (true) if the current part is not a part of the
31047 checked message itself, but part of an attached message. Attached message
31048 decoding is fully recursive.
31049
31050 .vitem &$mime_part_count$&
31051 This variable is a counter that is raised for each processed MIME part. It
31052 starts at zero for the very first part (which is usually a multipart). The
31053 counter is per-message, so it is reset when processing RFC822 attachments (see
31054 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31055 complete, so you can use it in the DATA ACL to determine the number of MIME
31056 parts of a message. For non-MIME messages, this variable contains the value -1.
31057 .endlist
31058
31059
31060
31061 .section "Scanning with regular expressions" "SECTscanregex"
31062 .cindex "content scanning" "with regular expressions"
31063 .cindex "regular expressions" "content scanning with"
31064 You can specify your own custom regular expression matches on the full body of
31065 the message, or on individual MIME parts.
31066
31067 The &%regex%& condition takes one or more regular expressions as arguments and
31068 matches them against the full message (when called in the DATA ACL) or a raw
31069 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31070 linewise, with a maximum line length of 32K characters. That means you cannot
31071 have multiline matches with the &%regex%& condition.
31072
31073 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31074 to 32K of decoded content (the whole content at once, not linewise). If the
31075 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31076 is decoded automatically when &%mime_regex%& is executed (using default path
31077 and filename values). If the decoded data is larger than  32K, only the first
31078 32K characters are checked.
31079
31080 The regular expressions are passed as a colon-separated list. To include a
31081 literal colon, you must double it. Since the whole right-hand side string is
31082 expanded before being used, you must also escape dollar signs and backslashes
31083 with more backslashes, or use the &`\N`& facility to disable expansion.
31084 Here is a simple example that contains two regular expressions:
31085 .code
31086 deny message = contains blacklisted regex ($regex_match_string)
31087      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31088 .endd
31089 The conditions returns true if any one of the regular expressions matches. The
31090 &$regex_match_string$& expansion variable is then set up and contains the
31091 matching regular expression.
31092
31093 &*Warning*&: With large messages, these conditions can be fairly
31094 CPU-intensive.
31095
31096
31097
31098
31099 .section "The demime condition" "SECTdemimecond"
31100 .cindex "content scanning" "MIME checking"
31101 .cindex "MIME content scanning"
31102 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31103 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31104 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31105 ACL functionality, but provides no additional facilities. Please note that this
31106 condition is deprecated and kept only for backward compatibility. You must set
31107 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31108 use the &%demime%& condition.
31109
31110 The &%demime%& condition unpacks MIME containers in the message. It detects
31111 errors in MIME containers and can match file extensions found in the message
31112 against a list. Using this facility produces files containing the unpacked MIME
31113 parts of the message in the temporary scan directory. If you do antivirus
31114 scanning, it is recommended that you use the &%demime%& condition before the
31115 antivirus (&%malware%&) condition.
31116
31117 On the right-hand side of the &%demime%& condition you can pass a
31118 colon-separated list of file extensions that it should match against. For
31119 example:
31120 .code
31121 deny message = Found blacklisted file attachment
31122      demime  = vbs:com:bat:pif:prf:lnk
31123 .endd
31124 If one of the file extensions is found, the condition is true, otherwise it is
31125 false. If there is a temporary error while demimeing (for example, &"disk
31126 full"&), the condition defers, and the message is temporarily rejected (unless
31127 the condition is on a &%warn%& verb).
31128
31129 The right-hand side is expanded before being treated as a list, so you can have
31130 conditions and lookups there. If it expands to an empty string, &"false"&, or
31131 zero (&"0"&), no demimeing is done and the condition is false.
31132
31133 The &%demime%& condition set the following variables:
31134
31135 .vlist
31136 .vitem &$demime_errorlevel$&
31137 .vindex "&$demime_errorlevel$&"
31138 When an error is detected in a MIME container, this variable contains the
31139 severity of the error, as an integer number. The higher the value, the more
31140 severe the error (the current maximum value is 3). If this variable is unset or
31141 zero, no error occurred.
31142
31143 .vitem &$demime_reason$&
31144 .vindex "&$demime_reason$&"
31145 When &$demime_errorlevel$& is greater than zero, this variable contains a
31146 human-readable text string describing the MIME error that occurred.
31147 .endlist
31148
31149 .vlist
31150 .vitem &$found_extension$&
31151 .vindex "&$found_extension$&"
31152 When the &%demime%& condition is true, this variable contains the file
31153 extension it found.
31154 .endlist
31155
31156 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31157 the &%demime%& condition, and are not changed on subsequent calls.
31158
31159 If you do not want to check for file extensions, but rather use the &%demime%&
31160 condition for unpacking or error checking purposes, pass &"*"& as the
31161 right-hand side value. Here is a more elaborate example of how to use this
31162 facility:
31163 .code
31164 # Reject messages with serious MIME container errors
31165 deny  message = Found MIME error ($demime_reason).
31166       demime = *
31167       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31168
31169 # Reject known virus spreading file extensions.
31170 # Accepting these is pretty much braindead.
31171 deny  message = contains $found_extension file (blacklisted).
31172       demime  = com:vbs:bat:pif:scr
31173
31174 # Freeze .exe and .doc files. Postmaster can
31175 # examine them and eventually thaw them.
31176 deny  log_message = Another $found_extension file.
31177       demime = exe:doc
31178       control = freeze
31179 .endd
31180 .ecindex IIDcosca
31181
31182
31183
31184
31185 . ////////////////////////////////////////////////////////////////////////////
31186 . ////////////////////////////////////////////////////////////////////////////
31187
31188 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31189          "Local scan function"
31190 .scindex IIDlosca "&[local_scan()]& function" "description of"
31191 .cindex "customizing" "input scan using C function"
31192 .cindex "policy control" "by local scan function"
31193 In these days of email worms, viruses, and ever-increasing spam, some sites
31194 want to apply a lot of checking to messages before accepting them.
31195
31196 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31197 passing messages to external virus and spam scanning software. You can also do
31198 a certain amount in Exim itself through string expansions and the &%condition%&
31199 condition in the ACL that runs after the SMTP DATA command or the ACL for
31200 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31201
31202 To allow for further customization to a site's own requirements, there is the
31203 possibility of linking Exim with a private message scanning function, written
31204 in C. If you want to run code that is written in something other than C, you
31205 can of course use a little C stub to call it.
31206
31207 The local scan function is run once for every incoming message, at the point
31208 when Exim is just about to accept the message.
31209 It can therefore be used to control non-SMTP messages from local processes as
31210 well as messages arriving via SMTP.
31211
31212 Exim applies a timeout to calls of the local scan function, and there is an
31213 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31214 Zero means &"no timeout"&.
31215 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31216 before calling the local scan function, so that the most common types of crash
31217 are caught. If the timeout is exceeded or one of those signals is caught, the
31218 incoming message is rejected with a temporary error if it is an SMTP message.
31219 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31220 code. The incident is logged on the main and reject logs.
31221
31222
31223
31224 .section "Building Exim to use a local scan function" "SECID207"
31225 .cindex "&[local_scan()]& function" "building Exim to use"
31226 To make use of the local scan function feature, you must tell Exim where your
31227 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31228 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31229 directory, so you might set
31230 .code
31231 LOCAL_SCAN_SOURCE=Local/local_scan.c
31232 .endd
31233 for example. The function must be called &[local_scan()]&. It is called by
31234 Exim after it has received a message, when the success return code is about to
31235 be sent. This is after all the ACLs have been run. The return code from your
31236 function controls whether the message is actually accepted or not. There is a
31237 commented template function (that just accepts the message) in the file
31238 _src/local_scan.c_.
31239
31240 If you want to make use of Exim's run time configuration file to set options
31241 for your &[local_scan()]& function, you must also set
31242 .code
31243 LOCAL_SCAN_HAS_OPTIONS=yes
31244 .endd
31245 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31246
31247
31248
31249
31250 .section "API for local_scan()" "SECTapiforloc"
31251 .cindex "&[local_scan()]& function" "API description"
31252 You must include this line near the start of your code:
31253 .code
31254 #include "local_scan.h"
31255 .endd
31256 This header file defines a number of variables and other values, and the
31257 prototype for the function itself. Exim is coded to use unsigned char values
31258 almost exclusively, and one of the things this header defines is a shorthand
31259 for &`unsigned char`& called &`uschar`&.
31260 It also contains the following macro definitions, to simplify casting character
31261 strings and pointers to character strings:
31262 .code
31263 #define CS   (char *)
31264 #define CCS  (const char *)
31265 #define CSS  (char **)
31266 #define US   (unsigned char *)
31267 #define CUS  (const unsigned char *)
31268 #define USS  (unsigned char **)
31269 .endd
31270 The function prototype for &[local_scan()]& is:
31271 .code
31272 extern int local_scan(int fd, uschar **return_text);
31273 .endd
31274 The arguments are as follows:
31275
31276 .ilist
31277 &%fd%& is a file descriptor for the file that contains the body of the message
31278 (the -D file). The file is open for reading and writing, but updating it is not
31279 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31280
31281 The descriptor is positioned at character 19 of the file, which is the first
31282 character of the body itself, because the first 19 characters are the message
31283 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31284 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31285 case this changes in some future version.
31286 .next
31287 &%return_text%& is an address which you can use to return a pointer to a text
31288 string at the end of the function. The value it points to on entry is NULL.
31289 .endlist
31290
31291 The function must return an &%int%& value which is one of the following macros:
31292
31293 .vlist
31294 .vitem &`LOCAL_SCAN_ACCEPT`&
31295 .vindex "&$local_scan_data$&"
31296 The message is accepted. If you pass back a string of text, it is saved with
31297 the message, and made available in the variable &$local_scan_data$&. No
31298 newlines are permitted (if there are any, they are turned into spaces) and the
31299 maximum length of text is 1000 characters.
31300
31301 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31302 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31303 queued without immediate delivery, and is frozen.
31304
31305 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31306 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31307 queued without immediate delivery.
31308
31309 .vitem &`LOCAL_SCAN_REJECT`&
31310 The message is rejected; the returned text is used as an error message which is
31311 passed back to the sender and which is also logged. Newlines are permitted &--
31312 they cause a multiline response for SMTP rejections, but are converted to
31313 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31314 used.
31315
31316 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31317 The message is temporarily rejected; the returned text is used as an error
31318 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31319 problem"& is used.
31320
31321 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31322 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31323 message is not written to the reject log. It has the effect of unsetting the
31324 &%rejected_header%& log selector for just this rejection. If
31325 &%rejected_header%& is already unset (see the discussion of the
31326 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31327 same as LOCAL_SCAN_REJECT.
31328
31329 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31330 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31331 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31332 .endlist
31333
31334 If the message is not being received by interactive SMTP, rejections are
31335 reported by writing to &%stderr%& or by sending an email, as configured by the
31336 &%-oe%& command line options.
31337
31338
31339
31340 .section "Configuration options for local_scan()" "SECTconoptloc"
31341 .cindex "&[local_scan()]& function" "configuration options"
31342 It is possible to have option settings in the main configuration file
31343 that set values in static variables in the &[local_scan()]& module. If you
31344 want to do this, you must have the line
31345 .code
31346 LOCAL_SCAN_HAS_OPTIONS=yes
31347 .endd
31348 in your &_Local/Makefile_& when you build Exim. (This line is in
31349 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31350 file, you must define static variables to hold the option values, and a table
31351 to define them.
31352
31353 The table must be a vector called &%local_scan_options%&, of type
31354 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31355 and a pointer to the variable that holds the value. The entries must appear in
31356 alphabetical order. Following &%local_scan_options%& you must also define a
31357 variable called &%local_scan_options_count%& that contains the number of
31358 entries in the table. Here is a short example, showing two kinds of option:
31359 .code
31360 static int my_integer_option = 42;
31361 static uschar *my_string_option = US"a default string";
31362
31363 optionlist local_scan_options[] = {
31364   { "my_integer", opt_int,       &my_integer_option },
31365   { "my_string",  opt_stringptr, &my_string_option }
31366 };
31367
31368 int local_scan_options_count =
31369   sizeof(local_scan_options)/sizeof(optionlist);
31370 .endd
31371 The values of the variables can now be changed from Exim's runtime
31372 configuration file by including a local scan section as in this example:
31373 .code
31374 begin local_scan
31375 my_integer = 99
31376 my_string = some string of text...
31377 .endd
31378 The available types of option data are as follows:
31379
31380 .vlist
31381 .vitem &*opt_bool*&
31382 This specifies a boolean (true/false) option. The address should point to a
31383 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31384 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31385 whether such a variable has been set at all, you can initialize it to
31386 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31387 values.)
31388
31389 .vitem &*opt_fixed*&
31390 This specifies a fixed point number, such as is used for load averages.
31391 The address should point to a variable of type &`int`&. The value is stored
31392 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31393
31394 .vitem &*opt_int*&
31395 This specifies an integer; the address should point to a variable of type
31396 &`int`&. The value may be specified in any of the integer formats accepted by
31397 Exim.
31398
31399 .vitem &*opt_mkint*&
31400 This is the same as &%opt_int%&, except that when such a value is output in a
31401 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31402 printed with the suffix K or M.
31403
31404 .vitem &*opt_octint*&
31405 This also specifies an integer, but the value is always interpreted as an
31406 octal integer, whether or not it starts with the digit zero, and it is
31407 always output in octal.
31408
31409 .vitem &*opt_stringptr*&
31410 This specifies a string value; the address must be a pointer to a
31411 variable that points to a string (for example, of type &`uschar *`&).
31412
31413 .vitem &*opt_time*&
31414 This specifies a time interval value. The address must point to a variable of
31415 type &`int`&. The value that is placed there is a number of seconds.
31416 .endlist
31417
31418 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31419 out the values of all the &[local_scan()]& options.
31420
31421
31422
31423 .section "Available Exim variables" "SECID208"
31424 .cindex "&[local_scan()]& function" "available Exim variables"
31425 The header &_local_scan.h_& gives you access to a number of C variables. These
31426 are the only ones that are guaranteed to be maintained from release to release.
31427 Note, however, that you can obtain the value of any Exim expansion variable,
31428 including &$recipients$&, by calling &'expand_string()'&. The exported
31429 C variables are as follows:
31430
31431 .vlist
31432 .vitem &*int&~body_linecount*&
31433 This variable contains the number of lines in the message's body.
31434
31435 .vitem &*int&~body_zerocount*&
31436 This variable contains the number of binary zero bytes in the message's body.
31437
31438 .vitem &*unsigned&~int&~debug_selector*&
31439 This variable is set to zero when no debugging is taking place. Otherwise, it
31440 is a bitmap of debugging selectors. Two bits are identified for use in
31441 &[local_scan()]&; they are defined as macros:
31442
31443 .ilist
31444 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31445 testing option that is not privileged &-- any caller may set it. All the
31446 other selector bits can be set only by admin users.
31447
31448 .next
31449 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31450 by the &`+local_scan`& debug selector. It is not included in the default set
31451 of debugging bits.
31452 .endlist ilist
31453
31454 Thus, to write to the debugging output only when &`+local_scan`& has been
31455 selected, you should use code like this:
31456 .code
31457 if ((debug_selector & D_local_scan) != 0)
31458   debug_printf("xxx", ...);
31459 .endd
31460 .vitem &*uschar&~*expand_string_message*&
31461 After a failing call to &'expand_string()'& (returned value NULL), the
31462 variable &%expand_string_message%& contains the error message, zero-terminated.
31463
31464 .vitem &*header_line&~*header_list*&
31465 A pointer to a chain of header lines. The &%header_line%& structure is
31466 discussed below.
31467
31468 .vitem &*header_line&~*header_last*&
31469 A pointer to the last of the header lines.
31470
31471 .vitem &*uschar&~*headers_charset*&
31472 The value of the &%headers_charset%& configuration option.
31473
31474 .vitem &*BOOL&~host_checking*&
31475 This variable is TRUE during a host checking session that is initiated by the
31476 &%-bh%& command line option.
31477
31478 .vitem &*uschar&~*interface_address*&
31479 The IP address of the interface that received the message, as a string. This
31480 is NULL for locally submitted messages.
31481
31482 .vitem &*int&~interface_port*&
31483 The port on which this message was received. When testing with the &%-bh%&
31484 command line option, the value of this variable is -1 unless a port has been
31485 specified via the &%-oMi%& option.
31486
31487 .vitem &*uschar&~*message_id*&
31488 This variable contains Exim's message id for the incoming message (the value of
31489 &$message_exim_id$&) as a zero-terminated string.
31490
31491 .vitem &*uschar&~*received_protocol*&
31492 The name of the protocol by which the message was received.
31493
31494 .vitem &*int&~recipients_count*&
31495 The number of accepted recipients.
31496
31497 .vitem &*recipient_item&~*recipients_list*&
31498 .cindex "recipient" "adding in local scan"
31499 .cindex "recipient" "removing in local scan"
31500 The list of accepted recipients, held in a vector of length
31501 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31502 can add additional recipients by calling &'receive_add_recipient()'& (see
31503 below). You can delete recipients by removing them from the vector and
31504 adjusting the value in &%recipients_count%&. In particular, by setting
31505 &%recipients_count%& to zero you remove all recipients. If you then return the
31506 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31507 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31508 and then call &'receive_add_recipient()'& as often as needed.
31509
31510 .vitem &*uschar&~*sender_address*&
31511 The envelope sender address. For bounce messages this is the empty string.
31512
31513 .vitem &*uschar&~*sender_host_address*&
31514 The IP address of the sending host, as a string. This is NULL for
31515 locally-submitted messages.
31516
31517 .vitem &*uschar&~*sender_host_authenticated*&
31518 The name of the authentication mechanism that was used, or NULL if the message
31519 was not received over an authenticated SMTP connection.
31520
31521 .vitem &*uschar&~*sender_host_name*&
31522 The name of the sending host, if known.
31523
31524 .vitem &*int&~sender_host_port*&
31525 The port on the sending host.
31526
31527 .vitem &*BOOL&~smtp_input*&
31528 This variable is TRUE for all SMTP input, including BSMTP.
31529
31530 .vitem &*BOOL&~smtp_batched_input*&
31531 This variable is TRUE for BSMTP input.
31532
31533 .vitem &*int&~store_pool*&
31534 The contents of this variable control which pool of memory is used for new
31535 requests. See section &<<SECTmemhanloc>>& for details.
31536 .endlist
31537
31538
31539 .section "Structure of header lines" "SECID209"
31540 The &%header_line%& structure contains the members listed below.
31541 You can add additional header lines by calling the &'header_add()'& function
31542 (see below). You can cause header lines to be ignored (deleted) by setting
31543 their type to *.
31544
31545
31546 .vlist
31547 .vitem &*struct&~header_line&~*next*&
31548 A pointer to the next header line, or NULL for the last line.
31549
31550 .vitem &*int&~type*&
31551 A code identifying certain headers that Exim recognizes. The codes are printing
31552 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31553 Notice in particular that any header line whose type is * is not transmitted
31554 with the message. This flagging is used for header lines that have been
31555 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31556 lines.) Effectively, * means &"deleted"&.
31557
31558 .vitem &*int&~slen*&
31559 The number of characters in the header line, including the terminating and any
31560 internal newlines.
31561
31562 .vitem &*uschar&~*text*&
31563 A pointer to the text of the header. It always ends with a newline, followed by
31564 a zero byte. Internal newlines are preserved.
31565 .endlist
31566
31567
31568
31569 .section "Structure of recipient items" "SECID210"
31570 The &%recipient_item%& structure contains these members:
31571
31572 .vlist
31573 .vitem &*uschar&~*address*&
31574 This is a pointer to the recipient address as it was received.
31575
31576 .vitem &*int&~pno*&
31577 This is used in later Exim processing when top level addresses are created by
31578 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31579 and must always contain -1 at this stage.
31580
31581 .vitem &*uschar&~*errors_to*&
31582 If this value is not NULL, bounce messages caused by failing to deliver to the
31583 recipient are sent to the address it contains. In other words, it overrides the
31584 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31585 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31586 an unqualified address, Exim qualifies it using the domain from
31587 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31588 is NULL for all recipients.
31589 .endlist
31590
31591
31592
31593 .section "Available Exim functions" "SECID211"
31594 .cindex "&[local_scan()]& function" "available Exim functions"
31595 The header &_local_scan.h_& gives you access to a number of Exim functions.
31596 These are the only ones that are guaranteed to be maintained from release to
31597 release:
31598
31599 .vlist
31600 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31601        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31602
31603 This function creates a child process that runs the command specified by
31604 &%argv%&. The environment for the process is specified by &%envp%&, which can
31605 be NULL if no environment variables are to be passed. A new umask is supplied
31606 for the process in &%newumask%&.
31607
31608 Pipes to the standard input and output of the new process are set up
31609 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31610 standard error is cloned to the standard output. If there are any file
31611 descriptors &"in the way"& in the new process, they are closed. If the final
31612 argument is TRUE, the new process is made into a process group leader.
31613
31614 The function returns the pid of the new process, or -1 if things go wrong.
31615
31616 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31617 This function waits for a child process to terminate, or for a timeout (in
31618 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31619 return value is as follows:
31620
31621 .ilist
31622 >= 0
31623
31624 The process terminated by a normal exit and the value is the process
31625 ending status.
31626
31627 .next
31628 < 0 and > &--256
31629
31630 The process was terminated by a signal and the value is the negation of the
31631 signal number.
31632
31633 .next
31634 &--256
31635
31636 The process timed out.
31637 .next
31638 &--257
31639
31640 The was some other error in wait(); &%errno%& is still set.
31641 .endlist
31642
31643 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
31644 This function provide you with a means of submitting a new message to
31645 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
31646 want, but this packages it all up for you.) The function creates a pipe,
31647 forks a subprocess that is running
31648 .code
31649 exim -t -oem -oi -f <>
31650 .endd
31651 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
31652 that is connected to the standard input. The yield of the function is the PID
31653 of the subprocess. You can then write a message to the file descriptor, with
31654 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
31655
31656 When you have finished, call &'child_close()'& to wait for the process to
31657 finish and to collect its ending status. A timeout value of zero is usually
31658 fine in this circumstance. Unless you have made a mistake with the recipient
31659 addresses, you should get a return code of zero.
31660
31661
31662 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
31663        *sender_authentication)*&
31664 This function is a more sophisticated version of &'child_open()'&. The command
31665 that it runs is:
31666 .display
31667 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
31668 .endd
31669 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
31670
31671
31672 .vitem &*void&~debug_printf(char&~*,&~...)*&
31673 This is Exim's debugging function, with arguments as for &'(printf()'&. The
31674 output is written to the standard error stream. If no debugging is selected,
31675 calls to &'debug_printf()'& have no effect. Normally, you should make calls
31676 conditional on the &`local_scan`& debug selector by coding like this:
31677 .code
31678 if ((debug_selector & D_local_scan) != 0)
31679   debug_printf("xxx", ...);
31680 .endd
31681
31682 .vitem &*uschar&~*expand_string(uschar&~*string)*&
31683 This is an interface to Exim's string expansion code. The return value is the
31684 expanded string, or NULL if there was an expansion failure.
31685 The C variable &%expand_string_message%& contains an error message after an
31686 expansion failure. If expansion does not change the string, the return value is
31687 the pointer to the input string. Otherwise, the return value points to a new
31688 block of memory that was obtained by a call to &'store_get()'&. See section
31689 &<<SECTmemhanloc>>& below for a discussion of memory handling.
31690
31691 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
31692 This function allows you to an add additional header line at the end of the
31693 existing ones. The first argument is the type, and should normally be a space
31694 character. The second argument is a format string and any number of
31695 substitution arguments as for &[sprintf()]&. You may include internal newlines
31696 if you want, and you must ensure that the string ends with a newline.
31697
31698 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
31699         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
31700 This function adds a new header line at a specified point in the header
31701 chain. The header itself is specified as for &'header_add()'&.
31702
31703 If &%name%& is NULL, the new header is added at the end of the chain if
31704 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
31705 NULL, the header lines are searched for the first non-deleted header that
31706 matches the name. If one is found, the new header is added before it if
31707 &%after%& is false. If &%after%& is true, the new header is added after the
31708 found header and any adjacent subsequent ones with the same name (even if
31709 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
31710 option controls where the header is added. If it is true, addition is at the
31711 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
31712 headers, or at the top if there are no &'Received:'& headers, you could use
31713 .code
31714 header_add_at_position(TRUE, US"Received", TRUE,
31715   ' ', "X-xxx: ...");
31716 .endd
31717 Normally, there is always at least one non-deleted &'Received:'& header, but
31718 there may not be if &%received_header_text%& expands to an empty string.
31719
31720
31721 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
31722 This function removes header lines. If &%occurrence%& is zero or negative, all
31723 occurrences of the header are removed. If occurrence is greater than zero, that
31724 particular instance of the header is removed. If no header(s) can be found that
31725 match the specification, the function does nothing.
31726
31727
31728 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
31729         int&~length,&~BOOL&~notdel)*&"
31730 This function tests whether the given header has the given name. It is not just
31731 a string comparison, because white space is permitted between the name and the
31732 colon. If the &%notdel%& argument is true, a false return is forced for all
31733 &"deleted"& headers; otherwise they are not treated specially. For example:
31734 .code
31735 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
31736 .endd
31737 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
31738 .cindex "base64 encoding" "functions for &[local_scan()]& use"
31739 This function base64-encodes a string, which is passed by address and length.
31740 The text may contain bytes of any value, including zero. The result is passed
31741 back in dynamic memory that is obtained by calling &'store_get()'&. It is
31742 zero-terminated.
31743
31744 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
31745 This function decodes a base64-encoded string. Its arguments are a
31746 zero-terminated base64-encoded string and the address of a variable that is set
31747 to point to the result, which is in dynamic memory. The length of the decoded
31748 string is the yield of the function. If the input is invalid base64 data, the
31749 yield is -1. A zero byte is added to the end of the output string to make it
31750 easy to interpret as a C string (assuming it contains no zeros of its own). The
31751 added zero byte is not included in the returned count.
31752
31753 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
31754 This function checks for a match in a domain list. Domains are always
31755 matched caselessly. The return value is one of the following:
31756 .display
31757 &`OK     `& match succeeded
31758 &`FAIL   `& match failed
31759 &`DEFER  `& match deferred
31760 .endd
31761 DEFER is usually caused by some kind of lookup defer, such as the
31762 inability to contact a database.
31763
31764 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
31765         BOOL&~caseless)*&"
31766 This function checks for a match in a local part list. The third argument
31767 controls case-sensitivity. The return values are as for
31768 &'lss_match_domain()'&.
31769
31770 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
31771         BOOL&~caseless)*&"
31772 This function checks for a match in an address list. The third argument
31773 controls the case-sensitivity of the local part match. The domain is always
31774 matched caselessly. The return values are as for &'lss_match_domain()'&.
31775
31776 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
31777         uschar&~*list)*&"
31778 This function checks for a match in a host list. The most common usage is
31779 expected to be
31780 .code
31781 lss_match_host(sender_host_name, sender_host_address, ...)
31782 .endd
31783 .vindex "&$sender_host_address$&"
31784 An empty address field matches an empty item in the host list. If the host name
31785 is NULL, the name corresponding to &$sender_host_address$& is automatically
31786 looked up if a host name is required to match an item in the list. The return
31787 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
31788 returns ERROR in the case when it had to look up a host name, but the lookup
31789 failed.
31790
31791 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
31792         *format,&~...)*&"
31793 This function writes to Exim's log files. The first argument should be zero (it
31794 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
31795 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
31796 them. It specifies to which log or logs the message is written. The remaining
31797 arguments are a format and relevant insertion arguments. The string should not
31798 contain any newlines, not even at the end.
31799
31800
31801 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
31802 This function adds an additional recipient to the message. The first argument
31803 is the recipient address. If it is unqualified (has no domain), it is qualified
31804 with the &%qualify_recipient%& domain. The second argument must always be -1.
31805
31806 This function does not allow you to specify a private &%errors_to%& address (as
31807 described with the structure of &%recipient_item%& above), because it pre-dates
31808 the addition of that field to the structure. However, it is easy to add such a
31809 value afterwards. For example:
31810 .code
31811  receive_add_recipient(US"monitor@mydom.example", -1);
31812  recipients_list[recipients_count-1].errors_to =
31813    US"postmaster@mydom.example";
31814 .endd
31815
31816 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
31817 This is a convenience function to remove a named recipient from the list of
31818 recipients. It returns true if a recipient was removed, and false if no
31819 matching recipient could be found. The argument must be a complete email
31820 address.
31821 .endlist
31822
31823
31824 .cindex "RFC 2047"
31825 .vlist
31826 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
31827   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
31828 This function decodes strings that are encoded according to RFC 2047. Typically
31829 these are the contents of header lines. First, each &"encoded word"& is decoded
31830 from the Q or B encoding into a byte-string. Then, if provided with the name of
31831 a charset encoding, and if the &[iconv()]& function is available, an attempt is
31832 made  to translate the result to the named character set. If this fails, the
31833 binary string is returned with an error message.
31834
31835 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
31836 maximum MIME word length is enforced. The third argument is the target
31837 encoding, or NULL if no translation is wanted.
31838
31839 .cindex "binary zero" "in RFC 2047 decoding"
31840 .cindex "RFC 2047" "binary zero in"
31841 If a binary zero is encountered in the decoded string, it is replaced by the
31842 contents of the &%zeroval%& argument. For use with Exim headers, the value must
31843 not be 0 because header lines are handled as zero-terminated strings.
31844
31845 The function returns the result of processing the string, zero-terminated; if
31846 &%lenptr%& is not NULL, the length of the result is set in the variable to
31847 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
31848
31849 If an error is encountered, the function returns NULL and uses the &%error%&
31850 argument to return an error message. The variable pointed to by &%error%& is
31851 set to NULL if there is no error; it may be set non-NULL even when the function
31852 returns a non-NULL value if decoding was successful, but there was a problem
31853 with translation.
31854
31855
31856 .vitem &*int&~smtp_fflush(void)*&
31857 This function is used in conjunction with &'smtp_printf()'&, as described
31858 below.
31859
31860 .vitem &*void&~smtp_printf(char&~*,&~...)*&
31861 The arguments of this function are like &[printf()]&; it writes to the SMTP
31862 output stream. You should use this function only when there is an SMTP output
31863 stream, that is, when the incoming message is being received via interactive
31864 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
31865 is FALSE. If you want to test for an incoming message from another host (as
31866 opposed to a local process that used the &%-bs%& command line option), you can
31867 test the value of &%sender_host_address%&, which is non-NULL when a remote host
31868 is involved.
31869
31870 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
31871 output function, so it can be used for all forms of SMTP connection.
31872
31873 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
31874 must start with an appropriate response code: 550 if you are going to return
31875 LOCAL_SCAN_REJECT, 451 if you are going to return
31876 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
31877 initial lines of a multi-line response, the code must be followed by a hyphen
31878 to indicate that the line is not the final response line. You must also ensure
31879 that the lines you write terminate with CRLF. For example:
31880 .code
31881 smtp_printf("550-this is some extra info\r\n");
31882 return LOCAL_SCAN_REJECT;
31883 .endd
31884 Note that you can also create multi-line responses by including newlines in
31885 the data returned via the &%return_text%& argument. The added value of using
31886 &'smtp_printf()'& is that, for instance, you could introduce delays between
31887 multiple output lines.
31888
31889 The &'smtp_printf()'& function does not return any error indication, because it
31890 does not automatically flush pending output, and therefore does not test
31891 the state of the stream. (In the main code of Exim, flushing and error
31892 detection is done when Exim is ready for the next SMTP input command.) If
31893 you want to flush the output and check for an error (for example, the
31894 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
31895 arguments. It flushes the output stream, and returns a non-zero value if there
31896 is an error.
31897
31898 .vitem &*void&~*store_get(int)*&
31899 This function accesses Exim's internal store (memory) manager. It gets a new
31900 chunk of memory whose size is given by the argument. Exim bombs out if it ever
31901 runs out of memory. See the next section for a discussion of memory handling.
31902
31903 .vitem &*void&~*store_get_perm(int)*&
31904 This function is like &'store_get()'&, but it always gets memory from the
31905 permanent pool. See the next section for a discussion of memory handling.
31906
31907 .vitem &*uschar&~*string_copy(uschar&~*string)*&
31908 See below.
31909
31910 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
31911 See below.
31912
31913 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
31914 These three functions create strings using Exim's dynamic memory facilities.
31915 The first makes a copy of an entire string. The second copies up to a maximum
31916 number of characters, indicated by the second argument. The third uses a format
31917 and insertion arguments to create a new string. In each case, the result is a
31918 pointer to a new string in the current memory pool. See the next section for
31919 more discussion.
31920 .endlist
31921
31922
31923
31924 .section "More about Exim's memory handling" "SECTmemhanloc"
31925 .cindex "&[local_scan()]& function" "memory handling"
31926 No function is provided for freeing memory, because that is never needed.
31927 The dynamic memory that Exim uses when receiving a message is automatically
31928 recycled if another message is received by the same process (this applies only
31929 to incoming SMTP connections &-- other input methods can supply only one
31930 message at a time). After receiving the last message, a reception process
31931 terminates.
31932
31933 Because it is recycled, the normal dynamic memory cannot be used for holding
31934 data that must be preserved over a number of incoming messages on the same SMTP
31935 connection. However, Exim in fact uses two pools of dynamic memory; the second
31936 one is not recycled, and can be used for this purpose.
31937
31938 If you want to allocate memory that remains available for subsequent messages
31939 in the same SMTP connection, you should set
31940 .code
31941 store_pool = POOL_PERM
31942 .endd
31943 before calling the function that does the allocation. There is no need to
31944 restore the value if you do not need to; however, if you do want to revert to
31945 the normal pool, you can either restore the previous value of &%store_pool%& or
31946 set it explicitly to POOL_MAIN.
31947
31948 The pool setting applies to all functions that get dynamic memory, including
31949 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
31950 There is also a convenience function called &'store_get_perm()'& that gets a
31951 block of memory from the permanent pool while preserving the value of
31952 &%store_pool%&.
31953 .ecindex IIDlosca
31954
31955
31956
31957
31958 . ////////////////////////////////////////////////////////////////////////////
31959 . ////////////////////////////////////////////////////////////////////////////
31960
31961 .chapter "System-wide message filtering" "CHAPsystemfilter"
31962 .scindex IIDsysfil1 "filter" "system filter"
31963 .scindex IIDsysfil2 "filtering all mail"
31964 .scindex IIDsysfil3 "system filter"
31965 The previous chapters (on ACLs and the local scan function) describe checks
31966 that can be applied to messages before they are accepted by a host. There is
31967 also a mechanism for checking messages once they have been received, but before
31968 they are delivered. This is called the &'system filter'&.
31969
31970 The system filter operates in a similar manner to users' filter files, but it
31971 is run just once per message (however many recipients the message has).
31972 It should not normally be used as a substitute for routing, because &%deliver%&
31973 commands in a system router provide new envelope recipient addresses.
31974 The system filter must be an Exim filter. It cannot be a Sieve filter.
31975
31976 The system filter is run at the start of a delivery attempt, before any routing
31977 is done. If a message fails to be completely delivered at the first attempt,
31978 the system filter is run again at the start of every retry.
31979 If you want your filter to do something only once per message, you can make use
31980 of the &%first_delivery%& condition in an &%if%& command in the filter to
31981 prevent it happening on retries.
31982
31983 .vindex "&$domain$&"
31984 .vindex "&$local_part$&"
31985 &*Warning*&: Because the system filter runs just once, variables that are
31986 specific to individual recipient addresses, such as &$local_part$& and
31987 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
31988 you want to run a centrally-specified filter for each recipient address
31989 independently, you can do so by setting up a suitable &(redirect)& router, as
31990 described in section &<<SECTperaddfil>>& below.
31991
31992
31993 .section "Specifying a system filter" "SECID212"
31994 .cindex "uid (user id)" "system filter"
31995 .cindex "gid (group id)" "system filter"
31996 The name of the file that contains the system filter must be specified by
31997 setting &%system_filter%&. If you want the filter to run under a uid and gid
31998 other than root, you must also set &%system_filter_user%& and
31999 &%system_filter_group%& as appropriate. For example:
32000 .code
32001 system_filter = /etc/mail/exim.filter
32002 system_filter_user = exim
32003 .endd
32004 If a system filter generates any deliveries directly to files or pipes (via the
32005 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32006 specified by setting &%system_filter_file_transport%& and
32007 &%system_filter_pipe_transport%&, respectively. Similarly,
32008 &%system_filter_reply_transport%& must be set to handle any messages generated
32009 by the &%reply%& command.
32010
32011
32012 .section "Testing a system filter" "SECID213"
32013 You can run simple tests of a system filter in the same way as for a user
32014 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32015 are permitted only in system filters are recognized.
32016
32017 If you want to test the combined effect of a system filter and a user filter,
32018 you can use both &%-bF%& and &%-bf%& on the same command line.
32019
32020
32021
32022 .section "Contents of a system filter" "SECID214"
32023 The language used to specify system filters is the same as for users' filter
32024 files. It is described in the separate end-user document &'Exim's interface to
32025 mail filtering'&. However, there are some additional features that are
32026 available only in system filters; these are described in subsequent sections.
32027 If they are encountered in a user's filter file or when testing with &%-bf%&,
32028 they cause errors.
32029
32030 .cindex "frozen messages" "manual thaw; testing in filter"
32031 There are two special conditions which, though available in users' filter
32032 files, are designed for use in system filters. The condition &%first_delivery%&
32033 is true only for the first attempt at delivering a message, and
32034 &%manually_thawed%& is true only if the message has been frozen, and
32035 subsequently thawed by an admin user. An explicit forced delivery counts as a
32036 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32037
32038 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32039 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32040 succeed, it will not be tried again.
32041 If you want Exim to retry an unseen delivery until it succeeds, you should
32042 arrange to set it up every time the filter runs.
32043
32044 When a system filter finishes running, the values of the variables &$n0$& &--
32045 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32046 users' filter files. Thus a system filter can, for example, set up &"scores"&
32047 to which users' filter files can refer.
32048
32049
32050
32051 .section "Additional variable for system filters" "SECID215"
32052 .vindex "&$recipients$&"
32053 The expansion variable &$recipients$&, containing a list of all the recipients
32054 of the message (separated by commas and white space), is available in system
32055 filters. It is not available in users' filters for privacy reasons.
32056
32057
32058
32059 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32060 .cindex "freezing messages"
32061 .cindex "message" "freezing"
32062 .cindex "message" "forced failure"
32063 .cindex "&%fail%&" "in system filter"
32064 .cindex "&%freeze%& in system filter"
32065 .cindex "&%defer%& in system filter"
32066 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32067 always available in system filters, but are not normally enabled in users'
32068 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32069 for the &(redirect)& router.) These commands can optionally be followed by the
32070 word &%text%& and a string containing an error message, for example:
32071 .code
32072 fail text "this message looks like spam to me"
32073 .endd
32074 The keyword &%text%& is optional if the next character is a double quote.
32075
32076 The &%defer%& command defers delivery of the original recipients of the
32077 message. The &%fail%& command causes all the original recipients to be failed,
32078 and a bounce message to be created. The &%freeze%& command suspends all
32079 delivery attempts for the original recipients. In all cases, any new deliveries
32080 that are specified by the filter are attempted as normal after the filter has
32081 run.
32082
32083 The &%freeze%& command is ignored if the message has been manually unfrozen and
32084 not manually frozen since. This means that automatic freezing by a system
32085 filter can be used as a way of checking out suspicious messages. If a message
32086 is found to be all right, manually unfreezing it allows it to be delivered.
32087
32088 .cindex "log" "&%fail%& command log line"
32089 .cindex "&%fail%&" "log line; reducing"
32090 The text given with a fail command is used as part of the bounce message as
32091 well as being written to the log. If the message is quite long, this can fill
32092 up a lot of log space when such failures are common. To reduce the size of the
32093 log message, Exim interprets the text in a special way if it starts with the
32094 two characters &`<<`& and contains &`>>`& later. The text between these two
32095 strings is written to the log, and the rest of the text is used in the bounce
32096 message. For example:
32097 .code
32098 fail "<<filter test 1>>Your message is rejected \
32099      because it contains attachments that we are \
32100      not prepared to receive."
32101 .endd
32102
32103 .cindex "loop" "caused by &%fail%&"
32104 Take great care with the &%fail%& command when basing the decision to fail on
32105 the contents of the message, because the bounce message will of course include
32106 the contents of the original message and will therefore trigger the &%fail%&
32107 command again (causing a mail loop) unless steps are taken to prevent this.
32108 Testing the &%error_message%& condition is one way to prevent this. You could
32109 use, for example
32110 .code
32111 if $message_body contains "this is spam" and not error_message
32112 then fail text "spam is not wanted here" endif
32113 .endd
32114 though of course that might let through unwanted bounce messages. The
32115 alternative is clever checking of the body and/or headers to detect bounces
32116 generated by the filter.
32117
32118 The interpretation of a system filter file ceases after a
32119 &%defer%&,
32120 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32121 set up earlier in the filter file are honoured, so you can use a sequence such
32122 as
32123 .code
32124 mail ...
32125 freeze
32126 .endd
32127 to send a specified message when the system filter is freezing (or deferring or
32128 failing) a message. The normal deliveries for the message do not, of course,
32129 take place.
32130
32131
32132
32133 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32134 .cindex "header lines" "adding; in system filter"
32135 .cindex "header lines" "removing; in system filter"
32136 .cindex "filter" "header lines; adding/removing"
32137 Two filter commands that are available only in system filters are:
32138 .code
32139 headers add <string>
32140 headers remove <string>
32141 .endd
32142 The argument for the &%headers add%& is a string that is expanded and then
32143 added to the end of the message's headers. It is the responsibility of the
32144 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32145 space is ignored, and if the string is otherwise empty, or if the expansion is
32146 forced to fail, the command has no effect.
32147
32148 You can use &"\n"& within the string, followed by white space, to specify
32149 continued header lines. More than one header may be added in one command by
32150 including &"\n"& within the string without any following white space. For
32151 example:
32152 .code
32153 headers add "X-header-1: ....\n  \
32154              continuation of X-header-1 ...\n\
32155              X-header-2: ...."
32156 .endd
32157 Note that the header line continuation white space after the first newline must
32158 be placed before the backslash that continues the input string, because white
32159 space after input continuations is ignored.
32160
32161 The argument for &%headers remove%& is a colon-separated list of header names.
32162 This command applies only to those headers that are stored with the message;
32163 those that are added at delivery time (such as &'Envelope-To:'& and
32164 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32165 header with the same name, they are all removed.
32166
32167 The &%headers%& command in a system filter makes an immediate change to the set
32168 of header lines that was received with the message (with possible additions
32169 from ACL processing). Subsequent commands in the system filter operate on the
32170 modified set, which also forms the basis for subsequent message delivery.
32171 Unless further modified during routing or transporting, this set of headers is
32172 used for all recipients of the message.
32173
32174 During routing and transporting, the variables that refer to the contents of
32175 header lines refer only to those lines that are in this set. Thus, header lines
32176 that are added by a system filter are visible to users' filter files and to all
32177 routers and transports. This contrasts with the manipulation of header lines by
32178 routers and transports, which is not immediate, but which instead is saved up
32179 until the message is actually being written (see section
32180 &<<SECTheadersaddrem>>&).
32181
32182 If the message is not delivered at the first attempt, header lines that were
32183 added by the system filter are stored with the message, and so are still
32184 present at the next delivery attempt. Header lines that were removed are still
32185 present, but marked &"deleted"& so that they are not transported with the
32186 message. For this reason, it is usual to make the &%headers%& command
32187 conditional on &%first_delivery%& so that the set of header lines is not
32188 modified more than once.
32189
32190 Because header modification in a system filter acts immediately, you have to
32191 use an indirect approach if you want to modify the contents of a header line.
32192 For example:
32193 .code
32194 headers add "Old-Subject: $h_subject:"
32195 headers remove "Subject"
32196 headers add "Subject: new subject (was: $h_old-subject:)"
32197 headers remove "Old-Subject"
32198 .endd
32199
32200
32201
32202 .section "Setting an errors address in a system filter" "SECID217"
32203 .cindex "envelope sender"
32204 In a system filter, if a &%deliver%& command is followed by
32205 .code
32206 errors_to <some address>
32207 .endd
32208 in order to change the envelope sender (and hence the error reporting) for that
32209 delivery, any address may be specified. (In a user filter, only the current
32210 user's address can be set.) For example, if some mail is being monitored, you
32211 might use
32212 .code
32213 unseen deliver monitor@spying.example errors_to root@local.example
32214 .endd
32215 to take a copy which would not be sent back to the normal error reporting
32216 address if its delivery failed.
32217
32218
32219
32220 .section "Per-address filtering" "SECTperaddfil"
32221 .vindex "&$domain$&"
32222 .vindex "&$local_part$&"
32223 In contrast to the system filter, which is run just once per message for each
32224 delivery attempt, it is also possible to set up a system-wide filtering
32225 operation that runs once for each recipient address. In this case, variables
32226 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32227 filter file could be made dependent on them. This is an example of a router
32228 which implements such a filter:
32229 .code
32230 central_filter:
32231   check_local_user
32232   driver = redirect
32233   domains = +local_domains
32234   file = /central/filters/$local_part
32235   no_verify
32236   allow_filter
32237   allow_freeze
32238 .endd
32239 The filter is run in a separate process under its own uid. Therefore, either
32240 &%check_local_user%& must be set (as above), in which case the filter is run as
32241 the local user, or the &%user%& option must be used to specify which user to
32242 use. If both are set, &%user%& overrides.
32243
32244 Care should be taken to ensure that none of the commands in the filter file
32245 specify a significant delivery if the message is to go on to be delivered to
32246 its intended recipient. The router will not then claim to have dealt with the
32247 address, so it will be passed on to subsequent routers to be delivered in the
32248 normal way.
32249 .ecindex IIDsysfil1
32250 .ecindex IIDsysfil2
32251 .ecindex IIDsysfil3
32252
32253
32254
32255
32256
32257
32258 . ////////////////////////////////////////////////////////////////////////////
32259 . ////////////////////////////////////////////////////////////////////////////
32260
32261 .chapter "Message processing" "CHAPmsgproc"
32262 .scindex IIDmesproc "message" "general processing"
32263 Exim performs various transformations on the sender and recipient addresses of
32264 all messages that it handles, and also on the messages' header lines. Some of
32265 these are optional and configurable, while others always take place. All of
32266 this processing, except rewriting as a result of routing, and the addition or
32267 removal of header lines while delivering, happens when a message is received,
32268 before it is placed on Exim's queue.
32269
32270 Some of the automatic processing takes place by default only for
32271 &"locally-originated"& messages. This adjective is used to describe messages
32272 that are not received over TCP/IP, but instead are passed to an Exim process on
32273 its standard input. This includes the interactive &"local SMTP"& case that is
32274 set up by the &%-bs%& command line option.
32275
32276 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32277 or ::1) are not considered to be locally-originated. Exim does not treat the
32278 loopback interface specially in any way.
32279
32280 If you want the loopback interface to be treated specially, you must ensure
32281 that there are appropriate entries in your ACLs.
32282
32283
32284
32285
32286 .section "Submission mode for non-local messages" "SECTsubmodnon"
32287 .cindex "message" "submission"
32288 .cindex "submission mode"
32289 Processing that happens automatically for locally-originated messages (unless
32290 &%suppress_local_fixups%& is set) can also be requested for messages that are
32291 received over TCP/IP. The term &"submission mode"& is used to describe this
32292 state. Submission mode is set by the modifier
32293 .code
32294 control = submission
32295 .endd
32296 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32297 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32298 a local submission, and is normally used when the source of the message is
32299 known to be an MUA running on a client host (as opposed to an MTA). For
32300 example, to set submission mode for messages originating on the IPv4 loopback
32301 interface, you could include the following in the MAIL ACL:
32302 .code
32303 warn  hosts = 127.0.0.1
32304       control = submission
32305 .endd
32306 .cindex "&%sender_retain%& submission option"
32307 There are some options that can be used when setting submission mode. A slash
32308 is used to separate options. For example:
32309 .code
32310 control = submission/sender_retain
32311 .endd
32312 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32313 true and &%local_from_check%& false for the current incoming message. The first
32314 of these allows an existing &'Sender:'& header in the message to remain, and
32315 the second suppresses the check to ensure that &'From:'& matches the
32316 authenticated sender. With this setting, Exim still fixes up messages by adding
32317 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32318 attempt to check sender authenticity in header lines.
32319
32320 When &%sender_retain%& is not set, a submission mode setting may specify a
32321 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32322 example:
32323 .code
32324 control = submission/domain=some.domain
32325 .endd
32326 The domain may be empty. How this value is used is described in sections
32327 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32328 that allows you to specify the user's full name for inclusion in a created
32329 &'Sender:'& or &'From:'& header line. For example:
32330 .code
32331 accept authenticated = *
32332        control = submission/domain=wonderland.example/\
32333                             name=${lookup {$authenticated_id} \
32334                                    lsearch {/etc/exim/namelist}}
32335 .endd
32336 Because the name may contain any characters, including slashes, the &%name%&
32337 option must be given last. The remainder of the string is used as the name. For
32338 the example above, if &_/etc/exim/namelist_& contains:
32339 .code
32340 bigegg:  Humpty Dumpty
32341 .endd
32342 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32343 line would be:
32344 .code
32345 Sender: Humpty Dumpty <bigegg@wonderland.example>
32346 .endd
32347 .cindex "return path" "in submission mode"
32348 By default, submission mode forces the return path to the same address as is
32349 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32350 specified, the return path is also left unchanged.
32351
32352 &*Note*&: The changes caused by submission mode take effect after the predata
32353 ACL. This means that any sender checks performed before the fix-ups use the
32354 untrusted sender address specified by the user, not the trusted sender address
32355 specified by submission mode. Although this might be slightly unexpected, it
32356 does mean that you can configure ACL checks to spot that a user is trying to
32357 spoof another's address.
32358
32359 .section "Line endings" "SECTlineendings"
32360 .cindex "line endings"
32361 .cindex "carriage return"
32362 .cindex "linefeed"
32363 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32364 linefeed) is the line ending for messages transmitted over the Internet using
32365 SMTP over TCP/IP. However, within individual operating systems, different
32366 conventions are used. For example, Unix-like systems use just LF, but others
32367 use CRLF or just CR.
32368
32369 Exim was designed for Unix-like systems, and internally, it stores messages
32370 using the system's convention of a single LF as a line terminator. When
32371 receiving a message, all line endings are translated to this standard format.
32372 Originally, it was thought that programs that passed messages directly to an
32373 MTA within an operating system would use that system's convention. Experience
32374 has shown that this is not the case; for example, there are Unix applications
32375 that use CRLF in this circumstance. For this reason, and for compatibility with
32376 other MTAs, the way Exim handles line endings for all messages is now as
32377 follows:
32378
32379 .ilist
32380 LF not preceded by CR is treated as a line ending.
32381 .next
32382 CR is treated as a line ending; if it is immediately followed by LF, the LF
32383 is ignored.
32384 .next
32385 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32386 nor a local message in the state where a line containing only a dot is a
32387 terminator.
32388 .next
32389 If a bare CR is encountered within a header line, an extra space is added after
32390 the line terminator so as not to end the header line. The reasoning behind this
32391 is that bare CRs in header lines are most likely either to be mistakes, or
32392 people trying to play silly games.
32393 .next
32394 If the first header line received in a message ends with CRLF, a subsequent
32395 bare LF in a header line is treated in the same way as a bare CR in a header
32396 line.
32397 .endlist
32398
32399
32400
32401
32402
32403 .section "Unqualified addresses" "SECID218"
32404 .cindex "unqualified addresses"
32405 .cindex "address" "qualification"
32406 By default, Exim expects every envelope address it receives from an external
32407 host to be fully qualified. Unqualified addresses cause negative responses to
32408 SMTP commands. However, because SMTP is used as a means of transporting
32409 messages from MUAs running on personal workstations, there is sometimes a
32410 requirement to accept unqualified addresses from specific hosts or IP networks.
32411
32412 Exim has two options that separately control which hosts may send unqualified
32413 sender or recipient addresses in SMTP commands, namely
32414 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32415 cases, if an unqualified address is accepted, it is qualified by adding the
32416 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32417
32418 .oindex "&%qualify_domain%&"
32419 .oindex "&%qualify_recipient%&"
32420 Unqualified addresses in header lines are automatically qualified for messages
32421 that are locally originated, unless the &%-bnq%& option is given on the command
32422 line. For messages received over SMTP, unqualified addresses in header lines
32423 are qualified only if unqualified addresses are permitted in SMTP commands. In
32424 other words, such qualification is also controlled by
32425 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32426
32427
32428
32429
32430 .section "The UUCP From line" "SECID219"
32431 .cindex "&""From""& line"
32432 .cindex "UUCP" "&""From""& line"
32433 .cindex "sender" "address"
32434 .oindex "&%uucp_from_pattern%&"
32435 .oindex "&%uucp_from_sender%&"
32436 .cindex "envelope sender"
32437 .cindex "Sendmail compatibility" "&""From""& line"
32438 Messages that have come from UUCP (and some other applications) often begin
32439 with a line containing the envelope sender and a timestamp, following the word
32440 &"From"&. Examples of two common formats are:
32441 .code
32442 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32443 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32444 .endd
32445 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32446 Exim recognizes such lines at the start of messages that are submitted to it
32447 via the command line (that is, on the standard input). It does not recognize
32448 such lines in incoming SMTP messages, unless the sending host matches
32449 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32450 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32451 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32452 default value matches the two common cases shown above and puts the address
32453 that follows &"From"& into &$1$&.
32454
32455 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32456 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32457 a trusted user, the message's sender address is constructed by expanding the
32458 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32459 then parsed as an RFC 2822 address. If there is no domain, the local part is
32460 qualified with &%qualify_domain%& unless it is the empty string. However, if
32461 the command line &%-f%& option is used, it overrides the &"From"& line.
32462
32463 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32464 sender address is not changed. This is also the case for incoming SMTP messages
32465 that are permitted to contain &"From"& lines.
32466
32467 Only one &"From"& line is recognized. If there is more than one, the second is
32468 treated as a data line that starts the body of the message, as it is not valid
32469 as a header line. This also happens if a &"From"& line is present in an
32470 incoming SMTP message from a source that is not permitted to send them.
32471
32472
32473
32474 .section "Resent- header lines" "SECID220"
32475 .cindex "&%Resent-%& header lines"
32476 RFC 2822 makes provision for sets of header lines starting with the string
32477 &`Resent-`& to be added to a message when it is resent by the original
32478 recipient to somebody else. These headers are &'Resent-Date:'&,
32479 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32480 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32481
32482 .blockquote
32483 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32484 processing of replies or other such automatic actions on messages.'&
32485 .endblockquote
32486
32487 This leaves things a bit vague as far as other processing actions such as
32488 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32489 follows:
32490
32491 .ilist
32492 A &'Resent-From:'& line that just contains the login id of the submitting user
32493 is automatically rewritten in the same way as &'From:'& (see below).
32494 .next
32495 If there's a rewriting rule for a particular header line, it is also applied to
32496 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32497 &'From:'& also rewrites &'Resent-From:'&.
32498 .next
32499 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32500 also removed.
32501 .next
32502 For a locally-submitted message,
32503 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32504 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32505 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32506 included in log lines in this case.
32507 .next
32508 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32509 &%Resent-%& header lines are present.
32510 .endlist
32511
32512
32513
32514
32515 .section "The Auto-Submitted: header line" "SECID221"
32516 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32517 includes the header line:
32518 .code
32519 Auto-Submitted: auto-replied
32520 .endd
32521
32522 .section "The Bcc: header line" "SECID222"
32523 .cindex "&'Bcc:'& header line"
32524 If Exim is called with the &%-t%& option, to take recipient addresses from a
32525 message's header, it removes any &'Bcc:'& header line that may exist (after
32526 extracting its addresses). If &%-t%& is not present on the command line, any
32527 existing &'Bcc:'& is not removed.
32528
32529
32530 .section "The Date: header line" "SECID223"
32531 .cindex "&'Date:'& header line"
32532 If a locally-generated or submission-mode message has no &'Date:'& header line,
32533 Exim adds one, using the current date and time, unless the
32534 &%suppress_local_fixups%& control has been specified.
32535
32536 .section "The Delivery-date: header line" "SECID224"
32537 .cindex "&'Delivery-date:'& header line"
32538 .oindex "&%delivery_date_remove%&"
32539 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32540 set. Exim can be configured to add them to the final delivery of messages. (See
32541 the generic &%delivery_date_add%& transport option.) They should not be present
32542 in messages in transit. If the &%delivery_date_remove%& configuration option is
32543 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32544 messages.
32545
32546
32547 .section "The Envelope-to: header line" "SECID225"
32548 .cindex "&'Envelope-to:'& header line"
32549 .oindex "&%envelope_to_remove%&"
32550 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32551 Exim can be configured to add them to the final delivery of messages. (See the
32552 generic &%envelope_to_add%& transport option.) They should not be present in
32553 messages in transit. If the &%envelope_to_remove%& configuration option is set
32554 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32555 messages.
32556
32557
32558 .section "The From: header line" "SECTthefrohea"
32559 .cindex "&'From:'& header line"
32560 .cindex "Sendmail compatibility" "&""From""& line"
32561 .cindex "message" "submission"
32562 .cindex "submission mode"
32563 If a submission-mode message does not contain a &'From:'& header line, Exim
32564 adds one if either of the following conditions is true:
32565
32566 .ilist
32567 The envelope sender address is not empty (that is, this is not a bounce
32568 message). The added header line copies the envelope sender address.
32569 .next
32570 .vindex "&$authenticated_id$&"
32571 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32572 .olist
32573 .vindex "&$qualify_domain$&"
32574 If no domain is specified by the submission control, the local part is
32575 &$authenticated_id$& and the domain is &$qualify_domain$&.
32576 .next
32577 If a non-empty domain is specified by the submission control, the local
32578 part is &$authenticated_id$&, and the domain is the specified domain.
32579 .next
32580 If an empty domain is specified by the submission control,
32581 &$authenticated_id$& is assumed to be the complete address.
32582 .endlist
32583 .endlist
32584
32585 A non-empty envelope sender takes precedence.
32586
32587 If a locally-generated incoming message does not contain a &'From:'& header
32588 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32589 containing the sender's address. The calling user's login name and full name
32590 are used to construct the address, as described in section &<<SECTconstr>>&.
32591 They are obtained from the password data by calling &[getpwuid()]& (but see the
32592 &%unknown_login%& configuration option). The address is qualified with
32593 &%qualify_domain%&.
32594
32595 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32596 &'From:'& header line containing just the unqualified login name of the calling
32597 user, this is replaced by an address containing the user's login name and full
32598 name as described in section &<<SECTconstr>>&.
32599
32600
32601 .section "The Message-ID: header line" "SECID226"
32602 .cindex "&'Message-ID:'& header line"
32603 .cindex "message" "submission"
32604 .oindex "&%message_id_header_text%&"
32605 If a locally-generated or submission-mode incoming message does not contain a
32606 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32607 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32608 to the message. If there are any &'Resent-:'& headers in the message, it
32609 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32610 message id, preceded by the letter E to ensure it starts with a letter, and
32611 followed by @ and the primary host name. Additional information can be included
32612 in this header line by setting the &%message_id_header_text%& and/or
32613 &%message_id_header_domain%& options.
32614
32615
32616 .section "The Received: header line" "SECID227"
32617 .cindex "&'Received:'& header line"
32618 A &'Received:'& header line is added at the start of every message. The
32619 contents are defined by the &%received_header_text%& configuration option, and
32620 Exim automatically adds a semicolon and a timestamp to the configured string.
32621
32622 The &'Received:'& header is generated as soon as the message's header lines
32623 have been received. At this stage, the timestamp in the &'Received:'& header
32624 line is the time that the message started to be received. This is the value
32625 that is seen by the DATA ACL and by the &[local_scan()]& function.
32626
32627 Once a message is accepted, the timestamp in the &'Received:'& header line is
32628 changed to the time of acceptance, which is (apart from a small delay while the
32629 -H spool file is written) the earliest time at which delivery could start.
32630
32631
32632 .section "The References: header line" "SECID228"
32633 .cindex "&'References:'& header line"
32634 Messages created by the &(autoreply)& transport include a &'References:'&
32635 header line. This is constructed according to the rules that are described in
32636 section 3.64 of RFC 2822 (which states that replies should contain such a
32637 header line), and section 3.14 of RFC 3834 (which states that automatic
32638 responses are not different in this respect). However, because some mail
32639 processing software does not cope well with very long header lines, no more
32640 than 12 message IDs are copied from the &'References:'& header line in the
32641 incoming message. If there are more than 12, the first one and then the final
32642 11 are copied, before adding the message ID of the incoming message.
32643
32644
32645
32646 .section "The Return-path: header line" "SECID229"
32647 .cindex "&'Return-path:'& header line"
32648 .oindex "&%return_path_remove%&"
32649 &'Return-path:'& header lines are defined as something an MTA may insert when
32650 it does the final delivery of messages. (See the generic &%return_path_add%&
32651 transport option.) Therefore, they should not be present in messages in
32652 transit. If the &%return_path_remove%& configuration option is set (the
32653 default), Exim removes &'Return-path:'& header lines from incoming messages.
32654
32655
32656
32657 .section "The Sender: header line" "SECTthesenhea"
32658 .cindex "&'Sender:'& header line"
32659 .cindex "message" "submission"
32660 For a locally-originated message from an untrusted user, Exim may remove an
32661 existing &'Sender:'& header line, and it may add a new one. You can modify
32662 these actions by setting the &%local_sender_retain%& option true, the
32663 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
32664 control setting.
32665
32666 When a local message is received from an untrusted user and
32667 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
32668 control has not been set, a check is made to see if the address given in the
32669 &'From:'& header line is the correct (local) sender of the message. The address
32670 that is expected has the login name as the local part and the value of
32671 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
32672 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
32673 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
32674 line is added to the message.
32675
32676 If you set &%local_from_check%& false, this checking does not occur. However,
32677 the removal of an existing &'Sender:'& line still happens, unless you also set
32678 &%local_sender_retain%& to be true. It is not possible to set both of these
32679 options true at the same time.
32680
32681 .cindex "submission mode"
32682 By default, no processing of &'Sender:'& header lines is done for messages
32683 received over TCP/IP or for messages submitted by trusted users. However, when
32684 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
32685 not specified on the submission control, the following processing takes place:
32686
32687 .vindex "&$authenticated_id$&"
32688 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
32689 authenticated, and &$authenticated_id$& is not empty, a sender address is
32690 created as follows:
32691
32692 .ilist
32693 .vindex "&$qualify_domain$&"
32694 If no domain is specified by the submission control, the local part is
32695 &$authenticated_id$& and the domain is &$qualify_domain$&.
32696 .next
32697 If a non-empty domain is specified by the submission control, the local part
32698 is &$authenticated_id$&, and the domain is the specified domain.
32699 .next
32700 If an empty domain is specified by the submission control,
32701 &$authenticated_id$& is assumed to be the complete address.
32702 .endlist
32703
32704 This address is compared with the address in the &'From:'& header line. If they
32705 are different, a &'Sender:'& header line containing the created address is
32706 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
32707 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
32708
32709 .cindex "return path" "created from &'Sender:'&"
32710 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
32711 the message (the envelope sender address) is changed to be the same address,
32712 except in the case of submission mode when &%sender_retain%& is specified.
32713
32714
32715
32716 .section "Adding and removing header lines in routers and transports" &&&
32717          "SECTheadersaddrem"
32718 .cindex "header lines" "adding; in router or transport"
32719 .cindex "header lines" "removing; in router or transport"
32720 When a message is delivered, the addition and removal of header lines can be
32721 specified in a system filter, or on any of the routers and transports that
32722 process the message. Section &<<SECTaddremheasys>>& contains details about
32723 modifying headers in a system filter. Header lines can also be added in an ACL
32724 as a message is received (see section &<<SECTaddheadacl>>&).
32725
32726 In contrast to what happens in a system filter, header modifications that are
32727 specified on routers and transports apply only to the particular recipient
32728 addresses that are being processed by those routers and transports. These
32729 changes do not actually take place until a copy of the message is being
32730 transported. Therefore, they do not affect the basic set of header lines, and
32731 they do not affect the values of the variables that refer to header lines.
32732
32733 &*Note*&: In particular, this means that any expansions in the configuration of
32734 the transport cannot refer to the modified header lines, because such
32735 expansions all occur before the message is actually transported.
32736
32737 For both routers and transports, the argument of a &%headers_add%&
32738 option must be in the form of one or more RFC 2822 header lines, separated by
32739 newlines (coded as &"\n"&). For example:
32740 .code
32741 headers_add = X-added-header: added by $primary_hostname\n\
32742               X-added-second: another added header line
32743 .endd
32744 Exim does not check the syntax of these added header lines.
32745
32746 Multiple &%headers_add%& options for a single router or transport can be
32747 specified; the values will append to a single list of header lines.
32748 Each header-line is separately expanded.
32749
32750 The argument of a &%headers_remove%& option must consist of a colon-separated
32751 list of header names. This is confusing, because header names themselves are
32752 often terminated by colons. In this case, the colons are the list separators,
32753 not part of the names. For example:
32754 .code
32755 headers_remove = return-receipt-to:acknowledge-to
32756 .endd
32757
32758 Multiple &%headers_remove%& options for a single router or transport can be
32759 specified; the arguments will append to a single header-names list.
32760 Each item is separately expanded.
32761 Note that colons in complex expansions which are used to
32762 form all or part of a &%headers_remove%& list
32763 will act as list separators.
32764
32765 When &%headers_add%& or &%headers_remove%& is specified on a router,
32766 items are expanded at routing time,
32767 and then associated with all addresses that are
32768 accepted by that router, and also with any new addresses that it generates. If
32769 an address passes through several routers as a result of aliasing or
32770 forwarding, the changes are cumulative.
32771
32772 .oindex "&%unseen%&"
32773 However, this does not apply to multiple routers that result from the use of
32774 the &%unseen%& option. Any header modifications that were specified by the
32775 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
32776
32777 Addresses that end up with different &%headers_add%& or &%headers_remove%&
32778 settings cannot be delivered together in a batch, so a transport is always
32779 dealing with a set of addresses that have the same header-processing
32780 requirements.
32781
32782 The transport starts by writing the original set of header lines that arrived
32783 with the message, possibly modified by the system filter. As it writes out
32784 these lines, it consults the list of header names that were attached to the
32785 recipient address(es) by &%headers_remove%& options in routers, and it also
32786 consults the transport's own &%headers_remove%& option. Header lines whose
32787 names are on either of these lists are not written out. If there are multiple
32788 instances of any listed header, they are all skipped.
32789
32790 After the remaining original header lines have been written, new header
32791 lines that were specified by routers' &%headers_add%& options are written, in
32792 the order in which they were attached to the address. These are followed by any
32793 header lines specified by the transport's &%headers_add%& option.
32794
32795 This way of handling header line modifications in routers and transports has
32796 the following consequences:
32797
32798 .ilist
32799 The original set of header lines, possibly modified by the system filter,
32800 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
32801 to it, at all times.
32802 .next
32803 Header lines that are added by a router's
32804 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
32805 expansion syntax in subsequent routers or the transport.
32806 .next
32807 Conversely, header lines that are specified for removal by &%headers_remove%&
32808 in a router remain visible to subsequent routers and the transport.
32809 .next
32810 Headers added to an address by &%headers_add%& in a router cannot be removed by
32811 a later router or by a transport.
32812 .next
32813 An added header can refer to the contents of an original header that is to be
32814 removed, even it has the same name as the added header. For example:
32815 .code
32816 headers_remove = subject
32817 headers_add = Subject: new subject (was: $h_subject:)
32818 .endd
32819 .endlist
32820
32821 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
32822 for a &(redirect)& router that has the &%one_time%& option set.
32823
32824
32825
32826
32827
32828 .section "Constructed addresses" "SECTconstr"
32829 .cindex "address" "constructed"
32830 .cindex "constructed address"
32831 When Exim constructs a sender address for a locally-generated message, it uses
32832 the form
32833 .display
32834 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
32835 .endd
32836 For example:
32837 .code
32838 Zaphod Beeblebrox <zaphod@end.univ.example>
32839 .endd
32840 The user name is obtained from the &%-F%& command line option if set, or
32841 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
32842 &"gecos"& field from the password entry. If the &"gecos"& field contains an
32843 ampersand character, this is replaced by the login name with the first letter
32844 upper cased, as is conventional in a number of operating systems. See the
32845 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
32846 The &%unknown_username%& option can be used to specify user names in cases when
32847 there is no password file entry.
32848
32849 .cindex "RFC 2047"
32850 In all cases, the user name is made to conform to RFC 2822 by quoting all or
32851 parts of it if necessary. In addition, if it contains any non-printing
32852 characters, it is encoded as described in RFC 2047, which defines a way of
32853 including non-ASCII characters in header lines. The value of the
32854 &%headers_charset%& option specifies the name of the encoding that is used (the
32855 characters are assumed to be in this encoding). The setting of
32856 &%print_topbitchars%& controls whether characters with the top bit set (that
32857 is, with codes greater than 127) count as printing characters or not.
32858
32859
32860
32861 .section "Case of local parts" "SECID230"
32862 .cindex "case of local parts"
32863 .cindex "local part" "case of"
32864 RFC 2822 states that the case of letters in the local parts of addresses cannot
32865 be assumed to be non-significant. Exim preserves the case of local parts of
32866 addresses, but by default it uses a lower-cased form when it is routing,
32867 because on most Unix systems, usernames are in lower case and case-insensitive
32868 routing is required. However, any particular router can be made to use the
32869 original case for local parts by setting the &%caseful_local_part%& generic
32870 router option.
32871
32872 .cindex "mixed-case login names"
32873 If you must have mixed-case user names on your system, the best way to proceed,
32874 assuming you want case-independent handling of incoming email, is to set up
32875 your first router to convert incoming local parts in your domains to the
32876 correct case by means of a file lookup. For example:
32877 .code
32878 correct_case:
32879   driver = redirect
32880   domains = +local_domains
32881   data = ${lookup{$local_part}cdb\
32882               {/etc/usercased.cdb}{$value}fail}\
32883               @$domain
32884 .endd
32885 For this router, the local part is forced to lower case by the default action
32886 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
32887 up a new local part in the correct case. If you then set &%caseful_local_part%&
32888 on any subsequent routers which process your domains, they will operate on
32889 local parts with the correct case in a case-sensitive manner.
32890
32891
32892
32893 .section "Dots in local parts" "SECID231"
32894 .cindex "dot" "in local part"
32895 .cindex "local part" "dots in"
32896 RFC 2822 forbids empty components in local parts. That is, an unquoted local
32897 part may not begin or end with a dot, nor have two consecutive dots in the
32898 middle. However, it seems that many MTAs do not enforce this, so Exim permits
32899 empty components for compatibility.
32900
32901
32902
32903 .section "Rewriting addresses" "SECID232"
32904 .cindex "rewriting" "addresses"
32905 Rewriting of sender and recipient addresses, and addresses in headers, can
32906 happen automatically, or as the result of configuration options, as described
32907 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
32908 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
32909
32910 Automatic rewriting includes qualification, as mentioned above. The other case
32911 in which it can happen is when an incomplete non-local domain is given. The
32912 routing process may cause this to be expanded into the full domain name. For
32913 example, a header such as
32914 .code
32915 To: hare@teaparty
32916 .endd
32917 might get rewritten as
32918 .code
32919 To: hare@teaparty.wonderland.fict.example
32920 .endd
32921 Rewriting as a result of routing is the one kind of message processing that
32922 does not happen at input time, as it cannot be done until the address has
32923 been routed.
32924
32925 Strictly, one should not do &'any'& deliveries of a message until all its
32926 addresses have been routed, in case any of the headers get changed as a
32927 result of routing. However, doing this in practice would hold up many
32928 deliveries for unreasonable amounts of time, just because one address could not
32929 immediately be routed. Exim therefore does not delay other deliveries when
32930 routing of one or more addresses is deferred.
32931 .ecindex IIDmesproc
32932
32933
32934
32935 . ////////////////////////////////////////////////////////////////////////////
32936 . ////////////////////////////////////////////////////////////////////////////
32937
32938 .chapter "SMTP processing" "CHAPSMTP"
32939 .scindex IIDsmtpproc1 "SMTP" "processing details"
32940 .scindex IIDsmtpproc2 "LMTP" "processing details"
32941 Exim supports a number of different ways of using the SMTP protocol, and its
32942 LMTP variant, which is an interactive protocol for transferring messages into a
32943 closed mail store application. This chapter contains details of how SMTP is
32944 processed. For incoming mail, the following are available:
32945
32946 .ilist
32947 SMTP over TCP/IP (Exim daemon or &'inetd'&);
32948 .next
32949 SMTP over the standard input and output (the &%-bs%& option);
32950 .next
32951 Batched SMTP on the standard input (the &%-bS%& option).
32952 .endlist
32953
32954 For mail delivery, the following are available:
32955
32956 .ilist
32957 SMTP over TCP/IP (the &(smtp)& transport);
32958 .next
32959 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
32960 &"lmtp"&);
32961 .next
32962 LMTP over a pipe to a process running in the local host (the &(lmtp)&
32963 transport);
32964 .next
32965 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
32966 the &%use_bsmtp%& option set).
32967 .endlist
32968
32969 &'Batched SMTP'& is the name for a process in which batches of messages are
32970 stored in or read from files (or pipes), in a format in which SMTP commands are
32971 used to contain the envelope information.
32972
32973
32974
32975 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
32976 .cindex "SMTP" "outgoing over TCP/IP"
32977 .cindex "outgoing SMTP over TCP/IP"
32978 .cindex "LMTP" "over TCP/IP"
32979 .cindex "outgoing LMTP over TCP/IP"
32980 .cindex "EHLO"
32981 .cindex "HELO"
32982 .cindex "SIZE option on MAIL command"
32983 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
32984 The &%protocol%& option selects which protocol is to be used, but the actual
32985 processing is the same in both cases.
32986
32987 If, in response to its EHLO command, Exim is told that the SIZE
32988 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
32989 command. The value of <&'n'&> is the message size plus the value of the
32990 &%size_addition%& option (default 1024) to allow for additions to the message
32991 such as per-transport header lines, or changes made in a
32992 .cindex "transport" "filter"
32993 .cindex "filter" "transport filter"
32994 transport filter. If &%size_addition%& is set negative, the use of SIZE is
32995 suppressed.
32996
32997 If the remote server advertises support for PIPELINING, Exim uses the
32998 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
32999 required for the transaction.
33000
33001 If the remote server advertises support for the STARTTLS command, and Exim
33002 was built to support TLS encryption, it tries to start a TLS session unless the
33003 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33004 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33005 is called for verification.
33006
33007 If the remote server advertises support for the AUTH command, Exim scans
33008 the authenticators configuration for any suitable client settings, as described
33009 in chapter &<<CHAPSMTPAUTH>>&.
33010
33011 .cindex "carriage return"
33012 .cindex "linefeed"
33013 Responses from the remote host are supposed to be terminated by CR followed by
33014 LF. However, there are known to be hosts that do not send CR characters, so in
33015 order to be able to interwork with such hosts, Exim treats LF on its own as a
33016 line terminator.
33017
33018 If a message contains a number of different addresses, all those with the same
33019 characteristics (for example, the same envelope sender) that resolve to the
33020 same set of hosts, in the same order, are sent in a single SMTP transaction,
33021 even if they are for different domains, unless there are more than the setting
33022 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33023 they are split into groups containing no more than &%max_rcpt%&s addresses
33024 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33025 in parallel sessions. The order of hosts with identical MX values is not
33026 significant when checking whether addresses can be batched in this way.
33027
33028 When the &(smtp)& transport suffers a temporary failure that is not
33029 message-related, Exim updates its transport-specific database, which contains
33030 records indexed by host name that remember which messages are waiting for each
33031 particular host. It also updates the retry database with new retry times.
33032
33033 .cindex "hints database" "retry keys"
33034 Exim's retry hints are based on host name plus IP address, so if one address of
33035 a multi-homed host is broken, it will soon be skipped most of the time.
33036 See the next section for more detail about error handling.
33037
33038 .cindex "SMTP" "passed connection"
33039 .cindex "SMTP" "batching over TCP/IP"
33040 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33041 looks in the hints database for the transport to see if there are any queued
33042 messages waiting for the host to which it is connected. If it finds one, it
33043 creates a new Exim process using the &%-MC%& option (which can only be used by
33044 a process running as root or the Exim user) and passes the TCP/IP socket to it
33045 so that it can deliver another message using the same socket. The new process
33046 does only those deliveries that are routed to the connected host, and may in
33047 turn pass the socket on to a third process, and so on.
33048
33049 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33050 limit the number of messages sent down a single TCP/IP connection.
33051
33052 .cindex "asterisk" "after IP address"
33053 The second and subsequent messages delivered down an existing connection are
33054 identified in the main log by the addition of an asterisk after the closing
33055 square bracket of the IP address.
33056
33057
33058
33059
33060 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33061 .cindex "error" "in outgoing SMTP"
33062 .cindex "SMTP" "errors in outgoing"
33063 .cindex "host" "error"
33064 Three different kinds of error are recognized for outgoing SMTP: host errors,
33065 message errors, and recipient errors.
33066
33067 .vlist
33068 .vitem "&*Host errors*&"
33069 A host error is not associated with a particular message or with a
33070 particular recipient of a message. The host errors are:
33071
33072 .ilist
33073 Connection refused or timed out,
33074 .next
33075 Any error response code on connection,
33076 .next
33077 Any error response code to EHLO or HELO,
33078 .next
33079 Loss of connection at any time, except after &"."&,
33080 .next
33081 I/O errors at any time,
33082 .next
33083 Timeouts during the session, other than in response to MAIL, RCPT or
33084 the &"."& at the end of the data.
33085 .endlist ilist
33086
33087 For a host error, a permanent error response on connection, or in response to
33088 EHLO, causes all addresses routed to the host to be failed. Any other host
33089 error causes all addresses to be deferred, and retry data to be created for the
33090 host. It is not tried again, for any message, until its retry time arrives. If
33091 the current set of addresses are not all delivered in this run (to some
33092 alternative host), the message is added to the list of those waiting for this
33093 host, so if it is still undelivered when a subsequent successful delivery is
33094 made to the host, it will be sent down the same SMTP connection.
33095
33096 .vitem "&*Message errors*&"
33097 .cindex "message" "error"
33098 A message error is associated with a particular message when sent to a
33099 particular host, but not with a particular recipient of the message. The
33100 message errors are:
33101
33102 .ilist
33103 Any error response code to MAIL, DATA, or the &"."& that terminates
33104 the data,
33105 .next
33106 Timeout after MAIL,
33107 .next
33108 Timeout or loss of connection after the &"."& that terminates the data. A
33109 timeout after the DATA command itself is treated as a host error, as is loss of
33110 connection at any other time.
33111 .endlist ilist
33112
33113 For a message error, a permanent error response (5&'xx'&) causes all addresses
33114 to be failed, and a delivery error report to be returned to the sender. A
33115 temporary error response (4&'xx'&), or one of the timeouts, causes all
33116 addresses to be deferred. Retry data is not created for the host, but instead,
33117 a retry record for the combination of host plus message id is created. The
33118 message is not added to the list of those waiting for this host. This ensures
33119 that the failing message will not be sent to this host again until the retry
33120 time arrives. However, other messages that are routed to the host are not
33121 affected, so if it is some property of the message that is causing the error,
33122 it will not stop the delivery of other mail.
33123
33124 If the remote host specified support for the SIZE parameter in its response
33125 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33126 over-large message will cause a message error because the error arrives as a
33127 response to MAIL.
33128
33129 .vitem "&*Recipient errors*&"
33130 .cindex "recipient" "error"
33131 A recipient error is associated with a particular recipient of a message. The
33132 recipient errors are:
33133
33134 .ilist
33135 Any error response to RCPT,
33136 .next
33137 Timeout after RCPT.
33138 .endlist
33139
33140 For a recipient error, a permanent error response (5&'xx'&) causes the
33141 recipient address to be failed, and a bounce message to be returned to the
33142 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33143 address to be deferred, and routing retry data to be created for it. This is
33144 used to delay processing of the address in subsequent queue runs, until its
33145 routing retry time arrives. This applies to all messages, but because it
33146 operates only in queue runs, one attempt will be made to deliver a new message
33147 to the failing address before the delay starts to operate. This ensures that,
33148 if the failure is really related to the message rather than the recipient
33149 (&"message too big for this recipient"& is a possible example), other messages
33150 have a chance of getting delivered. If a delivery to the address does succeed,
33151 the retry information gets cleared, so all stuck messages get tried again, and
33152 the retry clock is reset.
33153
33154 The message is not added to the list of those waiting for this host. Use of the
33155 host for other messages is unaffected, and except in the case of a timeout,
33156 other recipients are processed independently, and may be successfully delivered
33157 in the current SMTP session. After a timeout it is of course impossible to
33158 proceed with the session, so all addresses get deferred. However, those other
33159 than the one that failed do not suffer any subsequent retry delays. Therefore,
33160 if one recipient is causing trouble, the others have a chance of getting
33161 through when a subsequent delivery attempt occurs before the failing
33162 recipient's retry time.
33163 .endlist
33164
33165 In all cases, if there are other hosts (or IP addresses) available for the
33166 current set of addresses (for example, from multiple MX records), they are
33167 tried in this run for any undelivered addresses, subject of course to their
33168 own retry data. In other words, recipient error retry data does not take effect
33169 until the next delivery attempt.
33170
33171 Some hosts have been observed to give temporary error responses to every
33172 MAIL command at certain times (&"insufficient space"& has been seen). It
33173 would be nice if such circumstances could be recognized, and defer data for the
33174 host itself created, but this is not possible within the current Exim design.
33175 What actually happens is that retry data for every (host, message) combination
33176 is created.
33177
33178 The reason that timeouts after MAIL and RCPT are treated specially is that
33179 these can sometimes arise as a result of the remote host's verification
33180 procedures. Exim makes this assumption, and treats them as if a temporary error
33181 response had been received. A timeout after &"."& is treated specially because
33182 it is known that some broken implementations fail to recognize the end of the
33183 message if the last character of the last line is a binary zero. Thus, it is
33184 helpful to treat this case as a message error.
33185
33186 Timeouts at other times are treated as host errors, assuming a problem with the
33187 host, or the connection to it. If a timeout after MAIL, RCPT,
33188 or &"."& is really a connection problem, the assumption is that at the next try
33189 the timeout is likely to occur at some other point in the dialogue, causing it
33190 then to be treated as a host error.
33191
33192 There is experimental evidence that some MTAs drop the connection after the
33193 terminating &"."& if they do not like the contents of the message for some
33194 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33195 should be given. That is why Exim treats this case as a message rather than a
33196 host error, in order not to delay other messages to the same host.
33197
33198
33199
33200
33201 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33202 .cindex "SMTP" "incoming over TCP/IP"
33203 .cindex "incoming SMTP over TCP/IP"
33204 .cindex "inetd"
33205 .cindex "daemon"
33206 Incoming SMTP messages can be accepted in one of two ways: by running a
33207 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33208 &_/etc/inetd.conf_& should be like this:
33209 .code
33210 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33211 .endd
33212 Exim distinguishes between this case and the case of a locally running user
33213 agent using the &%-bs%& option by checking whether or not the standard input is
33214 a socket. When it is, either the port must be privileged (less than 1024), or
33215 the caller must be root or the Exim user. If any other user passes a socket
33216 with an unprivileged port number, Exim prints a message on the standard error
33217 stream and exits with an error code.
33218
33219 By default, Exim does not make a log entry when a remote host connects or
33220 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33221 unexpected. It can be made to write such log entries by setting the
33222 &%smtp_connection%& log selector.
33223
33224 .cindex "carriage return"
33225 .cindex "linefeed"
33226 Commands from the remote host are supposed to be terminated by CR followed by
33227 LF. However, there are known to be hosts that do not send CR characters. In
33228 order to be able to interwork with such hosts, Exim treats LF on its own as a
33229 line terminator.
33230 Furthermore, because common code is used for receiving messages from all
33231 sources, a CR on its own is also interpreted as a line terminator. However, the
33232 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33233
33234 .cindex "EHLO" "invalid data"
33235 .cindex "HELO" "invalid data"
33236 One area that sometimes gives rise to problems concerns the EHLO or
33237 HELO commands. Some clients send syntactically invalid versions of these
33238 commands, which Exim rejects by default. (This is nothing to do with verifying
33239 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33240 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33241 match the broken hosts that send invalid commands.
33242
33243 .cindex "SIZE option on MAIL command"
33244 .cindex "MAIL" "SIZE option"
33245 The amount of disk space available is checked whenever SIZE is received on
33246 a MAIL command, independently of whether &%message_size_limit%& or
33247 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33248 false. A temporary error is given if there is not enough space. If
33249 &%check_spool_space%& is set, the check is for that amount of space plus the
33250 value given with SIZE, that is, it checks that the addition of the incoming
33251 message will not reduce the space below the threshold.
33252
33253 When a message is successfully received, Exim includes the local message id in
33254 its response to the final &"."& that terminates the data. If the remote host
33255 logs this text it can help with tracing what has happened to a message.
33256
33257 The Exim daemon can limit the number of simultaneous incoming connections it is
33258 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33259 number of simultaneous incoming connections from a single remote host (see the
33260 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33261 rejected using the SMTP temporary error code 421.
33262
33263 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33264 subprocess has finished, as this can get lost at busy times. Instead, it looks
33265 for completed subprocesses every time it wakes up. Provided there are other
33266 things happening (new incoming calls, starts of queue runs), completed
33267 processes will be noticed and tidied away. On very quiet systems you may
33268 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33269 it will be noticed when the daemon next wakes up.
33270
33271 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33272 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33273 high system load &-- for details see the &%smtp_accept_reserve%&,
33274 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33275 applies in both the daemon and &'inetd'& cases.
33276
33277 Exim normally starts a delivery process for each message received, though this
33278 can be varied by means of the &%-odq%& command line option and the
33279 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33280 number of simultaneously running delivery processes started in this way from
33281 SMTP input can be limited by the &%smtp_accept_queue%& and
33282 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33283 subsequently received messages are just put on the input queue without starting
33284 a delivery process.
33285
33286 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33287 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33288 started up from the &'inetd'& daemon, because in that case each connection is
33289 handled by an entirely independent Exim process. Control by load average is,
33290 however, available with &'inetd'&.
33291
33292 Exim can be configured to verify addresses in incoming SMTP commands as they
33293 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33294 to rewrite addresses at this time &-- before any syntax checking is done. See
33295 section &<<SECTrewriteS>>&.
33296
33297 Exim can also be configured to limit the rate at which a client host submits
33298 MAIL and RCPT commands in a single SMTP session. See the
33299 &%smtp_ratelimit_hosts%& option.
33300
33301
33302
33303 .section "Unrecognized SMTP commands" "SECID234"
33304 .cindex "SMTP" "unrecognized commands"
33305 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33306 commands during a single SMTP connection, it drops the connection after sending
33307 the error response to the last command. The default value for
33308 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33309 abuse that subvert web servers into making connections to SMTP ports; in these
33310 circumstances, a number of non-SMTP lines are sent first.
33311
33312
33313 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33314 .cindex "SMTP" "syntax errors"
33315 .cindex "SMTP" "protocol errors"
33316 A syntax error is detected if an SMTP command is recognized, but there is
33317 something syntactically wrong with its data, for example, a malformed email
33318 address in a RCPT command. Protocol errors include invalid command
33319 sequencing such as RCPT before MAIL. If Exim receives more than
33320 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33321 drops the connection after sending the error response to the last command. The
33322 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33323 broken clients that loop sending bad commands (yes, it has been seen).
33324
33325
33326
33327 .section "Use of non-mail SMTP commands" "SECID236"
33328 .cindex "SMTP" "non-mail commands"
33329 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33330 DATA. Exim counts such commands, and drops the connection if there are too
33331 many of them in a single SMTP session. This action catches some
33332 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33333 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33334 defines what &"too many"& means. Its default value is 10.
33335
33336 When a new message is expected, one occurrence of RSET is not counted. This
33337 allows a client to send one RSET between messages (this is not necessary,
33338 but some clients do it). Exim also allows one uncounted occurrence of HELO
33339 or EHLO, and one occurrence of STARTTLS between messages. After
33340 starting up a TLS session, another EHLO is expected, and so it too is not
33341 counted.
33342
33343 The first occurrence of AUTH in a connection, or immediately following
33344 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33345 RCPT, DATA, and QUIT are counted.
33346
33347 You can control which hosts are subject to the limit set by
33348 &%smtp_accept_max_nonmail%& by setting
33349 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33350 the limit apply to all hosts. This option means that you can exclude any
33351 specific badly-behaved hosts that you have to live with.
33352
33353
33354
33355
33356 .section "The VRFY and EXPN commands" "SECID237"
33357 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33358 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33359 appropriate) in order to decide whether the command should be accepted or not.
33360 If no ACL is defined, the command is rejected.
33361
33362 .cindex "VRFY" "processing"
33363 When VRFY is accepted, it runs exactly the same code as when Exim is
33364 called with the &%-bv%& option.
33365
33366 .cindex "EXPN" "processing"
33367 When EXPN is accepted, a single-level expansion of the address is done.
33368 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33369 than a verification (the &%-bv%& option). If an unqualified local part is given
33370 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33371 of VRFY and EXPN commands are logged on the main and reject logs, and
33372 VRFY verification failures are logged on the main log for consistency with
33373 RCPT failures.
33374
33375
33376
33377 .section "The ETRN command" "SECTETRN"
33378 .cindex "ETRN" "processing"
33379 RFC 1985 describes an SMTP command called ETRN that is designed to
33380 overcome the security problems of the TURN command (which has fallen into
33381 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33382 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33383 should be accepted or not. If no ACL is defined, the command is rejected.
33384
33385 The ETRN command is concerned with &"releasing"& messages that are awaiting
33386 delivery to certain hosts. As Exim does not organize its message queue by host,
33387 the only form of ETRN that is supported by default is the one where the
33388 text starts with the &"#"& prefix, in which case the remainder of the text is
33389 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33390 the &%-R%& option to happen, with the remainder of the ETRN text as its
33391 argument. For example,
33392 .code
33393 ETRN #brigadoon
33394 .endd
33395 runs the command
33396 .code
33397 exim -R brigadoon
33398 .endd
33399 which causes a delivery attempt on all messages with undelivered addresses
33400 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33401 default), Exim prevents the simultaneous execution of more than one queue run
33402 for the same argument string as a result of an ETRN command. This stops
33403 a misbehaving client from starting more than one queue runner at once.
33404
33405 .cindex "hints database" "ETRN serialization"
33406 Exim implements the serialization by means of a hints database in which a
33407 record is written whenever a process is started by ETRN, and deleted when
33408 the process completes. However, Exim does not keep the SMTP session waiting for
33409 the ETRN process to complete. Once ETRN is accepted, the client is sent
33410 a &"success"& return code. Obviously there is scope for hints records to get
33411 left lying around if there is a system or program crash. To guard against this,
33412 Exim ignores any records that are more than six hours old.
33413
33414 .oindex "&%smtp_etrn_command%&"
33415 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33416 used. This specifies a command that is run whenever ETRN is received,
33417 whatever the form of its argument. For
33418 example:
33419 .code
33420 smtp_etrn_command = /etc/etrn_command $domain \
33421                     $sender_host_address
33422 .endd
33423 .vindex "&$domain$&"
33424 The string is split up into arguments which are independently expanded. The
33425 expansion variable &$domain$& is set to the argument of the ETRN command,
33426 and no syntax checking is done on the contents of this argument. Exim does not
33427 wait for the command to complete, so its status code is not checked. Exim runs
33428 under its own uid and gid when receiving incoming SMTP, so it is not possible
33429 for it to change them before running the command.
33430
33431
33432
33433 .section "Incoming local SMTP" "SECID238"
33434 .cindex "SMTP" "local incoming"
33435 Some user agents use SMTP to pass messages to their local MTA using the
33436 standard input and output, as opposed to passing the envelope on the command
33437 line and writing the message to the standard input. This is supported by the
33438 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33439 messages over TCP/IP (including the use of ACLs), except that the envelope
33440 sender given in a MAIL command is ignored unless the caller is trusted. In
33441 an ACL you can detect this form of SMTP input by testing for an empty host
33442 identification. It is common to have this as the first line in the ACL that
33443 runs for RCPT commands:
33444 .code
33445 accept hosts = :
33446 .endd
33447 This accepts SMTP messages from local processes without doing any other tests.
33448
33449
33450
33451 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33452 .cindex "SMTP" "batched outgoing"
33453 .cindex "batched SMTP output"
33454 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33455 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33456 be output in BSMTP format. No SMTP responses are possible for this form of
33457 delivery. All it is doing is using SMTP commands as a way of transmitting the
33458 envelope along with the message.
33459
33460 The message is written to the file or pipe preceded by the SMTP commands
33461 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33462 the message that start with a dot have an extra dot added. The SMTP command
33463 HELO is not normally used. If it is required, the &%message_prefix%& option
33464 can be used to specify it.
33465
33466 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33467 one recipient address at a time by default. However, you can arrange for them
33468 to handle several addresses at once by setting the &%batch_max%& option. When
33469 this is done for BSMTP, messages may contain multiple RCPT commands. See
33470 chapter &<<CHAPbatching>>& for more details.
33471
33472 .vindex "&$host$&"
33473 When one or more addresses are routed to a BSMTP transport by a router that
33474 sets up a host list, the name of the first host on the list is available to the
33475 transport in the variable &$host$&. Here is an example of such a transport and
33476 router:
33477 .code
33478 begin routers
33479 route_append:
33480   driver = manualroute
33481   transport = smtp_appendfile
33482   route_list = domain.example  batch.host.example
33483
33484 begin transports
33485 smtp_appendfile:
33486   driver = appendfile
33487   directory = /var/bsmtp/$host
33488   batch_max = 1000
33489   use_bsmtp
33490   user = exim
33491 .endd
33492 This causes messages addressed to &'domain.example'& to be written in BSMTP
33493 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33494 message (unless there are more than 1000 recipients).
33495
33496
33497
33498 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33499 .cindex "SMTP" "batched incoming"
33500 .cindex "batched SMTP input"
33501 The &%-bS%& command line option causes Exim to accept one or more messages by
33502 reading SMTP on the standard input, but to generate no responses. If the caller
33503 is trusted, the senders in the MAIL commands are believed; otherwise the
33504 sender is always the caller of Exim. Unqualified senders and receivers are not
33505 rejected (there seems little point) but instead just get qualified. HELO
33506 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33507 as NOOP; QUIT quits.
33508
33509 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33510 ACL is run in the same way as for non-SMTP local input.
33511
33512 If an error is detected while reading a message, including a missing &"."& at
33513 the end, Exim gives up immediately. It writes details of the error to the
33514 standard output in a stylized way that the calling program should be able to
33515 make some use of automatically, for example:
33516 .code
33517 554 Unexpected end of file
33518 Transaction started in line 10
33519 Error detected in line 14
33520 .endd
33521 It writes a more verbose version, for human consumption, to the standard error
33522 file, for example:
33523 .code
33524 An error was detected while processing a file of BSMTP input.
33525 The error message was:
33526
33527 501 '>' missing at end of address
33528
33529 The SMTP transaction started in line 10.
33530 The error was detected in line 12.
33531 The SMTP command at fault was:
33532
33533 rcpt to:<malformed@in.com.plete
33534
33535 1 previous message was successfully processed.
33536 The rest of the batch was abandoned.
33537 .endd
33538 The return code from Exim is zero only if there were no errors. It is 1 if some
33539 messages were accepted before an error was detected, and 2 if no messages were
33540 accepted.
33541 .ecindex IIDsmtpproc1
33542 .ecindex IIDsmtpproc2
33543
33544
33545
33546 . ////////////////////////////////////////////////////////////////////////////
33547 . ////////////////////////////////////////////////////////////////////////////
33548
33549 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33550          "Customizing messages"
33551 When a message fails to be delivered, or remains on the queue for more than a
33552 configured amount of time, Exim sends a message to the original sender, or
33553 to an alternative configured address. The text of these messages is built into
33554 the code of Exim, but it is possible to change it, either by adding a single
33555 string, or by replacing each of the paragraphs by text supplied in a file.
33556
33557 The &'From:'& and &'To:'& header lines are automatically generated; you can
33558 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33559 option. Exim also adds the line
33560 .code
33561 Auto-Submitted: auto-generated
33562 .endd
33563 to all warning and bounce messages,
33564
33565
33566 .section "Customizing bounce messages" "SECID239"
33567 .cindex "customizing" "bounce message"
33568 .cindex "bounce message" "customizing"
33569 If &%bounce_message_text%& is set, its contents are included in the default
33570 message immediately after &"This message was created automatically by mail
33571 delivery software."& The string is not expanded. It is not used if
33572 &%bounce_message_file%& is set.
33573
33574 When &%bounce_message_file%& is set, it must point to a template file for
33575 constructing error messages. The file consists of a series of text items,
33576 separated by lines consisting of exactly four asterisks. If the file cannot be
33577 opened, default text is used and a message is written to the main and panic
33578 logs. If any text item in the file is empty, default text is used for that
33579 item.
33580
33581 .vindex "&$bounce_recipient$&"
33582 .vindex "&$bounce_return_size_limit$&"
33583 Each item of text that is read from the file is expanded, and there are two
33584 expansion variables which can be of use here: &$bounce_recipient$& is set to
33585 the recipient of an error message while it is being created, and
33586 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33587 option, rounded to a whole number.
33588
33589 The items must appear in the file in the following order:
33590
33591 .ilist
33592 The first item is included in the headers, and should include at least a
33593 &'Subject:'& header. Exim does not check the syntax of these headers.
33594 .next
33595 The second item forms the start of the error message. After it, Exim lists the
33596 failing addresses with their error messages.
33597 .next
33598 The third item is used to introduce any text from pipe transports that is to be
33599 returned to the sender. It is omitted if there is no such text.
33600 .next
33601 .new
33602 The fourth, fifth and sixth items will be ignored and may be empty.
33603 The fields exist for back-compatibility
33604 .wen
33605 .endlist
33606
33607 The default state (&%bounce_message_file%& unset) is equivalent to the
33608 following file, in which the sixth item is empty. The &'Subject:'& and some
33609 other lines have been split in order to fit them on the page:
33610 .code
33611 Subject: Mail delivery failed
33612   ${if eq{$sender_address}{$bounce_recipient}
33613   {: returning message to sender}}
33614 ****
33615 This message was created automatically by mail delivery software.
33616
33617 A message ${if eq{$sender_address}{$bounce_recipient}
33618   {that you sent }{sent by
33619
33620 <$sender_address>
33621
33622 }}could not be delivered to all of its recipients.
33623 This is a permanent error. The following address(es) failed:
33624 ****
33625 The following text was generated during the delivery attempt(s):
33626 ****
33627 ------ This is a copy of the message, including all the headers.
33628   ------
33629 ****
33630 ------ The body of the message is $message_size characters long;
33631   only the first
33632 ------ $bounce_return_size_limit or so are included here.
33633 ****
33634 .endd
33635 .section "Customizing warning messages" "SECTcustwarn"
33636 .cindex "customizing" "warning message"
33637 .cindex "warning of delay" "customizing the message"
33638 The option &%warn_message_file%& can be pointed at a template file for use when
33639 warnings about message delays are created. In this case there are only three
33640 text sections:
33641
33642 .ilist
33643 The first item is included in the headers, and should include at least a
33644 &'Subject:'& header. Exim does not check the syntax of these headers.
33645 .next
33646 The second item forms the start of the warning message. After it, Exim lists
33647 the delayed addresses.
33648 .next
33649 The third item then ends the message.
33650 .endlist
33651
33652 The default state is equivalent to the following file, except that some lines
33653 have been split here, in order to fit them on the page:
33654 .code
33655 Subject: Warning: message $message_exim_id delayed
33656   $warn_message_delay
33657 ****
33658 This message was created automatically by mail delivery software.
33659
33660 A message ${if eq{$sender_address}{$warn_message_recipients}
33661 {that you sent }{sent by
33662
33663 <$sender_address>
33664
33665 }}has not been delivered to all of its recipients after
33666 more than $warn_message_delay on the queue on $primary_hostname.
33667
33668 The message identifier is:     $message_exim_id
33669 The subject of the message is: $h_subject
33670 The date of the message is:    $h_date
33671
33672 The following address(es) have not yet been delivered:
33673 ****
33674 No action is required on your part. Delivery attempts will
33675 continue for some time, and this warning may be repeated at
33676 intervals if the message remains undelivered. Eventually the
33677 mail delivery software will give up, and when that happens,
33678 the message will be returned to you.
33679 .endd
33680 .vindex "&$warn_message_delay$&"
33681 .vindex "&$warn_message_recipients$&"
33682 However, in the default state the subject and date lines are omitted if no
33683 appropriate headers exist. During the expansion of this file,
33684 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
33685 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
33686 of recipients for the warning message. There may be more than one if there are
33687 multiple addresses with different &%errors_to%& settings on the routers that
33688 handled them.
33689
33690
33691
33692
33693 . ////////////////////////////////////////////////////////////////////////////
33694 . ////////////////////////////////////////////////////////////////////////////
33695
33696 .chapter "Some common configuration settings" "CHAPcomconreq"
33697 This chapter discusses some configuration settings that seem to be fairly
33698 common. More examples and discussion can be found in the Exim book.
33699
33700
33701
33702 .section "Sending mail to a smart host" "SECID240"
33703 .cindex "smart host" "example router"
33704 If you want to send all mail for non-local domains to a &"smart host"&, you
33705 should replace the default &(dnslookup)& router with a router which does the
33706 routing explicitly:
33707 .code
33708 send_to_smart_host:
33709   driver = manualroute
33710   route_list = !+local_domains smart.host.name
33711   transport = remote_smtp
33712 .endd
33713 You can use the smart host's IP address instead of the name if you wish.
33714 If you are using Exim only to submit messages to a smart host, and not for
33715 receiving incoming messages, you can arrange for it to do the submission
33716 synchronously by setting the &%mua_wrapper%& option (see chapter
33717 &<<CHAPnonqueueing>>&).
33718
33719
33720
33721
33722 .section "Using Exim to handle mailing lists" "SECTmailinglists"
33723 .cindex "mailing lists"
33724 Exim can be used to run simple mailing lists, but for large and/or complicated
33725 requirements, the use of additional specialized mailing list software such as
33726 Majordomo or Mailman is recommended.
33727
33728 The &(redirect)& router can be used to handle mailing lists where each list
33729 is maintained in a separate file, which can therefore be managed by an
33730 independent manager. The &%domains%& router option can be used to run these
33731 lists in a separate domain from normal mail. For example:
33732 .code
33733 lists:
33734   driver = redirect
33735   domains = lists.example
33736   file = /usr/lists/$local_part
33737   forbid_pipe
33738   forbid_file
33739   errors_to = $local_part-request@lists.example
33740   no_more
33741 .endd
33742 This router is skipped for domains other than &'lists.example'&. For addresses
33743 in that domain, it looks for a file that matches the local part. If there is no
33744 such file, the router declines, but because &%no_more%& is set, no subsequent
33745 routers are tried, and so the whole delivery fails.
33746
33747 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
33748 expanded into a file name or a pipe delivery, which is usually inappropriate in
33749 a mailing list.
33750
33751 .oindex "&%errors_to%&"
33752 The &%errors_to%& option specifies that any delivery errors caused by addresses
33753 taken from a mailing list are to be sent to the given address rather than the
33754 original sender of the message. However, before acting on this, Exim verifies
33755 the error address, and ignores it if verification fails.
33756
33757 For example, using the configuration above, mail sent to
33758 &'dicts@lists.example'& is passed on to those addresses contained in
33759 &_/usr/lists/dicts_&, with error reports directed to
33760 &'dicts-request@lists.example'&, provided that this address can be verified.
33761 There could be a file called &_/usr/lists/dicts-request_& containing
33762 the address(es) of this particular list's manager(s), but other approaches,
33763 such as setting up an earlier router (possibly using the &%local_part_prefix%&
33764 or &%local_part_suffix%& options) to handle addresses of the form
33765 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
33766
33767
33768
33769 .section "Syntax errors in mailing lists" "SECID241"
33770 .cindex "mailing lists" "syntax errors in"
33771 If an entry in redirection data contains a syntax error, Exim normally defers
33772 delivery of the original address. That means that a syntax error in a mailing
33773 list holds up all deliveries to the list. This may not be appropriate when a
33774 list is being maintained automatically from data supplied by users, and the
33775 addresses are not rigorously checked.
33776
33777 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
33778 entries that fail to parse, noting the incident in the log. If in addition
33779 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
33780 whenever a broken address is skipped. It is usually appropriate to set
33781 &%syntax_errors_to%& to the same address as &%errors_to%&.
33782
33783
33784
33785 .section "Re-expansion of mailing lists" "SECID242"
33786 .cindex "mailing lists" "re-expansion of"
33787 Exim remembers every individual address to which a message has been delivered,
33788 in order to avoid duplication, but it normally stores only the original
33789 recipient addresses with a message. If all the deliveries to a mailing list
33790 cannot be done at the first attempt, the mailing list is re-expanded when the
33791 delivery is next tried. This means that alterations to the list are taken into
33792 account at each delivery attempt, so addresses that have been added to
33793 the list since the message arrived will therefore receive a copy of the
33794 message, even though it pre-dates their subscription.
33795
33796 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
33797 on the &(redirect)& router. If this is done, any addresses generated by the
33798 router that fail to deliver at the first attempt are added to the message as
33799 &"top level"& addresses, and the parent address that generated them is marked
33800 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
33801 subsequent delivery attempts. The disadvantage of this is that if any of the
33802 failing addresses are incorrect, correcting them in the file has no effect on
33803 pre-existing messages.
33804
33805 The original top-level address is remembered with each of the generated
33806 addresses, and is output in any log messages. However, any intermediate parent
33807 addresses are not recorded. This makes a difference to the log only if the
33808 &%all_parents%& selector is set, but for mailing lists there is normally only
33809 one level of expansion anyway.
33810
33811
33812
33813 .section "Closed mailing lists" "SECID243"
33814 .cindex "mailing lists" "closed"
33815 The examples so far have assumed open mailing lists, to which anybody may
33816 send mail. It is also possible to set up closed lists, where mail is accepted
33817 from specified senders only. This is done by making use of the generic
33818 &%senders%& option to restrict the router that handles the list.
33819
33820 The following example uses the same file as a list of recipients and as a list
33821 of permitted senders. It requires three routers:
33822 .code
33823 lists_request:
33824   driver = redirect
33825   domains = lists.example
33826   local_part_suffix = -request
33827   file = /usr/lists/$local_part$local_part_suffix
33828   no_more
33829
33830 lists_post:
33831   driver = redirect
33832   domains = lists.example
33833   senders = ${if exists {/usr/lists/$local_part}\
33834              {lsearch;/usr/lists/$local_part}{*}}
33835   file = /usr/lists/$local_part
33836   forbid_pipe
33837   forbid_file
33838   errors_to = $local_part-request@lists.example
33839   no_more
33840
33841 lists_closed:
33842   driver = redirect
33843   domains = lists.example
33844   allow_fail
33845   data = :fail: $local_part@lists.example is a closed mailing list
33846 .endd
33847 All three routers have the same &%domains%& setting, so for any other domains,
33848 they are all skipped. The first router runs only if the local part ends in
33849 &%-request%&. It handles messages to the list manager(s) by means of an open
33850 mailing list.
33851
33852 The second router runs only if the &%senders%& precondition is satisfied. It
33853 checks for the existence of a list that corresponds to the local part, and then
33854 checks that the sender is on the list by means of a linear search. It is
33855 necessary to check for the existence of the file before trying to search it,
33856 because otherwise Exim thinks there is a configuration error. If the file does
33857 not exist, the expansion of &%senders%& is *, which matches all senders. This
33858 means that the router runs, but because there is no list, declines, and
33859 &%no_more%& ensures that no further routers are run. The address fails with an
33860 &"unrouteable address"& error.
33861
33862 The third router runs only if the second router is skipped, which happens when
33863 a mailing list exists, but the sender is not on it. This router forcibly fails
33864 the address, giving a suitable error message.
33865
33866
33867
33868
33869 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
33870 .cindex "VERP"
33871 .cindex "Variable Envelope Return Paths"
33872 .cindex "envelope sender"
33873 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
33874 are a way of helping mailing list administrators discover which subscription
33875 address is the cause of a particular delivery failure. The idea is to encode
33876 the original recipient address in the outgoing envelope sender address, so that
33877 if the message is forwarded by another host and then subsequently bounces, the
33878 original recipient can be extracted from the recipient address of the bounce.
33879
33880 .oindex &%errors_to%&
33881 .oindex &%return_path%&
33882 Envelope sender addresses can be modified by Exim using two different
33883 facilities: the &%errors_to%& option on a router (as shown in previous mailing
33884 list examples), or the &%return_path%& option on a transport. The second of
33885 these is effective only if the message is successfully delivered to another
33886 host; it is not used for errors detected on the local host (see the description
33887 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
33888 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
33889 .code
33890 verp_smtp:
33891   driver = smtp
33892   max_rcpt = 1
33893   return_path = \
33894     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33895       {$1-request+$local_part=$domain@your.dom.example}fail}
33896 .endd
33897 This has the effect of rewriting the return path (envelope sender) on outgoing
33898 SMTP messages, if the local part of the original return path ends in
33899 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
33900 local part and domain of the recipient into the return path. Suppose, for
33901 example, that a message whose return path has been set to
33902 &'somelist-request@your.dom.example'& is sent to
33903 &'subscriber@other.dom.example'&. In the transport, the return path is
33904 rewritten as
33905 .code
33906 somelist-request+subscriber=other.dom.example@your.dom.example
33907 .endd
33908 .vindex "&$local_part$&"
33909 For this to work, you must tell Exim to send multiple copies of messages that
33910 have more than one recipient, so that each copy has just one recipient. This is
33911 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
33912 might be sent to several different recipients in the same domain, in which case
33913 &$local_part$& is not available in the transport, because it is not unique.
33914
33915 Unless your host is doing nothing but mailing list deliveries, you should
33916 probably use a separate transport for the VERP deliveries, so as not to use
33917 extra resources in making one-per-recipient copies for other deliveries. This
33918 can easily be done by expanding the &%transport%& option in the router:
33919 .code
33920 dnslookup:
33921   driver = dnslookup
33922   domains = ! +local_domains
33923   transport = \
33924     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
33925       {verp_smtp}{remote_smtp}}
33926   no_more
33927 .endd
33928 If you want to change the return path using &%errors_to%& in a router instead
33929 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
33930 routers that handle mailing list addresses. This will ensure that all delivery
33931 errors, including those detected on the local host, are sent to the VERP
33932 address.
33933
33934 On a host that does no local deliveries and has no manual routing, only the
33935 &(dnslookup)& router needs to be changed. A special transport is not needed for
33936 SMTP deliveries. Every mailing list recipient has its own return path value,
33937 and so Exim must hand them to the transport one at a time. Here is an example
33938 of a &(dnslookup)& router that implements VERP:
33939 .code
33940 verp_dnslookup:
33941   driver = dnslookup
33942   domains = ! +local_domains
33943   transport = remote_smtp
33944   errors_to = \
33945     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
33946      {$1-request+$local_part=$domain@your.dom.example}fail}
33947   no_more
33948 .endd
33949 Before you start sending out messages with VERPed return paths, you must also
33950 configure Exim to accept the bounce messages that come back to those paths.
33951 Typically this is done by setting a &%local_part_suffix%& option for a
33952 router, and using this to route the messages to wherever you want to handle
33953 them.
33954
33955 The overhead incurred in using VERP depends very much on the size of the
33956 message, the number of recipient addresses that resolve to the same remote
33957 host, and the speed of the connection over which the message is being sent. If
33958 a lot of addresses resolve to the same host and the connection is slow, sending
33959 a separate copy of the message for each address may take substantially longer
33960 than sending a single copy with many recipients (for which VERP cannot be
33961 used).
33962
33963
33964
33965
33966
33967
33968 .section "Virtual domains" "SECTvirtualdomains"
33969 .cindex "virtual domains"
33970 .cindex "domain" "virtual"
33971 The phrase &'virtual domain'& is unfortunately used with two rather different
33972 meanings:
33973
33974 .ilist
33975 A domain for which there are no real mailboxes; all valid local parts are
33976 aliases for other email addresses. Common examples are organizational
33977 top-level domains and &"vanity"& domains.
33978 .next
33979 One of a number of independent domains that are all handled by the same host,
33980 with mailboxes on that host, but where the mailbox owners do not necessarily
33981 have login accounts on that host.
33982 .endlist
33983
33984 The first usage is probably more common, and does seem more &"virtual"& than
33985 the second. This kind of domain can be handled in Exim with a straightforward
33986 aliasing router. One approach is to create a separate alias file for each
33987 virtual domain. Exim can test for the existence of the alias file to determine
33988 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
33989 to a router of this form:
33990 .code
33991 virtual:
33992   driver = redirect
33993   domains = dsearch;/etc/mail/virtual
33994   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
33995   no_more
33996 .endd
33997 The &%domains%& option specifies that the router is to be skipped, unless there
33998 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
33999 domain that is being processed. When the router runs, it looks up the local
34000 part in the file to find a new address (or list of addresses). The &%no_more%&
34001 setting ensures that if the lookup fails (leading to &%data%& being an empty
34002 string), Exim gives up on the address without trying any subsequent routers.
34003
34004 This one router can handle all the virtual domains because the alias file names
34005 follow a fixed pattern. Permissions can be arranged so that appropriate people
34006 can edit the different alias files. A successful aliasing operation results in
34007 a new envelope recipient address, which is then routed from scratch.
34008
34009 The other kind of &"virtual"& domain can also be handled in a straightforward
34010 way. One approach is to create a file for each domain containing a list of
34011 valid local parts, and use it in a router like this:
34012 .code
34013 my_domains:
34014   driver = accept
34015   domains = dsearch;/etc/mail/domains
34016   local_parts = lsearch;/etc/mail/domains/$domain
34017   transport = my_mailboxes
34018 .endd
34019 The address is accepted if there is a file for the domain, and the local part
34020 can be found in the file. The &%domains%& option is used to check for the
34021 file's existence because &%domains%& is tested before the &%local_parts%&
34022 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34023 because that option is tested after &%local_parts%&. The transport is as
34024 follows:
34025 .code
34026 my_mailboxes:
34027   driver = appendfile
34028   file = /var/mail/$domain/$local_part
34029   user = mail
34030 .endd
34031 This uses a directory of mailboxes for each domain. The &%user%& setting is
34032 required, to specify which uid is to be used for writing to the mailboxes.
34033
34034 The configuration shown here is just one example of how you might support this
34035 requirement. There are many other ways this kind of configuration can be set
34036 up, for example, by using a database instead of separate files to hold all the
34037 information about the domains.
34038
34039
34040
34041 .section "Multiple user mailboxes" "SECTmulbox"
34042 .cindex "multiple mailboxes"
34043 .cindex "mailbox" "multiple"
34044 .cindex "local part" "prefix"
34045 .cindex "local part" "suffix"
34046 Heavy email users often want to operate with multiple mailboxes, into which
34047 incoming mail is automatically sorted. A popular way of handling this is to
34048 allow users to use multiple sender addresses, so that replies can easily be
34049 identified. Users are permitted to add prefixes or suffixes to their local
34050 parts for this purpose. The wildcard facility of the generic router options
34051 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34052 example, consider this router:
34053 .code
34054 userforward:
34055   driver = redirect
34056   check_local_user
34057   file = $home/.forward
34058   local_part_suffix = -*
34059   local_part_suffix_optional
34060   allow_filter
34061 .endd
34062 .vindex "&$local_part_suffix$&"
34063 It runs a user's &_.forward_& file for all local parts of the form
34064 &'username-*'&. Within the filter file the user can distinguish different
34065 cases by testing the variable &$local_part_suffix$&. For example:
34066 .code
34067 if $local_part_suffix contains -special then
34068 save /home/$local_part/Mail/special
34069 endif
34070 .endd
34071 If the filter file does not exist, or does not deal with such addresses, they
34072 fall through to subsequent routers, and, assuming no subsequent use of the
34073 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34074 control over which suffixes are valid.
34075
34076 Alternatively, a suffix can be used to trigger the use of a different
34077 &_.forward_& file &-- which is the way a similar facility is implemented in
34078 another MTA:
34079 .code
34080 userforward:
34081   driver = redirect
34082   check_local_user
34083   file = $home/.forward$local_part_suffix
34084   local_part_suffix = -*
34085   local_part_suffix_optional
34086   allow_filter
34087 .endd
34088 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34089 example, &_.forward-special_& is used. Once again, if the appropriate file
34090 does not exist, or does not deal with the address, it is passed on to
34091 subsequent routers, which could, if required, look for an unqualified
34092 &_.forward_& file to use as a default.
34093
34094
34095
34096 .section "Simplified vacation processing" "SECID244"
34097 .cindex "vacation processing"
34098 The traditional way of running the &'vacation'& program is for a user to set up
34099 a pipe command in a &_.forward_& file
34100 (see section &<<SECTspecitredli>>& for syntax details).
34101 This is prone to error by inexperienced users. There are two features of Exim
34102 that can be used to make this process simpler for users:
34103
34104 .ilist
34105 A local part prefix such as &"vacation-"& can be specified on a router which
34106 can cause the message to be delivered directly to the &'vacation'& program, or
34107 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34108 &_.forward_& file are then much simpler. For example:
34109 .code
34110 spqr, vacation-spqr
34111 .endd
34112 .next
34113 The &%require_files%& generic router option can be used to trigger a
34114 vacation delivery by checking for the existence of a certain file in the
34115 user's home directory. The &%unseen%& generic option should also be used, to
34116 ensure that the original delivery also proceeds. In this case, all the user has
34117 to do is to create a file called, say, &_.vacation_&, containing a vacation
34118 message.
34119 .endlist
34120
34121 Another advantage of both these methods is that they both work even when the
34122 use of arbitrary pipes by users is locked out.
34123
34124
34125
34126 .section "Taking copies of mail" "SECID245"
34127 .cindex "message" "copying every"
34128 Some installations have policies that require archive copies of all messages to
34129 be made. A single copy of each message can easily be taken by an appropriate
34130 command in a system filter, which could, for example, use a different file for
34131 each day's messages.
34132
34133 There is also a shadow transport mechanism that can be used to take copies of
34134 messages that are successfully delivered by local transports, one copy per
34135 delivery. This could be used, &'inter alia'&, to implement automatic
34136 notification of delivery by sites that insist on doing such things.
34137
34138
34139
34140 .section "Intermittently connected hosts" "SECID246"
34141 .cindex "intermittently connected hosts"
34142 It has become quite common (because it is cheaper) for hosts to connect to the
34143 Internet periodically rather than remain connected all the time. The normal
34144 arrangement is that mail for such hosts accumulates on a system that is
34145 permanently connected.
34146
34147 Exim was designed for use on permanently connected hosts, and so it is not
34148 particularly well-suited to use in an intermittently connected environment.
34149 Nevertheless there are some features that can be used.
34150
34151
34152 .section "Exim on the upstream server host" "SECID247"
34153 It is tempting to arrange for incoming mail for the intermittently connected
34154 host to remain on Exim's queue until the client connects. However, this
34155 approach does not scale very well. Two different kinds of waiting message are
34156 being mixed up in the same queue &-- those that cannot be delivered because of
34157 some temporary problem, and those that are waiting for their destination host
34158 to connect. This makes it hard to manage the queue, as well as wasting
34159 resources, because each queue runner scans the entire queue.
34160
34161 A better approach is to separate off those messages that are waiting for an
34162 intermittently connected host. This can be done by delivering these messages
34163 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34164 format, from where they are transmitted by other software when their
34165 destination connects. This makes it easy to collect all the mail for one host
34166 in a single directory, and to apply local timeout rules on a per-message basis
34167 if required.
34168
34169 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34170 you are doing this, you should configure Exim with a long retry period for the
34171 intermittent host. For example:
34172 .code
34173 cheshire.wonderland.fict.example    *   F,5d,24h
34174 .endd
34175 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34176 which messages it has queued up for that host. Once the intermittent host comes
34177 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34178 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34179 causes all the queued up messages to be delivered, often down a single SMTP
34180 connection. While the host remains connected, any new messages get delivered
34181 immediately.
34182
34183 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34184 issued with a different IP address each time it connects, Exim's retry
34185 mechanisms on the holding host get confused, because the IP address is normally
34186 used as part of the key string for holding retry information. This can be
34187 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34188 Since this has disadvantages for permanently connected hosts, it is best to
34189 arrange a separate transport for the intermittently connected ones.
34190
34191
34192
34193 .section "Exim on the intermittently connected client host" "SECID248"
34194 The value of &%smtp_accept_queue_per_connection%& should probably be
34195 increased, or even set to zero (that is, disabled) on the intermittently
34196 connected host, so that all incoming messages down a single connection get
34197 delivered immediately.
34198
34199 .cindex "SMTP" "passed connection"
34200 .cindex "SMTP" "multiple deliveries"
34201 .cindex "multiple SMTP deliveries"
34202 Mail waiting to be sent from an intermittently connected host will probably
34203 not have been routed, because without a connection DNS lookups are not
34204 possible. This means that if a normal queue run is done at connection time,
34205 each message is likely to be sent in a separate SMTP session. This can be
34206 avoided by starting the queue run with a command line option beginning with
34207 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34208 first pass, routing is done but no deliveries take place. The second pass is a
34209 normal queue run; since all the messages have been previously routed, those
34210 destined for the same host are likely to get sent as multiple deliveries in a
34211 single SMTP connection.
34212
34213
34214
34215 . ////////////////////////////////////////////////////////////////////////////
34216 . ////////////////////////////////////////////////////////////////////////////
34217
34218 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34219          "Exim as a non-queueing client"
34220 .cindex "client, non-queueing"
34221 .cindex "smart host" "suppressing queueing"
34222 On a personal computer, it is a common requirement for all
34223 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34224 configured to operate that way, for all the popular operating systems.
34225 However, there are some MUAs for Unix-like systems that cannot be so
34226 configured: they submit messages using the command line interface of
34227 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34228 messages this way.
34229
34230 If the personal computer runs continuously, there is no problem, because it can
34231 run a conventional MTA that handles delivery to the smart host, and deal with
34232 any delays via its queueing mechanism. However, if the computer does not run
34233 continuously or runs different operating systems at different times, queueing
34234 email is not desirable.
34235
34236 There is therefore a requirement for something that can provide the
34237 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34238 any queueing or retrying facilities. Furthermore, the delivery to the smart
34239 host should be synchronous, so that if it fails, the sending MUA is immediately
34240 informed. In other words, we want something that extends an MUA that submits
34241 to a local MTA via the command line so that it behaves like one that submits
34242 to a remote smart host using TCP/SMTP.
34243
34244 There are a number of applications (for example, there is one called &'ssmtp'&)
34245 that do this job. However, people have found them to be lacking in various
34246 ways. For instance, you might want to allow aliasing and forwarding to be done
34247 before sending a message to the smart host.
34248
34249 Exim already had the necessary infrastructure for doing this job. Just a few
34250 tweaks were needed to make it behave as required, though it is somewhat of an
34251 overkill to use a fully-featured MTA for this purpose.
34252
34253 .oindex "&%mua_wrapper%&"
34254 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34255 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34256 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34257 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34258 compatible router and transport configuration. Typically there will be just one
34259 router and one transport, sending everything to a smart host.
34260
34261 When run in MUA wrapping mode, the behaviour of Exim changes in the
34262 following ways:
34263
34264 .ilist
34265 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34266 In other words, the only way to submit messages is via the command line.
34267 .next
34268 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34269 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34270 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34271 does not finish until the delivery attempt is complete. If the delivery is
34272 successful, a zero return code is given.
34273 .next
34274 Address redirection is permitted, but the final routing for all addresses must
34275 be to the same remote transport, and to the same list of hosts. Furthermore,
34276 the return address (envelope sender) must be the same for all recipients, as
34277 must any added or deleted header lines. In other words, it must be possible to
34278 deliver the message in a single SMTP transaction, however many recipients there
34279 are.
34280 .next
34281 If these conditions are not met, or if routing any address results in a
34282 failure or defer status, or if Exim is unable to deliver all the recipients
34283 successfully to one of the smart hosts, delivery of the entire message fails.
34284 .next
34285 Because no queueing is allowed, all failures are treated as permanent; there
34286 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34287 smart host. Furthermore, because only a single yes/no response can be given to
34288 the caller, it is not possible to deliver to some recipients and not others. If
34289 there is an error (temporary or permanent) for any recipient, all are failed.
34290 .next
34291 If more than one smart host is listed, Exim will try another host after a
34292 connection failure or a timeout, in the normal way. However, if this kind of
34293 failure happens for all the hosts, the delivery fails.
34294 .next
34295 When delivery fails, an error message is written to the standard error stream
34296 (as well as to Exim's log), and Exim exits to the caller with a return code
34297 value 1. The message is expunged from Exim's spool files. No bounce messages
34298 are ever generated.
34299 .next
34300 No retry data is maintained, and any retry rules are ignored.
34301 .next
34302 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34303 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34304 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34305 .endlist
34306
34307 The overall effect is that Exim makes a single synchronous attempt to deliver
34308 the message, failing if there is any kind of problem. Because no local
34309 deliveries are done and no daemon can be run, Exim does not need root
34310 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34311 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34312 the advantages and disadvantages of running without root privilege.
34313
34314
34315
34316
34317 . ////////////////////////////////////////////////////////////////////////////
34318 . ////////////////////////////////////////////////////////////////////////////
34319
34320 .chapter "Log files" "CHAPlog"
34321 .scindex IIDloggen "log" "general description"
34322 .cindex "log" "types of"
34323 Exim writes three different logs, referred to as the main log, the reject log,
34324 and the panic log:
34325
34326 .ilist
34327 .cindex "main log"
34328 The main log records the arrival of each message and each delivery in a single
34329 line in each case. The format is as compact as possible, in an attempt to keep
34330 down the size of log files. Two-character flag sequences make it easy to pick
34331 out these lines. A number of other events are recorded in the main log. Some of
34332 them are optional, in which case the &%log_selector%& option controls whether
34333 they are included or not. A Perl script called &'eximstats'&, which does simple
34334 analysis of main log files, is provided in the Exim distribution (see section
34335 &<<SECTmailstat>>&).
34336 .next
34337 .cindex "reject log"
34338 The reject log records information from messages that are rejected as a result
34339 of a configuration option (that is, for policy reasons).
34340 The first line of each rejection is a copy of the line that is also written to
34341 the main log. Then, if the message's header has been read at the time the log
34342 is written, its contents are written to this log. Only the original header
34343 lines are available; header lines added by ACLs are not logged. You can use the
34344 reject log to check that your policy controls are working correctly; on a busy
34345 host this may be easier than scanning the main log for rejection messages. You
34346 can suppress the writing of the reject log by setting &%write_rejectlog%&
34347 false.
34348 .next
34349 .cindex "panic log"
34350 .cindex "system log"
34351 When certain serious errors occur, Exim writes entries to its panic log. If the
34352 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34353 are usually written to the main log as well, but can get lost amid the mass of
34354 other entries. The panic log should be empty under normal circumstances. It is
34355 therefore a good idea to check it (or to have a &'cron'& script check it)
34356 regularly, in order to become aware of any problems. When Exim cannot open its
34357 panic log, it tries as a last resort to write to the system log (syslog). This
34358 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34359 message itself is written at priority LOG_CRIT.
34360 .endlist
34361
34362 Every log line starts with a timestamp, in the format shown in the following
34363 example. Note that many of the examples shown in this chapter are line-wrapped.
34364 In the log file, this would be all on one line:
34365 .code
34366 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34367   by QUIT
34368 .endd
34369 By default, the timestamps are in the local timezone. There are two
34370 ways of changing this:
34371
34372 .ilist
34373 You can set the &%timezone%& option to a different time zone; in particular, if
34374 you set
34375 .code
34376 timezone = UTC
34377 .endd
34378 the timestamps will be in UTC (aka GMT).
34379 .next
34380 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34381 example:
34382 .code
34383 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34384 .endd
34385 .endlist
34386
34387 .cindex "log" "process ids in"
34388 .cindex "pid (process id)" "in log lines"
34389 Exim does not include its process id in log lines by default, but you can
34390 request that it does so by specifying the &`pid`& log selector (see section
34391 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34392 brackets, immediately after the time and date.
34393
34394
34395
34396
34397 .section "Where the logs are written" "SECTwhelogwri"
34398 .cindex "log" "destination"
34399 .cindex "log" "to file"
34400 .cindex "log" "to syslog"
34401 .cindex "syslog"
34402 The logs may be written to local files, or to syslog, or both. However, it
34403 should be noted that many syslog implementations use UDP as a transport, and
34404 are therefore unreliable in the sense that messages are not guaranteed to
34405 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34406 It has also been reported that on large log files (tens of megabytes) you may
34407 need to tweak syslog to prevent it syncing the file with each write &-- on
34408 Linux this has been seen to make syslog take 90% plus of CPU time.
34409
34410 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34411 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34412 configuration. This latter string is expanded, so it can contain, for example,
34413 references to the host name:
34414 .code
34415 log_file_path = /var/log/$primary_hostname/exim_%slog
34416 .endd
34417 It is generally advisable, however, to set the string in &_Local/Makefile_&
34418 rather than at run time, because then the setting is available right from the
34419 start of Exim's execution. Otherwise, if there's something it wants to log
34420 before it has read the configuration file (for example, an error in the
34421 configuration file) it will not use the path you want, and may not be able to
34422 log at all.
34423
34424 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34425 list, currently limited to at most two items. This is one option where the
34426 facility for changing a list separator may not be used. The list must always be
34427 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34428 otherwise the item must either be an absolute path, containing &`%s`& at the
34429 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34430 implying the use of a default path.
34431
34432 When Exim encounters an empty item in the list, it searches the list defined by
34433 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34434 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34435 mean &"use the path specified at build time"&. It no such item exists, log
34436 files are written in the &_log_& subdirectory of the spool directory. This is
34437 equivalent to the setting:
34438 .code
34439 log_file_path = $spool_directory/log/%slog
34440 .endd
34441 If you do not specify anything at build time or run time, that is where the
34442 logs are written.
34443
34444 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34445 are in use &-- see section &<<SECTdatlogfil>>& below.
34446
34447 Here are some examples of possible settings:
34448 .display
34449 &`LOG_FILE_PATH=syslog                    `& syslog only
34450 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34451 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34452 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34453 .endd
34454 If there are more than two paths in the list, the first is used and a panic
34455 error is logged.
34456
34457
34458
34459 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34460 .cindex "log" "cycling local files"
34461 .cindex "cycling logs"
34462 .cindex "&'exicyclog'&"
34463 .cindex "log" "local files; writing to"
34464 Some operating systems provide centralized and standardized methods for cycling
34465 log files. For those that do not, a utility script called &'exicyclog'& is
34466 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34467 main and reject logs each time it is called. The maximum number of old logs to
34468 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34469
34470 An Exim delivery process opens the main log when it first needs to write to it,
34471 and it keeps the file open in case subsequent entries are required &-- for
34472 example, if a number of different deliveries are being done for the same
34473 message. However, remote SMTP deliveries can take a long time, and this means
34474 that the file may be kept open long after it is renamed if &'exicyclog'& or
34475 something similar is being used to rename log files on a regular basis. To
34476 ensure that a switch of log files is noticed as soon as possible, Exim calls
34477 &[stat()]& on the main log's name before reusing an open file, and if the file
34478 does not exist, or its inode has changed, the old file is closed and Exim
34479 tries to open the main log from scratch. Thus, an old log file may remain open
34480 for quite some time, but no Exim processes should write to it once it has been
34481 renamed.
34482
34483
34484
34485 .section "Datestamped log files" "SECTdatlogfil"
34486 .cindex "log" "datestamped files"
34487 Instead of cycling the main and reject log files by renaming them
34488 periodically, some sites like to use files whose names contain a datestamp,
34489 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34490 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34491 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34492 point where the datestamp is required. For example:
34493 .code
34494 log_file_path = /var/spool/exim/log/%slog-%D
34495 log_file_path = /var/log/exim-%s-%D.log
34496 log_file_path = /var/spool/exim/log/%D-%slog
34497 log_file_path = /var/log/exim/%s.%M
34498 .endd
34499 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34500 examples of names generated by the above examples:
34501 .code
34502 /var/spool/exim/log/mainlog-20021225
34503 /var/log/exim-reject-20021225.log
34504 /var/spool/exim/log/20021225-mainlog
34505 /var/log/exim/main.200212
34506 .endd
34507 When this form of log file is specified, Exim automatically switches to new
34508 files at midnight. It does not make any attempt to compress old logs; you
34509 will need to write your own script if you require this. You should not
34510 run &'exicyclog'& with this form of logging.
34511
34512 The location of the panic log is also determined by &%log_file_path%&, but it
34513 is not datestamped, because rotation of the panic log does not make sense.
34514 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34515 the string. In addition, if it immediately follows a slash, a following
34516 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34517 character is removed. Thus, the four examples above would give these panic
34518 log names:
34519 .code
34520 /var/spool/exim/log/paniclog
34521 /var/log/exim-panic.log
34522 /var/spool/exim/log/paniclog
34523 /var/log/exim/panic
34524 .endd
34525
34526
34527 .section "Logging to syslog" "SECID249"
34528 .cindex "log" "syslog; writing to"
34529 The use of syslog does not change what Exim logs or the format of its messages,
34530 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34531 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34532 that, the same strings are written to syslog as to log files. The syslog
34533 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34534 by default, but you can change these by setting the &%syslog_facility%& and
34535 &%syslog_processname%& options, respectively. If Exim was compiled with
34536 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34537 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34538 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34539 the time and host name to each line.
34540 The three log streams are mapped onto syslog priorities as follows:
34541
34542 .ilist
34543 &'mainlog'& is mapped to LOG_INFO
34544 .next
34545 &'rejectlog'& is mapped to LOG_NOTICE
34546 .next
34547 &'paniclog'& is mapped to LOG_ALERT
34548 .endlist
34549
34550 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34551 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34552 these are routed by syslog to the same place. You can suppress this duplication
34553 by setting &%syslog_duplication%& false.
34554
34555 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34556 entries contain multiple lines when headers are included. To cope with both
34557 these cases, entries written to syslog are split into separate &[syslog()]&
34558 calls at each internal newline, and also after a maximum of
34559 870 data characters. (This allows for a total syslog line length of 1024, when
34560 additions such as timestamps are added.) If you are running a syslog
34561 replacement that can handle lines longer than the 1024 characters allowed by
34562 RFC 3164, you should set
34563 .code
34564 SYSLOG_LONG_LINES=yes
34565 .endd
34566 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34567 lines, but it still splits at internal newlines in &'reject'& log entries.
34568
34569 To make it easy to re-assemble split lines later, each component of a split
34570 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34571 where <&'n'&> is the component number and <&'m'&> is the total number of
34572 components in the entry. The / delimiter is used when the line was split
34573 because it was too long; if it was split because of an internal newline, the \
34574 delimiter is used. For example, supposing the length limit to be 50 instead of
34575 870, the following would be the result of a typical rejection message to
34576 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34577 name, and pid as added by syslog:
34578 .code
34579 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34580 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34581 [3/5]  when scanning for sender: missing or malformed lo
34582 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34583 [5/5] mple>)
34584 .endd
34585 The same error might cause the following lines to be written to &"rejectlog"&
34586 (LOG_NOTICE):
34587 .code
34588 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34589 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34590 [3/18] er when scanning for sender: missing or malformed
34591 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34592 [5\18] .example>)
34593 [6\18] Recipients: ph10@some.domain.cam.example
34594 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34595 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34596 [9\18]        id 16RdAL-0006pc-00
34597 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34598 [11\18] 09:43 +0100
34599 [12\18] F From: <>
34600 [13\18]   Subject: this is a test header
34601 [18\18]   X-something: this is another header
34602 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34603 [16\18] le>
34604 [17\18] B Bcc:
34605 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34606 .endd
34607 Log lines that are neither too long nor contain newlines are written to syslog
34608 without modification.
34609
34610 If only syslog is being used, the Exim monitor is unable to provide a log tail
34611 display, unless syslog is routing &'mainlog'& to a file on the local host and
34612 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34613 where it is.
34614
34615
34616
34617 .section "Log line flags" "SECID250"
34618 One line is written to the main log for each message received, and for each
34619 successful, unsuccessful, and delayed delivery. These lines can readily be
34620 picked out by the distinctive two-character flags that immediately follow the
34621 timestamp. The flags are:
34622 .display
34623 &`<=`&     message arrival
34624 &`=>`&     normal message delivery
34625 &`->`&     additional address in same delivery
34626 &`>>`&     cutthrough message delivery
34627 &`*>`&     delivery suppressed by &%-N%&
34628 &`**`&     delivery failed; address bounced
34629 &`==`&     delivery deferred; temporary problem
34630 .endd
34631
34632
34633 .section "Logging message reception" "SECID251"
34634 .cindex "log" "reception line"
34635 The format of the single-line entry in the main log that is written for every
34636 message received is shown in the basic example below, which is split over
34637 several lines in order to fit it on the page:
34638 .code
34639 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34640   H=mailer.fict.example [192.168.123.123] U=exim
34641   P=smtp S=5678 id=<incoming message id>
34642 .endd
34643 The address immediately following &"<="& is the envelope sender address. A
34644 bounce message is shown with the sender address &"<>"&, and if it is locally
34645 generated, this is followed by an item of the form
34646 .code
34647 R=<message id>
34648 .endd
34649 which is a reference to the message that caused the bounce to be sent.
34650
34651 .cindex "HELO"
34652 .cindex "EHLO"
34653 For messages from other hosts, the H and U fields identify the remote host and
34654 record the RFC 1413 identity of the user that sent the message, if one was
34655 received. The number given in square brackets is the IP address of the sending
34656 host. If there is a single, unparenthesized  host name in the H field, as
34657 above, it has been verified to correspond to the IP address (see the
34658 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
34659 by the remote host in the SMTP HELO or EHLO command, and has not been
34660 verified. If verification yields a different name to that given for HELO or
34661 EHLO, the verified name appears first, followed by the HELO or EHLO
34662 name in parentheses.
34663
34664 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
34665 without brackets, in the HELO or EHLO command, leading to entries in
34666 the log containing text like these examples:
34667 .code
34668 H=(10.21.32.43) [192.168.8.34]
34669 H=([10.21.32.43]) [192.168.8.34]
34670 .endd
34671 This can be confusing. Only the final address in square brackets can be relied
34672 on.
34673
34674 For locally generated messages (that is, messages not received over TCP/IP),
34675 the H field is omitted, and the U field contains the login name of the caller
34676 of Exim.
34677
34678 .cindex "authentication" "logging"
34679 .cindex "AUTH" "logging"
34680 For all messages, the P field specifies the protocol used to receive the
34681 message. This is the value that is stored in &$received_protocol$&. In the case
34682 of incoming SMTP messages, the value indicates whether or not any SMTP
34683 extensions (ESMTP), encryption, or authentication were used. If the SMTP
34684 session was encrypted, there is an additional X field that records the cipher
34685 suite that was used.
34686
34687 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
34688 hosts that have authenticated themselves using the SMTP AUTH command. The first
34689 value is used when the SMTP connection was encrypted (&"secure"&). In this case
34690 there is an additional item A= followed by the name of the authenticator that
34691 was used. If an authenticated identification was set up by the authenticator's
34692 &%server_set_id%& option, this is logged too, separated by a colon from the
34693 authenticator name.
34694
34695 .cindex "size" "of message"
34696 The id field records the existing message id, if present. The size of the
34697 received message is given by the S field. When the message is delivered,
34698 headers may be removed or added, so that the size of delivered copies of the
34699 message may not correspond with this value (and indeed may be different to each
34700 other).
34701
34702 The &%log_selector%& option can be used to request the logging of additional
34703 data when a message is received. See section &<<SECTlogselector>>& below.
34704
34705
34706
34707 .section "Logging deliveries" "SECID252"
34708 .cindex "log" "delivery line"
34709 The format of the single-line entry in the main log that is written for every
34710 delivery is shown in one of the examples below, for local and remote
34711 deliveries, respectively. Each example has been split into two lines in order
34712 to fit it on the page:
34713 .code
34714 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
34715   <marv@hitch.fict.example> R=localuser T=local_delivery
34716 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
34717   monk@holistic.fict.example R=dnslookup T=remote_smtp
34718   H=holistic.fict.example [192.168.234.234]
34719 .endd
34720 For ordinary local deliveries, the original address is given in angle brackets
34721 after the final delivery address, which might be a pipe or a file. If
34722 intermediate address(es) exist between the original and the final address, the
34723 last of these is given in parentheses after the final address. The R and T
34724 fields record the router and transport that were used to process the address.
34725
34726 If SMTP AUTH was used for the delivery there is an additional item A=
34727 followed by the name of the authenticator that was used.
34728 If an authenticated identification was set up by the authenticator's &%client_set_id%&
34729 option, this is logged too, separated by a colon from the authenticator name.
34730
34731 If a shadow transport was run after a successful local delivery, the log line
34732 for the successful delivery has an item added on the end, of the form
34733 .display
34734 &`ST=<`&&'shadow transport name'&&`>`&
34735 .endd
34736 If the shadow transport did not succeed, the error message is put in
34737 parentheses afterwards.
34738
34739 .cindex "asterisk" "after IP address"
34740 When more than one address is included in a single delivery (for example, two
34741 SMTP RCPT commands in one transaction) the second and subsequent addresses are
34742 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
34743 down a single SMTP connection, an asterisk follows the IP address in the log
34744 lines for the second and subsequent messages.
34745
34746 .cindex "delivery" "cutthrough; logging"
34747 .cindex "cutthrough" "logging"
34748 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
34749 line precedes the reception line, since cutthrough waits for a possible
34750 rejection from the destination in case it can reject the sourced item.
34751
34752 The generation of a reply message by a filter file gets logged as a
34753 &"delivery"& to the addressee, preceded by &">"&.
34754
34755 The &%log_selector%& option can be used to request the logging of additional
34756 data when a message is delivered. See section &<<SECTlogselector>>& below.
34757
34758
34759 .section "Discarded deliveries" "SECID253"
34760 .cindex "discarded messages"
34761 .cindex "message" "discarded"
34762 .cindex "delivery" "discarded; logging"
34763 When a message is discarded as a result of the command &"seen finish"& being
34764 obeyed in a filter file which generates no deliveries, a log entry of the form
34765 .code
34766 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
34767   <low.club@bridge.example> R=userforward
34768 .endd
34769 is written, to record why no deliveries are logged. When a message is discarded
34770 because it is aliased to &":blackhole:"& the log line is like this:
34771 .code
34772 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
34773   <hole@nowhere.example> R=blackhole_router
34774 .endd
34775
34776
34777 .section "Deferred deliveries" "SECID254"
34778 When a delivery is deferred, a line of the following form is logged:
34779 .code
34780 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
34781   R=dnslookup T=smtp defer (146): Connection refused
34782 .endd
34783 In the case of remote deliveries, the error is the one that was given for the
34784 last IP address that was tried. Details of individual SMTP failures are also
34785 written to the log, so the above line would be preceded by something like
34786 .code
34787 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
34788   mail1.endrest.example [192.168.239.239]: Connection refused
34789 .endd
34790 When a deferred address is skipped because its retry time has not been reached,
34791 a message is written to the log, but this can be suppressed by setting an
34792 appropriate value in &%log_selector%&.
34793
34794
34795
34796 .section "Delivery failures" "SECID255"
34797 .cindex "delivery" "failure; logging"
34798 If a delivery fails because an address cannot be routed, a line of the
34799 following form is logged:
34800 .code
34801 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
34802   <jim@trek99.example>: unknown mail domain
34803 .endd
34804 If a delivery fails at transport time, the router and transport are shown, and
34805 the response from the remote host is included, as in this example:
34806 .code
34807 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
34808   R=dnslookup T=remote_smtp: SMTP error from remote mailer
34809   after pipelined RCPT TO:<ace400@pb.example>: host
34810   pbmail3.py.example [192.168.63.111]: 553 5.3.0
34811   <ace400@pb.example>...Addressee unknown
34812 .endd
34813 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
34814 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
34815 disabling PIPELINING. The log lines for all forms of delivery failure are
34816 flagged with &`**`&.
34817
34818
34819
34820 .section "Fake deliveries" "SECID256"
34821 .cindex "delivery" "fake; logging"
34822 If a delivery does not actually take place because the &%-N%& option has been
34823 used to suppress it, a normal delivery line is written to the log, except that
34824 &"=>"& is replaced by &"*>"&.
34825
34826
34827
34828 .section "Completion" "SECID257"
34829 A line of the form
34830 .code
34831 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
34832 .endd
34833 is written to the main log when a message is about to be removed from the spool
34834 at the end of its processing.
34835
34836
34837
34838
34839 .section "Summary of Fields in Log Lines" "SECID258"
34840 .cindex "log" "summary of fields"
34841 A summary of the field identifiers that are used in log lines is shown in
34842 the following table:
34843 .display
34844 &`A   `&        authenticator name (and optional id and sender)
34845 &`C   `&        SMTP confirmation on delivery
34846 &`    `&        command list for &"no mail in SMTP session"&
34847 &`CV  `&        certificate verification status
34848 &`D   `&        duration of &"no mail in SMTP session"&
34849 &`DN  `&        distinguished name from peer certificate
34850 &`DT  `&        on &`=>`& lines: time taken for a delivery
34851 &`F   `&        sender address (on delivery lines)
34852 &`H   `&        host name and IP address
34853 &`I   `&        local interface used
34854 &`id  `&        message id for incoming message
34855 &`P   `&        on &`<=`& lines: protocol used
34856 &`    `&        on &`=>`& and &`**`& lines: return path
34857 &`QT  `&        on &`=>`& lines: time spent on queue so far
34858 &`    `&        on &"Completed"& lines: time spent on queue
34859 &`R   `&        on &`<=`& lines: reference for local bounce
34860 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
34861 &`S   `&        size of message
34862 &`SNI `&        server name indication from TLS client hello
34863 &`ST  `&        shadow transport name
34864 &`T   `&        on &`<=`& lines: message subject (topic)
34865 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
34866 &`U   `&        local user or RFC 1413 identity
34867 &`X   `&        TLS cipher suite
34868 .endd
34869
34870
34871 .section "Other log entries" "SECID259"
34872 Various other types of log entry are written from time to time. Most should be
34873 self-explanatory. Among the more common are:
34874
34875 .ilist
34876 .cindex "retry" "time not reached"
34877 &'retry time not reached'&&~&~An address previously suffered a temporary error
34878 during routing or local delivery, and the time to retry has not yet arrived.
34879 This message is not written to an individual message log file unless it happens
34880 during the first delivery attempt.
34881 .next
34882 &'retry time not reached for any host'&&~&~An address previously suffered
34883 temporary errors during remote delivery, and the retry time has not yet arrived
34884 for any of the hosts to which it is routed.
34885 .next
34886 .cindex "spool directory" "file locked"
34887 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
34888 some other Exim process is already working on the message. This can be quite
34889 common if queue running processes are started at frequent intervals. The
34890 &'exiwhat'& utility script can be used to find out what Exim processes are
34891 doing.
34892 .next
34893 .cindex "error" "ignored"
34894 &'error ignored'&&~&~There are several circumstances that give rise to this
34895 message:
34896 .olist
34897 Exim failed to deliver a bounce message whose age was greater than
34898 &%ignore_bounce_errors_after%&. The bounce was discarded.
34899 .next
34900 A filter file set up a delivery using the &"noerror"& option, and the delivery
34901 failed. The delivery was discarded.
34902 .next
34903 A delivery set up by a router configured with
34904 . ==== As this is a nested list, any displays it contains must be indented
34905 . ==== as otherwise they are too far to the left.
34906 .code
34907     errors_to = <>
34908 .endd
34909 failed. The delivery was discarded.
34910 .endlist olist
34911 .endlist ilist
34912
34913
34914
34915
34916
34917 .section "Reducing or increasing what is logged" "SECTlogselector"
34918 .cindex "log" "selectors"
34919 By setting the &%log_selector%& global option, you can disable some of Exim's
34920 default logging, or you can request additional logging. The value of
34921 &%log_selector%& is made up of names preceded by plus or minus characters. For
34922 example:
34923 .code
34924 log_selector = +arguments -retry_defer
34925 .endd
34926 The list of optional log items is in the following table, with the default
34927 selection marked by asterisks:
34928 .display
34929 &` 8bitmime                   `&  received 8BITMIME status
34930 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
34931 &` address_rewrite            `&  address rewriting
34932 &` all_parents                `&  all parents in => lines
34933 &` arguments                  `&  command line arguments
34934 &`*connection_reject          `&  connection rejections
34935 &`*delay_delivery             `&  immediate delivery delayed
34936 &` deliver_time               `&  time taken to perform delivery
34937 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
34938 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
34939 &`*etrn                       `&  ETRN commands
34940 &`*host_lookup_failed         `&  as it says
34941 &` ident_timeout              `&  timeout for ident connection
34942 &` incoming_interface         `&  incoming interface on <= lines
34943 &` incoming_port              `&  incoming port on <= lines
34944 &`*lost_incoming_connection   `&  as it says (includes timeouts)
34945 &` outgoing_port              `&  add remote port to => lines
34946 &`*queue_run                  `&  start and end queue runs
34947 &` queue_time                 `&  time on queue for one recipient
34948 &` queue_time_overall         `&  time on queue for whole message
34949 &` pid                        `&  Exim process id
34950 &` received_recipients        `&  recipients on <= lines
34951 &` received_sender            `&  sender on <= lines
34952 &`*rejected_header            `&  header contents on reject log
34953 &`*retry_defer                `&  &"retry time not reached"&
34954 &` return_path_on_delivery    `&  put return path on => and ** lines
34955 &` sender_on_delivery         `&  add sender to => lines
34956 &`*sender_verify_fail         `&  sender verification failures
34957 &`*size_reject                `&  rejection because too big
34958 &`*skip_delivery              `&  delivery skipped in a queue run
34959 &`*smtp_confirmation          `&  SMTP confirmation on => lines
34960 &` smtp_connection            `&  SMTP connections
34961 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
34962 &` smtp_mailauth              `&  AUTH argument to MAIL commands
34963 &` smtp_no_mail               `&  session with no MAIL commands
34964 &` smtp_protocol_error        `&  SMTP protocol errors
34965 &` smtp_syntax_error          `&  SMTP syntax errors
34966 &` subject                    `&  contents of &'Subject:'& on <= lines
34967 .new
34968 &`*tls_certificate_verified   `&  certificate verification status
34969 .wen
34970 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
34971 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
34972 &` tls_sni                    `&  TLS SNI on <= lines
34973 &` unknown_in_list            `&  DNS lookup failed in list match
34974
34975 &` all                        `&  all of the above
34976 .endd
34977 More details on each of these items follows:
34978
34979 .ilist
34980 .cindex "8BITMIME"
34981 .cindex "log" "8BITMIME"
34982 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
34983 which may help in tracking down interoperability issues with ancient MTAs
34984 that are not 8bit clean.  This is added to the &"<="& line, tagged with
34985 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
34986 &`7BIT`& and &`8BITMIME`& respectively.
34987 .next
34988 .cindex "&%warn%& ACL verb" "log when skipping"
34989 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
34990 its conditions cannot be evaluated, a log line to this effect is written if
34991 this log selector is set.
34992 .next
34993 .cindex "log" "rewriting"
34994 .cindex "rewriting" "logging"
34995 &%address_rewrite%&: This applies both to global rewrites and per-transport
34996 rewrites, but not to rewrites in filters run as an unprivileged user (because
34997 such users cannot access the log).
34998 .next
34999 .cindex "log" "full parentage"
35000 &%all_parents%&: Normally only the original and final addresses are logged on
35001 delivery lines; with this selector, intermediate parents are given in
35002 parentheses between them.
35003 .next
35004 .cindex "log" "Exim arguments"
35005 .cindex "Exim arguments, logging"
35006 &%arguments%&: This causes Exim to write the arguments with which it was called
35007 to the main log, preceded by the current working directory. This is a debugging
35008 feature, added to make it easier to find out how certain MUAs call
35009 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35010 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35011 that are empty or that contain white space are quoted. Non-printing characters
35012 are shown as escape sequences. This facility cannot log unrecognized arguments,
35013 because the arguments are checked before the configuration file is read. The
35014 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35015 between the caller and Exim.
35016 .next
35017 .cindex "log" "connection rejections"
35018 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35019 connection is rejected, for whatever reason.
35020 .next
35021 .cindex "log" "delayed delivery"
35022 .cindex "delayed delivery, logging"
35023 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35024 started for an incoming message because the load is too high or too many
35025 messages were received on one connection. Logging does not occur if no delivery
35026 process is started because &%queue_only%& is set or &%-odq%& was used.
35027 .next
35028 .cindex "log" "delivery duration"
35029 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35030 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35031 .next
35032 .cindex "log" "message size on delivery"
35033 .cindex "size" "of message"
35034 &%delivery_size%&: For each delivery, the size of message delivered is added to
35035 the &"=>"& line, tagged with S=.
35036 .next
35037 .cindex "log" "dnslist defer"
35038 .cindex "DNS list" "logging defer"
35039 .cindex "black list (DNS)"
35040 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35041 DNS black list suffers a temporary error.
35042 .next
35043 .cindex "log" "ETRN commands"
35044 .cindex "ETRN" "logging"
35045 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35046 is run to determine whether or not it is actually accepted. An invalid ETRN
35047 command, or one received within a message transaction is not logged by this
35048 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35049 .next
35050 .cindex "log" "host lookup failure"
35051 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35052 any addresses, or when a lookup of an IP address fails to find a host name, a
35053 log line is written. This logging does not apply to direct DNS lookups when
35054 routing email addresses, but it does apply to &"byname"& lookups.
35055 .next
35056 .cindex "log" "ident timeout"
35057 .cindex "RFC 1413" "logging timeout"
35058 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35059 client's ident port times out.
35060 .next
35061 .cindex "log" "incoming interface"
35062 .cindex "interface" "logging"
35063 &%incoming_interface%&: The interface on which a message was received is added
35064 to the &"<="& line as an IP address in square brackets, tagged by I= and
35065 followed by a colon and the port number. The local interface and port are also
35066 added to other SMTP log lines, for example &"SMTP connection from"&, and to
35067 rejection lines.
35068 .next
35069 .cindex "log" "incoming remote port"
35070 .cindex "port" "logging remote"
35071 .cindex "TCP/IP" "logging incoming remote port"
35072 .vindex "&$sender_fullhost$&"
35073 .vindex "&$sender_rcvhost$&"
35074 &%incoming_port%&: The remote port number from which a message was received is
35075 added to log entries and &'Received:'& header lines, following the IP address
35076 in square brackets, and separated from it by a colon. This is implemented by
35077 changing the value that is put in the &$sender_fullhost$& and
35078 &$sender_rcvhost$& variables. Recording the remote port number has become more
35079 important with the widening use of NAT (see RFC 2505).
35080 .next
35081 .cindex "log" "dropped connection"
35082 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35083 connection is unexpectedly dropped.
35084 .next
35085 .cindex "log" "outgoing remote port"
35086 .cindex "port" "logging outgoint remote"
35087 .cindex "TCP/IP" "logging ougtoing remote port"
35088 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35089 containing => tags) following the IP address. This option is not included in
35090 the default setting, because for most ordinary configurations, the remote port
35091 number is always 25 (the SMTP port).
35092 .next
35093 .cindex "log" "process ids in"
35094 .cindex "pid (process id)" "in log lines"
35095 &%pid%&: The current process id is added to every log line, in square brackets,
35096 immediately after the time and date.
35097 .next
35098 .cindex "log" "queue run"
35099 .cindex "queue runner" "logging"
35100 &%queue_run%&: The start and end of every queue run are logged.
35101 .next
35102 .cindex "log" "queue time"
35103 &%queue_time%&: The amount of time the message has been in the queue on the
35104 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35105 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35106 includes reception time as well as the delivery time for the current address.
35107 This means that it may be longer than the difference between the arrival and
35108 delivery log line times, because the arrival log line is not written until the
35109 message has been successfully received.
35110 .next
35111 &%queue_time_overall%&: The amount of time the message has been in the queue on
35112 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35113 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35114 message, so it includes reception time as well as the total delivery time.
35115 .next
35116 .cindex "log" "recipients"
35117 &%received_recipients%&: The recipients of a message are listed in the main log
35118 as soon as the message is received. The list appears at the end of the log line
35119 that is written when a message is received, preceded by the word &"for"&. The
35120 addresses are listed after they have been qualified, but before any rewriting
35121 has taken place.
35122 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35123 in the list.
35124 .next
35125 .cindex "log" "sender reception"
35126 &%received_sender%&: The unrewritten original sender of a message is added to
35127 the end of the log line that records the message's arrival, after the word
35128 &"from"& (before the recipients if &%received_recipients%& is also set).
35129 .next
35130 .cindex "log" "header lines for rejection"
35131 &%rejected_header%&: If a message's header has been received at the time a
35132 rejection is written to the reject log, the complete header is added to the
35133 log. Header logging can be turned off individually for messages that are
35134 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35135 .next
35136 .cindex "log" "retry defer"
35137 &%retry_defer%&: A log line is written if a delivery is deferred because a
35138 retry time has not yet been reached. However, this &"retry time not reached"&
35139 message is always omitted from individual message logs after the first delivery
35140 attempt.
35141 .next
35142 .cindex "log" "return path"
35143 &%return_path_on_delivery%&: The return path that is being transmitted with
35144 the message is included in delivery and bounce lines, using the tag P=.
35145 This is omitted if no delivery actually happens, for example, if routing fails,
35146 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35147 .next
35148 .cindex "log" "sender on delivery"
35149 &%sender_on_delivery%&: The message's sender address is added to every delivery
35150 and bounce line, tagged by F= (for &"from"&).
35151 This is the original sender that was received with the message; it is not
35152 necessarily the same as the outgoing return path.
35153 .next
35154 .cindex "log" "sender verify failure"
35155 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35156 gives details of a sender verification failure is not written. Log lines for
35157 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35158 detail is lost.
35159 .next
35160 .cindex "log" "size rejection"
35161 &%size_reject%&: A log line is written whenever a message is rejected because
35162 it is too big.
35163 .next
35164 .cindex "log" "frozen messages; skipped"
35165 .cindex "frozen messages" "logging skipping"
35166 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35167 queue run because it is frozen or because another process is already delivering
35168 it.
35169 .cindex "&""spool file is locked""&"
35170 The message that is written is &"spool file is locked"&.
35171 .next
35172 .cindex "log" "smtp confirmation"
35173 .cindex "SMTP" "logging confirmation"
35174 .cindex "LMTP" "logging confirmation"
35175 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35176 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35177 A number of MTAs (including Exim) return an identifying string in this
35178 response.
35179 .next
35180 .cindex "log" "SMTP connections"
35181 .cindex "SMTP" "logging connections"
35182 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35183 established or closed, unless the connection is from a host that matches
35184 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35185 only when the closure is unexpected.) This applies to connections from local
35186 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35187 dropped in the middle of a message, a log line is always written, whether or
35188 not this selector is set, but otherwise nothing is written at the start and end
35189 of connections unless this selector is enabled.
35190
35191 For TCP/IP connections to an Exim daemon, the current number of connections is
35192 included in the log message for each new connection, but note that the count is
35193 reset if the daemon is restarted.
35194 Also, because connections are closed (and the closure is logged) in
35195 subprocesses, the count may not include connections that have been closed but
35196 whose termination the daemon has not yet noticed. Thus, while it is possible to
35197 match up the opening and closing of connections in the log, the value of the
35198 logged counts may not be entirely accurate.
35199 .next
35200 .cindex "log" "SMTP transaction; incomplete"
35201 .cindex "SMTP" "logging incomplete transactions"
35202 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35203 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35204 and the message sender plus any accepted recipients are included in the log
35205 line. This can provide evidence of dictionary attacks.
35206 .next
35207 .cindex "log" "non-MAIL SMTP sessions"
35208 .cindex "MAIL" "logging session without"
35209 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35210 connection terminates without having issued a MAIL command. This includes both
35211 the case when the connection is dropped, and the case when QUIT is used. It
35212 does not include cases where the connection is rejected right at the start (by
35213 an ACL, or because there are too many connections, or whatever). These cases
35214 already have their own log lines.
35215
35216 The log line that is written contains the identity of the client in the usual
35217 way, followed by D= and a time, which records the duration of the connection.
35218 If the connection was authenticated, this fact is logged exactly as it is for
35219 an incoming message, with an A= item. If the connection was encrypted, CV=,
35220 DN=, and X= items may appear as they do for an incoming message, controlled by
35221 the same logging options.
35222
35223 Finally, if any SMTP commands were issued during the connection, a C= item
35224 is added to the line, listing the commands that were used. For example,
35225 .code
35226 C=EHLO,QUIT
35227 .endd
35228 shows that the client issued QUIT straight after EHLO. If there were fewer
35229 than 20 commands, they are all listed. If there were more than 20 commands,
35230 the last 20 are listed, preceded by &"..."&. However, with the default
35231 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35232 have been aborted before 20 non-mail commands are processed.
35233 .next
35234 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35235 colon-separated, is appended to the A= item for a message arrival or delivery
35236 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35237 was accepted or used.
35238 .next
35239 .cindex "log" "SMTP protocol error"
35240 .cindex "SMTP" "logging protocol error"
35241 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35242 encountered. Exim does not have perfect detection of all protocol errors
35243 because of transmission delays and the use of pipelining. If PIPELINING has
35244 been advertised to a client, an Exim server assumes that the client will use
35245 it, and therefore it does not count &"expected"& errors (for example, RCPT
35246 received after rejecting MAIL) as protocol errors.
35247 .next
35248 .cindex "SMTP" "logging syntax errors"
35249 .cindex "SMTP" "syntax errors; logging"
35250 .cindex "SMTP" "unknown command; logging"
35251 .cindex "log" "unknown SMTP command"
35252 .cindex "log" "SMTP syntax error"
35253 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35254 encountered. An unrecognized command is treated as a syntax error. For an
35255 external connection, the host identity is given; for an internal connection
35256 using &%-bs%& the sender identification (normally the calling user) is given.
35257 .next
35258 .cindex "log" "subject"
35259 .cindex "subject, logging"
35260 &%subject%&: The subject of the message is added to the arrival log line,
35261 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35262 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35263 specifies whether characters with values greater than 127 should be logged
35264 unchanged, or whether they should be rendered as escape sequences.
35265 .next
35266 .cindex "log" "certificate verification"
35267 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35268 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35269 verified, and &`CV=no`& if not.
35270 .next
35271 .cindex "log" "TLS cipher"
35272 .cindex "TLS" "logging cipher"
35273 &%tls_cipher%&: When a message is sent or received over an encrypted
35274 connection, the cipher suite used is added to the log line, preceded by X=.
35275 .next
35276 .cindex "log" "TLS peer DN"
35277 .cindex "TLS" "logging peer DN"
35278 &%tls_peerdn%&: When a message is sent or received over an encrypted
35279 connection, and a certificate is supplied by the remote host, the peer DN is
35280 added to the log line, preceded by DN=.
35281 .next
35282 .cindex "log" "TLS SNI"
35283 .cindex "TLS" "logging SNI"
35284 &%tls_sni%&: When a message is received over an encrypted connection, and
35285 the remote host provided the Server Name Indication extension, the SNI is
35286 added to the log line, preceded by SNI=.
35287 .next
35288 .cindex "log" "DNS failure in list"
35289 &%unknown_in_list%&: This setting causes a log entry to be written when the
35290 result of a list match is failure because a DNS lookup failed.
35291 .endlist
35292
35293
35294 .section "Message log" "SECID260"
35295 .cindex "message" "log file for"
35296 .cindex "log" "message log; description of"
35297 .cindex "&_msglog_& directory"
35298 .oindex "&%preserve_message_logs%&"
35299 In addition to the general log files, Exim writes a log file for each message
35300 that it handles. The names of these per-message logs are the message ids, and
35301 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35302 message log contains copies of the log lines that apply to the message. This
35303 makes it easier to inspect the status of an individual message without having
35304 to search the main log. A message log is deleted when processing of the message
35305 is complete, unless &%preserve_message_logs%& is set, but this should be used
35306 only with great care because they can fill up your disk very quickly.
35307
35308 On a heavily loaded system, it may be desirable to disable the use of
35309 per-message logs, in order to reduce disk I/O. This can be done by setting the
35310 &%message_logs%& option false.
35311 .ecindex IIDloggen
35312
35313
35314
35315
35316 . ////////////////////////////////////////////////////////////////////////////
35317 . ////////////////////////////////////////////////////////////////////////////
35318
35319 .chapter "Exim utilities" "CHAPutils"
35320 .scindex IIDutils "utilities"
35321 A number of utility scripts and programs are supplied with Exim and are
35322 described in this chapter. There is also the Exim Monitor, which is covered in
35323 the next chapter. The utilities described here are:
35324
35325 .itable none 0 0 3  7* left  15* left  40* left
35326 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35327   "list what Exim processes are doing"
35328 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35329 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35330 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35331 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35332                                                 various criteria"
35333 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35334 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35335   "extract statistics from the log"
35336 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35337   "check address acceptance from given IP"
35338 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35339 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35340 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35341 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35342 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35343 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35344 .endtable
35345
35346 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35347 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35348 &url(http://duncanthrax.net/exilog/) for details.
35349
35350
35351
35352
35353 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35354 .cindex "&'exiwhat'&"
35355 .cindex "process, querying"
35356 .cindex "SIGUSR1"
35357 On operating systems that can restart a system call after receiving a signal
35358 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35359 a line describing what it is doing to the file &_exim-process.info_& in the
35360 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35361 processes it can find, having first emptied the file. It then waits for one
35362 second to allow the Exim processes to react before displaying the results. In
35363 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35364 send the signal to the Exim processes, so it is normally run as root.
35365
35366 &*Warning*&: This is not an efficient process. It is intended for occasional
35367 use by system administrators. It is not sensible, for example, to set up a
35368 script that sends SIGUSR1 signals to Exim processes at short intervals.
35369
35370
35371 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35372 varies in different operating systems. Not only are different options used,
35373 but the format of the output is different. For this reason, there are some
35374 system configuration options that configure exactly how &'exiwhat'& works. If
35375 it doesn't seem to be working for you, check the following compile-time
35376 options:
35377 .display
35378 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35379 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35380 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35381 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35382 .endd
35383 An example of typical output from &'exiwhat'& is
35384 .code
35385 164 daemon: -q1h, listening on port 25
35386 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35387 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35388   [10.19.42.42] (editor@ref.example)
35389 10592 handling incoming call from [192.168.243.242]
35390 10628 accepting a local non-SMTP message
35391 .endd
35392 The first number in the output line is the process number. The third line has
35393 been split here, in order to fit it on the page.
35394
35395
35396
35397 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35398 .cindex "&'exiqgrep'&"
35399 .cindex "queue" "grepping"
35400 This utility is a Perl script contributed by Matt Hubbard. It runs
35401 .code
35402 exim -bpu
35403 .endd
35404 or (in case &*-a*& switch is specified)
35405 .code
35406 exim -bp
35407 .endd
35408 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35409 contain alternate exim configuration the queue management might be using.
35410
35411 to obtain a queue listing, and then greps the output to select messages 
35412 that match given criteria. The following selection options are available:
35413
35414 .vlist
35415 .vitem &*-f*&&~<&'regex'&>
35416 Match the sender address using a case-insensitive search. The field that is
35417 tested is enclosed in angle brackets, so you can test for bounce messages with
35418 .code
35419 exiqgrep -f '^<>$'
35420 .endd
35421 .vitem &*-r*&&~<&'regex'&>
35422 Match a recipient address using a case-insensitve search. The field that is
35423 tested is not enclosed in angle brackets.
35424
35425 .vitem &*-s*&&~<&'regex'&>
35426 Match against the size field.
35427
35428 .vitem &*-y*&&~<&'seconds'&>
35429 Match messages that are younger than the given time.
35430
35431 .vitem &*-o*&&~<&'seconds'&>
35432 Match messages that are older than the given time.
35433
35434 .vitem &*-z*&
35435 Match only frozen messages.
35436
35437 .vitem &*-x*&
35438 Match only non-frozen messages.
35439 .endlist
35440
35441 The following options control the format of the output:
35442
35443 .vlist
35444 .vitem &*-c*&
35445 Display only the count of matching messages.
35446
35447 .vitem &*-l*&
35448 Long format &-- display the full message information as output by Exim. This is
35449 the default.
35450
35451 .vitem &*-i*&
35452 Display message ids only.
35453
35454 .vitem &*-b*&
35455 Brief format &-- one line per message.
35456
35457 .vitem &*-R*&
35458 Display messages in reverse order.
35459
35460 .vitem &*-a*&
35461 Include delivered recipients in queue listing.
35462 .endlist
35463
35464 There is one more option, &%-h%&, which outputs a list of options.
35465
35466
35467
35468 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35469 .cindex "&'exiqsumm'&"
35470 .cindex "queue" "summary"
35471 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35472 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35473 running a command such as
35474 .code
35475 exim -bp | exiqsumm
35476 .endd
35477 The output consists of one line for each domain that has messages waiting for
35478 it, as in the following example:
35479 .code
35480 3   2322   74m   66m  msn.com.example
35481 .endd
35482 Each line lists the number of pending deliveries for a domain, their total
35483 volume, and the length of time that the oldest and the newest messages have
35484 been waiting. Note that the number of pending deliveries is greater than the
35485 number of messages when messages have more than one recipient.
35486
35487 A summary line is output at the end. By default the output is sorted on the
35488 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35489 the output to be sorted by oldest message and by count of messages,
35490 respectively. There are also three options that split the messages for each
35491 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35492 separates frozen messages, and &%-s%& separates messages according to their
35493 sender.
35494
35495 The output of &'exim -bp'& contains the original addresses in the message, so
35496 this also applies to the output from &'exiqsumm'&. No domains from addresses
35497 generated by aliasing or forwarding are included (unless the &%one_time%&
35498 option of the &(redirect)& router has been used to convert them into &"top
35499 level"& addresses).
35500
35501
35502
35503
35504 .section "Extracting specific information from the log (exigrep)" &&&
35505          "SECTextspeinf"
35506 .cindex "&'exigrep'&"
35507 .cindex "log" "extracts; grepping for"
35508 The &'exigrep'& utility is a Perl script that searches one or more main log
35509 files for entries that match a given pattern. When it finds a match, it
35510 extracts all the log entries for the relevant message, not just those that
35511 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35512 given message, or all mail for a given user, or for a given host, for example.
35513 The input files can be in Exim log format or syslog format.
35514 If a matching log line is not associated with a specific message, it is
35515 included in &'exigrep'&'s output without any additional lines. The usage is:
35516 .display
35517 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35518 .endd
35519 If no log file names are given on the command line, the standard input is read.
35520
35521 The &%-t%& argument specifies a number of seconds. It adds an additional
35522 condition for message selection. Messages that are complete are shown only if
35523 they spent more than <&'n'&> seconds on the queue.
35524
35525 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35526 makes it case-sensitive. This may give a performance improvement when searching
35527 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35528 option; with &%-I%& they do not. In both cases it is possible to change the
35529 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35530
35531 The &%-l%& option means &"literal"&, that is, treat all characters in the
35532 pattern as standing for themselves. Otherwise the pattern must be a Perl
35533 regular expression.
35534
35535 The &%-v%& option inverts the matching condition. That is, a line is selected
35536 if it does &'not'& match the pattern.
35537
35538 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35539 that are generated as a result/response to a message that &'exigrep'& matched
35540 normally.
35541
35542 Example of &%-M%&:
35543 user_a sends a message to user_b, which generates a bounce back to user_b. If
35544 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35545 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35546 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35547 when searching for &"user_a"& will show both messages since the bounce is
35548 &"related"& to or a &"result"& of the first message that was found by the
35549 search term.
35550
35551 If the location of a &'zcat'& command is known from the definition of
35552 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35553 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35554
35555
35556 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35557 .cindex "&'exipick'&"
35558 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35559 lists messages from the queue according to a variety of criteria. For details
35560 of &'exipick'&'s facilities, visit the web page at
35561 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35562 the &%--help%& option.
35563
35564
35565 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35566 .cindex "log" "cycling local files"
35567 .cindex "cycling logs"
35568 .cindex "&'exicyclog'&"
35569 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35570 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35571 you are using log files with datestamps in their names (see section
35572 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35573 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35574 There are two command line options for &'exicyclog'&:
35575 .ilist
35576 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35577 default that is set when Exim is built. The default default is 10.
35578 .next
35579 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35580 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35581 overriding the script's default, which is to find the setting from Exim's
35582 configuration.
35583 .endlist
35584
35585 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35586 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35587 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35588 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35589 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35590 logs are handled similarly.
35591
35592 If the limit is greater than 99, the script uses 3-digit numbers such as
35593 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35594 to one that is greater, or &'vice versa'&, you will have to fix the names of
35595 any existing log files.
35596
35597 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35598 the end are deleted. All files with numbers greater than 01 are compressed,
35599 using a compression command which is configured by the COMPRESS_COMMAND
35600 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35601 root &%crontab%& entry of the form
35602 .code
35603 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35604 .endd
35605 assuming you have used the name &"exim"& for the Exim user. You can run
35606 &'exicyclog'& as root if you wish, but there is no need.
35607
35608
35609
35610 .section "Mail statistics (eximstats)" "SECTmailstat"
35611 .cindex "statistics"
35612 .cindex "&'eximstats'&"
35613 A Perl script called &'eximstats'& is provided for extracting statistical
35614 information from log files. The output is either plain text, or HTML.
35615 Exim log files are also supported by the &'Lire'& system produced by the
35616 LogReport Foundation &url(http://www.logreport.org).
35617
35618 The &'eximstats'& script has been hacked about quite a bit over time. The
35619 latest version is the result of some extensive revision by Steve Campbell. A
35620 lot of information is given by default, but there are options for suppressing
35621 various parts of it. Following any options, the arguments to the script are a
35622 list of files, which should be main log files. For example:
35623 .code
35624 eximstats -nr /var/spool/exim/log/mainlog.01
35625 .endd
35626 By default, &'eximstats'& extracts information about the number and volume of
35627 messages received from or delivered to various hosts. The information is sorted
35628 both by message count and by volume, and the top fifty hosts in each category
35629 are listed on the standard output. Similar information, based on email
35630 addresses or domains instead of hosts can be requested by means of various
35631 options. For messages delivered and received locally, similar statistics are
35632 also produced per user.
35633
35634 The output also includes total counts and statistics about delivery errors, and
35635 histograms showing the number of messages received and deliveries made in each
35636 hour of the day. A delivery with more than one address in its envelope (for
35637 example, an SMTP transaction with more than one RCPT command) is counted
35638 as a single delivery by &'eximstats'&.
35639
35640 Though normally more deliveries than receipts are reported (as messages may
35641 have multiple recipients), it is possible for &'eximstats'& to report more
35642 messages received than delivered, even though the queue is empty at the start
35643 and end of the period in question. If an incoming message contains no valid
35644 recipients, no deliveries are recorded for it. A bounce message is handled as
35645 an entirely separate message.
35646
35647 &'eximstats'& always outputs a grand total summary giving the volume and number
35648 of messages received and deliveries made, and the number of hosts involved in
35649 each case. It also outputs the number of messages that were delayed (that is,
35650 not completely delivered at the first attempt), and the number that had at
35651 least one address that failed.
35652
35653 The remainder of the output is in sections that can be independently disabled
35654 or modified by various options. It consists of a summary of deliveries by
35655 transport, histograms of messages received and delivered per time interval
35656 (default per hour), information about the time messages spent on the queue,
35657 a list of relayed messages, lists of the top fifty sending hosts, local
35658 senders, destination hosts, and destination local users by count and by volume,
35659 and a list of delivery errors that occurred.
35660
35661 The relay information lists messages that were actually relayed, that is, they
35662 came from a remote host and were directly delivered to some other remote host,
35663 without being processed (for example, for aliasing or forwarding) locally.
35664
35665 There are quite a few options for &'eximstats'& to control exactly what it
35666 outputs. These are documented in the Perl script itself, and can be extracted
35667 by running the command &(perldoc)& on the script. For example:
35668 .code
35669 perldoc /usr/exim/bin/eximstats
35670 .endd
35671
35672 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
35673 .cindex "&'exim_checkaccess'&"
35674 .cindex "policy control" "checking access"
35675 .cindex "checking access"
35676 The &%-bh%& command line argument allows you to run a fake SMTP session with
35677 debugging output, in order to check what Exim is doing when it is applying
35678 policy controls to incoming SMTP mail. However, not everybody is sufficiently
35679 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
35680 sometimes you just want to answer the question &"Does this address have
35681 access?"& without bothering with any further details.
35682
35683 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
35684 two arguments, an IP address and an email address:
35685 .code
35686 exim_checkaccess 10.9.8.7 A.User@a.domain.example
35687 .endd
35688 The utility runs a call to Exim with the &%-bh%& option, to test whether the
35689 given email address would be accepted in a RCPT command in a TCP/IP
35690 connection from the host with the given IP address. The output of the utility
35691 is either the word &"accepted"&, or the SMTP error response, for example:
35692 .code
35693 Rejected:
35694 550 Relay not permitted
35695 .endd
35696 When running this test, the utility uses &`<>`& as the envelope sender address
35697 for the MAIL command, but you can change this by providing additional
35698 options. These are passed directly to the Exim command. For example, to specify
35699 that the test is to be run with the sender address &'himself@there.example'&
35700 you can use:
35701 .code
35702 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
35703                  -f himself@there.example
35704 .endd
35705 Note that these additional Exim command line items must be given after the two
35706 mandatory arguments.
35707
35708 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
35709 while running its checks. You can run checks that include callouts by using
35710 &%-bhc%&, but this is not yet available in a &"packaged"& form.
35711
35712
35713
35714 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
35715 .cindex "DBM" "building dbm files"
35716 .cindex "building DBM files"
35717 .cindex "&'exim_dbmbuild'&"
35718 .cindex "lower casing"
35719 .cindex "binary zero" "in lookup key"
35720 The &'exim_dbmbuild'& program reads an input file containing keys and data in
35721 the format used by the &(lsearch)& lookup (see section
35722 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
35723 names as keys and the remainder of the information as data. The lower-casing
35724 can be prevented by calling the program with the &%-nolc%& option.
35725
35726 A terminating zero is included as part of the key string. This is expected by
35727 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
35728 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
35729 strings or the data strings. The &(dbmnz)& lookup type can be used with such
35730 files.
35731
35732 The program requires two arguments: the name of the input file (which can be a
35733 single hyphen to indicate the standard input), and the name of the output file.
35734 It creates the output under a temporary name, and then renames it if all went
35735 well.
35736
35737 .cindex "USE_DB"
35738 If the native DB interface is in use (USE_DB is set in a compile-time
35739 configuration file &-- this is common in free versions of Unix) the two file
35740 names must be different, because in this mode the Berkeley DB functions create
35741 a single output file using exactly the name given. For example,
35742 .code
35743 exim_dbmbuild /etc/aliases /etc/aliases.db
35744 .endd
35745 reads the system alias file and creates a DBM version of it in
35746 &_/etc/aliases.db_&.
35747
35748 In systems that use the &'ndbm'& routines (mostly proprietary versions of
35749 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
35750 environment, the suffixes are added to the second argument of
35751 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
35752 when the Berkeley functions are used in compatibility mode (though this is not
35753 recommended), because in that case it adds a &_.db_& suffix to the file name.
35754
35755 If a duplicate key is encountered, the program outputs a warning, and when it
35756 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
35757 option is used. By default, only the first of a set of duplicates is used &--
35758 this makes it compatible with &(lsearch)& lookups. There is an option
35759 &%-lastdup%& which causes it to use the data for the last duplicate instead.
35760 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
35761 &%stderr%&. For other errors, where it doesn't actually make a new file, the
35762 return code is 2.
35763
35764
35765
35766
35767 .section "Finding individual retry times (exinext)" "SECTfinindret"
35768 .cindex "retry" "times"
35769 .cindex "&'exinext'&"
35770 A utility called &'exinext'& (mostly a Perl script) provides the ability to
35771 fish specific information out of the retry database. Given a mail domain (or a
35772 complete address), it looks up the hosts for that domain, and outputs any retry
35773 information for the hosts or for the domain. At present, the retry information
35774 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
35775 output. For example:
35776 .code
35777 $ exinext piglet@milne.fict.example
35778 kanga.milne.example:192.168.8.1 error 146: Connection refused
35779   first failed: 21-Feb-1996 14:57:34
35780   last tried:   21-Feb-1996 14:57:34
35781   next try at:  21-Feb-1996 15:02:34
35782 roo.milne.example:192.168.8.3 error 146: Connection refused
35783   first failed: 20-Jan-1996 13:12:08
35784   last tried:   21-Feb-1996 11:42:03
35785   next try at:  21-Feb-1996 19:42:03
35786   past final cutoff time
35787 .endd
35788 You can also give &'exinext'& a local part, without a domain, and it
35789 will give any retry information for that local part in your default domain.
35790 A message id can be used to obtain retry information pertaining to a specific
35791 message. This exists only when an attempt to deliver a message to a remote host
35792 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
35793 &'exinext'& is not particularly efficient, but then it is not expected to be
35794 run very often.
35795
35796 The &'exinext'& utility calls Exim to find out information such as the location
35797 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
35798 passed on to the &'exim'& commands. The first specifies an alternate Exim
35799 configuration file, and the second sets macros for use within the configuration
35800 file. These features are mainly to help in testing, but might also be useful in
35801 environments where more than one configuration file is in use.
35802
35803
35804
35805 .section "Hints database maintenance" "SECThindatmai"
35806 .cindex "hints database" "maintenance"
35807 .cindex "maintaining Exim's hints database"
35808 Three utility programs are provided for maintaining the DBM files that Exim
35809 uses to contain its delivery hint information. Each program requires two
35810 arguments. The first specifies the name of Exim's spool directory, and the
35811 second is the name of the database it is to operate on. These are as follows:
35812
35813 .ilist
35814 &'retry'&: the database of retry information
35815 .next
35816 &'wait-'&<&'transport name'&>: databases of information about messages waiting
35817 for remote hosts
35818 .next
35819 &'callout'&: the callout cache
35820 .next
35821 &'ratelimit'&: the data for implementing the ratelimit ACL condition
35822 .next
35823 &'misc'&: other hints data
35824 .endlist
35825
35826 The &'misc'& database is used for
35827
35828 .ilist
35829 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
35830 .next
35831 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
35832 &(smtp)& transport)
35833 .endlist
35834
35835
35836
35837 .section "exim_dumpdb" "SECID261"
35838 .cindex "&'exim_dumpdb'&"
35839 The entire contents of a database are written to the standard output by the
35840 &'exim_dumpdb'& program, which has no options or arguments other than the
35841 spool and database names. For example, to dump the retry database:
35842 .code
35843 exim_dumpdb /var/spool/exim retry
35844 .endd
35845 Two lines of output are produced for each entry:
35846 .code
35847 T:mail.ref.example:192.168.242.242 146 77 Connection refused
35848 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
35849 .endd
35850 The first item on the first line is the key of the record. It starts with one
35851 of the letters R, or T, depending on whether it refers to a routing or
35852 transport retry. For a local delivery, the next part is the local address; for
35853 a remote delivery it is the name of the remote host, followed by its failing IP
35854 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
35855 transport). If the remote port is not the standard one (port 25), it is added
35856 to the IP address. Then there follows an error code, an additional error code,
35857 and a textual description of the error.
35858
35859 The three times on the second line are the time of first failure, the time of
35860 the last delivery attempt, and the computed time for the next attempt. The line
35861 ends with an asterisk if the cutoff time for the last retry rule has been
35862 exceeded.
35863
35864 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
35865 consists of a host name followed by a list of ids for messages that are or were
35866 waiting to be delivered to that host. If there are a very large number for any
35867 one host, continuation records, with a sequence number added to the host name,
35868 may be seen. The data in these records is often out of date, because a message
35869 may be routed to several alternative hosts, and Exim makes no effort to keep
35870 cross-references.
35871
35872
35873
35874 .section "exim_tidydb" "SECID262"
35875 .cindex "&'exim_tidydb'&"
35876 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
35877 database. If run with no options, it removes all records that are more than 30
35878 days old. The age is calculated from the date and time that the record was last
35879 updated. Note that, in the case of the retry database, it is &'not'& the time
35880 since the first delivery failure. Information about a host that has been down
35881 for more than 30 days will remain in the database, provided that the record is
35882 updated sufficiently often.
35883
35884 The cutoff date can be altered by means of the &%-t%& option, which must be
35885 followed by a time. For example, to remove all records older than a week from
35886 the retry database:
35887 .code
35888 exim_tidydb -t 7d /var/spool/exim retry
35889 .endd
35890 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
35891 message ids. In the former these appear as data in records keyed by host &--
35892 they were messages that were waiting for that host &-- and in the latter they
35893 are the keys for retry information for messages that have suffered certain
35894 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
35895 message ids in database records are those of messages that are still on the
35896 queue. Message ids for messages that no longer exist are removed from
35897 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
35898 For the &'retry'& database, records whose keys are non-existent message ids are
35899 removed. The &'exim_tidydb'& utility outputs comments on the standard output
35900 whenever it removes information from the database.
35901
35902 Certain records are automatically removed by Exim when they are no longer
35903 needed, but others are not. For example, if all the MX hosts for a domain are
35904 down, a retry record is created for each one. If the primary MX host comes back
35905 first, its record is removed when Exim successfully delivers to it, but the
35906 records for the others remain because Exim has not tried to use those hosts.
35907
35908 It is important, therefore, to run &'exim_tidydb'& periodically on all the
35909 hints databases. You should do this at a quiet time of day, because it requires
35910 a database to be locked (and therefore inaccessible to Exim) while it does its
35911 work. Removing records from a DBM file does not normally make the file smaller,
35912 but all the common DBM libraries are able to re-use the space that is released.
35913 After an initial phase of increasing in size, the databases normally reach a
35914 point at which they no longer get any bigger, as long as they are regularly
35915 tidied.
35916
35917 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
35918 databases is likely to keep on increasing.
35919
35920
35921
35922
35923 .section "exim_fixdb" "SECID263"
35924 .cindex "&'exim_fixdb'&"
35925 The &'exim_fixdb'& program is a utility for interactively modifying databases.
35926 Its main use is for testing Exim, but it might also be occasionally useful for
35927 getting round problems in a live system. It has no options, and its interface
35928 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
35929 key of a database record can then be entered, and the data for that record is
35930 displayed.
35931
35932 If &"d"& is typed at the next prompt, the entire record is deleted. For all
35933 except the &'retry'& database, that is the only operation that can be carried
35934 out. For the &'retry'& database, each field is output preceded by a number, and
35935 data for individual fields can be changed by typing the field number followed
35936 by new data, for example:
35937 .code
35938 > 4 951102:1000
35939 .endd
35940 resets the time of the next delivery attempt. Time values are given as a
35941 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
35942 used as optional separators.
35943
35944
35945
35946
35947 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
35948 .cindex "mailbox" "maintenance"
35949 .cindex "&'exim_lock'&"
35950 .cindex "locking mailboxes"
35951 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
35952 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
35953 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
35954 a user agent while investigating a problem. The utility requires the name of
35955 the file as its first argument. If the locking is successful, the second
35956 argument is run as a command (using C's &[system()]& function); if there is no
35957 second argument, the value of the SHELL environment variable is used; if this
35958 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
35959 is unlocked and the utility ends. The following options are available:
35960
35961 .vlist
35962 .vitem &%-fcntl%&
35963 Use &[fcntl()]& locking on the open mailbox.
35964
35965 .vitem &%-flock%&
35966 Use &[flock()]& locking on the open mailbox, provided the operating system
35967 supports it.
35968
35969 .vitem &%-interval%&
35970 This must be followed by a number, which is a number of seconds; it sets the
35971 interval to sleep between retries (default 3).
35972
35973 .vitem &%-lockfile%&
35974 Create a lock file before opening the mailbox.
35975
35976 .vitem &%-mbx%&
35977 Lock the mailbox using MBX rules.
35978
35979 .vitem &%-q%&
35980 Suppress verification output.
35981
35982 .vitem &%-retries%&
35983 This must be followed by a number; it sets the number of times to try to get
35984 the lock (default 10).
35985
35986 .vitem &%-restore_time%&
35987 This option causes &%exim_lock%& to restore the modified and read times to the
35988 locked file before exiting. This allows you to access a locked mailbox (for
35989 example, to take a backup copy) without disturbing the times that the user
35990 subsequently sees.
35991
35992 .vitem &%-timeout%&
35993 This must be followed by a number, which is a number of seconds; it sets a
35994 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
35995 default), a non-blocking call is used.
35996
35997 .vitem &%-v%&
35998 Generate verbose output.
35999 .endlist
36000
36001 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36002 default is to create a lock file and also to use &[fcntl()]& locking on the
36003 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36004 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36005 requires that the directory containing the file be writeable. Locking by lock
36006 file does not last for ever; Exim assumes that a lock file is expired if it is
36007 more than 30 minutes old.
36008
36009 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36010 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36011 to be taken out on the open mailbox, and an exclusive lock on the file
36012 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36013 number of the mailbox file. When the locking is released, if an exclusive lock
36014 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36015
36016 The default output contains verification of the locking that takes place. The
36017 &%-v%& option causes some additional information to be given. The &%-q%& option
36018 suppresses all output except error messages.
36019
36020 A command such as
36021 .code
36022 exim_lock /var/spool/mail/spqr
36023 .endd
36024 runs an interactive shell while the file is locked, whereas
36025 .display
36026 &`exim_lock -q /var/spool/mail/spqr <<End`&
36027 <&'some commands'&>
36028 &`End`&
36029 .endd
36030 runs a specific non-interactive sequence of commands while the file is locked,
36031 suppressing all verification output. A single command can be run by a command
36032 such as
36033 .code
36034 exim_lock -q /var/spool/mail/spqr \
36035   "cp /var/spool/mail/spqr /some/where"
36036 .endd
36037 Note that if a command is supplied, it must be entirely contained within the
36038 second argument &-- hence the quotes.
36039 .ecindex IIDutils
36040
36041
36042 . ////////////////////////////////////////////////////////////////////////////
36043 . ////////////////////////////////////////////////////////////////////////////
36044
36045 .chapter "The Exim monitor" "CHAPeximon"
36046 .scindex IIDeximon "Exim monitor" "description"
36047 .cindex "X-windows"
36048 .cindex "&'eximon'&"
36049 .cindex "Local/eximon.conf"
36050 .cindex "&_exim_monitor/EDITME_&"
36051 The Exim monitor is an application which displays in an X window information
36052 about the state of Exim's queue and what Exim is doing. An admin user can
36053 perform certain operations on messages from this GUI interface; however all
36054 such facilities are also available from the command line, and indeed, the
36055 monitor itself makes use of the command line to perform any actions requested.
36056
36057
36058
36059 .section "Running the monitor" "SECID264"
36060 The monitor is started by running the script called &'eximon'&. This is a shell
36061 script that sets up a number of environment variables, and then runs the
36062 binary called &_eximon.bin_&. The default appearance of the monitor window can
36063 be changed by editing the &_Local/eximon.conf_& file created by editing
36064 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36065 parameters are for.
36066
36067 The parameters that get built into the &'eximon'& script can be overridden for
36068 a particular invocation by setting up environment variables of the same names,
36069 preceded by &`EXIMON_`&. For example, a shell command such as
36070 .code
36071 EXIMON_LOG_DEPTH=400 eximon
36072 .endd
36073 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36074 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36075 overrides the Exim log file configuration. This makes it possible to have
36076 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36077 syslog messages are routed to a file on the local host.
36078
36079 X resources can be used to change the appearance of the window in the normal
36080 way. For example, a resource setting of the form
36081 .code
36082 Eximon*background: gray94
36083 .endd
36084 changes the colour of the background to light grey rather than white. The
36085 stripcharts are drawn with both the data lines and the reference lines in
36086 black. This means that the reference lines are not visible when on top of the
36087 data. However, their colour can be changed by setting a resource called
36088 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36089 For example, if your X server is running Unix, you could set up lighter
36090 reference lines in the stripcharts by obeying
36091 .code
36092 xrdb -merge <<End
36093 Eximon*highlight: gray
36094 End
36095 .endd
36096 .cindex "admin user"
36097 In order to see the contents of messages on the queue, and to operate on them,
36098 &'eximon'& must either be run as root or by an admin user.
36099
36100 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36101 contain X11 resource parameters interpreted by the X11 library.  In addition,
36102 if the first parameter starts with the string "gdb" then it is removed and the
36103 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36104 versioned variants of gdb can be invoked).
36105
36106 The monitor's window is divided into three parts. The first contains one or
36107 more stripcharts and two action buttons, the second contains a &"tail"& of the
36108 main log file, and the third is a display of the queue of messages awaiting
36109 delivery, with two more action buttons. The following sections describe these
36110 different parts of the display.
36111
36112
36113
36114
36115 .section "The stripcharts" "SECID265"
36116 .cindex "stripchart"
36117 The first stripchart is always a count of messages on the queue. Its name can
36118 be configured by setting QUEUE_STRIPCHART_NAME in the
36119 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36120 configuration script by regular expression matches on log file entries, making
36121 it possible to display, for example, counts of messages delivered to certain
36122 hosts or using certain transports. The supplied defaults display counts of
36123 received and delivered messages, and of local and SMTP deliveries. The default
36124 period between stripchart updates is one minute; this can be adjusted by a
36125 parameter in the &_Local/eximon.conf_& file.
36126
36127 The stripchart displays rescale themselves automatically as the value they are
36128 displaying changes. There are always 10 horizontal lines in each chart; the
36129 title string indicates the value of each division when it is greater than one.
36130 For example, &"x2"& means that each division represents a value of 2.
36131
36132 It is also possible to have a stripchart which shows the percentage fullness of
36133 a particular disk partition, which is useful when local deliveries are confined
36134 to a single partition.
36135
36136 .cindex "&%statvfs%& function"
36137 This relies on the availability of the &[statvfs()]& function or equivalent in
36138 the operating system. Most, but not all versions of Unix that support Exim have
36139 this. For this particular stripchart, the top of the chart always represents
36140 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36141 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36142 &_Local/eximon.conf_& file.
36143
36144
36145
36146
36147 .section "Main action buttons" "SECID266"
36148 .cindex "size" "of monitor window"
36149 .cindex "Exim monitor" "window size"
36150 .cindex "window size"
36151 Below the stripcharts there is an action button for quitting the monitor. Next
36152 to this is another button marked &"Size"&. They are placed here so that
36153 shrinking the window to its default minimum size leaves just the queue count
36154 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36155 the window to expand to its maximum size, unless it is already at the maximum,
36156 in which case it is reduced to its minimum.
36157
36158 When expanding to the maximum, if the window cannot be fully seen where it
36159 currently is, it is moved back to where it was the last time it was at full
36160 size. When it is expanding from its minimum size, the old position is
36161 remembered, and next time it is reduced to the minimum it is moved back there.
36162
36163 The idea is that you can keep a reduced window just showing one or two
36164 stripcharts at a convenient place on your screen, easily expand it to show
36165 the full window when required, and just as easily put it back to what it was.
36166 The idea is copied from what the &'twm'& window manager does for its
36167 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36168 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36169
36170 Normally, the monitor starts up with the window at its full size, but it can be
36171 built so that it starts up with the window at its smallest size, by setting
36172 START_SMALL=yes in &_Local/eximon.conf_&.
36173
36174
36175
36176 .section "The log display" "SECID267"
36177 .cindex "log" "tail of; in monitor"
36178 The second section of the window is an area in which a display of the tail of
36179 the main log is maintained.
36180 To save space on the screen, the timestamp on each log line is shortened by
36181 removing the date and, if &%log_timezone%& is set, the timezone.
36182 The log tail is not available when the only destination for logging data is
36183 syslog, unless the syslog lines are routed to a local file whose name is passed
36184 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36185
36186 The log sub-window has a scroll bar at its lefthand side which can be used to
36187 move back to look at earlier text, and the up and down arrow keys also have a
36188 scrolling effect. The amount of log that is kept depends on the setting of
36189 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36190 to use. When this is full, the earlier 50% of data is discarded &-- this is
36191 much more efficient than throwing it away line by line. The sub-window also has
36192 a horizontal scroll bar for accessing the ends of long log lines. This is the
36193 only means of horizontal scrolling; the right and left arrow keys are not
36194 available. Text can be cut from this part of the window using the mouse in the
36195 normal way. The size of this subwindow is controlled by parameters in the
36196 configuration file &_Local/eximon.conf_&.
36197
36198 Searches of the text in the log window can be carried out by means of the ^R
36199 and ^S keystrokes, which default to a reverse and a forward search,
36200 respectively. The search covers only the text that is displayed in the window.
36201 It cannot go further back up the log.
36202
36203 The point from which the search starts is indicated by a caret marker. This is
36204 normally at the end of the text in the window, but can be positioned explicitly
36205 by pointing and clicking with the left mouse button, and is moved automatically
36206 by a successful search. If new text arrives in the window when it is scrolled
36207 back, the caret remains where it is, but if the window is not scrolled back,
36208 the caret is moved to the end of the new text.
36209
36210 Pressing ^R or ^S pops up a window into which the search text can be typed.
36211 There are buttons for selecting forward or reverse searching, for carrying out
36212 the search, and for cancelling. If the &"Search"& button is pressed, the search
36213 happens and the window remains so that further searches can be done. If the
36214 &"Return"& key is pressed, a single search is done and the window is closed. If
36215 ^C is typed the search is cancelled.
36216
36217 The searching facility is implemented using the facilities of the Athena text
36218 widget. By default this pops up a window containing both &"search"& and
36219 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36220 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36221 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36222 provided version of &%TextPop%& when the remaining parts of the text widget
36223 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36224 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36225 on these systems, at the expense of having unwanted items in the search popup
36226 window.
36227
36228
36229
36230 .section "The queue display" "SECID268"
36231 .cindex "queue" "display in monitor"
36232 The bottom section of the monitor window contains a list of all messages that
36233 are on the queue, which includes those currently being received or delivered,
36234 as well as those awaiting delivery. The size of this subwindow is controlled by
36235 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36236 at which it is updated is controlled by another parameter in the same file &--
36237 the default is 5 minutes, since queue scans can be quite expensive. However,
36238 there is an &"Update"& action button just above the display which can be used
36239 to force an update of the queue display at any time.
36240
36241 When a host is down for some time, a lot of pending mail can build up for it,
36242 and this can make it hard to deal with other messages on the queue. To help
36243 with this situation there is a button next to &"Update"& called &"Hide"&. If
36244 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36245 type anything in here and press &"Return"&, the text is added to a chain of
36246 such texts, and if every undelivered address in a message matches at least one
36247 of the texts, the message is not displayed.
36248
36249 If there is an address that does not match any of the texts, all the addresses
36250 are displayed as normal. The matching happens on the ends of addresses so, for
36251 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36252 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36253 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36254 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36255 a hide request is automatically cancelled after one hour.
36256
36257 While the dialogue box is displayed, you can't press any buttons or do anything
36258 else to the monitor window. For this reason, if you want to cut text from the
36259 queue display to use in the dialogue box, you have to do the cutting before
36260 pressing the &"Hide"& button.
36261
36262 The queue display contains, for each unhidden queued message, the length of
36263 time it has been on the queue, the size of the message, the message id, the
36264 message sender, and the first undelivered recipient, all on one line. If it is
36265 a bounce message, the sender is shown as &"<>"&. If there is more than one
36266 recipient to which the message has not yet been delivered, subsequent ones are
36267 listed on additional lines, up to a maximum configured number, following which
36268 an ellipsis is displayed. Recipients that have already received the message are
36269 not shown.
36270
36271 .cindex "frozen messages" "display"
36272 If a message is frozen, an asterisk is displayed at the left-hand side.
36273
36274 The queue display has a vertical scroll bar, and can also be scrolled by means
36275 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36276 The text searching facilities, as described above for the log window, are also
36277 available, but the caret is always moved to the end of the text when the queue
36278 display is updated.
36279
36280
36281
36282 .section "The queue menu" "SECID269"
36283 .cindex "queue" "menu in monitor"
36284 If the &%shift%& key is held down and the left button is clicked when the mouse
36285 pointer is over the text for any message, an action menu pops up, and the first
36286 line of the queue display for the message is highlighted. This does not affect
36287 any selected text.
36288
36289 If you want to use some other event for popping up the menu, you can set the
36290 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36291 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36292 value set in this parameter is a standard X event description. For example, to
36293 run eximon using &%ctrl%& rather than &%shift%& you could use
36294 .code
36295 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36296 .endd
36297 The title of the menu is the message id, and it contains entries which act as
36298 follows:
36299
36300 .ilist
36301 &'message log'&: The contents of the message log for the message are displayed
36302 in a new text window.
36303 .next
36304 &'headers'&: Information from the spool file that contains the envelope
36305 information and headers is displayed in a new text window. See chapter
36306 &<<CHAPspool>>& for a description of the format of spool files.
36307 .next
36308 &'body'&: The contents of the spool file containing the body of the message are
36309 displayed in a new text window. There is a default limit of 20,000 bytes to the
36310 amount of data displayed. This can be changed by setting the BODY_MAX
36311 option at compile time, or the EXIMON_BODY_MAX option at run time.
36312 .next
36313 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36314 delivery of the message. This causes an automatic thaw if the message is
36315 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36316 a new text window. The delivery is run in a separate process, to avoid holding
36317 up the monitor while the delivery proceeds.
36318 .next
36319 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36320 that the message be frozen.
36321 .next
36322 .cindex "thawing messages"
36323 .cindex "unfreezing messages"
36324 .cindex "frozen messages" "thawing"
36325 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36326 that the message be thawed.
36327 .next
36328 .cindex "delivery" "forcing failure"
36329 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36330 that Exim gives up trying to deliver the message. A bounce message is generated
36331 for any remaining undelivered addresses.
36332 .next
36333 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36334 that the message be deleted from the system without generating a bounce
36335 message.
36336 .next
36337 &'add recipient'&: A dialog box is displayed into which a recipient address can
36338 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36339 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36340 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36341 causes a call to Exim to be made using the &%-Mar%& option to request that an
36342 additional recipient be added to the message, unless the entry box is empty, in
36343 which case no action is taken.
36344 .next
36345 &'mark delivered'&: A dialog box is displayed into which a recipient address
36346 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36347 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36348 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36349 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36350 recipient address as already delivered, unless the entry box is empty, in which
36351 case no action is taken.
36352 .next
36353 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36354 mark all recipient addresses as already delivered.
36355 .next
36356 &'edit sender'&: A dialog box is displayed initialized with the current
36357 sender's address. Pressing RETURN causes a call to Exim to be made using the
36358 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36359 in which case no action is taken. If you want to set an empty sender (as in
36360 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36361 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36362 the address is qualified with that domain.
36363 .endlist
36364
36365 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36366 other cases when a call to Exim is made, if there is any output from Exim (in
36367 particular, if the command fails) a window containing the command and the
36368 output is displayed. Otherwise, the results of the action are normally apparent
36369 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36370 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36371 if no output is generated.
36372
36373 The queue display is automatically updated for actions such as freezing and
36374 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36375 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36376 force an update of the display after one of these actions.
36377
36378 In any text window that is displayed as result of a menu action, the normal
36379 cut-and-paste facility is available, and searching can be carried out using ^R
36380 and ^S, as described above for the log tail window.
36381 .ecindex IIDeximon
36382
36383
36384
36385
36386
36387 . ////////////////////////////////////////////////////////////////////////////
36388 . ////////////////////////////////////////////////////////////////////////////
36389
36390 .chapter "Security considerations" "CHAPsecurity"
36391 .scindex IIDsecurcon "security" "discussion of"
36392 This chapter discusses a number of issues concerned with security, some of
36393 which are also covered in other parts of this manual.
36394
36395 For reasons that this author does not understand, some people have promoted
36396 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36397 existence of this chapter in the documentation. However, the intent of the
36398 chapter is simply to describe the way Exim works in relation to certain
36399 security concerns, not to make any specific claims about the effectiveness of
36400 its security as compared with other MTAs.
36401
36402 What follows is a description of the way Exim is supposed to be. Best efforts
36403 have been made to try to ensure that the code agrees with the theory, but an
36404 absence of bugs can never be guaranteed. Any that are reported will get fixed
36405 as soon as possible.
36406
36407
36408 .section "Building a more &""hardened""& Exim" "SECID286"
36409 .cindex "security" "build-time features"
36410 There are a number of build-time options that can be set in &_Local/Makefile_&
36411 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36412 Exim administrator who does not have the root password, or by someone who has
36413 penetrated the Exim (but not the root) account. These options are as follows:
36414
36415 .ilist
36416 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36417 start of any file names used with the &%-C%& option. When it is set, these file
36418 names are also not allowed to contain the sequence &"/../"&. (However, if the
36419 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36420 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36421 default setting for &%ALT_CONFIG_PREFIX%&.
36422
36423 If the permitted configuration files are confined to a directory to
36424 which only root has access, this guards against someone who has broken
36425 into the Exim account from running a privileged Exim with an arbitrary
36426 configuration file, and using it to break into other accounts.
36427 .next
36428
36429 If a non-trusted configuration file (i.e. not the default configuration file
36430 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36431 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36432 the next item), then root privilege is retained only if the caller of Exim is
36433 root. This locks out the possibility of testing a configuration using &%-C%&
36434 right through message reception and delivery, even if the caller is root. The
36435 reception works, but by that time, Exim is running as the Exim user, so when
36436 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36437 privilege to be lost. However, root can test reception and delivery using two
36438 separate commands.
36439
36440 .next
36441 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36442 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36443 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36444 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36445 the restrictive side.  Requiring build-time selection of safe macros is onerous
36446 but this option is intended solely as a transition mechanism to permit
36447 previously-working configurations to continue to work after release 4.73.
36448 .next
36449 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36450 is disabled.
36451 .next
36452 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36453 never to be used for any deliveries. This is like the &%never_users%& runtime
36454 option, but it cannot be overridden; the runtime option adds additional users
36455 to the list. The default setting is &"root"&; this prevents a non-root user who
36456 is permitted to modify the runtime file from using Exim as a way to get root.
36457 .endlist
36458
36459
36460
36461 .section "Root privilege" "SECID270"
36462 .cindex "setuid"
36463 .cindex "root privilege"
36464 The Exim binary is normally setuid to root, which means that it gains root
36465 privilege (runs as root) when it starts execution. In some special cases (for
36466 example, when the daemon is not in use and there are no local deliveries), it
36467 may be possible to run Exim setuid to some user other than root. This is
36468 discussed in the next section. However, in most installations, root privilege
36469 is required for two things:
36470
36471 .ilist
36472 To set up a socket connected to the standard SMTP port (25) when initialising
36473 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36474 not required.
36475 .next
36476 To be able to change uid and gid in order to read users' &_.forward_& files and
36477 perform local deliveries as the receiving user or as specified in the
36478 configuration.
36479 .endlist
36480
36481 It is not necessary to be root to do any of the other things Exim does, such as
36482 receiving messages and delivering them externally over SMTP, and it is
36483 obviously more secure if Exim does not run as root except when necessary.
36484 For this reason, a user and group for Exim to use must be defined in
36485 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36486 group"&. Their values can be changed by the run time configuration, though this
36487 is not recommended. Often a user called &'exim'& is used, but some sites use
36488 &'mail'& or another user name altogether.
36489
36490 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36491 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36492 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36493
36494 After a new Exim process has interpreted its command line options, it changes
36495 uid and gid in the following cases:
36496
36497 .ilist
36498 .oindex "&%-C%&"
36499 .oindex "&%-D%&"
36500 If the &%-C%& option is used to specify an alternate configuration file, or if
36501 the &%-D%& option is used to define macro values for the configuration, and the
36502 calling process is not running as root, the uid and gid are changed to those of
36503 the calling process.
36504 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36505 option may not be used at all.
36506 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36507 can be supplied if the calling process is running as root, the Exim run-time
36508 user or CONFIGURE_OWNER, if defined.
36509 .next
36510 .oindex "&%-be%&"
36511 .oindex "&%-bf%&"
36512 .oindex "&%-bF%&"
36513 If the expansion test option (&%-be%&) or one of the filter testing options
36514 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36515 calling process.
36516 .next
36517 If the process is not a daemon process or a queue runner process or a delivery
36518 process or a process for testing address routing (started with &%-bt%&), the
36519 uid and gid are changed to the Exim user and group. This means that Exim always
36520 runs under its own uid and gid when receiving messages. This also applies when
36521 testing address verification
36522 .oindex "&%-bv%&"
36523 .oindex "&%-bh%&"
36524 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36525 option).
36526 .next
36527 For a daemon, queue runner, delivery, or address testing process, the uid
36528 remains as root at this stage, but the gid is changed to the Exim group.
36529 .endlist
36530
36531 The processes that initially retain root privilege behave as follows:
36532
36533 .ilist
36534 A daemon process changes the gid to the Exim group and the uid to the Exim
36535 user after setting up one or more listening sockets. The &[initgroups()]&
36536 function is called, so that if the Exim user is in any additional groups, they
36537 will be used during message reception.
36538 .next
36539 A queue runner process retains root privilege throughout its execution. Its
36540 job is to fork a controlled sequence of delivery processes.
36541 .next
36542 A delivery process retains root privilege throughout most of its execution,
36543 but any actual deliveries (that is, the transports themselves) are run in
36544 subprocesses which always change to a non-root uid and gid. For local
36545 deliveries this is typically the uid and gid of the owner of the mailbox; for
36546 remote deliveries, the Exim uid and gid are used. Once all the delivery
36547 subprocesses have been run, a delivery process changes to the Exim uid and gid
36548 while doing post-delivery tidying up such as updating the retry database and
36549 generating bounce and warning messages.
36550
36551 While the recipient addresses in a message are being routed, the delivery
36552 process runs as root. However, if a user's filter file has to be processed,
36553 this is done in a subprocess that runs under the individual user's uid and
36554 gid. A system filter is run as root unless &%system_filter_user%& is set.
36555 .next
36556 A process that is testing addresses (the &%-bt%& option) runs as root so that
36557 the routing is done in the same environment as a message delivery.
36558 .endlist
36559
36560
36561
36562
36563 .section "Running Exim without privilege" "SECTrunexiwitpri"
36564 .cindex "privilege, running without"
36565 .cindex "unprivileged running"
36566 .cindex "root privilege" "running without"
36567 Some installations like to run Exim in an unprivileged state for more of its
36568 operation, for added security. Support for this mode of operation is provided
36569 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36570 gid are changed to the Exim user and group at the start of a delivery process
36571 (and also queue runner and address testing processes). This means that address
36572 routing is no longer run as root, and the deliveries themselves cannot change
36573 to any other uid.
36574
36575 .cindex SIGHUP
36576 .cindex "daemon" "restarting"
36577 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36578 that the daemon can still be started in the usual way, and it can respond
36579 correctly to SIGHUP because the re-invocation regains root privilege.
36580
36581 An alternative approach is to make Exim setuid to the Exim user and also setgid
36582 to the Exim group. If you do this, the daemon must be started from a root
36583 process. (Calling Exim from a root process makes it behave in the way it does
36584 when it is setuid root.) However, the daemon cannot restart itself after a
36585 SIGHUP signal because it cannot regain privilege.
36586
36587 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36588 stops Exim from trying to re-invoke itself to do a delivery after a message has
36589 been received. Such a re-invocation is a waste of resources because it has no
36590 effect.
36591
36592 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36593 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36594 to the Exim user seems a clean approach, but there is one complication:
36595
36596 In this style of operation, Exim is running with the real uid and gid set to
36597 those of the calling process, and the effective uid/gid set to Exim's values.
36598 Ideally, any association with the calling process' uid/gid should be dropped,
36599 that is, the real uid/gid should be reset to the effective values so as to
36600 discard any privileges that the caller may have. While some operating systems
36601 have a function that permits this action for a non-root effective uid, quite a
36602 number of them do not. Because of this lack of standardization, Exim does not
36603 address this problem at this time.
36604
36605 For this reason, the recommended approach for &"mostly unprivileged"& running
36606 is to keep the Exim binary setuid to root, and to set
36607 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36608 be used in the most straightforward way.
36609
36610 If you configure Exim not to run delivery processes as root, there are a
36611 number of restrictions on what you can do:
36612
36613 .ilist
36614 You can deliver only as the Exim user/group. You should  explicitly use the
36615 &%user%& and &%group%& options to override routers or local transports that
36616 normally deliver as the recipient. This makes sure that configurations that
36617 work in this mode function the same way in normal mode. Any implicit or
36618 explicit specification of another user causes an error.
36619 .next
36620 Use of &_.forward_& files is severely restricted, such that it is usually
36621 not worthwhile to include them in the configuration.
36622 .next
36623 Users who wish to use &_.forward_& would have to make their home directory and
36624 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36625 and their equivalents in Exim filters, cannot be used. While they could be
36626 enabled in the Exim user's name, that would be insecure and not very useful.
36627 .next
36628 Unless the local user mailboxes are all owned by the Exim user (possible in
36629 some POP3 or IMAP-only environments):
36630
36631 .olist
36632 They must be owned by the Exim group and be writeable by that group. This
36633 implies you must set &%mode%& in the appendfile configuration, as well as the
36634 mode of the mailbox files themselves.
36635 .next
36636 You must set &%no_check_owner%&, since most or all of the files will not be
36637 owned by the Exim user.
36638 .next
36639 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
36640 on a newly created mailbox when unprivileged. This also implies that new
36641 mailboxes need to be created manually.
36642 .endlist olist
36643 .endlist ilist
36644
36645
36646 These restrictions severely restrict what can be done in local deliveries.
36647 However, there are no restrictions on remote deliveries. If you are running a
36648 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
36649 gives more security at essentially no cost.
36650
36651 If you are using the &%mua_wrapper%& facility (see chapter
36652 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
36653
36654
36655
36656
36657 .section "Delivering to local files" "SECID271"
36658 Full details of the checks applied by &(appendfile)& before it writes to a file
36659 are given in chapter &<<CHAPappendfile>>&.
36660
36661
36662
36663 .section "Running local commands" "SECTsecconslocalcmds"
36664 .cindex "security" "local commands"
36665 .cindex "security" "command injection attacks"
36666 There are a number of ways in which an administrator can configure Exim to run
36667 commands based upon received, untrustworthy, data. Further, in some
36668 configurations a user who can control a &_.forward_& file can also arrange to
36669 run commands. Configuration to check includes, but is not limited to:
36670
36671 .ilist
36672 Use of &%use_shell%& in the pipe transport: various forms of shell command
36673 injection may be possible with this option present. It is dangerous and should
36674 be used only with considerable caution. Consider constraints which whitelist
36675 allowed characters in a variable which is to be used in a pipe transport that
36676 has &%use_shell%& enabled.
36677 .next
36678 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
36679 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
36680 &_.forward_& files in a redirect router. If Exim is running on a central mail
36681 hub to which ordinary users do not have shell access, but home directories are
36682 NFS mounted (for instance) then administrators should review the list of these
36683 forbid options available, and should bear in mind that the options that may
36684 need forbidding can change as new features are added between releases.
36685 .next
36686 The &%${run...}%& expansion item does not use a shell by default, but
36687 administrators can configure use of &_/bin/sh_& as part of the command.
36688 Such invocations should be viewed with prejudicial suspicion.
36689 .next
36690 Administrators who use embedded Perl are advised to explore how Perl's
36691 taint checking might apply to their usage.
36692 .next
36693 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
36694 administrators are well advised to view its use with suspicion, in case (for
36695 instance) it allows a local-part to contain embedded Exim directives.
36696 .next
36697 Use of &%${match_local_part...}%& and friends becomes more dangerous if
36698 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
36699 each can reference arbitrary lists and files, rather than just being a list
36700 of opaque strings.
36701 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
36702 real-world security vulnerabilities caused by its use with untrustworthy data
36703 injected in, for SQL injection attacks.
36704 Consider the use of the &%inlisti%& expansion condition instead.
36705 .endlist
36706
36707
36708
36709
36710 .section "Trust in configuration data" "SECTsecconfdata"
36711 .cindex "security" "data sources"
36712 .cindex "security" "regular expressions"
36713 .cindex "regular expressions" "security"
36714 .cindex "PCRE" "security"
36715 If configuration data for Exim can come from untrustworthy sources, there
36716 are some issues to be aware of:
36717
36718 .ilist
36719 Use of &%${expand...}%& may provide a path for shell injection attacks.
36720 .next
36721 Letting untrusted data provide a regular expression is unwise.
36722 .next
36723 Using &%${match...}%& to apply a fixed regular expression against untrusted
36724 data may result in pathological behaviour within PCRE.  Be aware of what
36725 "backtracking" means and consider options for being more strict with a regular
36726 expression. Avenues to explore include limiting what can match (avoiding &`.`&
36727 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
36728 possessive quantifiers or just not using regular expressions against untrusted
36729 data.
36730 .next
36731 It can be important to correctly use &%${quote:...}%&,
36732 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
36733 items to ensure that data is correctly constructed.
36734 .next
36735 Some lookups might return multiple results, even though normal usage is only
36736 expected to yield one result.
36737 .endlist
36738
36739
36740
36741
36742 .section "IPv4 source routing" "SECID272"
36743 .cindex "source routing" "in IP packets"
36744 .cindex "IP source routing"
36745 Many operating systems suppress IP source-routed packets in the kernel, but
36746 some cannot be made to do this, so Exim does its own check. It logs incoming
36747 IPv4 source-routed TCP calls, and then drops them. Things are all different in
36748 IPv6. No special checking is currently done.
36749
36750
36751
36752 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
36753 Support for these SMTP commands is disabled by default. If required, they can
36754 be enabled by defining suitable ACLs.
36755
36756
36757
36758
36759 .section "Privileged users" "SECID274"
36760 .cindex "trusted users"
36761 .cindex "admin user"
36762 .cindex "privileged user"
36763 .cindex "user" "trusted"
36764 .cindex "user" "admin"
36765 Exim recognizes two sets of users with special privileges. Trusted users are
36766 able to submit new messages to Exim locally, but supply their own sender
36767 addresses and information about a sending host. For other users submitting
36768 local messages, Exim sets up the sender address from the uid, and doesn't
36769 permit a remote host to be specified.
36770
36771 .oindex "&%-f%&"
36772 However, an untrusted user is permitted to use the &%-f%& command line option
36773 in the special form &%-f <>%& to indicate that a delivery failure for the
36774 message should not cause an error report. This affects the message's envelope,
36775 but it does not affect the &'Sender:'& header. Untrusted users may also be
36776 permitted to use specific forms of address with the &%-f%& option by setting
36777 the &%untrusted_set_sender%& option.
36778
36779 Trusted users are used to run processes that receive mail messages from some
36780 other mail domain and pass them on to Exim for delivery either locally, or over
36781 the Internet. Exim trusts a caller that is running as root, as the Exim user,
36782 as any user listed in the &%trusted_users%& configuration option, or under any
36783 group listed in the &%trusted_groups%& option.
36784
36785 Admin users are permitted to do things to the messages on Exim's queue. They
36786 can freeze or thaw messages, cause them to be returned to their senders, remove
36787 them entirely, or modify them in various ways. In addition, admin users can run
36788 the Exim monitor and see all the information it is capable of providing, which
36789 includes the contents of files on the spool.
36790
36791 .oindex "&%-M%&"
36792 .oindex "&%-q%&"
36793 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
36794 delivery of messages on its queue is restricted to admin users. This
36795 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
36796 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
36797 queue is also restricted to admin users. This restriction can be relaxed by
36798 setting &%no_queue_list_requires_admin%&.
36799
36800 Exim recognizes an admin user if the calling process is running as root or as
36801 the Exim user or if any of the groups associated with the calling process is
36802 the Exim group. It is not necessary actually to be running under the Exim
36803 group. However, if admin users who are not root or the Exim user are to access
36804 the contents of files on the spool via the Exim monitor (which runs
36805 unprivileged), Exim must be built to allow group read access to its spool
36806 files.
36807
36808
36809
36810 .section "Spool files" "SECID275"
36811 .cindex "spool directory" "files"
36812 Exim's spool directory and everything it contains is owned by the Exim user and
36813 set to the Exim group. The mode for spool files is defined in the
36814 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
36815 any user who is a member of the Exim group can access these files.
36816
36817
36818
36819 .section "Use of argv[0]" "SECID276"
36820 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
36821 of specific strings, Exim assumes certain options. For example, calling Exim
36822 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
36823 to calling it with the option &%-bS%&. There are no security implications in
36824 this.
36825
36826
36827
36828 .section "Use of %f formatting" "SECID277"
36829 The only use made of &"%f"& by Exim is in formatting load average values. These
36830 are actually stored in integer variables as 1000 times the load average.
36831 Consequently, their range is limited and so therefore is the length of the
36832 converted output.
36833
36834
36835
36836 .section "Embedded Exim path" "SECID278"
36837 Exim uses its own path name, which is embedded in the code, only when it needs
36838 to re-exec in order to regain root privilege. Therefore, it is not root when it
36839 does so. If some bug allowed the path to get overwritten, it would lead to an
36840 arbitrary program's being run as exim, not as root.
36841
36842
36843
36844 .section "Dynamic module directory" "SECTdynmoddir"
36845 Any dynamically loadable modules must be installed into the directory
36846 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
36847 loading it.
36848
36849
36850 .section "Use of sprintf()" "SECID279"
36851 .cindex "&[sprintf()]&"
36852 A large number of occurrences of &"sprintf"& in the code are actually calls to
36853 &'string_sprintf()'&, a function that returns the result in malloc'd store.
36854 The intermediate formatting is done into a large fixed buffer by a function
36855 that runs through the format string itself, and checks the length of each
36856 conversion before performing it, thus preventing buffer overruns.
36857
36858 The remaining uses of &[sprintf()]& happen in controlled circumstances where
36859 the output buffer is known to be sufficiently long to contain the converted
36860 string.
36861
36862
36863
36864 .section "Use of debug_printf() and log_write()" "SECID280"
36865 Arbitrary strings are passed to both these functions, but they do their
36866 formatting by calling the function &'string_vformat()'&, which runs through
36867 the format string itself, and checks the length of each conversion.
36868
36869
36870
36871 .section "Use of strcat() and strcpy()" "SECID281"
36872 These are used only in cases where the output buffer is known to be large
36873 enough to hold the result.
36874 .ecindex IIDsecurcon
36875
36876
36877
36878
36879 . ////////////////////////////////////////////////////////////////////////////
36880 . ////////////////////////////////////////////////////////////////////////////
36881
36882 .chapter "Format of spool files" "CHAPspool"
36883 .scindex IIDforspo1 "format" "spool files"
36884 .scindex IIDforspo2 "spool directory" "format of files"
36885 .scindex IIDforspo3 "spool files" "format of"
36886 .cindex "spool files" "editing"
36887 A message on Exim's queue consists of two files, whose names are the message id
36888 followed by -D and -H, respectively. The data portion of the message is kept in
36889 the -D file on its own. The message's envelope, status, and headers are all
36890 kept in the -H file, whose format is described in this chapter. Each of these
36891 two files contains the final component of its own name as its first line. This
36892 is insurance against disk crashes where the directory is lost but the files
36893 themselves are recoverable.
36894
36895 Some people are tempted into editing -D files in order to modify messages. You
36896 need to be extremely careful if you do this; it is not recommended and you are
36897 on your own if you do it. Here are some of the pitfalls:
36898
36899 .ilist
36900 You must ensure that Exim does not try to deliver the message while you are
36901 fiddling with it. The safest way is to take out a write lock on the -D file,
36902 which is what Exim itself does, using &[fcntl()]&. If you update the file in
36903 place, the lock will be retained. If you write a new file and rename it, the
36904 lock will be lost at the instant of rename.
36905 .next
36906 .vindex "&$body_linecount$&"
36907 If you change the number of lines in the file, the value of
36908 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
36909 present, this value is not used by Exim, but there is no guarantee that this
36910 will always be the case.
36911 .next
36912 If the message is in MIME format, you must take care not to break it.
36913 .next
36914 If the message is cryptographically signed, any change will invalidate the
36915 signature.
36916 .endlist
36917 All in all, modifying -D files is fraught with danger.
36918
36919 Files whose names end with -J may also be seen in the &_input_& directory (or
36920 its subdirectories when &%split_spool_directory%& is set). These are journal
36921 files, used to record addresses to which the message has been delivered during
36922 the course of a delivery attempt. If there are still undelivered recipients at
36923 the end, the -H file is updated, and the -J file is deleted. If, however, there
36924 is some kind of crash (for example, a power outage) before this happens, the -J
36925 file remains in existence. When Exim next processes the message, it notices the
36926 -J file and uses it to update the -H file before starting the next delivery
36927 attempt.
36928
36929 .section "Format of the -H file" "SECID282"
36930 .cindex "uid (user id)" "in spool file"
36931 .cindex "gid (group id)" "in spool file"
36932 The second line of the -H file contains the login name for the uid of the
36933 process that called Exim to read the message, followed by the numerical uid and
36934 gid. For a locally generated message, this is normally the user who sent the
36935 message. For a message received over TCP/IP via the daemon, it is
36936 normally the Exim user.
36937
36938 The third line of the file contains the address of the message's sender as
36939 transmitted in the envelope, contained in angle brackets. The sender address is
36940 empty for bounce messages. For incoming SMTP mail, the sender address is given
36941 in the MAIL command. For locally generated mail, the sender address is
36942 created by Exim from the login name of the current user and the configured
36943 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
36944 leading &"From&~"& line if the caller is trusted, or if the supplied address is
36945 &"<>"& or an address that matches &%untrusted_set_senders%&.
36946
36947 The fourth line contains two numbers. The first is the time that the message
36948 was received, in the conventional Unix form &-- the number of seconds since the
36949 start of the epoch. The second number is a count of the number of messages
36950 warning of delayed delivery that have been sent to the sender.
36951
36952 There follow a number of lines starting with a hyphen. These can appear in any
36953 order, and are omitted when not relevant:
36954
36955 .vlist
36956 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
36957 This item is obsolete, and is not generated from Exim release 4.61 onwards;
36958 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
36959 recognized, to provide backward compatibility. In the old format, a line of
36960 this form is present for every ACL variable that is not empty. The number
36961 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
36962 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
36963 the data string for the variable. The string itself starts at the beginning of
36964 the next line, and is followed by a newline character. It may contain internal
36965 newlines.
36966
36967 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
36968 A line of this form is present for every ACL connection variable that is
36969 defined. Note that there is a space between &%-aclc%& and the rest of the name.
36970 The length is the length of the data string for the variable. The string itself
36971 starts at the beginning of the next line, and is followed by a newline
36972 character. It may contain internal newlines.
36973
36974 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
36975 A line of this form is present for every ACL message variable that is defined.
36976 Note that there is a space between &%-aclm%& and the rest of the name. The
36977 length is the length of the data string for the variable. The string itself
36978 starts at the beginning of the next line, and is followed by a newline
36979 character. It may contain internal newlines.
36980
36981 .vitem "&%-active_hostname%&&~<&'hostname'&>"
36982 This is present if, when the message was received over SMTP, the value of
36983 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
36984
36985 .vitem &%-allow_unqualified_recipient%&
36986 This is present if unqualified recipient addresses are permitted in header
36987 lines (to stop such addresses from being qualified if rewriting occurs at
36988 transport time). Local messages that were input using &%-bnq%& and remote
36989 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
36990
36991 .vitem &%-allow_unqualified_sender%&
36992 This is present if unqualified sender addresses are permitted in header lines
36993 (to stop such addresses from being qualified if rewriting occurs at transport
36994 time). Local messages that were input using &%-bnq%& and remote messages from
36995 hosts that match &%sender_unqualified_hosts%& set this flag.
36996
36997 .vitem "&%-auth_id%&&~<&'text'&>"
36998 The id information for a message received on an authenticated SMTP connection
36999 &-- the value of the &$authenticated_id$& variable.
37000
37001 .vitem "&%-auth_sender%&&~<&'address'&>"
37002 The address of an authenticated sender &-- the value of the
37003 &$authenticated_sender$& variable.
37004
37005 .vitem "&%-body_linecount%&&~<&'number'&>"
37006 This records the number of lines in the body of the message, and is always
37007 present.
37008
37009 .vitem "&%-body_zerocount%&&~<&'number'&>"
37010 This records the number of binary zero bytes in the body of the message, and is
37011 present if the number is greater than zero.
37012
37013 .vitem &%-deliver_firsttime%&
37014 This is written when a new message is first added to the spool. When the spool
37015 file is updated after a deferral, it is omitted.
37016
37017 .vitem "&%-frozen%&&~<&'time'&>"
37018 .cindex "frozen messages" "spool data"
37019 The message is frozen, and the freezing happened at <&'time'&>.
37020
37021 .vitem "&%-helo_name%&&~<&'text'&>"
37022 This records the host name as specified by a remote host in a HELO or EHLO
37023 command.
37024
37025 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37026 This records the IP address of the host from which the message was received and
37027 the remote port number that was used. It is omitted for locally generated
37028 messages.
37029
37030 .vitem "&%-host_auth%&&~<&'text'&>"
37031 If the message was received on an authenticated SMTP connection, this records
37032 the name of the authenticator &-- the value of the
37033 &$sender_host_authenticated$& variable.
37034
37035 .vitem &%-host_lookup_failed%&
37036 This is present if an attempt to look up the sending host's name from its IP
37037 address failed. It corresponds to the &$host_lookup_failed$& variable.
37038
37039 .vitem "&%-host_name%&&~<&'text'&>"
37040 .cindex "reverse DNS lookup"
37041 .cindex "DNS" "reverse lookup"
37042 This records the name of the remote host from which the message was received,
37043 if the host name was looked up from the IP address when the message was being
37044 received. It is not present if no reverse lookup was done.
37045
37046 .vitem "&%-ident%&&~<&'text'&>"
37047 For locally submitted messages, this records the login of the originating user,
37048 unless it was a trusted user and the &%-oMt%& option was used to specify an
37049 ident value. For messages received over TCP/IP, this records the ident string
37050 supplied by the remote host, if any.
37051
37052 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37053 This records the IP address of the local interface and the port number through
37054 which a message was received from a remote host. It is omitted for locally
37055 generated messages.
37056
37057 .vitem &%-local%&
37058 The message is from a local sender.
37059
37060 .vitem &%-localerror%&
37061 The message is a locally-generated bounce message.
37062
37063 .vitem "&%-local_scan%&&~<&'string'&>"
37064 This records the data string that was returned by the &[local_scan()]& function
37065 when the message was received &-- the value of the &$local_scan_data$&
37066 variable. It is omitted if no data was returned.
37067
37068 .vitem &%-manual_thaw%&
37069 The message was frozen but has been thawed manually, that is, by an explicit
37070 Exim command rather than via the auto-thaw process.
37071
37072 .vitem &%-N%&
37073 A testing delivery process was started using the &%-N%& option to suppress any
37074 actual deliveries, but delivery was deferred. At any further delivery attempts,
37075 &%-N%& is assumed.
37076
37077 .vitem &%-received_protocol%&
37078 This records the value of the &$received_protocol$& variable, which contains
37079 the name of the protocol by which the message was received.
37080
37081 .vitem &%-sender_set_untrusted%&
37082 The envelope sender of this message was set by an untrusted local caller (used
37083 to ensure that the caller is displayed in queue listings).
37084
37085 .vitem "&%-spam_score_int%&&~<&'number'&>"
37086 If a message was scanned by SpamAssassin, this is present. It records the value
37087 of &$spam_score_int$&.
37088
37089 .vitem &%-tls_certificate_verified%&
37090 A TLS certificate was received from the client that sent this message, and the
37091 certificate was verified by the server.
37092
37093 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37094 When the message was received over an encrypted connection, this records the
37095 name of the cipher suite that was used.
37096
37097 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37098 When the message was received over an encrypted connection, and a certificate
37099 was received from the client, this records the Distinguished Name from that
37100 certificate.
37101 .endlist
37102
37103 Following the options there is a list of those addresses to which the message
37104 is not to be delivered. This set of addresses is initialized from the command
37105 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37106 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37107 the address is added to this set. The addresses are kept internally as a
37108 balanced binary tree, and it is a representation of that tree which is written
37109 to the spool file. If an address is expanded via an alias or forward file, the
37110 original address is added to the tree when deliveries to all its child
37111 addresses are complete.
37112
37113 If the tree is empty, there is a single line in the spool file containing just
37114 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37115 Y or N, followed by an address. The address is the value for the node of the
37116 tree, and the letters indicate whether the node has a left branch and/or a
37117 right branch attached to it, respectively. If branches exist, they immediately
37118 follow. Here is an example of a three-node tree:
37119 .code
37120 YY darcy@austen.fict.example
37121 NN alice@wonderland.fict.example
37122 NN editor@thesaurus.ref.example
37123 .endd
37124 After the non-recipients tree, there is a list of the message's recipients.
37125 This is a simple list, preceded by a count. It includes all the original
37126 recipients of the message, including those to whom the message has already been
37127 delivered. In the simplest case, the list contains one address per line. For
37128 example:
37129 .code
37130 4
37131 editor@thesaurus.ref.example
37132 darcy@austen.fict.example
37133 rdo@foundation
37134 alice@wonderland.fict.example
37135 .endd
37136 However, when a child address has been added to the top-level addresses as a
37137 result of the use of the &%one_time%& option on a &(redirect)& router, each
37138 line is of the following form:
37139 .display
37140 <&'top-level address'&> <&'errors_to address'&> &&&
37141   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37142 .endd
37143 The 01 flag bit indicates the presence of the three other fields that follow
37144 the top-level address. Other bits may be used in future to support additional
37145 fields. The <&'parent number'&> is the offset in the recipients list of the
37146 original parent of the &"one time"& address. The first two fields are the
37147 envelope sender that is associated with this address and its length. If the
37148 length is zero, there is no special envelope sender (there are then two space
37149 characters in the line). A non-empty field can arise from a &(redirect)& router
37150 that has an &%errors_to%& setting.
37151
37152
37153 A blank line separates the envelope and status information from the headers
37154 which follow. A header may occupy several lines of the file, and to save effort
37155 when reading it in, each header is preceded by a number and an identifying
37156 character. The number is the number of characters in the header, including any
37157 embedded newlines and the terminating newline. The character is one of the
37158 following:
37159
37160 .table2 50pt
37161 .row <&'blank'&>         "header in which Exim has no special interest"
37162 .row &`B`&               "&'Bcc:'& header"
37163 .row &`C`&               "&'Cc:'& header"
37164 .row &`F`&               "&'From:'& header"
37165 .row &`I`&               "&'Message-id:'& header"
37166 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37167 .row &`R`&               "&'Reply-To:'& header"
37168 .row &`S`&               "&'Sender:'& header"
37169 .row &`T`&               "&'To:'& header"
37170 .row &`*`&               "replaced or deleted header"
37171 .endtable
37172
37173 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37174 purposes. They are not transmitted when the message is delivered. Here is a
37175 typical set of headers:
37176 .code
37177 111P Received: by hobbit.fict.example with local (Exim 4.00)
37178 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37179 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37180 038* X-rewrote-sender: bb@hobbit.fict.example
37181 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37182 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37183 099* To: alice@wonderland.fict.example, rdo@foundation,
37184 darcy@austen.fict.example, editor@thesaurus.ref.example
37185 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37186 darcy@austen.fict.example, editor@thesaurus.ref.example
37187 038  Date: Fri, 11 May 2001 10:28:59 +0100
37188 .endd
37189 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37190 &'To:'& header have been rewritten, the last one because routing expanded the
37191 unqualified domain &'foundation'&.
37192 .ecindex IIDforspo1
37193 .ecindex IIDforspo2
37194 .ecindex IIDforspo3
37195
37196 . ////////////////////////////////////////////////////////////////////////////
37197 . ////////////////////////////////////////////////////////////////////////////
37198
37199 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37200          "DKIM Support"
37201 .cindex "DKIM"
37202
37203 DKIM is a mechanism by which messages sent by some entity can be provably
37204 linked to a domain which that entity controls.  It permits reputation to
37205 be tracked on a per-domain basis, rather than merely upon source IP address.
37206 DKIM is documented in RFC 4871.
37207
37208 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37209 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37210
37211 Exim's DKIM implementation allows to
37212 .olist
37213 Sign outgoing messages: This function is implemented in the SMTP transport.
37214 It can co-exist with all other Exim features
37215 (including transport filters)
37216 except cutthrough delivery.
37217 .next
37218 Verify signatures in incoming messages: This is implemented by an additional
37219 ACL (acl_smtp_dkim), which can be called several times per message, with
37220 different signature contexts.
37221 .endlist
37222
37223 In typical Exim style, the verification implementation does not include any
37224 default "policy". Instead it enables you to build your own policy using
37225 Exim's standard controls.
37226
37227 Please note that verification of DKIM signatures in incoming mail is turned
37228 on by default for logging purposes. For each signature in incoming email,
37229 exim will log a line displaying the most important signature details, and the
37230 signature status. Here is an example (with line-breaks added for clarity):
37231 .code
37232 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37233     d=facebookmail.com s=q1-2009b
37234     c=relaxed/relaxed a=rsa-sha1
37235     i=@facebookmail.com t=1252484542 [verification succeeded]
37236 .endd
37237 You might want to turn off DKIM verification processing entirely for internal
37238 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37239 control modifier. This should typically be done in the RCPT ACL, at points
37240 where you accept mail from relay sources (internal hosts or authenticated
37241 senders).
37242
37243
37244 .section "Signing outgoing messages" "SECID513"
37245 .cindex "DKIM" "signing"
37246
37247 Signing is implemented by setting private options on the SMTP transport.
37248 These options take (expandable) strings as arguments.
37249
37250 .option dkim_domain smtp string&!! unset
37251 MANDATORY:
37252 The domain you want to sign with. The result of this expanded
37253 option is put into the &%$dkim_domain%& expansion variable.
37254
37255 .option dkim_selector smtp string&!! unset
37256 MANDATORY:
37257 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37258 variable to look up a matching selector. The result is put in the expansion
37259 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37260 option along with &%$dkim_domain%&.
37261
37262 .option dkim_private_key smtp string&!! unset
37263 MANDATORY:
37264 This sets the private key to use. You can use the &%$dkim_domain%& and
37265 &%$dkim_selector%& expansion variables to determine the private key to use.
37266 The result can either
37267 .ilist
37268 be a valid RSA private key in ASCII armor, including line breaks.
37269 .next
37270 start with a slash, in which case it is treated as a file that contains
37271 the private key.
37272 .next
37273 be "0", "false" or the empty string, in which case the message will not
37274 be signed. This case will not result in an error, even if &%dkim_strict%&
37275 is set.
37276 .endlist
37277
37278 .option dkim_canon smtp string&!! unset
37279 OPTIONAL:
37280 This option sets the canonicalization method used when signing a message.
37281 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37282 The option defaults to "relaxed" when unset. Note: the current implementation
37283 only supports using the same canonicalization method for both headers and body.
37284
37285 .option dkim_strict smtp string&!! unset
37286 OPTIONAL:
37287 This  option  defines  how  Exim  behaves  when  signing a message that
37288 should be signed fails for some reason.  When the expansion evaluates to
37289 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37290 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37291 variables here.
37292
37293 .option dkim_sign_headers smtp string&!! unset
37294 OPTIONAL:
37295 When set, this option must expand to (or be specified as) a colon-separated
37296 list of header names. Headers with these names will be included in the message
37297 signature. When unspecified, the header names recommended in RFC4871 will be
37298 used.
37299
37300
37301 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37302 .cindex "DKIM" "verification"
37303
37304 Verification of DKIM signatures in incoming email is implemented via the
37305 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37306 syntactically(!) correct signature in the incoming message.
37307 A missing ACL definition defaults to accept.
37308 If any ACL call does not acccept, the message is not accepted.
37309 If a cutthrough delivery was in progress for the message it is
37310 summarily dropped (having wasted the transmission effort).
37311
37312 To evaluate the signature in the ACL a large number of expansion variables
37313 containing the signature status and its details are set up during the
37314 runtime of the ACL.
37315
37316 Calling the ACL only for existing signatures is not sufficient to build
37317 more advanced policies. For that reason, the global option
37318 &%dkim_verify_signers%&, and a global expansion variable
37319 &%$dkim_signers%& exist.
37320
37321 The global option &%dkim_verify_signers%& can be set to a colon-separated
37322 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37323 called. It is expanded when the message has been received. At this point,
37324 the expansion variable &%$dkim_signers%& already contains a colon-separated
37325 list of signer domains and identities for the message. When
37326 &%dkim_verify_signers%& is not specified in the main configuration,
37327 it defaults as:
37328 .code
37329 dkim_verify_signers = $dkim_signers
37330 .endd
37331 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37332 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37333 call the ACL for known domains or identities. This would be achieved as follows:
37334 .code
37335 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37336 .endd
37337 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37338 and "ebay.com", plus all domains and identities that have signatures in the message.
37339 You can also be more creative in constructing your policy. For example:
37340 .code
37341 dkim_verify_signers = $sender_address_domain:$dkim_signers
37342 .endd
37343
37344 If a domain or identity is listed several times in the (expanded) value of
37345 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37346
37347
37348 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37349 available (from most to least important):
37350
37351
37352 .vlist
37353 .vitem &%$dkim_cur_signer%&
37354 The signer that is being evaluated in this ACL run. This can be a domain or
37355 an identity. This is one of the list items from the expanded main option
37356 &%dkim_verify_signers%& (see above).
37357 .vitem &%$dkim_verify_status%&
37358 A string describing the general status of the signature. One of
37359 .ilist
37360 &%none%&: There is no signature in the message for the current domain or
37361 identity (as reflected by &%$dkim_cur_signer%&).
37362 .next
37363 &%invalid%&: The signature could not be verified due to a processing error.
37364 More detail is available in &%$dkim_verify_reason%&.
37365 .next
37366 &%fail%&: Verification of the signature failed.  More detail is
37367 available in &%$dkim_verify_reason%&.
37368 .next
37369 &%pass%&: The signature passed verification. It is valid.
37370 .endlist
37371 .vitem &%$dkim_verify_reason%&
37372 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37373 "fail" or "invalid". One of
37374 .ilist
37375 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37376 key for the domain could not be retrieved. This may be a temporary problem.
37377 .next
37378 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37379 record for the domain is syntactically invalid.
37380 .next
37381 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37382 body hash does not match the one specified in the signature header. This
37383 means that the message body was modified in transit.
37384 .next
37385 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37386 could not be verified. This may mean that headers were modified,
37387 re-written or otherwise changed in a way which is incompatible with
37388 DKIM verification. It may of course also mean that the signature is forged.
37389 .endlist
37390 .vitem &%$dkim_domain%&
37391 The signing domain. IMPORTANT: This variable is only populated if there is
37392 an actual signature in the message for the current domain or identity (as
37393 reflected by &%$dkim_cur_signer%&).
37394 .vitem &%$dkim_identity%&
37395 The signing identity, if present. IMPORTANT: This variable is only populated
37396 if there is an actual signature in the message for the current domain or
37397 identity (as reflected by &%$dkim_cur_signer%&).
37398 .vitem &%$dkim_selector%&
37399 The key record selector string.
37400 .vitem &%$dkim_algo%&
37401 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37402 .vitem &%$dkim_canon_body%&
37403 The body canonicalization method. One of 'relaxed' or 'simple'.
37404 .vitem &%dkim_canon_headers%&
37405 The header canonicalization method. One of 'relaxed' or 'simple'.
37406 .vitem &%$dkim_copiedheaders%&
37407 A transcript of headers and their values which are included in the signature
37408 (copied from the 'z=' tag of the signature).
37409 .vitem &%$dkim_bodylength%&
37410 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37411 limit was set by the signer, "9999999999999" is returned. This makes sure
37412 that this variable always expands to an integer value.
37413 .vitem &%$dkim_created%&
37414 UNIX timestamp reflecting the date and time when the signature was created.
37415 When this was not specified by the signer, "0" is returned.
37416 .vitem &%$dkim_expires%&
37417 UNIX timestamp reflecting the date and time when the signer wants the
37418 signature to be treated as "expired". When this was not specified by the
37419 signer, "9999999999999" is returned. This makes it possible to do useful
37420 integer size comparisons against this value.
37421 .vitem &%$dkim_headernames%&
37422 A colon-separated list of names of headers included in the signature.
37423 .vitem &%$dkim_key_testing%&
37424 "1" if the key record has the "testing" flag set, "0" if not.
37425 .vitem &%$dkim_key_nosubdomains%&
37426 "1" if the key record forbids subdomaining, "0" otherwise.
37427 .vitem &%$dkim_key_srvtype%&
37428 Service type (tag s=) from the key record. Defaults to "*" if not specified
37429 in the key record.
37430 .vitem &%$dkim_key_granularity%&
37431 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37432 in the key record.
37433 .vitem &%$dkim_key_notes%&
37434 Notes from the key record (tag n=).
37435 .endlist
37436
37437 In addition, two ACL conditions are provided:
37438
37439 .vlist
37440 .vitem &%dkim_signers%&
37441 ACL condition that checks a colon-separated list of domains or identities
37442 for a match against the domain or identity that the ACL is currently verifying
37443 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37444 verb to a group of domains or identities. For example:
37445
37446 .code
37447 # Warn when Mail purportedly from GMail has no signature at all
37448 warn log_message = GMail sender without DKIM signature
37449      sender_domains = gmail.com
37450      dkim_signers = gmail.com
37451      dkim_status = none
37452 .endd
37453
37454 .vitem &%dkim_status%&
37455 ACL condition that checks a colon-separated list of possible DKIM verification
37456 results against the actual result of verification. This is typically used
37457 to restrict an ACL verb to a list of verification outcomes, for example:
37458
37459 .code
37460 deny message = Mail from Paypal with invalid/missing signature
37461      sender_domains = paypal.com:paypal.de
37462      dkim_signers = paypal.com:paypal.de
37463      dkim_status = none:invalid:fail
37464 .endd
37465
37466 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37467 see the documentation of the &%$dkim_verify_status%& expansion variable above
37468 for more information of what they mean.
37469 .endlist
37470
37471 . ////////////////////////////////////////////////////////////////////////////
37472 . ////////////////////////////////////////////////////////////////////////////
37473
37474 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37475          "Adding drivers or lookups"
37476 .cindex "adding drivers"
37477 .cindex "new drivers, adding"
37478 .cindex "drivers" "adding new"
37479 The following actions have to be taken in order to add a new router, transport,
37480 authenticator, or lookup type to Exim:
37481
37482 .olist
37483 Choose a name for the driver or lookup type that does not conflict with any
37484 existing name; I will use &"newdriver"& in what follows.
37485 .next
37486 Add to &_src/EDITME_& the line:
37487 .display
37488 <&'type'&>&`_NEWDRIVER=yes`&
37489 .endd
37490 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37491 code is not to be included in the binary by default, comment this line out. You
37492 should also add any relevant comments about the driver or lookup type.
37493 .next
37494 Add to &_src/config.h.defaults_& the line:
37495 .code
37496 #define <type>_NEWDRIVER
37497 .endd
37498 .next
37499 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37500 and create a table entry as is done for all the other drivers and lookup types.
37501 .next
37502 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37503 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37504 Add your &`NEWDRIVER`& to that list.
37505 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37506 simple form that most lookups have.
37507 .next
37508 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37509 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37510 driver or lookup type and add it to the definition of OBJ.
37511 .next
37512 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37513 &_src_&.
37514 .next
37515 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37516 as for other drivers and lookups.
37517 .endlist
37518
37519 Then all you need to do is write the code! A good way to start is to make a
37520 proforma by copying an existing module of the same type, globally changing all
37521 occurrences of the name, and cutting out most of the code. Note that any
37522 options you create must be listed in alphabetical order, because the tables are
37523 searched using a binary chop procedure.
37524
37525 There is a &_README_& file in each of the sub-directories of &_src_& describing
37526 the interface that is expected.
37527
37528
37529
37530
37531 . ////////////////////////////////////////////////////////////////////////////
37532 . ////////////////////////////////////////////////////////////////////////////
37533
37534 . /////////////////////////////////////////////////////////////////////////////
37535 . These lines are processing instructions for the Simple DocBook Processor that
37536 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37537 . PDFs than using xmlto and fop. They will be ignored by all other XML
37538 . processors.
37539 . /////////////////////////////////////////////////////////////////////////////
37540
37541 .literal xml
37542 <?sdop
37543   format="newpage"
37544   foot_right_recto="&chaptertitle;"
37545   foot_right_verso="&chaptertitle;"
37546 ?>
37547 .literal off
37548
37549 .makeindex "Options index"   "option"
37550 .makeindex "Variables index" "variable"
37551 .makeindex "Concept index"   "concept"
37552
37553
37554 . /////////////////////////////////////////////////////////////////////////////
37555 . /////////////////////////////////////////////////////////////////////////////